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

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.

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",
  "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

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.