Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the subsystem to update.

Parameter 2: nvmet_subsys_update

nvmet_subsys_update

Type: object

Updated configuration data for the NVMe-oF subsystem.

No Additional Properties

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

NVMe Qualified Name (NQN) for the subsystem.

Must be a valid NQN format if provided.

Type: string

Must be at least 11 characters long

Must be at most 223 characters long

Type: null

Allow Any Host

Type: boolean

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

Pi Enable

Enable Protection Information (PI) for data integrity checking.

Any of

Option 1
Option 2

Type: boolean

Type: null

Qid Max

Maximum number of queue IDs allowed for this subsystem.

Any of

Option 1
Option 2

Type: integer

Type: null

Ieee Oui

IEEE Organizationally Unique Identifier for the subsystem.

Any of

Option 1
Option 2

Type: string

Type: null

Ana

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

NVMetSubsysEntry

Type: object

The updated NVMe-oF subsystem configuration.

No Additional Properties

Id

Type: integer

Unique identifier for the NVMe-oF subsystem.

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

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

Type: string

Serial number assigned to the subsystem.

Allow Any Host

Type: boolean Default: false

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

Pi Enable

Default: null

Enable Protection Information (PI) for data integrity checking.

Any of

Option 1
Option 2

Type: boolean

Type: null

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

Default: null

IEEE Organizationally Unique Identifier for the subsystem.

Any of

Option 1
Option 2

Type: string

Type: null

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

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

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

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

Call parameters

Tuple Validation

Parameter 1: id

id

Parameter 2: nvmet_subsys_update

nvmet_subsys_update

name

Name

subnqn

Subnqn

Any of

allow_any_host

Allow Any Host

pi_enable

Pi Enable

Any of

qid_max

Qid Max

Any of

ieee_oui

Ieee Oui

Any of

ana

Ana

Any of

Return value

NVMetSubsysEntry

id Required

Id

name Required

Name

subnqn

Subnqn

Any of

serial Required

Serial

allow_any_host

Allow Any Host

pi_enable

Pi Enable

Any of

qid_max

Qid Max

Any of

ieee_oui

Ieee Oui

Any of

ana

Ana

Any of

hosts

Hosts

Any of

Each item of this array must be:

namespaces

Namespaces

Any of

Each item of this array must be:

ports

Ports

Any of

Each item of this array must be: