Skip to main content

Retrieve an iSCSI session

Contributors
PDFs

GET /protocols/san/iscsi/sessions/{svm.uuid}/{tpgroup}/{tsih}

Introduced In: 9.6

Retrieves an iSCSI session.

  • vserver iscsi connection show

  • vserver iscsi session parameter show

  • vserver iscsi session show

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

The unique identifier of the SVM of the iSCSI session.

tpgroup

string

path

True

The target portal group of the iSCSI session.

tsih

integer

path

True

The target session identifying handle.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

connections

array[iscsi_connection]

The iSCSI connections that make up the iSCSI session.

igroups

array[igroups]

The initiator groups in which the initiator is a member.

initiator

initiator

The initiator that created the session.

isid

string

The initiator portion of the session identifier specified by the initiator during login.

svm

svm

SVM, applies only to SVM-scoped objects.

target_portal_group

string

The target portal group to which the session belongs.

target_portal_group_tag

integer

The target portal group tag of the session.

tsih

integer

The target session identifier handle (TSIH) of the session.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "connections": [
    {
      "_links": {
        "next": {
          "href": "/api/resourcelink"
        },
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "authentication_type": "string",
      "cid": 0,
      "initiator_address": {
        "address": "10.10.10.7",
        "port": 55432
      },
      "interface": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ip": {
          "address": "10.10.10.7",
          "port": 3260
        },
        "name": "lif1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ],
  "igroups": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "igroup1",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "initiator": {
    "alias": "initiator_alias1",
    "comment": "This is an iSCSI initiator for host 5",
    "name": "iqn.1992-01.example.com:string"
  },
  "isid": "61:62:63:64:65:00",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "target_portal_group": "tpgroup1",
  "target_portal_group_tag": 0,
  "tsih": 0
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2621462

An SVM with the specified UUID 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

_links

Name Type Description

next

href

self

href

initiator_address

The TCP socket information for the initiator end of the connection. This is useful for network packet debugging.

Name Type Description

address

string

The TCP IPv4 or IPv6 address of the initiator end of the iSCSI connection.

port

integer

The TCP port number of the initiator end of the iSCSI connection.

ip

The IP information. ONTAP only supports port 3260.

Name Type Description

address

string

IPv4 or IPv6 address

port

integer

The TCP port number of the iSCSI access endpoint.

interface

The network interface information for the target end of the connection.

Name Type Description

_links

_links

ip

ip

The IP information. ONTAP only supports port 3260.

  • readOnly: 1

  • Introduced in: 9.6

name

string

The name of the interface.

uuid

string

The UUID that uniquely identifies the interface.

iscsi_connection

An active iSCSI connection.

Name Type Description

_links

_links

authentication_type

string

The iSCSI authentication type used to establish the connection.

cid

integer

The identifier of the connection within the session.

initiator_address

initiator_address

The TCP socket information for the initiator end of the connection. This is useful for network packet debugging.

interface

interface

The network interface information for the target end of the connection.

igroups

Name Type Description

_links

_links

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

initiator

The initiator that created the session.

Name Type Description

alias

string

The initiator alias.

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} .

name

string

The world wide unique name of the initiator.

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.