nvmet.host_subsys.update¶
Update host/subsys association of id.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerID of the host-subsystem association to update.
Parameter 2: nvmet_host_subsys_update
nvmet_host_subsys_update
Type: objectUpdated host-subsystem association configuration data.
No Additional PropertiesHost Id
Type: integerID of the NVMe-oF host to authorize.
Subsys Id
Type: integerID of the NVMe-oF subsystem to grant access to.
NVMetHostSubsysEntry
Type: objectThe updated host-subsystem association.
No Additional PropertiesId
Type: integerUnique identifier for the host-subsystem association.
NVMetHostEntry
Type: objectNVMe-oF host that is authorized to access the subsystem.
No Additional PropertiesId
Type: integerUnique identifier for the NVMe-oF host.
Hostnqn
Type: stringNQN of the host that will connect to this TrueNAS.
Must be at least 1 characters long
Dhchap Key
Default: nullIf set, the secret that the host must present when connecting.
A suitable secret can be generated using nvme gen-dhchap-key, or by using the nvmet.host.generate_key API.
Must be at least 1 characters long
Dhchap Ctrl Key
Default: nullIf set, the secret that this TrueNAS will present to the host when the host is connecting (Bi-Directional Authentication).
A suitable secret can be generated using nvme gen-dhchap-key, or by using the nvmet.host.generate_key API.
Must be at least 1 characters long
Dhchap Dhgroup
Default: nullIf selected, the DH (Diffie-Hellman) key exchange built on top of CHAP to be used for authentication.
Must be one of:
- "2048-BIT"
- "3072-BIT"
- "4096-BIT"
- "6144-BIT"
- "8192-BIT"
Dhchap Hash
Type: enum (of string) Default: "SHA-256"HMAC (Hashed Message Authentication Code) to be used in conjunction if a dhchap_dhgroup is selected.
Must be one of:
- "SHA-256"
- "SHA-384"
- "SHA-512"
NVMetSubsysEntry
Type: objectNVMe-oF subsystem that the host is authorized to access.
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