nvmet.port_subsys.create

Create an association between a port and a subsystem (subsys).

This will make the subsystem accessible on that port (subject to access control by either the allow_any_host subsystem attribute, or hosts associated with the subsystem).

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: nvmet_port_subsys_create

nvmet_port_subsys_create

Type: object

Port-subsystem association configuration data for creation.

No Additional Properties

port_id Required

Port Id

Type: integer

ID of the NVMe-oF port to associate.

subsys_id Required

Subsys Id

Type: integer

ID of the NVMe-oF subsystem to make accessible.

Return value

NVMetPortSubsysEntry

Type: object

The created port-subsystem association.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the port-subsystem association.

port Required

NVMetPortEntry

Type: object

NVMe-oF port that provides access to the subsystem.

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.

subsys Required

Type: object

NVMe-oF subsystem that is accessible through the port.

Required roles: SHARING_NVME_TARGET_WRITE