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

Update a LUN attribute value

Contributors
PDFs

PATCH /storage/luns/{lun.uuid}/attributes/{name}

Introduced In: 9.10

Updates a LUN attribute value.

Learn more

Request Body

Name Type Description

_links

_links

lun

lun

The LUN for which the attribute is set.

name

string

The attribute name. Required in POST.

value

string

The attribute value. Required in POST; valid in PATCH.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "lun": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "name1",
  "value": "value1"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5374875

The specified LUN was not found.

5374929

The combined sizes of an attribute name and value are too large.

5374931

The specified attribute was not found.

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

lun

The LUN for which the attribute is set.

Name Type Description

_links

_links

uuid

string

The unique identifier of the LUN.

lun_attribute

A name/value pair optionally stored with the LUN. Attributes are available to callers to persist small amounts of application-specific metadata. They are in no way interpreted by ONTAP.

Attribute names and values must be at least one byte and no more than 4091 bytes in length. The sum of the name and value lengths must be no more than 4092 bytes.

Name Type Description

_links

_links

lun

lun

The LUN for which the attribute is set.

name

string

The attribute name. Required in POST.

value

string

The attribute value. Required in POST; valid in PATCH.

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.