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

Retrieve iSCSI services

Contributors
PDFs

GET /protocols/san/iscsi/services

Retrieves iSCSI services.

  • vserver iscsi show

Learn more

Parameters

Name Type In Required Description

enabled

boolean

query

False

Filter by enabled

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

target.name

string

query

False

Filter by target.name

target.alias

string

query

False

Filter by target.alias

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[iscsi_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "target": {
      "alias": "svm1",
      "name": "iqn.1992-08.com.netapp:sn.574caf71890911e8a6b7005056b4ea79:vs.2"
    }
  }
}

Error

Status: Default, Error
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

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

target

Name Type Description

alias

string

The iSCSI target alias of the iSCSI service.

The target alias can contain one (1) to 128 characters and feature any printable character except space (" "). A PATCH request with an empty alias ("") clears the alias.

Optional in POST and PATCH. In POST, this defaults to the name of the SVM.

name

string

The iSCSI target name of the iSCSI service. This is generated for the SVM during POST.

If required, the target name can be modified using the ONTAP command line.

  • example: iqn.1992-08.com.netapp:sn.574caf71890911e8a6b7005056b4ea79:vs.2

  • maxLength: 128

  • minLength: 1

  • readOnly: 1

iscsi_service

An iSCSI service defines the properties of the iSCSI target for an SVM. There can be at most one iSCSI service for an SVM. An SVM's iSCSI service must be created before iSCSI initiators can log in to the SVM.

An iSCSI service is identified by the UUID of its SVM.

Name Type Description

_links

_links

enabled

boolean

The administrative state of the iSCSI service. The iSCSI service can be disabled to block all iSCSI connectivity to the SVM.

Optional in POST and PATCH. The default setting is true (enabled) in POST.

svm

svm

SVM, applies only to SVM-scoped objects.

target

target

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.