Skip to main content

Retrieve an initiator

Contributors
PDFs

GET /protocols/san/initiators/{svm.uuid}/{name}

Introduced In: 9.14

Retrieves an initiator.

  • lun igroup initiator show

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

The unique identifier of the SVM for which the initiator properties are configured.

name

string

path

True

The name of the initiator.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

comment

string

A user-specified comment.

name

string

The name of the initiator.

protocol

string

The protocol of the initiator.

proximity

proximity

Properties that define to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for the initiator, the sub-object will not be present in GET.

These properties apply to all instances of the initiator in all initiator groups in the SVM and its peers.

svm

svm

The SVM for which the initiator properties are configured.
Example response 
{
  "comment": "My initiator comment.",
  "name": "iqn.2018-02.com.netapp.iscsi:name1",
  "protocol": "iscsi",
  "proximity": {
    "peer_svms": [
      {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "peer1",
        "uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
      }
    ]
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

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

self

href

peer_svms

A reference to an SVM peer relationship.

Name Type Description

_links

_links

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 to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for the initiator, the sub-object will not be present in GET.

These properties apply to all instances of the initiator in all initiator groups in the SVM and its peers.

Name Type Description

local_svm

boolean

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

peer_svms

array[peer_svms]

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

svm

The SVM for which the initiator properties are configured.

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.