nvmet.port_subsys.update

Update port/subsys association of id.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the port-subsystem association to update.

Parameter 2: nvmet_port_subsys_update

nvmet_port_subsys_update

Type: object

Updated port-subsystem association configuration data.

No Additional Properties

port_id

Port Id

Type: integer

ID of the NVMe-oF port to associate.

subsys_id

Subsys Id

Type: integer

ID of the NVMe-oF subsystem to make accessible.

Return value

NVMetPortSubsysEntry

Type: object

The updated 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

NVMetSubsysEntry

Type: object

NVMe-oF subsystem that is accessible through the port.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the NVMe-oF subsystem.

name Required

Name

Type: string

Human readable name for the subsystem.

If subnqn is not provided on creation, then this name will be appended to the basenqn from nvmet.global.config to generate a subnqn.

Must be at least 1 characters long

subnqn

Subnqn

Default: null

NVMe Qualified Name (NQN) for the subsystem.

If not provided during creation, will be auto-generated by appending the name to the basenqn from nvmet.global.config.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

serial Required

Serial

Type: string

Serial number assigned to the subsystem.

allow_any_host

Allow Any Host

Type: boolean Default: false

Any host can access the storage associated with this subsystem (i.e. no access control).

pi_enable

Pi Enable

Default: null

Enable Protection Information (PI) for data integrity checking.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

qid_max

Qid Max

Default: null

Maximum number of queue IDs allowed for this subsystem.

Any of

• Option 1
• Option 2

Type: integer

Type: null

ieee_oui

Ieee Oui

Default: null

IEEE Organizationally Unique Identifier for the subsystem.

Any of

• Option 1
• Option 2

Type: string

Type: null

ana

Ana

Default: null

If set to either True or False, then override the global ana setting from nvmet.global.config for this subsystem only.

If null, then the global ana setting will take effect.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

hosts

Hosts

Default: []

List of host ids which have access to this subsystem.

Only populated on query if extra.options.verbose is set.

Any of

• Option 1
• Option 2

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Type: null

namespaces

Namespaces

Default: []

List of namespaces ids in this subsystem.

Only populated on query if extra.options.verbose is set.

Any of

• Option 1
• Option 2

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Type: null

ports

Ports

Default: []

List of ports ids on which this subsystem is available.

Only populated on query if extra.options.verbose is set.

Any of

• Option 1
• Option 2

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Type: null

Required roles: SHARING_NVME_TARGET_WRITE