nvmet.subsys.create

Create a NVMe target subsystem (subsys).

When a subsys contains one of more namespaces, and is associated with one or more ports then clients may access the storage using NVMe-oF.

All clients may access the subsystem if the allow_any_host attribute is set. Otherwise, access is only permitted to hosts who have been associated with the subsystem.

See nvmet.host.create and nvmet.host_subsys.create.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: nvmet_subsys_create

nvmet_subsys_create

Type: object
No Additional Properties

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

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Must be at most 223 characters long

Type: null

allow_any_host

Allow Any Host

Type: boolean Default: false

If True then any host can access the storage associated with this subsystem (i.e. no access control).

pi_enable

Pi Enable

Default: null

Any of

• Option 1
• Option 2

Type: boolean

Type: null

qid_max

Qid Max

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

ieee_oui

Ieee Oui

Default: null

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

Return value

NVMetSubsysEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

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

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Must be at most 223 characters long

Type: null

serial Required

Serial

Type: string

allow_any_host

Allow Any Host

Type: boolean Default: false

If True then any host can access the storage associated with this subsystem (i.e. no access control).

pi_enable

Pi Enable

Default: null

Any of

• Option 1
• Option 2

Type: boolean

Type: null

qid_max

Qid Max

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

ieee_oui

Ieee Oui

Default: null

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