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

Update a volume efficiency policy

Contributors
PDFs

PATCH /storage/volume-efficiency-policies/{uuid}

Introduced In: 9.8

Updates a volume efficiency policy.

  • volume efficiency policy modify

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Volume efficiency policy UUID

Request Body

Name Type Description

_links

_links

comment

string

A comment associated with the volume efficiency policy.

duration

integer

This field is used with the policy types "scheduled" and "auto" to indicate the allowed duration for a session, in hours. Possible value is a number between 0 and 999 inclusive. Default is unlimited indicated by value 0.

enabled

boolean

Is the volume efficiency policy enabled?

name

string

Name of the volume efficiency policy.

qos_policy

string

QoS policy for the sis operation. Possible values are background and best_effort. In background, sis operation will run in background with minimal or no impact on data serving client operations. In best_effort, sis operations may have some impact on data serving client operations.

schedule

schedule

start_threshold_percent

integer

This field is used with the policy type "threshold" to indicate the threshold percentage for triggering the volume efficiency policy. It is mutuallly exclusive of the schedule.

svm

svm

SVM, applies only to SVM-scoped objects.

type

string

Type of volume efficiency policy.

uuid

string

Unique identifier of volume efficiency policy.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "duration": "5",
  "enabled": 1,
  "name": "default",
  "qos_policy": "string",
  "schedule": {
    "name": "daily"
  },
  "start_threshold_percent": "30",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "type": "string",
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Code

Error Code Description

6881341

Specified schedule not found.

6881344

Failed to queue specified job.

6881348

This operation cannot be performed because the specified policy is owned by the cluster admin.

6881349

Policy name is not valid.

6881362

Threshold percentage cannot be less than 1 percent.

6881433

For "{{0}}" type policy, "{{1}}" duration is not supported.

6881435

Only a policy of type "threshold" can set the "start-threshold-percent" attribute.

6881436

For a policy of type "scheduled", a valid "schedule" is a required attribute.

6881438

For "{{0}}" policy, modification of attributes is not allowed.

6881474

Duration cannot be null.

6881475

Duration is not valid.

6881476

Duration cannot be less than 1 hour.

6881477

Duration cannot be more than 999 hours.
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

schedule

Name Type Description

name

string

Schedule at which volume efficiency policies are captured on the SVM. Some common schedules already defined in the system are hourly, daily, weekly, at 5 minute intervals, and at 8 hour intervals. Volume efficiency policies with custom schedules can be referenced.

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.

volume_efficiency_policy

Name Type Description

_links

_links

comment

string

A comment associated with the volume efficiency policy.

duration

integer

This field is used with the policy types "scheduled" and "auto" to indicate the allowed duration for a session, in hours. Possible value is a number between 0 and 999 inclusive. Default is unlimited indicated by value 0.

enabled

boolean

Is the volume efficiency policy enabled?

name

string

Name of the volume efficiency policy.

qos_policy

string

QoS policy for the sis operation. Possible values are background and best_effort. In background, sis operation will run in background with minimal or no impact on data serving client operations. In best_effort, sis operations may have some impact on data serving client operations.

schedule

schedule

start_threshold_percent

integer

This field is used with the policy type "threshold" to indicate the threshold percentage for triggering the volume efficiency policy. It is mutuallly exclusive of the schedule.

svm

svm

SVM, applies only to SVM-scoped objects.

type

string

Type of volume efficiency policy.

uuid

string

Unique identifier of volume efficiency policy.

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.