nvmet.host_subsys.query ======================= Sent on nvmet.host_subsys changes. .. raw:: html
Type: object

NVMetHostSubsysAddedEvent

Type: object
No Additional Properties

Id

Type: integer

NVMetHostSubsysEntry

Type: object
No Additional Properties

Id

Type: integer

NVMetHostEntry

Type: object
No Additional Properties

Id

Type: integer

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"

NVMetSubsysEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

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

Subnqn

Default: null

Type: string

Must be at least 1 characters long

Must be at most 223 characters long

Type: null

Serial

Type: string

Allow Any Host

Type: boolean Default: false

If True then any host can access the storage associated with this subsystem (i.e. no access control).

Pi Enable

Default: null

Type: boolean
Type: null

Qid Max

Default: null

Type: integer
Type: null

Ieee Oui

Default: null

Type: string
Type: null

Ana

Default: null

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.

Type: boolean
Type: null

Hosts

Default: []

List of host ids which have access to this subsystem.

Only populated on query if extra.options.verbose is set.

Type: array of integer
No Additional Items
Each item of this array must be:
Type: integer
Type: null

Namespaces

Default: []

List of namespaces ids in this subsystem.

Only populated on query if extra.options.verbose is set.

Type: array of integer
No Additional Items
Each item of this array must be:
Type: integer
Type: null

Ports

Default: []

List of ports ids on which this subsystem is available.

Only populated on query if extra.options.verbose is set.

Type: array of integer
No Additional Items
Each item of this array must be:
Type: integer
Type: null

NVMetHostSubsysChangedEvent

Type: object
No Additional Properties

Id

Type: integer

NVMetHostSubsysEntry

Type: object
No Additional Properties

Id

Type: integer

NVMetHostEntry

Type: object
No Additional Properties

Id

Type: integer

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"

NVMetSubsysEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

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

Subnqn

Default: null

Type: string

Must be at least 1 characters long

Must be at most 223 characters long

Type: null

Serial

Type: string

Allow Any Host

Type: boolean Default: false

If True then any host can access the storage associated with this subsystem (i.e. no access control).

Pi Enable

Default: null

Type: boolean
Type: null

Qid Max

Default: null

Type: integer
Type: null

Ieee Oui

Default: null

Type: string
Type: null

Ana

Default: null

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.

Type: boolean
Type: null

Hosts

Default: []

List of host ids which have access to this subsystem.

Only populated on query if extra.options.verbose is set.

Type: array of integer
No Additional Items
Each item of this array must be:
Type: integer
Type: null

Namespaces

Default: []

List of namespaces ids in this subsystem.

Only populated on query if extra.options.verbose is set.

Type: array of integer
No Additional Items
Each item of this array must be:
Type: integer
Type: null

Ports

Default: []

List of ports ids on which this subsystem is available.

Only populated on query if extra.options.verbose is set.

Type: array of integer
No Additional Items
Each item of this array must be:
Type: integer
Type: null

NVMetHostSubsysRemovedEvent

Type: object
No Additional Properties

Id

Type: integer


*Required roles:* SHARING_NVME_TARGET_READ