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

Retrieve an FC WWPN alias

Contributors

GET /network/fc/wwpn-aliases/{svm.uuid}/{alias}

Introduced In: 9.6

Retrieves an FC WWPN alias.

  • vserver fcp wwpn-alias show

Parameters

Name Type In Required Description

svm.uuid

string

path

True

The unique identifier of the SVM in which the alias is found.

alias

string

path

True

The name of FC WWPN alias.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

alias

string

The FC WWPN alias. Required in POST.

svm

svm

SVM, applies only to SVM-scoped objects.

wwpn

string

The FC initiator WWPN. Required in POST.

Example response
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "alias": "host1",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "wwpn": "2f:a0:00:a0:98:0b:56:13"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2621462

The specified SVM does not exist or cannot be accessed by this user.

5374046

The alias could not be found.

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

Name Type Description

self

href

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.