nvmet.host.update

Update NVMe target host of id.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the NVMe-oF host to update.
Parameter 2: nvmet_host_update

nvmet_host_update

Type: object

Updated NVMe-oF host configuration data.

 No Additional Properties

Hostnqn

Type: string

NQN of the host that will connect to this TrueNAS.

Must be at least 11 characters long

Must be at most 223 characters long

Dhchap Key


If 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.

Type: string

Must be at least 1 characters long

Type: null

Dhchap Ctrl Key


If 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.

Type: string

Must be at least 1 characters long

Type: null

Dhchap Dhgroup


If selected, the DH (Diffie-Hellman) key exchange built on top of CHAP to be used for authentication.

Type: enum (of string)
Must be one of:
  • "2048-BIT"
  • "3072-BIT"
  • "4096-BIT"
  • "6144-BIT"
  • "8192-BIT"
Type: null

Dhchap Hash

Type: enum (of string)

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"

NVMetHostEntry

Type: object

The updated NVMe-oF host configuration.

 No Additional Properties

Id

Type: integer

Unique identifier for the NVMe-oF host.

Hostnqn

Type: string

NQN of the host that will connect to this TrueNAS.

Must be at least 1 characters long

Dhchap Key

Default: null

If 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.

Type: string

Must be at least 1 characters long

Type: null

Dhchap Ctrl Key

Default: null

If 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.

Type: string

Must be at least 1 characters long

Type: null

Dhchap Dhgroup

Default: null

If selected, the DH (Diffie-Hellman) key exchange built on top of CHAP to be used for authentication.

Type: enum (of string)
Must be one of:
  • "2048-BIT"
  • "3072-BIT"
  • "4096-BIT"
  • "6144-BIT"
  • "8192-BIT"
Type: null

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"


Required roles: SHARING_NVME_TARGET_WRITE