Skip to main content

Retrieve information for SnapMirror relationships

Contributors
PDFs

GET /snapmirror/relationships

Introduced In: 9.6

Retrieves information for SnapMirror relationships whose destination endpoints are in the current SVM or the current cluster, depending on the cluster context.

  • snapmirror show

  • snapmirror list-destinations

Expensive properties

  • fabriclink.pull_byte_count

  • fabriclink.push_byte_count

  • fabriclink.pending_work_task_count

  • fabriclink.status

  • source.consistency_group_volumes.name

  • destination.consistency_group_volumes.name

  • svmdr_volumes.name

Examples

The following examples show how to retrieve the list of SnapMirror relationships and the list of SnapMirror destinations.

  1. Retrieving the list of SnapMirror relationships. This API must be run on the cluster containing the destination endpoint.

 GET "/api/snapmirror/relationships/"

  1. Retrieving the list of SnapMirror destinations on source. This must be run on the cluster containing the source endpoint.

 GET "/api/snapmirror/relationships/?list_destinations_only=true"

  1. Retrieving the relationship UUID of SnapMirror relationships with lag time greater than 2 days. This API must be run on the cluster containing the destination endpoint.

 GET "/api/snapmirror/relationships/?fields=uuid&lag_time=>P2DT"

  1. Retrieving the list of SnapMirror relationships with lag time less than 10 hours. This API must be run on the cluster containing the destination endpoint.

 GET "/api/snapmirror/relationships/?lag_time=<PT10H"

  1. Retrieving the destination UUID information for object store SnapMirror relationships.

 GET "/api/snapmirror/relationships/?fields=destination.uuid"

  1. Retrieving the list of constituent volumes for SVM DR Snapmirror relationships.

 GET "/api/snapmirror/relationships/?fields=svmdr_volumes.name"

</private>

Learn more

Parameters

Name Type In Required Description

list_destinations_only

boolean

query

False

Set to true to show relationships from the source only.

healthy

boolean

query

False

Filter by healthy

transfer.end_time

string

query

False

Filter by transfer.end_time

  • Introduced in: 9.9

transfer.uuid

string

query

False

Filter by transfer.uuid

transfer.last_updated_time

string

query

False

Filter by transfer.last_updated_time

  • Introduced in: 9.15

transfer.type

string

query

False

Filter by transfer.type

  • Introduced in: 9.15

transfer.total_duration

string

query

False

Filter by transfer.total_duration

  • Introduced in: 9.9

transfer.state

string

query

False

Filter by transfer.state

transfer.bytes_transferred

integer

query

False

Filter by transfer.bytes_transferred

identity_preservation

string

query

False

Filter by identity_preservation

  • Introduced in: 9.11

restore

boolean

query

False

Filter by restore

policy.type

string

query

False

Filter by policy.type

policy.name

string

query

False

Filter by policy.name

policy.uuid

string

query

False

Filter by policy.uuid

last_transfer_network_compression_ratio

string

query

False

Filter by last_transfer_network_compression_ratio

  • Introduced in: 9.13

uuid

string

query

False

Filter by uuid

source.consistency_group_volumes.name

string

query

False

Filter by source.consistency_group_volumes.name

  • Introduced in: 9.8

source.cluster.name

string

query

False

Filter by source.cluster.name

  • Introduced in: 9.7

source.cluster.uuid

string

query

False

Filter by source.cluster.uuid

  • Introduced in: 9.7

source.svm.uuid

string

query

False

Filter by source.svm.uuid

source.svm.name

string

query

False

Filter by source.svm.name

source.path

string

query

False

Filter by source.path

destination.svm.uuid

string

query

False

Filter by destination.svm.uuid

destination.svm.name

string

query

False

Filter by destination.svm.name

destination.path

string

query

False

Filter by destination.path

destination.consistency_group_volumes.name

string

query

False

Filter by destination.consistency_group_volumes.name

  • Introduced in: 9.8

destination.cluster.name

string

query

False

Filter by destination.cluster.name

  • Introduced in: 9.7

destination.cluster.uuid

string

query

False

Filter by destination.cluster.uuid

  • Introduced in: 9.7

group_type

string

query

False

Filter by group_type

  • Introduced in: 9.11

preferred_site

string

query

False

Filter by preferred_site

  • Introduced in: 9.14

consistency_group_failover.state

string

query

False

Filter by consistency_group_failover.state

  • Introduced in: 9.14

consistency_group_failover.type

string

query

False

Filter by consistency_group_failover.type

  • Introduced in: 9.14

consistency_group_failover.error.code

string

query

False

Filter by consistency_group_failover.error.code

  • Introduced in: 9.8

consistency_group_failover.error.message

string

query

False

Filter by consistency_group_failover.error.message

  • Introduced in: 9.8

consistency_group_failover.error.arguments.message

string

query

False

Filter by consistency_group_failover.error.arguments.message

  • Introduced in: 9.8

consistency_group_failover.error.arguments.code

string

query

False

Filter by consistency_group_failover.error.arguments.code

  • Introduced in: 9.8

consistency_group_failover.status.message

string

query

False

Filter by consistency_group_failover.status.message

  • Introduced in: 9.8

consistency_group_failover.status.code

string

query

False

Filter by consistency_group_failover.status.code

  • Introduced in: 9.8

total_transfer_bytes

integer

query

False

Filter by total_transfer_bytes

  • Introduced in: 9.13

transfer_schedule.uuid

string

query

False

Filter by transfer_schedule.uuid

  • Introduced in: 9.11

transfer_schedule.name

string

query

False

Filter by transfer_schedule.name

  • Introduced in: 9.11

io_serving_copy

string

query

False

Filter by io_serving_copy

  • Introduced in: 9.14

last_transfer_type

string

query

False

Filter by last_transfer_type

  • Introduced in: 9.11

backoff_level

string

query

False

Filter by backoff_level

  • Introduced in: 9.15

total_transfer_duration

string

query

False

Filter by total_transfer_duration

  • Introduced in: 9.13

throttle

integer

query

False

Filter by throttle

  • Introduced in: 9.11

svmdr_volumes.name

string

query

False

Filter by svmdr_volumes.name

  • Introduced in: 9.13

unhealthy_reason.message

string

query

False

Filter by unhealthy_reason.message

unhealthy_reason.arguments

string

query

False

Filter by unhealthy_reason.arguments

  • Introduced in: 9.14

unhealthy_reason.code

string

query

False

Filter by unhealthy_reason.code

master_bias_activated_site

string

query

False

Filter by master_bias_activated_site

  • Introduced in: 9.15

state

string

query

False

Filter by state

exported_snapshot

string

query

False

Filter by exported_snapshot

lag_time

string

query

False

Filter by lag_time

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[snapmirror_relationship]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "backoff_level": "medium",
      "consistency_group_failover": {
        "error": {
          "arguments": [
            {
              "code": "string",
              "message": "string"
            }
          ],
          "code": "4",
          "message": "entry doesn't exist"
        },
        "state": "string",
        "status": {
          "code": "string",
          "message": "string"
        },
        "type": "string"
      },
      "create_destination": {
        "bucket_retention": {
          "default_period": "P10Y",
          "mode": "governance"
        },
        "snaplock": {
          "retention": {
            "default": "P30Y",
            "maximum": "P30Y",
            "minimum": "P30Y"
          },
          "type": "enterprise"
        },
        "storage_service": {
          "name": "string"
        },
        "tiering": {
          "policy": "string"
        }
      },
      "destination": {
        "cluster": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "cluster1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        },
        "consistency_group_volumes": [
          {
            "name": "volume1",
            "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
          }
        ],
        "ipspace": "Default",
        "path": "svm1:volume1",
        "svm": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "svm1",
          "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
        },
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "exported_snapshot": "string",
      "fabriclink": {
        "destination_bucket": "string",
        "destination_role": "string",
        "pending_work_task_count": 0,
        "pull_byte_count": 0,
        "push_byte_count": 0,
        "source_bucket": "string",
        "source_role": "string",
        "status": "string",
        "topology_uuid": "string"
      },
      "group_type": "consistency_group",
      "identity_preservation": "string",
      "io_serving_copy": "C1_sti85-vsim-ucs209a_cluster, C1_sti85-vsim-ucs209c_cluster",
      "lag_time": "PT8H35M42S",
      "last_transfer_network_compression_ratio": 61,
      "last_transfer_type": "initialize",
      "master_bias_activated_site": "C1_sti85-vsim-ucs209a_cluster",
      "policy": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "Asynchronous",
        "transfer_schedule": {
          "name": "hourly"
        },
        "type": "string",
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "preferred_site": "C1_sti85-vsim-ucs209a_cluster",
      "restore_to_snapshot": "string",
      "source": {
        "cluster": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "cluster1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        },
        "consistency_group_volumes": [
          {
            "name": "volume1",
            "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
          }
        ],
        "path": "svm1:volume1",
        "svm": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "svm1",
          "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
        },
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "state": "snapmirrored",
      "svmdr_volumes": [
        {
          "name": "volume1"
        }
      ],
      "throttle": 0,
      "total_transfer_bytes": 1098210312,
      "total_transfer_duration": "PT3M21S",
      "transfer": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "end_time": "2020-12-02 21:36:19 -0500",
        "last_updated_time": "2023-09-14 18:39:19 -0400",
        "state": "string",
        "total_duration": "PT28M41S",
        "type": "initialize",
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "transfer_schedule": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "weekly",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "unhealthy_reason": [
        {
          "arguments": [],
          "code": "6621444",
          "message": "Failed to complete update operation on one or more item relationships."
        },
        {
          "arguments": [],
          "code": "6621445",
          "message": "Group Update failed"
        }
      ],
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

13303825

Could not retrieve information for the SnapMirror policy type

13303817

Unknown value for the Snapmirror State
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

next

href

self

href

_links

Name Type Description

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

SnapMirror Consistency Group failover error message.

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

status

Name Type Description

code

string

Status code

message

string

SnapMirror Consistency Group failover status.

snapmirror_consistency_group_failover

SnapMirror Consistency Group failover information. The SnapMirror Consistency Group failover can be a planned or an unplanned operation. Only active SnapMirror Consistency Group failover operation progress can be monitored using this object. In case of an error during the failover operation, the property "consistency_group_failover.error" holds the reason for the error. ONTAP automatically retries any failed SnapMirror Consistency Group failover operation.

Name Type Description

error

error

SnapMirror Consistency Group failover error message.

state

string

SnapMirror Consistency Group failover state.

status

status

type

string

SnapMirror Consistency Group failover type.

bucket_retention

Specifies the retention-mode and default retention period configured on the destination bucket.

Name Type Description

default_period

string

Specifies the default retention period that is applied to objects while committing them to the WORM state without an associated retention period. The retention period can be in years, or days. The retention period value represents a duration and must be specified in the ISO-8601 duration format. A period specified for years and days is represented in the ISO-8601 format as "PY" and "PD" respectively, for example "P10Y" represents a duration of 10 years. The period string must contain only a single time element that is, either years, or days. A duration which combines different periods is not supported, for example "P1Y10D" is not supported.

mode

string

The lock mode of the bucket. compliance ‐ A SnapLock Compliance (SLC) bucket provides the highest level of WORM protection and an administrator cannot destroy a compliance bucket if it contains unexpired WORM objects. governance ‐ An administrator can delete a Governance bucket. no_lock ‐ Indicates the bucket does not support object locking.

retention

Name Type Description

default

string

Specifies the default retention period that is applied to Snapshot copies while committing them to the locked state without an associated retention period. This property is only supported when the SnapLock type is specified.

maximum

string

Specifies the maximum allowed retention period for Snapshot copies committed to the locked state on the volume. This property is only supported when the SnapLock type is specified.

minimum

string

Specifies the minimum allowed retention period for Snapshot copies committed to the locked state on the volume. This property is only supported when the SnapLock type is specified.

snaplock

Name Type Description

retention

retention

type

string

Optional property to create the destination endpoint with a SnapLock type for establishing a SnapMirror relationship. This property is only supported for relationships with a policy of type "vault".

storage_service

Name Type Description

enabled

boolean

This property indicates whether to create the destination endpoint using storage service.

enforce_performance

boolean

Optional property to enforce storage service performance on the destination endpoint. This property is applicable to FlexVol volume, FlexGroup volume, and Consistency Group endpoints.

name

string

Optional property to specify the storage service name for the destination endpoint. This property is considered when the property "create_destination.storage_service.enabled" is set to "true". When the property "create_destination.storage_service.enabled" is set to "true" and the "create_destination.storage_service.name" for the endpoint is not specified, then ONTAP selects the highest storage service available on the cluster to provision the destination endpoint. This property is applicable to FlexVol volume, FlexGroup volume, and Consistency Group endpoints.

  • enum: ["extreme", "performance", "value"]

  • Introduced in: 9.6

  • x-nullable: true

tiering

Name Type Description

aggregates_are_fabric_pool

Optional property that indicates whether or not all non-root aggregates are FabricPool aggregates. This property is set to "true" by default when the destination cluster has all non-root aggregates as FabricPool aggregates. It is set to "false" when at least one of the non-root aggregates is not a FabricPool aggregate.

policy

string

Optional property to specify the destination endpoint's tiering policy when "create_destination.tiering.supported" is set to "true". This property is applicable to FlexVol volume, FlexGroup volume, and Consistency Group endpoints. This property determines whether the user data blocks of the destination endpoint in a FabricPool will be tiered to the cloud store when they become cold. FabricPool combines flash (performance tier) with a cloud store into a single aggregate. Temperature of the destination endpoint volume blocks increases if they are accessed frequently and decreases when they are not. all ‐ This policy allows tiering of both destination endpoint Snapshot copies and the user transferred data blocks to the cloud store as soon as possible by ignoring the temperature on the volume blocks. This tiering policy is not applicable for Consistency Group destination endpoints or for synchronous relationships. auto ‐ This policy allows tiering of both destination endpoint Snapshot copies and the active file system user data to the cloud store none ‐ Destination endpoint volume blocks will not be tiered to the cloud store. snapshot_only ‐ This policy allows tiering of only the destination endpoint volume Snapshot copies not associated with the active file system. The default tiering policy is "snapshot_only" for a FlexVol volume and "none" for a FlexGroup volume.

supported

boolean

Optional property to enable provisioning of the destination endpoint volumes on FabricPool aggregates. This property is applicable to FlexVol volume, FlexGroup volume, and Consistency Group endpoints. Only FabricPool aggregates are used if this property is set to "true" and only non FabricPool aggregates are used if this property is set to "false". Tiering support for a FlexGroup volume can be changed by moving all of the constituents to the required aggregates. Note that in order to tier data, not only do the destination endpoint volumes need to support tiering by using FabricPools, the "create_destination.tiering.policy" must not be "none". A destination endpoint that uses FabricPools but has a tiering "policy" of "none" supports tiering but will not tier any data.

snapmirror_destination_creation

Use this object to provision the destination endpoint when establishing a SnapMirror relationship for a FlexVol volume, FlexGroup volume, SVM, Consistency Group or ONTAP S3 Bucket. Given a source endpoint, the destination endpoint is provisioned in the SVM specified in the "destination.path" property. While protecting an SVM, the SVM destination endpoint can only be provisioned on the local cluster. To provision the SVM destination endpoint use the optional "source.cluster.name" property to specify the remote cluster name or use the optional "source.cluster.uuid" property to specify the remote cluster UUID. When "create_destination.enabled" option is specified while making a POST for a SnapMirror relationship, the relationship can be automatically initialized by setting the "state" either to "snapmirrored" when the policy is of type "async" or to "in_sync" when the policy is of type "sync". The "destination.path" property must specify the destination endpoint path. For example, for FlexVol volume and FlexGroup volume, the "destination.path" can be specified as , for SVM data protection, the "destination.path" must be specified as <destination-svm-name:>, and for Consistency Group, the "destination.path" must be specified as <destination-svm-name:> along with the "destination.consistency_group_volumes" property to indicate the list of destination volumes of type "DP" in the Consistency Group. For a FlexVol volume, a FlexGroup volume, Consistency Group or a Bucket destination endpoint, the properties in this object can be specified either from the source or the destination cluster. For an SVM destination endpoint, the properties in this object can be specified from the destination cluster only. This object is not supported for non ONTAP endpoints. While protecting a S3 Bucket, the optional "size" property can be used to create ONTAP S3 Bucket destination endpoint of the specified size.</destination-svm-name:></destination-svm-name:>

Name Type Description

bucket_retention

bucket_retention

Specifies the retention-mode and default retention period configured on the destination bucket.

enabled

boolean

Optional property to create the destination endpoint when establishing a SnapMirror relationship. It is assumed to be "false" if no other property is set and assumed to be "true" if any other property is set.

size

integer

Optional property to specify the size of destination endpoint in bytes. This property is applicable only to ONTAP S3 Bucket endpoints. The minimum size for S3 bucket is 80MB and maximum size is 64TB. If not specified, system will create destination with default size of 800GB.

  • Introduced in: 9.10

  • x-nullable: true

snaplock

snaplock

snapshot_locking_enabled

boolean

Optional property to create the destination endpoint with Snapshot copy locking enabled when establishing a SnapMirror relationship. This property is applicable to FlexVol volumes and FlexGroup volumes.

storage_service

storage_service

tiering

tiering

cluster

Name Type Description

_links

_links

name

string

uuid

string

consistency_group_volumes

Name Type Description

name

string

The name of the volume.

uuid

string

Unique identifier of the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • x-ntap-createOnly: true

  • Introduced in: 9.8

  • x-nullable: true

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.

snapmirror_endpoint

Endpoint of a SnapMirror relationship. For a GET request, the property "cluster" is populated when the endpoint is on a remote cluster. A POST request to create the destination SVM endpoint or to establish an SVM DR relationship must have the property "cluster" populated with the remote cluster details. A POST request to create the destination FlexVol volume, FlexGroup volume, Consistency Group, ONTAP S3 bucket and NON-ONTAP object-store endpoints can optionally specify the "cluster" property when the source SVM and the destination SVM are peered. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify the "cluster" property for the remote endpoint.

Name Type Description

cluster

cluster

consistency_group_volumes

array[consistency_group_volumes]

Mandatory property for a Consistency Group endpoint. Specifies the list of FlexVol volumes for a Consistency Group.

ipspace

string

Optional property to specify the IPSpace of the SVM.

path

string

ONTAP FlexVol/FlexGroup - svm1:volume1 ONTAP SVM - svm1: ONTAP Consistency Group - svm1:/cg/cg_name ONTAP S3 - svm1:/bucket/bucket1 NON-ONTAP - objstore1:/objstore

  • example: svm1:volume1

  • Introduced in: 9.6

  • x-nullable: true

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

Unique identifier of the endpoint. Applicable for object store SnapMirror relationships only.

SnapMirror FabricLink relationship

Name Type Description

destination_bucket

string

Specifies the name of the destination bucket of the FabricLink SnapMirror relationship. This parameter is supported for FabricLink SnapMirror relationships with ONTAP or external object store vendor endpoints. This parameter is only available on ONTAP 9.10.1 or later.

  • readOnly: 1

  • x-nullable: true

destination_role

string

This field represents the destination bucket's role within FabricLink. Possible values for this field are "active_mirror" and "backup". In a bi-directional ONTAP to ONTAP mirroring relationship, both FabricLink SnapMirror records will contain "active_mirror" in both the source-role and destination-role fields. This field conveys that both mirrors are capable of performing an active role at any time. In an ONTAP to Non-ONTAP FabricLink replication relationship, the source-role is "active_mirror" and the destination-role is "backup". This parameter is supported for FabricLink SnapMirror relationships with ONTAP or external object store vendor endpoints. This parameter is only available in ONTAP 9.10.1 or later.

  • enum: ["active_mirror", "backup"]

  • readOnly: 1

  • x-nullable: true

pending_work_task_count

integer

Conveys how many discrete tasks the bucket in this unidirectional FabricLink SnapMirror relationship knows it will eventually have to perform to fully update the destination to reflect the source's state. Each work item might represent the need to push a newly created object from the source to the destination mirror, or perhaps to advise the destination mirror that an existing object has been modified or deleted. If the link is configured with an RPO of one hour and the user creates an object on the source bucket, that bucket will immediately show that it now has a pending work item to send that new object to the destination; FabricLink intentionally will not act on that work item until the hour has elapsed. This parameter is only available in ONTAP 9.10.1 or later.

  • readOnly: 1

  • x-nullable: true

pull_byte_count

integer

Represents the approximate number of bytes of data that the destination bucket anticipates reading from the source bucket for the FabricLink SnapMirror relationship. This parameter is only available in ONTAP 9.10.1 or later.

  • readOnly: 1

  • x-nullable: true

push_byte_count

integer

Represents the approximate number of bytes of data that must be pushed from the source bucket to the destination bucket for the FabricLink SnapMirror relationship. This parameter is only available in ONTAP 9.10.1 or later.

  • readOnly: 1

  • x-nullable: true

source_bucket

string

Specifies the name of the source bucket of the FabricLink SnapMirror relationship. This parameter is supported only for FabricLink SnapMirror relationships with ONTAP endpoints. This parameter is only available in ONTAP 9.10.1 or later.

  • readOnly: 1

  • x-nullable: true

source_role

string

This field represents the source bucket's role within FabricLink. One possible value for this field is "active_mirror". In a bi-directional ONTAP to ONTAP mirroring relationship, both FabricLink SnapMirror records will contain "active_mirror" in both the source-role and destination-role fields. This field conveys that both mirrors are capable of performing an active role at any time. In an ONTAP to Non-ONTAP FabricLink replication relationship, the source-role is "active_mirror" and the destination-role is "backup". This parameter is supported only for FabricLink SnapMirror relationships with an ONTAP endpoint. This parameter is only available in ONTAP 9.10.1 or later.

  • enum: ["active_mirror"]

  • readOnly: 1

  • x-nullable: true

status

string

Specifies the status of the FabricLink SnapMirror relationship. This parameter is only available in ONTAP 9.10.1 or later.

  • readOnly: 1

  • x-nullable: true

topology_uuid

string

Topology UUID is used to refer to a unique data set. All the links that connect the same data set share the same topology UUID. Thus, in a fan-out topology, all links fanning from the same source bucket will carry the same topology-uuid value. Similarly, in a cascading mirror arrangement, all links in the cascade will carry the same topology-uuid value. This parameter is only available in ONTAP 9.10.1 or later.

  • format: uuid

  • readOnly: 1

  • x-nullable: true

transfer_schedule

The schedule used to update the asynchronous relationship. This is only applicable when provisioning a destination endpoint on a remote cluster with an effective cluster version of 9.6 or earlier. Only cron schedules are supported for SnapMirror.

Name Type Description

name

string

policy

Basic policy information of the relationship.

Name Type Description

_links

_links

name

string

Name of the SnapMirror policy.

transfer_schedule

transfer_schedule

The schedule used to update the asynchronous relationship. This is only applicable when provisioning a destination endpoint on a remote cluster with an effective cluster version of 9.6 or earlier. Only cron schedules are supported for SnapMirror.

type

string

uuid

string

Unique identifier of the SnapMirror policy.

snapmirror_source_endpoint

Source endpoint of a SnapMirror relationship. For a GET request, the property "cluster" is populated when the endpoint is on a remote cluster. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify the "cluster" property for the remote endpoint.

Name Type Description

cluster

cluster

consistency_group_volumes

array[consistency_group_volumes]

Mandatory property for a Consistency Group endpoint. Specifies the list of FlexVol volumes for a Consistency Group.

path

string

ONTAP FlexVol/FlexGroup - svm1:volume1 ONTAP SVM - svm1: ONTAP Consistency Group - svm1:/cg/cg_name ONTAP S3 - svm1:/bucket/bucket1 NON-ONTAP - objstore1:/objstore

  • example: svm1:volume1

  • Introduced in: 9.14

  • x-nullable: true

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

Unique identifier of the endpoint. Applicable for object store SnapMirror relationships only.

svmdr_volumes

Name Type Description

name

string

The name of the volume.

transfer

Basic information on the current transfer or the last transfer if there is no active transfer at the time of the request.

Name Type Description

_links

_links

bytes_transferred

integer

Total bytes transferred in the current or last successful transfer.

end_time

string

End time of the last transfer.

last_updated_time

string

Last updated time of the bytes transferred in the current transfer.

state

string

total_duration

string

Elapsed time to transfer all Snapshot copies for the last successful transfer.

type

string

Specifies the operation type of the current transfer on the relationship. The initialize transfer occurs when the relationship state changes from "uninitialized" to "snapmirrored" or "in_sync". The update transfer occurs when Snapshot copies are being transferred from the source endpoint to the destination endpoint as part of a scheduled or manual update. The resync transfer occurs when the relationship state changes from "broken_off" to "snapmirrored" or "in_sync". The restore transfer occurs when a Snapshot copy is being restored from a destination endpoint to another endpoint.

uuid

string

Transfer UUID. This property is applicable only for active transfers.

transfer_schedule

Schedule used to update asynchronous relationships. This "transfer_schedule" overrides the "transfer_schedule" set on the SnapMirror relationship's policy. To remove the "transfer_schedule", set its value to null (no-quotes). Only cron schedules are supported for SnapMirror.

Name Type Description

_links

_links

name

string

Job schedule name

uuid

string

Job schedule UUID

snapmirror_error

SnapMirror error

Name Type Description

arguments

array[string]

Arguments present in the error message encountered.

code

string

Error code

message

string

Error message

snapmirror_relationship

SnapMirror relationship information. The SnapMirror relatiosnhip can be either "async" or "sync" based on the type of SnapMirror policy associated with the relationship. The source and destination endpoints of a SnapMirror relationship must be of the same type, for example, if the source endpoint is a FlexVol volume then the destination endpoint must be a FlexVol volume. The SnapMirror policy type "async" can be used when the SnapMirror relationship has FlexVol volume or FlexGroup volume or SVM as the endpoint. The SnapMirror policy type "sync" can be used when the SnapMirror relationship has FlexVol volume as the endpoint. The SnapMirror policy type "sync" with "sync_type" as "automated_failover" can be used when the SnapMirror relationship has Consistency Group as the endpoint.

Name Type Description

_links

_links

backoff_level

string

Specifies the SnapMirror backoff level due to Client Ops for FlexVol SnapMirror relationships.

consistency_group_failover

snapmirror_consistency_group_failover

SnapMirror Consistency Group failover information. The SnapMirror Consistency Group failover can be a planned or an unplanned operation. Only active SnapMirror Consistency Group failover operation progress can be monitored using this object. In case of an error during the failover operation, the property "consistency_group_failover.error" holds the reason for the error. ONTAP automatically retries any failed SnapMirror Consistency Group failover operation.

  • Introduced in: 9.8

  • readOnly: 1

create_destination

snapmirror_destination_creation

Use this object to provision the destination endpoint when establishing a SnapMirror relationship for a FlexVol volume, FlexGroup volume, SVM, Consistency Group or ONTAP S3 Bucket. Given a source endpoint, the destination endpoint is provisioned in the SVM specified in the "destination.path" property. While protecting an SVM, the SVM destination endpoint can only be provisioned on the local cluster. To provision the SVM destination endpoint use the optional "source.cluster.name" property to specify the remote cluster name or use the optional "source.cluster.uuid" property to specify the remote cluster UUID. When "create_destination.enabled" option is specified while making a POST for a SnapMirror relationship, the relationship can be automatically initialized by setting the "state" either to "snapmirrored" when the policy is of type "async" or to "in_sync" when the policy is of type "sync". The "destination.path" property must specify the destination endpoint path. For example, for FlexVol volume and FlexGroup volume, the "destination.path" can be specified as , for SVM data protection, the "destination.path" must be specified as <destination-SVM-name:>, and for Consistency Group, the "destination.path" must be specified as <destination-SVM-name:/cg/consistency-group-name> along with the "destination.consistency_group_volumes" property to indicate the list of destination volumes of type "DP" in the Consistency Group. For a FlexVol volume, a FlexGroup volume, Consistency Group or a Bucket destination endpoint, the properties in this object can be specified either from the source or the destination cluster. For an SVM destination endpoint, the properties in this object can be specified from the destination cluster only. This object is not supported for non ONTAP endpoints. While protecting a S3 Bucket, the optional "size" property can be used to create ONTAP S3 Bucket destination endpoint of the specified size.

  • Introduced in: 9.7

  • x-ntap-createOnly: true

destination

snapmirror_endpoint

Endpoint of a SnapMirror relationship. For a GET request, the property "cluster" is populated when the endpoint is on a remote cluster. A POST request to create the destination SVM endpoint or to establish an SVM DR relationship must have the property "cluster" populated with the remote cluster details. A POST request to create the destination FlexVol volume, FlexGroup volume, Consistency Group, ONTAP S3 bucket and NON-ONTAP object-store endpoints can optionally specify the "cluster" property when the source SVM and the destination SVM are peered. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify the "cluster" property for the remote endpoint.

  • Introduced in: 9.6

exported_snapshot

string

Snapshot copy exported to clients on destination.

fabriclink

fabriclink

SnapMirror FabricLink relationship

group_type

string

Specifies the group type of the top level SnapMirror relationship. The volume relationships are shown as none, the SVMDR relationships are shown as svm_dr, the Consistency Group relationships are shown as consistency_group, and the FlexGroup volume relationships are shown as flexgroup.

healthy

boolean

Is the relationship healthy?

identity_preservation

string

Specifies which configuration of the source SVM is replicated to the destination SVM. This property is applicable only for SVM data protection with "async" policy type. This "identity_preservation" overrides the "identity_preservation" set on the SnapMirror relationship's policy.

io_serving_copy

string

Specifies the sites serving I/O for the SnapMirror active sync relationship.

lag_time

string

Time since the exported Snapshot copy was created.

last_transfer_network_compression_ratio

string

Specifies the compression ratio achieved for the data sent over the wire with network compression enabled for the last successful transfer.

last_transfer_type

string

Specifies the operation type of the last transfer that occurred on the relationship. The initialize transfer occurs when the relationship state changes from uninitialized to snapmirrored or in_sync. The update transfer occurs when the snapshots are transferred from the source endpoint to the destination endpoint as part of scheduled or manual update. The resync transfer occurs when the relationship state changes from broken_off to snapmirrored or in_sync. The restore transfer occurs when the snapshot is restored from a destination endpoint to another endpoint.

master_bias_activated_site

string

Specifies the Master Bias Activated Site for the SnapMirror active sync relationship.

policy

policy

Basic policy information of the relationship.

preferred_site

string

Specifies the Primary Site of the SnapMirror active sync relationship.

preserve

boolean

Set to true on resync to preserve Snapshot copies on the destination that are newer than the latest common Snapshot copy. This property is applicable only for relationships with FlexVol volume or FlexGroup volume endpoints and when the PATCH state is being changed to "snapmirrored".

quick_resync

boolean

Set to true to reduce resync time by not preserving storage efficiency. This property is applicable only for relationships with FlexVol volume endpoints and SVMDR relationships when the PATCH state is being changed to "snapmirrored".

recover_after_break

boolean

Set to true to recover from a failed SnapMirror break operation on a FlexGroup volume relationship. This restores all destination FlexGroup constituent volumes to the latest Snapshot copy, and any writes to the read-write constituents are lost. This property is applicable only for SnapMirror relationships with FlexGroup volume endpoints and when the PATCH state is being changed to "broken_off".

restore

boolean

Set to true to create a relationship for restore. To trigger restore-transfer, use transfers POST on the restore relationship. SnapMirror relationships with the policy type "async" can be restored. SnapMirror relationships with the policy type "sync" cannot be restored.

restore_to_snapshot

string

Specifies the Snapshot copy to restore to on the destination during the break operation. This property is applicable only for SnapMirror relationships with FlexVol volume endpoints and when the PATCH state is being changed to "broken_off".

source

snapmirror_source_endpoint

Source endpoint of a SnapMirror relationship. For a GET request, the property "cluster" is populated when the endpoint is on a remote cluster. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify the "cluster" property for the remote endpoint.

state

string

State of the relationship. To initialize the relationship, PATCH the state to "snapmirrored" for relationships with a policy of type "async" or to state "in_sync" for relationships with a policy of type "sync". To break the relationship, PATCH the state to "broken_off" for relationships with a policy of type "async" or "sync". SnapMirror relationships with the policy type as "sync" and "sync_type" as "automated_failover" cannot be "broken_off". To resync the relationship, PATCH the state to "snapmirrored" for relationships with a policy of type "async" or to state "in_sync" for relationships with a policy of type "sync". SnapMirror relationships with the policy type as "sync" and "sync_type" as "automated_failover" can be in "broken_off" state due to a failed attempt of SnapMirror failover. To pause the relationship, suspending further transfers, PATCH the state to "paused" for relationships with a policy of type "async" or "sync". SnapMirror relationships with the policy type as "sync" and "sync_type" as "automated_failover" cannot be "paused". To resume transfers for a paused relationship, PATCH the state to "snapmirrored" for relationships with a policy of type "async" or to state "in_sync" for relationships with a policy of type "sync". The entries "in_sync", "out_of_sync", "synchronizing", and "expanding" are only applicable to relationships with a policy of type "sync". A PATCH call on the state change only triggers the transition to the specified state. You must poll on the "state", "healthy" and "unhealthy_reason" properties using a GET request to determine if the transition is successful. To automatically initialize the relationship when specifying "create_destination" property, set the state to "snapmirrored" for relationships with a policy of type "async" or to state "in_sync" for relationships with a policy of type "sync".

svmdr_volumes

array[svmdr_volumes]

Specifies the list of constituent FlexVol volumes and FlexGroup volumes for an SVM DR SnapMirror relationship. FlexGroup constituents are not considered.

throttle

integer

Throttle, in KBs per second. This "throttle" overrides the "throttle" set on the SnapMirror relationship's policy. If neither of these are set, defaults to 0, which is interpreted as unlimited.

total_transfer_bytes

integer

Cumulative bytes transferred for the relationship.

total_transfer_duration

string

Indicates the cumulative duration of all transfers since the last aggregate relocation, takeover/giveback, or metrocluster switchover/switchback involving the node that hosts the relationship.

transfer

transfer

Basic information on the current transfer or the last transfer if there is no active transfer at the time of the request.

transfer_schedule

transfer_schedule

Schedule used to update asynchronous relationships. This "transfer_schedule" overrides the "transfer_schedule" set on the SnapMirror relationship's policy. To remove the "transfer_schedule", set its value to null (no-quotes). Only cron schedules are supported for SnapMirror.

unhealthy_reason

array[snapmirror_error]

Reason the relationship is not healthy. It is a concatenation of up to four levels of error messages.

uuid

string

Unique identifier of the SnapMirror relationship.

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.