nvmet.port.create

Create a NVMe target port.

ports are the means through which subsystems (subsys) are made available to clients (hosts).

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: nvmet_port_create

nvmet_port_create

NVMe-oF port configuration data for creation (TCP/RDMA or Fibre Channel).

One of

• NVMetPortCreateRDMATCP
• NVMetPortCreateFC

NVMetPortCreateRDMATCP

Type: object
No Additional Properties

addr_trtype Required

Addr Trtype

Type: enum (of string)

Must be one of:

• "TCP"
• "RDMA"

addr_trsvcid

Addr Trsvcid

Type: integer Default: 4420

Value must be greater or equal to 1024 and lesser or equal to 65535

addr_traddr Required

Addr Traddr

Any of

• Option 1
• Option 2

Type: const
Specific value: ""

Type: string

inline_data_size

Inline Data Size

Default: null

Maximum size for inline data transfers or null for default.

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_queue_size

Max Queue Size

Default: null

Maximum number of queue entries or null for default.

Any of

• Option 1
• Option 2

Type: integer

Type: null

pi_enable

Pi Enable

Default: null

Whether Protection Information (PI) is enabled or null for default.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

enabled

Enabled

Type: boolean Default: true

Port enabled. When NVMe target is running, cannot make changes to an enabled port.

NVMetPortCreateFC

Type: object
No Additional Properties

addr_trtype Required

Addr Trtype

Type: const

Fabric transport technology name.

Specific value: "FC"

addr_traddr Required

Addr Traddr

Type: string

A transport-specific field identifying the NVMe host port to use for the connection to the controller.

Must be at least 1 characters long

inline_data_size

Inline Data Size

Default: null

Maximum size for inline data transfers or null for default.

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_queue_size

Max Queue Size

Default: null

Maximum number of queue entries or null for default.

Any of

• Option 1
• Option 2

Type: integer

Type: null

pi_enable

Pi Enable

Default: null

Whether Protection Information (PI) is enabled or null for default.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

enabled

Enabled

Type: boolean Default: true

Port enabled. When NVMe target is running, cannot make changes to an enabled port.

Return value

NVMetPortEntry

Type: object

The created NVMe-oF port configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the NVMe-oF port.

index Required

Index

Type: integer

Index of the port, for internal use.

addr_trtype Required

Addr Trtype

Type: enum (of string)

Fabric transport technology name.

Must be one of:

• "TCP"
• "RDMA"
• "FC"

addr_trsvcid Required

Addr Trsvcid

Transport-specific TRSVCID field. When configured for TCP/IP or RDMA this will be the port number.

Any of

• Option 1
• Option 2
• Option 3

Type: integer

Type: string

Must be at least 1 characters long

Type: null

addr_traddr Required

Addr Traddr

Type: string

A transport-specific field identifying the NVMe host port to use for the connection to the controller.

For TCP or RDMA transports, this will be an IPv4 or IPv6 address.

addr_adrfam Required

Addr Adrfam

Type: enum (of string)

Address family.

Must be one of:

• "IPV4"
• "IPV6"
• "FC"

inline_data_size

Inline Data Size

Default: null

Maximum size for inline data transfers or null for default.

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_queue_size

Max Queue Size

Default: null

Maximum number of queue entries or null for default.

Any of

• Option 1
• Option 2

Type: integer

Type: null

pi_enable

Pi Enable

Default: null

Whether Protection Information (PI) is enabled or null for default.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

enabled

Enabled

Type: boolean Default: true

Port enabled. When NVMe target is running, cannot make changes to an enabled port.

Required roles: SHARING_NVME_TARGET_WRITE