Skip to main content

Retrieve a list of ONTAP replication policies

Retrieves a list of ONTAP replication policies associated with a system. Use this to view SnapMirror policies and their rules created at the cluster level for the specified system.

HTTP method and endpoint

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy

Token usage

NetApp Console user token.

Usage notes

The API lists the SnapMirror policies created on the cluster level for the specified system. The system ID is passed as a parameter for the REST API call. It returns the SnapMirror policies and the rules associated with the policies.

Parameters

Name Type In Required Description

partial

boolean

query

False

Returns the attached-volumes-count with the policy if set to true

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

System ID

authorization

string

header

True

User token

X-Agent-Id

string

header

True

Request identifier

Response

Status: 200, Default response
Name Type Required Description

replication-policy

array[replication-policy]

False

Example response
{
  "replication-policy": [
    {
      "name": "string",
      "id": "string",
      "svm": "string",
      "rule": [
        {
          "label": "string",
          "retention": "string"
        }
      ],
      "transfer-schedule": {
        "uuid": "string",
        "name": "string",
        "cron": {
          "minutes": [
            "integer"
          ],
          "hours": [
            "integer"
          ],
          "weekdays": [
            "integer"
          ],
          "days": [
            "integer"
          ],
          "months": [
            "integer"
          ]
        },
        "interval": "string"
      },
      "policy-type": "string",
      "attached-volumes-count": "string"
    }
  ]
}

Definitions

See Definitions

rule

Name Type Required Description

label

string

False

retention

string

False

cron

Name Type Required Description

minutes

array[integer]

False

hours

array[integer]

False

weekdays

array[integer]

False

days

array[integer]

False

months

array[integer]

False

transfer-schedule

Name Type Required Description

uuid

string

False

name

string

False

cron

cron

False

interval

string

False

replication-policy

Name Type Required Description

name

string

False

id

string

False

svm

string

False

rule

array[rule]

False

transfer-schedule

transfer-schedule

False

policy-type

string

False

attached-volumes-count

string

False

copy-latest-source-snapshot

boolean

False

copy-all-source-snapshots

boolean

False

allow-policy-deletion

boolean

False