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

Type: array
No Additional Items

Tuple Validation

Parameter 1: nvmet_subsys_create

nvmet_subsys_create

Type: object

Configuration data for creating a new 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

Default: null

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 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.

Type: boolean
Type: null

Qid Max

Default: null

Maximum number of queue IDs allowed for this subsystem.

Type: integer
Type: null

Ieee Oui

Default: null

IEEE Organizationally Unique Identifier for the subsystem.

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.

Type: boolean
Type: null

Type: object

The newly created NVMe-oF subsystem configuration.


Required roles: SHARING_NVME_TARGET_WRITE