Skip to main content

Update a Snapshot copy policy

Contributors
PDFs

PATCH /storage/snapshot-policies/{uuid}

Introduced In: 9.6

Updates a Snapshot copy policy

  • snapshot policy modify

  • snapshot policy modify-schedule

  • snapshot policy add-schedule

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Snapshot copy policy UUID

Request Body

Name Type Description

_links

_links

comment

string

A comment associated with the Snapshot copy policy.

copies

array[copies]

enabled

boolean

Is the Snapshot copy policy enabled?

name

string

Name of the Snapshot copy policy.

scope

string

Set to "svm" when the request is on a data SVM, otherwise set to "cluster".

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "copies": [
    {
      "prefix": "string",
      "retention_period": "string",
      "schedule": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "weekly",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "snapmirror_label": "string"
    }
  ],
  "enabled": 1,
  "name": "default",
  "scope": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Code

Error Code Description

1638414

Cannot enable policy. Reason: Schedule not found.
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

schedule

Name Type Description

_links

_links

name

string

Job schedule name

uuid

string

Job schedule UUID

copies

Name Type Description

count

integer

The number of Snapshot copies to maintain for this schedule.

prefix

string

The prefix to use while creating Snapshot copies at regular intervals.

retention_period

string

The retention period of Snapshot copies for this schedule. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A period specified for years, months, and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PTH" and "PTM" respectively. The period string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported.

schedule

schedule

snapmirror_label

string

Label for SnapMirror operations

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

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.

snapshot_policy

The Snapshot copy policy object is associated with a read-write volume used to create and delete Snapshot copies at regular intervals.

Name Type Description

_links

_links

comment

string

A comment associated with the Snapshot copy policy.

copies

array[copies]

enabled

boolean

Is the Snapshot copy policy enabled?

name

string

Name of the Snapshot copy policy.

scope

string

Set to "svm" when the request is on a data SVM, otherwise set to "cluster".

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

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.