nvmet.namespace.update¶
Update NVMe target namespace of id.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 2: nvmet_namespace_update
nvmet_namespace_update
Type: objectNo Additional Properties
Nsid
Namespace ID (NSID)
Each namespace within a subsystem has an associated NSID, unique within that subsystem.
If not supplied during namespace creation then the next available NSID will be used.
Value must be greater or equal to 1 and strictly lesser than 4294967295
Device Type
Type: enum (of string)Type of device (or file) used to implement the namespace.
Must be one of:
- "ZVOL"
- "FILE"
Device Path
Type: stringPath to the device or file being used to implement the namespace.
When device_type is "ZVOL" then this path is e.g. "zvol/poolname/zvolname"
When device_type is "FILE" then this path is e.g. "/mnt/poolmnt/path/to/file". The file will be created if necessary.
Filesize
When device_type is "FILE" then this will be the size of the file in bytes.
Enabled
Type: booleanIf enabled is False then the namespace will not be accessible.
Some namespace configuration changes are blocked when that namespace is enabled.
Subsys Id
Type: integerNVMetNamespaceEntry
Type: objectNo Additional Properties
Id
Type: integerNsid
Default: nullNamespace ID (NSID)
Each namespace within a subsystem has an associated NSID, unique within that subsystem.
If not supplied during namespace creation then the next available NSID will be used.
Value must be greater or equal to 1 and strictly lesser than 4294967295
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:
Device Type
Type: enum (of string)Type of device (or file) used to implement the namespace.
Must be one of:
- "ZVOL"
- "FILE"
Device Path
Type: stringPath to the device or file being used to implement the namespace.
When device_type is "ZVOL" then this path is e.g. "zvol/poolname/zvolname"
When device_type is "FILE" then this path is e.g. "/mnt/poolmnt/path/to/file". The file will be created if necessary.
Filesize
Default: nullWhen device_type is "FILE" then this will be the size of the file in bytes.
Device Uuid
Type: stringMust be at least 1 characters long
Device Nguid
Type: stringMust be at least 1 characters long
Enabled
Type: boolean Default: trueIf enabled is False then the namespace will not be accessible.
Some namespace configuration changes are blocked when that namespace is enabled.
Locked
Reflect the locked state of the namespace.
The underlying device_path could be an encrypted ZVOL, or a file on an encrypted dataset. In either case locked will be True if the underlying entity is locked.
Required roles: SHARING_NVME_TARGET_WRITE