Update an NVMe subsystem host

vserver nvme subsystem host add-proximal-vserver
vserver nvme subsystem host remove-proximal-vserver

Learn more

DOC /protocols/nvme/subsystems

Parameters

Name	Type	In	Required	Description
subsystem.uuid	string	path	True	The unique identifier of the NVMe subsystem.
nqn	string	path	True	The NVMe qualified name (NQN) used to identify the NVMe subsystem host.

Name

Type

In

Required

Description

subsystem.uuid

string

path

True

The unique identifier of the NVMe subsystem.

nqn

string

path

True

The NVMe qualified name (NQN) used to identify the NVMe subsystem host.

Request Body

Name	Type	Description
io_queue	io_queue	The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
proximity	proximity	Properties that define the SVMs to which the host is proximal. This information is used to properly report active optimized and active non-optimized network paths using an NVMe controller. If no configuration has been specified for the host, the sub-object is not present in GET requests. These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.
subsystem	subsystem	The NVMe subsystem to which the NVMe host has been provisioned.

Name

Type

Description

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

proximity

Properties that define the SVMs to which the host is proximal. This information is used to properly report active optimized and active non-optimized network paths using an NVMe controller. If no configuration has been specified for the host, the sub-object is not present in GET requests.

These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.

Example request

{
  "io_queue": {
    "count": 4,
    "depth": 32
  },
  "proximity": {
    "peer_svms": [
      {
        "name": "peer1",
        "uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
      }
    ]
  },
  "subsystem": {
    "name": "subsystem1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code	Description
5376354	The SVM peer relationship does not exist.
26345675	The SVM peer relationship contains local SVM name mismatch.
72090001	The NVMe subsystem does not exist.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

dh_hmac_chap

A container for the configuration of NVMe in-band authentication using the DH-HMAC-CHAP protocol for a host.

Name	Type	Description
mode	string	The expected NVMe in-band authentication mode for the host. This property is an indication of which secrets are configured for the host. When set to: none: The host has neither the host nor controller secret configured, and no authentication is performed. unidirectional: The host has a host secret configured. The controller will authenticate the host. bidirectional: The host has both a host and controller secret configured. The controller will authenticate the host and the host will authenticate the controller.

Name

Type

Description

mode

string

The expected NVMe in-band authentication mode for the host. This property is an indication of which secrets are configured for the host. When set to:

none: The host has neither the host nor controller secret configured, and no authentication is performed.
unidirectional: The host has a host secret configured. The controller will authenticate the host.
bidirectional: The host has both a host and controller secret configured. The controller will authenticate the host and the host will authenticate the controller.

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

Name	Type	Description
count	integer	The number of I/O queue pairs. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue count is being used. Valid in GET only.
depth	integer	The I/O queue depth. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue depth is being used. Valid in GET only.

Name

Type

Description

count

integer

The number of I/O queue pairs. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue count is being used. Valid in GET only.

depth

integer

The I/O queue depth. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue depth is being used. Valid in GET only.

peer_svms

A reference to an SVM peer relationship.

Name	Type	Description
name	string	The local name of the peer SVM. This name is unique among all local and peer SVMs.
uuid	string	The unique identifier of the SVM peer relationship. This is the UUID of the relationship, not the UUID of the peer SVM itself.

Name

Type

Description

name

string

The local name of the peer SVM. This name is unique among all local and peer SVMs.

uuid

string

The unique identifier of the SVM peer relationship. This is the UUID of the relationship, not the UUID of the peer SVM itself.

proximity

Properties that define the SVMs to which the host is proximal. This information is used to properly report active optimized and active non-optimized network paths using an NVMe controller. If no configuration has been specified for the host, the sub-object is not present in GET requests.

These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.

Name	Type	Description
local_svm	boolean	A boolean that indicates if the host is proximal to the SVM for which it is configured.
peer_svms	array[peer_svms]	An array of remote peer SVMs to which the host is proximal.

Name

Type

Description

local_svm

boolean

A boolean that indicates if the host is proximal to the SVM for which it is configured.

peer_svms

array[peer_svms]

An array of remote peer SVMs to which the host is proximal.

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

Name	Type	Description
count	integer	The number of I/O queue pairs. The default value is inherited from the owning NVMe subsystem.
depth	integer	The I/O queue depth. The default value is inherited from the owning NVMe subsystem.

Name

Type

Description

count

integer

The number of I/O queue pairs. The default value is inherited from the owning NVMe subsystem.

depth

integer

The I/O queue depth. The default value is inherited from the owning NVMe subsystem.

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.

Name	Type	Description
name	string	The name of the NVMe subsystem.
uuid	string	The unique identifier of the NVMe subsystem.

Name

Type

Description

name

string

The name of the NVMe subsystem.

uuid

string

The unique identifier of the NVMe subsystem.

tls

A container for the configuration for NVMe/TCP-TLS transport session for the host.

records

The NVMe host provisioned to access NVMe namespaces mapped to a subsystem.

Name	Type	Description
io_queue	io_queue	The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
subsystem	subsystem	The NVMe subsystem to which the NVMe host has been provisioned.

Name

Type

Description

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.

nvme_subsystem_host

The NVMe host provisioned to access NVMe namespaces mapped to a subsystem.

Name	Type	Description
io_queue	io_queue	The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
proximity	proximity	Properties that define the SVMs to which the host is proximal. This information is used to properly report active optimized and active non-optimized network paths using an NVMe controller. If no configuration has been specified for the host, the sub-object is not present in GET requests. These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.
subsystem	subsystem	The NVMe subsystem to which the NVMe host has been provisioned.

Name

Type

Description

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

proximity

Properties that define the SVMs to which the host is proximal. This information is used to properly report active optimized and active non-optimized network paths using an NVMe controller. If no configuration has been specified for the host, the sub-object is not present in GET requests.

These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

returned_error

Name	Type	Description
arguments	array[error_arguments]	Message arguments
code	string	Error code
message	string	Error message
target	string	The target parameter that caused the error.

Name

Type

Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.

Update an NVMe subsystem host

Creating your file...

Related ONTAP commands

Learn more

Parameters

Request Body

Response

Error

Definitions