Skip to main content

Add a reporting node and its HA partner to a LUN map

Contributors
PDFs

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

Introduced In: 9.10

Adds a reporting node and its HA partner to a LUN map.

Platform Specifics

  • Unified ONTAP: POST must be used to add a reporting node and its HA partner to a LUN map.

  • ASA.Next: POST is not supported.

Required properties

  • uuid or name - A cluster node to add.

  • lun mapping add-reporting-nodes

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.

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

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.
Example request 
{
  "_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"
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

The number of records in the response.

records

array[lun_map_reporting_node]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "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"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

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.

5374920

The specified cluster node does not exist.

5374921

The specified cluster node name and UUID do not refer to the same cluster node.

5374922

The specified LUN map does not exist.

5374923

A cluster node uuid or name must be specified to add a reporting node.

5376454

Modifying reporting nodes of a LUN map is not supported on this platform.

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

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.

_links

Name Type Description

next

href

self

href

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.