Skip to main content
A newer release of this product is available.

Retrieve an NVMe interface

Contributors
PDFs

GET /protocols/nvme/interfaces/{uuid}

Introduced In: 9.6

Retrieves an NVMe interface.

  • vserver nvme show-interface

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

The unique identifier of the NVMe interface.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.
Example response 
{
  "_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

ONTAP Error Response Codes

Error Code Description

2621462

The supplied SVM does not exist.

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

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

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.

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.