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

Retrieve a portset

Contributors
PDFs

GET /protocols/san/portsets/{uuid}

Introduced In: 9.9

Retrieves a portset.

  • lun portset show

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

The unique identifier of the portset.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

igroups

array[igroups]

An array initiator groups to which the portset is bound.

interfaces

array[interfaces]

An array of network interfaces that are members of the portset. These are the only network interfaces through which the initiators of a bound igroup can access mapped LUNs.

Zero or more network interfaces can be supplied when the portset is created. After creation, network interfaces can be added or removed from the portset using the /protocols/san/portsets/{portset.uuid}/interfaces endpoint. See link:post-protocols-san-portsets-interfaces(#-san-portset-interface-create)anddelete-protocols-san-portsets-interfaces-.htmlPOST /protocols/san/portsets/{portset.uuid}/interfaces and [DELETE /protocols/san/portsets/{portset.uuid}/interfaces/{uuid}] for more details.

name

string

The name of the portset. Required in POST.

The name of a portset cannot be changed after creation.

protocol

string

The protocols supported by the portset. This restricts the type of network interfaces that can be added to the portset. Optional in POST; if not supplied, this defaults to mixed.

The protocol of a portset cannot be changed after creation.

svm

svm

uuid

string

The unique identifier for a portset.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "igroups": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "igroup1",
    "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
  },
  "interfaces": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "fc": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "fc_lif1",
      "uuid": "3a09ab42-4da1-32cf-9d35-3385a6101a0b",
      "wwpn": "20:00:00:50:56:b4:13:a8"
    },
    "ip": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "ip": {
        "address": "10.10.10.7"
      },
      "name": "lif1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "portset1",
  "protocol": "fcp",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

4

The portset 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

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.

fc

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.

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

ip

A network interface. Either UUID or name may be supplied on input.

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface.

uuid

string

The UUID that uniquely identifies the interface.

interfaces

A container for either a Fibre Channel network interface or an IP network interface. On POST fc and ip are mutually exclusive.

Name Type Description

_links

_links

fc

fc

An FC interface.

ip

ip

A network interface. Either UUID or name may be supplied on input.

uuid

string

The unique identifier of the network 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.