Update a volume efficiency policy
Suggest changes
PDFs
PATCH /storage/volume-efficiency-policies/{uuid}
Introduced In: 9.8
Updates a volume efficiency policy.
Related ONTAP commands
-
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 |
|---|---|---|
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? |
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 |
||
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. |
type |
string |
Type of volume efficiency policy. |
uuid |
string |
Unique identifier of volume efficiency policy. |
Example request
{
"comment": "string",
"qos_policy": "string",
"schedule": {
"name": "string"
},
"type": "string",
"uuid": "string"
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
6881341 |
Specified schedule not found. |
6881344 |
Failed to queue specified job. |
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. |
6881438 |
For "inline-only and auto" policy, modification of attributes is not allowed. |
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? |
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 |
||
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. |
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. |