Skip to main content

Retrieve NVMe interfaces

Contributors
PDFs

GET /protocols/nvme/interfaces

Introduced In: 9.6

Retrieves NVMe interfaces.

  • vserver nvme show-interface

Learn more

Parameters

Name Type In Required Description

uuid

string

query

False

Filter by uuid

fc_interface.wwnn

string

query

False

Filter by fc_interface.wwnn

fc_interface.port.name

string

query

False

Filter by fc_interface.port.name

fc_interface.port.node.name

string

query

False

Filter by fc_interface.port.node.name

fc_interface.port.uuid

string

query

False

Filter by fc_interface.port.uuid

fc_interface.wwpn

string

query

False

Filter by fc_interface.wwpn

transport_protocols

string

query

False

Filter by transport_protocols

  • Introduced in: 9.10

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

transport_address

string

query

False

Filter by transport_address

interface_type

string

query

False

Filter by interface_type

  • Introduced in: 9.10

name

string

query

False

Filter by name

ip_interface.location.port.name

string

query

False

Filter by ip_interface.location.port.name

  • Introduced in: 9.10

ip_interface.location.port.node.name

string

query

False

Filter by ip_interface.location.port.node.name

  • Introduced in: 9.10

ip_interface.location.port.uuid

string

query

False

Filter by ip_interface.location.port.uuid

  • Introduced in: 9.10

ip_interface.ip.address

string

query

False

Filter by ip_interface.ip.address

  • Introduced in: 9.10

enabled

boolean

query

False

Filter by enabled

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

The number of records in the response.

records

array[nvme_interface]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "fc_interface": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "port": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "0a",
          "node": {
            "name": "node1"
          },
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        },
        "wwnn": "20:00:00:50:56:b4:13:a9",
        "wwpn": "20:00:00:50:56:b4:13:a8"
      },
      "interface_type": "string",
      "ip_interface": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ip": {
          "address": "10.10.10.7"
        },
        "location": {
          "port": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "e1b",
            "node": {
              "name": "node1"
            },
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        }
      },
      "name": "lif1",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "transport_address": "nn-0x200a00a0989062da:pn-0x200100a0989062da",
      "transport_protocols": [
        "string"
      ],
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

node

The node on which the FC port is located.

Name Type Description

name

string

The name of the node on which the FC port is located.

port

An FC port is the physical port of an FC adapter on a cluster node that can be connected to an FC network.

Name Type Description

_links

_links

name

string

The name of the FC port.

node

node

The node on which the FC port is located.

uuid

string

The unique identifier of the FC port.

fc_interface

The attributes specific to a Fibre Channel-based NVMe interface.

This is populated when interface_type is fc_interface.

Name Type Description

_links

_links

port

port

An FC port is the physical port of an FC adapter on a cluster node that can be connected to an FC network.

wwnn

string

The WWNN (world wide node name) of the Fibre Channel NVMe interface.

wwpn

string

The WWPN (world wide port name) of the Fibre Channel NVMe interface.
Name Type Description

self

href

ip

Name Type Description

address

string

IPv4 or IPv6 address

node

Name Type Description

name

string

Name of node on which the port is located.

port_reference

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

Name Type Description

_links

_links

name

string

node

node

uuid

string

location

Name Type Description

port

port_reference

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

ip_interface

The attributes specific to an IP-based NVMe interface.

This is populated when interface_type is ip_interface.

Name Type Description

_links

self_link

ip

ip

location

location

node

Name Type Description

_links

_links

name

string

uuid

string

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

nvme_interface

NVMe interfaces are network interfaces configured to support an NVMe over Fabrics (NVMe-oF) protocol. The NVMe interfaces are Fibre Channel interfaces supporting an NVMe-oF data protocol. Regardless of the underlying physical and data protocol, NVMe interfaces are treated equally for host-side application configuration. This endpoint provides a consolidated view of all NVMe interfaces for the purpose of configuring host-side applications.

NVMe interfaces must be created using the protocol-specific endpoints for Fibre Channel interfaces. See POST /network/fc/interfaces . After creation, the interfaces are available via this interface.

Name Type Description

_links

_links

enabled

boolean

The administrative state of the NVMe interface.

fc_interface

fc_interface

The attributes specific to a Fibre Channel-based NVMe interface.

This is populated when interface_type is fc_interface.

interface_type

string

The underlying interface type of the NVMe interface. This property identifies which of fc_interface and ip_interface will be further populated.

ip_interface

ip_interface

The attributes specific to an IP-based NVMe interface.

This is populated when interface_type is ip_interface.

name

string

The name of the NVMe interface.

node

node

svm

svm

SVM, applies only to SVM-scoped objects.

transport_address

string

The transport address of the NVMe interface.

transport_protocols

array[string]

The transport protocols supported by the NVMe interface.

uuid

string

The unique identifier of the NVMe interface.

error_arguments

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.