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

Retrieve LUN map reporting nodes

PDFs

GET /protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes

Introduced In: 9.10

Retrieves LUN map reporting nodes.

  • lun mapping show

Learn more

Parameters

Name Type In Required Description

lun.uuid

string

path

True

The unique identifier of the LUN.

igroup.uuid

string

path

True

The unique identifier of the igroup.

name

string

query

False

Filter by name

uuid

string

query

False

Filter by uuid

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.

  • Default value: 1

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.

  • Default value: 15

  • Max value: 120

  • Min value: 0

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[lun_map_reporting_node]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "node": {
          "href": "/api/resourcelink"
        },
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "igroup": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "lun": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "name": "node1",
      "uuid": "5ac8eb9c-4e32-dbaa-57ca-fb905976f54e"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5374875

The specified LUN does not exist or is not accessible to the caller.

5374878

The specified initiator group does not exist, is not accessible to the caller, or is not in the same SVM as the specified LUN.

5374922

The specified LUN map 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

next

href

self

href

_links

Name Type Description

node

href

self

href

_links

Name Type Description

self

href

igroup

The initiator group of the LUN map of the reporting node.

Name Type Description

_links

_links

uuid

string

The unique identifier of the initiator group.

lun

The LUN of the LUN map of the reporting node.

Name Type Description

_links

_links

uuid

string

The unique identifier of the LUN.

lun_map_reporting_node

A cluster node from which network paths to the LUN are advertised by ONTAP via the SAN protocols.

Name Type Description

_links

_links

igroup

igroup

The initiator group of the LUN map of the reporting node.

lun

lun

The LUN of the LUN map of the reporting node.

name

string

The name of the node.

Either uuid or name are required in POST.

uuid

string

The unique identifier of the node.

Either uuid or name are required in POST.

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.