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

Create a Snapshot copy policy

Contributors
PDFs

POST /storage/snapshot-policies

Introduced In: 9.6

Creates a Snapshot copy policy.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the Snapshot copy policy.

  • name - Name for the Snapshot copy policy.

  • copies.schedule - Schedule at which Snapshot copies are captured on the volume.

  • copies.count - Number of Snapshot copies to maintain for this schedule.

  • copies.prefix - Prefix to use when creating Snapshot copies at regular intervals.

  • copies.snapmirror - Label for SnapMirror operations.

  • copies.retention - Retention period for Snapshot copy locking enabled volumes.

Default property values

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

  • enabled - true

  • copies.prefix - Value of schedule.name

  • snapshot 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

_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

uuid

string
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "copies": [
    {
      "prefix": "string",
      "retention_period": "string",
      "schedule": {
        "name": "hourly"
      },
      "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: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1638407

When adding schedule to a Snapshot copy policy, the count for that schedule must be specified.

1638408

When adding schedule to a Snapshot copy policy, the schedule name must be specified.

1638413

Schedule not found.

1638417

Specified policy name is invalid.

1638451

This operation would result in total Snapshot copy count for the policy to exceed maximum supported count.

1638508

Another schedule has the same prefix within this policy.

1638526

This operation is not supported on a node Vserver.

1638527

Policy name already exists.

1638528

This operation is not supported in a mixed-version cluster.

1638531

This operation is not supported because specified policy is owned by the cluster admin.
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 Snapshot copies are captured on the volume. Some common schedules already defined in the system are hourly, daily, weekly, at 15 minute intervals, and at 5 minute intervals. Snapshot copy policies with custom schedules can be referenced.

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

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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

uuid

string

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.