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.
No Additional Items
Tuple Validation
Parameter 1: nvmet_subsys_create
nvmet_subsys_create
Type: objectNo Additional Properties
Name
Type: stringHuman 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: nullMust be at least 1 characters long
Must be at most 223 characters long
Allow Any Host
Type: boolean Default: falseIf True then any host can access the storage associated with this subsystem (i.e. no access control).
Pi Enable
Default: nullQid Max
Default: nullIeee Oui
Default: nullAna
Default: nullIf 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.
NVMetSubsysEntry
Type: objectNo Additional Properties
Id
Type: integerName
Type: stringHuman 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: nullMust be at least 1 characters long
Must be at most 223 characters long
Serial
Type: stringAllow Any Host
Type: boolean Default: falseIf True then any host can access the storage associated with this subsystem (i.e. no access control).
Pi Enable
Default: nullQid Max
Default: nullIeee Oui
Default: nullAna
Default: nullIf 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.
Hosts
Default: []List of host ids which have access to this subsystem.
Only populated on query if extra.options.verbose is set.
No Additional Items
Each item of this array must be:
Namespaces
Default: []List of namespaces ids in this subsystem.
Only populated on query if extra.options.verbose is set.
No Additional Items
Each item of this array must be:
Ports
Default: []List of ports ids on which this subsystem is available.
Only populated on query if extra.options.verbose is set.
No Additional Items
Each item of this array must be:
Required roles: SHARING_NVME_TARGET_WRITE