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

Retrieve an FC login

Contributors
PDFs

GET /network/fc/logins/{interface.uuid}/{initiator.wwpn}

Introduced In: 9.6

Retrieves an FC login.

  • vserver fcp initiator show

Learn more

Parameters

Name Type In Required Description

interface.uuid

string

path

True

The unique identifier of the FC interface through which the initiator logged in.

initiator.wwpn

string

path

True

The world wide port name (WWPN) of the initiator.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

igroups

array[igroups]

The initiator groups in which the initiator is a member.

initiator

initiator

Information about the logged in FC initiator.

interface

interface

An FC interface.

protocol

string

The data protocol used to perform the login.

svm

svm
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "igroups": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "igroup1",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "initiator": {
    "aliases": [
      "alias1"
    ],
    "comment": "This is an FC initiator for host 5",
    "port_address": "5060A",
    "wwnn": "2f:a0:00:a0:98:0b:56:13",
    "wwpn": "2f:a0:00:a0:98:0b:56:13"
  },
  "interface": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "fc_lif1",
    "uuid": "3a09ab42-4da1-32cf-9d35-3385a6101a0b",
    "wwpn": "20:00:00:50:56:b4:13:a8"
  },
  "protocol": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

4

The Fibre Channel login specified does not exist.

5373983

An invalid WWPN was supplied.

5374881

The Fibre Channel interface specified does not exist.
Name Type Description

error

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

igroups

Name Type Description

_links

_links

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

initiator

Information about the logged in FC initiator.

Name Type Description

aliases

array[string]

The logged in initiator world wide port name (WWPN) aliases.

comment

string

A comment available for use by the administrator. This is modifiable from the initiator REST endpoint directly. See PATCH /protocols/san/igroups/{igroup.uuid}/initiators/{name} .

port_address

string

The port address of the initiator's FC port.

Each port in an FC switched fabric has its own unique port address for routing purposes. The port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the address given by a switch to the initiator port.

This is useful for obtaining statistics and diagnostic information from FC switches.

This is a hexadecimal encoded numeric value.

wwnn

string

The logged in initiator world wide node name (WWNN).

wwpn

string

The logged in initiator WWPN.

interface

An FC interface.

Name Type Description

_links

_links

name

string

The name of the FC interface.

uuid

string

The unique identifier of the FC interface.

wwpn

string

The WWPN of the FC interface.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.