Skip to main content
REST API reference

Create a volume efficiency policy

PDFs

POST /storage/volume-efficiency-policies

Introduced In: 9.8

Creates a volume efficiency policy.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the volume efficiency policy.

  • name - Name for the volume efficiency policy.

  • type - Type of volume policy.

  • schedule - Schedule the volume efficiency defined in minutes, hourly, daily and weekly.

  • duration - Indicates the allowed duration for a session for policy type "scheduled".

  • start_threshold_percent - Indicates the start threshold percentage for the policy type "threshold". It is mutually exclusive of the schedule.

  • qos_policy - QoS policy for the sis operation.

  • comment - A comment associated with the volume efficiency policy.

  • enabled - Is the volume efficiency policy enabled?

Default property values

If not specified in POST, the following default property values are assigned:

  • type - scheduled

  • start_threshold_percent - 20

  • enabled - true

  • qos_policy - best_effort

  • schedule - daily

  • volume efficiency policy create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

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

  • Default value:

Request Body

Name Type Description

comment

string

A comment associated with the volume efficiency policy.

duration

integer

This field is used with the policy type "scheduled" 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 mutually 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 
{
  "comment": "string",
  "name": "string",
  "qos_policy": "string",
  "schedule": {
    "name": "string"
  },
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "type": "string",
  "uuid": "string"
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

918702

The specified operation on the volume efficiency policies endpoint is not supported on this platform.

6881341

Specified schedule not found.

6881344

Failed to queue specified job.

6881345

This operation is not permitted on a node SVM.

6881349

Policy name is not valid.

6881351

Policy name is too long.

6881352

Policy name is not valid.

6881362

Threshold percentage cannot be less than 1 percent.

6881433

For "threshold" type policy, "schedule and duration" is not supported.

6881435

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

6881454

An efficiency policy of type "threshold" requires an effective cluster version of ONTAP 8.3 or later.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

_links

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

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

volume_efficiency_policy

Name Type Description

comment

string

A comment associated with the volume efficiency policy.

duration

integer

This field is used with the policy type "scheduled" 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 mutually 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

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.