nvmet.subsys.update¶
Update NVMe target subsystem (subsys) of id.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerID of the subsystem to update.
Parameter 2: nvmet_subsys_update
nvmet_subsys_update
Type: objectUpdated configuration data for the NVMe-oF subsystem.
No Additional PropertiesName
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
NVMe Qualified Name (NQN) for the subsystem.
Must be a valid NQN format if provided.
Must be at least 11 characters long
Must be at most 223 characters long
Allow Any Host
Type: booleanAny host can access the storage associated with this subsystem (i.e. no access control).
Pi Enable
Enable Protection Information (PI) for data integrity checking.
Qid Max
Maximum number of queue IDs allowed for this subsystem.
Ieee Oui
IEEE Organizationally Unique Identifier for the subsystem.
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.
NVMetSubsysEntry
Type: objectThe updated NVMe-oF subsystem configuration.
No Additional PropertiesId
Type: integerUnique identifier for the NVMe-oF subsystem.
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: nullNVMe 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.
Must be at least 1 characters long
Serial
Type: stringSerial number assigned to the subsystem.
Allow Any Host
Type: boolean Default: falseAny host can access the storage associated with this subsystem (i.e. no access control).
Pi Enable
Default: nullEnable Protection Information (PI) for data integrity checking.
Qid Max
Default: nullMaximum number of queue IDs allowed for this subsystem.
Ieee Oui
Default: nullIEEE Organizationally Unique Identifier for the subsystem.
Ana
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