nvmet.host.create

Create an NVMe target host.

This may be then be associated with one or more subsystems to control access.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: nvmet_host_create

nvmet_host_create

Type: object

NVMe-oF host configuration data for creation.

No Additional Properties

hostnqn Required

Hostnqn

Type: string

Must be at least 11 characters long

Must be at most 223 characters long

dhchap_key

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.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

dhchap_ctrl_key

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.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

dhchap_dhgroup

Dhchap Dhgroup

Default: null

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

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "2048-BIT"
• "3072-BIT"
• "4096-BIT"
• "6144-BIT"
• "8192-BIT"

Type: null

dhchap_hash

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"

Return value

NVMetHostEntry

Type: object

The created NVMe-oF host configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the NVMe-oF host.

hostnqn Required

Hostnqn

Type: string

NQN of the host that will connect to this TrueNAS.

Must be at least 1 characters long

dhchap_key

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.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

dhchap_ctrl_key

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.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

dhchap_dhgroup

Dhchap Dhgroup

Default: null

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

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "2048-BIT"
• "3072-BIT"
• "4096-BIT"
• "6144-BIT"
• "8192-BIT"

Type: null

dhchap_hash

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