nvmet.namespace.create ====================== Create a NVMe target namespace in a subsystem (`subsys`). This will expose the namespace to any hosts permitted to access the subsystem. .. raw:: html
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
Type of device (or file) used to implement the namespace.
Path 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.
When device_type
is "FILE" then this will be the size of the file in bytes.
If enabled
is False
then the namespace will not be accessible.
Some namespace configuration changes are blocked when that namespace is enabled.
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
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
Must be at least 1
characters long
Must be at most 223
characters long
If True
then any host can access the storage associated with this subsystem (i.e. no access control).
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.
List of host ids which have access to this subsystem.
Only populated on query if extra.options.verbose
is set.
List of namespaces ids in this subsystem.
Only populated on query if extra.options.verbose
is set.
List of ports ids on which this subsystem is available.
Only populated on query if extra.options.verbose
is set.
Type of device (or file) used to implement the namespace.
Path 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.
When device_type
is "FILE" then this will be the size of the file in bytes.
Must be at least 1
characters long
Must be at least 1
characters long
If enabled
is False
then the namespace will not be accessible.
Some namespace configuration changes are blocked when that namespace is enabled.
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.