APIs in Category: snapmirror | Cluster-Mode API version 1.21

snapmirror-abort snapmirror-abort-async snapmirror-abort-iter snapmirror-break snapmirror-break-async snapmirror-break-iter snapmirror-check snapmirror-check-iter snapmirror-create snapmirror-destroy snapmirror-destroy-async snapmirror-destroy-iter snapmirror-get snapmirror-get-destination snapmirror-get-destination-iter snapmirror-get-iter snapmirror-get-total-records snapmirror-get-volume-status snapmirror-initialize snapmirror-initialize-iter snapmirror-initialize-ls-set snapmirror-modify snapmirror-modify-iter snapmirror-promote snapmirror-promote-iter snapmirror-quiesce snapmirror-quiesce-iter snapmirror-release snapmirror-release-iter snapmirror-restore snapmirror-resume snapmirror-resume-iter snapmirror-resync snapmirror-resync-iter snapmirror-snapshot-owner-get snapmirror-snapshot-owner-get-snapshots snapmirror-update snapmirror-update-iter snapmirror-update-ls-set | This set of APIs allows to manage SnapMirror relationships on Data ONTAP operating in 7-Mode or in Cluster-Mode. This includes the creation, initialization, update, resynchronization, modification of configuration parameters, and information query. The user's role determines the APIs that can be issued. In general APIs that simply query status information about SnapMirror relationships only require that the user has read access. APIs that modify the state of the system require write access. This includes creation, destruction, modification or update of relationships. A valid SnapMirror license is necessary to be able to use APIs that create, initialize, or destroy SnapMirror relationships. Most of the APIs require that you specify at least one of the endpoints of the SnapMirror relationship. On Data ONTAP operating in 7-Mode, the endpoint can be a volume or a qtree. On Data ONTAP operating in Cluster-Mode the endpoint can only be a volume. An endpoint can be specified by providing its location in a path format. The format depends on the version of Data ONTAP and the mode it is operating in: On Data ONTAP operating in 7-Mode the format is: <system>:/vol/<volume>[/<qtree>] where 'system' is the name of the storage system; 'volume' is the name of the volume, and 'qtree' the name of the qtree. On Data ONTAP 8.1 operating in Cluster-Mode, the format is: [<cluster>:]//<vserver>/<volume> where 'cluster' is the name of the cluster, 'vserver' the name of the Vserver, 'volume' is the name of the volume. On Data ONTAP 8.2 or later operating in Cluster-Mode, the format of the path is: [<vserver>:]<volume> where 'vserver' is the name of the Vserver, 'volume' is the name of the volume. Note that this requires the Vserver peering capability, which handles the mapping of a Vserver to the right cluster. The control plane for these relationship is specific to Data ONTAP 8.2 and later. The progress of long operations such as initialize, update, resync, or restore is monitored via the snapmirror-get API. The relationship-control-plane field is set to 'v2'. For backward compatibility with Data ONTAP 8.1 operating in Cluster-Mode, and to accommodate load-sharing relationships which are only supported in a Data ONTAP 8.1 compatible way, the relationships that match one of the following conditions are managed as on Data ONTAP 8.1 operating Cluster-Mode. The control plane of these relationships is compatible with Data ONTAP 8.1 operating Cluster-Mode. Load-sharing relationship. Cross-cluster relationship with the source endpoint on Data ONTAP 8.1 operating in Cluster-Mode. Relationship existed before the local cluster was upgraded from Data ONTAP 8.1 operating in Cluster-Mode and has not yet been converted to one with Data ONTAP 8.2 capabilities. The path format of Data ONTAP 8.1 operating in Cluster-Mode must be used. Long operations such as initialize, update, resync, restore spawn a job. The job API must be used to track the progress of the operation. The relationship-control-plane field is set to 'v1' for these relationships. On Data ONTAP operating in Cluster-Mode, it is also possible to specify the endpoint by providing the names of the cluster, Vserver, and volume of the endpoint separately. In general it is mandatory to specify the destination endpoint.

NetApp Manage ONTAP

snapmirror-abort | [top]

> The snapmirror-abort API stops ongoing transfers for a SnapMirror relationship. The relationship is identified by its destination endpoint. You must specify the destination endpoint when using snapmirror-abort. On Data ONTAP operating in Cluster-Mode, the snapmirror-abort API stops all of the active transfers to each associated volume on the receiving side in a set of load-sharing mirrors. Load-sharing mirrors are either up to date and serving data to clients, or they are lagging and not serving data to clients. If the snapmirror-abort API identifies an up-to-date load-sharing mirror, then SnapMirror transfers to associated up-to-date load-sharing mirrors in the set of load-sharing mirrors are also aborted. If the snapmirror-abort API identifies a lagging load-sharing mirror, then only the SnapMirror transfer associated with the lagging load-sharing mirror is aborted. After the snapmirror-abort API successfully completes its operation, the volume on the receiving side of the transfer might contain a restart checkpoint. The restart checkpoint can be used by a subsequent transfer to restart and continue the aborted SnapMirror transfer. Snapmirror-abort API must be used from the destination storage system on Data ONTAP operating in 7-Mode, from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, from the destination Vserver or cluster on Data ONTAP 8.2 or later operating in Cluster-Mode. This API is not supported if the destination end point is an Infinite Volume.

> Input Name | Range | Type | Description
> check-only |  | boolean optional | If this option is specified true, only snapmirror-check operations active on the relationship will be aborted.
> clear-checkpoint |  | boolean optional | If true, the restart checkpoint is cleared. The default is false, not cleared.
> destination-cluster |  | string optional | Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination volume. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source volume. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.

> Errno | Description
> ESNAPMIRRORERR |  |
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_ISNOT_LS_VOLUME |  |
> EANOTHER_OP_ACTIVE |  |
> ENOTRANSFER_IN_PROGRESS |  |
> EVSERVER_OP_NOT_ALLOWED |  |

snapmirror-abort-async | [top]

> The snapmirror-abort-async API stops ongoing transfer for a SnapMirror relationship on Infinite Volume. The relationship is identified by its destination endpoint. You must specify the destination endpoint when using the snapmirror-abort-async API. After the snapmirror-abort-async API successfully aborted the transfer, the volume on the receiving side of the transfer might contain a restart checkpoint. The restart checkpoint can be used by a subsequent transfer to restart and continue the aborted SnapMirror transfer. Snapmirror-abort-async API must be used from the destination cluster on Data ONTAP Cluster-Mode. This API is not supported if the destination end point is a flexible volume or an Infinite Volume constituent. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> check-only |  | boolean optional | If this option is specified true, only snapmirror-check operations active on the relationship will be aborted.
> clear-checkpoint |  | boolean optional | If this option is specified true, the restart checkpoint is discarded and the destination volume is restored to the last Snapshot copy that was successfully transferred. You can use the clear-checkpoint option to discard the restart checkpoint of a previous transfer attempt which forces the subsequent transfer to start with a fresh Snapshot copy on the destination volume.
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EVOLUME_TYPE_NOT_SUPPORTED |  |

snapmirror-abort-iter | [top]

> The snapmirror-abort-iter API aborts SnapMirror transfers for one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.

> Input Name | Range | Type | Description
> check-only |  | boolean optional | If this option is specified true, only snapmirror-check operations active on the relationship will be aborted.
> clear-checkpoint |  | boolean optional | If this option is specified true, the restart checkpoint is discarded and the destination volume is restored to the last Snapshot copy that was successfully transferred. You can use the clear-checkpoint option to discard the restart checkpoint of a previous transfer attempt which forces the subsequent transfer to start with a fresh Snapshot copy on the destination volume.
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-abort-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-abort-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-break | [top]

> Breaks a SnapMirror relationship between a source and destination volume of a data protection mirror. When Data ONTAP breaks the relationship, the destination volume is made a read-write volume and can diverge from the source volume, client redirection is turned off on the destination volume, the restart checkpoint is cleared, and the clients can see the latest Snapshot copy. On Data ONTAP operating in 7-Mode, no check is done to determine whether the operation is legal or successful. You need to query the status afterward by using the snapmirror-get-status API. Subsequent manual or scheduled SnapMirror updates to the broken relationship will fail until the SnapMirror relationship is re-established using the snapmirror-resync API. On Data ONTAP operating in Cluster-Mode, this API applies only to data protection mirrors and not to load-sharing mirrors. The snapmirror-break API must be issued on destination storage system on Data ONTAP operating in 7-Mode, and on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination cluster or Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode. This API is not supported if the destination end point is an Infinite Volume.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. On Data ONTAP operating in 7-Mode, If the destination endpoint is a qtree, it must be quiesced using snapmirror-quiesce. This parameter is mandatory on Data ONTAP 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination volume. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source volume. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.

> Errno | Description
> ESNAPMIRRORERR |  |
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> EDEST_IS_LS_VOLUME |  |
> EDEST_IS_EXISTING_SOURCE_VOLUME |  |
> EANOTHER_OP_ACTIVE |  |
> EDEST_VOL_LOCKED |  |
> EVSERVER_OP_NOT_ALLOWED |  |

snapmirror-break-async | [top]

> The snapmirror-break-async API breaks an Infinite Volume SnapMirror relationship between a source and destination volume of a data protection mirror. When Data ONTAP breaks the relationship, the destination volume is made a read-write volume and can diverge from the source volume, client redirection is turned off on the destination volume, the restart checkpoint is cleared, and the clients can see the latest Snapshot copy. You must specify the destination endpoint when using snapmirror-break-async. Subsequent manual or scheduled SnapMirror updates to the broken relationship will fail until the SnapMirror relationship is reestablished using the snapmirror-resync API. This API applies only to data protection mirrors for Infinite Volume. You must use the snapmirror-break-async API from the destination cluster. This API is not supported on Infinite Volume constituents. This API is not supported if the destination end point is a flexible volume. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EVOLUME_TYPE_NOT_SUPPORTED |  |

snapmirror-break-iter | [top]

> The snapmirror-break-iter API breaks one or more SnapMirror relationships.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-break-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-break-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-check | [top]

> The snapmirror-check API starts an operation to compare the contents of a snapshot between the source volume and destination volume. You must specify the destination endpoint when using snapmirror-check. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> target-snapshot |  | string optional | Specifies the Snapshot copy on the destination endpoint to check.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_VOLUME_NOT_INITIALIZED |  |
> EOP_FROM_NONMGR_VSERVER |  |

snapmirror-check-iter | [top]

> The snapmirror-check-iter API checks one or more SnapMirror relationships. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> target-snapshot |  | string optional | Specifies the Snapshot copy on the destination endpoint to check.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-check-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
> success-list |  | snapmirror-check-iter-info[] optional | The snapmirror objects that were successfully processed or scheduled to be processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-create | [top]

> The snapmirror-create API creates a SnapMirror relationship between a source and destination volumes. The following types of relationships can be created: 'data_protection' - For Disater Recovery (DR); 'load_sharing' - For load-sharing within the same Vserver; 'vault' - For Vault; 'transition_data_protection' - For 7-mode to Cluster-Mode transition; 'restore' - For restoring a data protection (DP) volume data; On Data ONTAP 8.1 operating in Cluster-Mode, only 'data_protection' and 'load_sharing' type are supported. Relationships of type 'restore' are created temporary during a restore operation initiated using the snapmirror-restore API or the corresponding command. The source and destination endpoints must be specified when using the snapmirror-create API. This API will fail if the destination volume does not exist. On Data ONTAP 8.2 operating in Cluster-Mode, the API does not validate the attributes and the existence of the source volume. It will succeed even if the source volume does not exist. The validation will be done at the first transfer time. On Data ONTAP 8.1 operating in Cluster-Mode, the API will fail if the source volume is not in online state and read-write (RW) type, or the destination volume is not in online state and a DP (Data Protection) type. Note: The source volume might contain data and Snapshot copies prior to creating the Snapmirror relationship. If the destination volume is not empty, it must have a Snapshot copy in common with the source volume, that is, it must have once been a copy of the source volume. On Data ONTAP 8.1 operating in Cluster-Mode, the API will fail if there is no common Snapshot copy. On Data ONTAP 8.2 operating in Cluster-Mode the API will succeed, but all subsequent transfers will fail if there is no common snapshot copy. Load-sharing mirrors have the following restrictions: - They only use FlexVol volumes. - They are confined to a single Vserver; they are not allowed to span Vservers. - The source or destination of a load-sharing relationship cannot be the source or destination of any other SnapMirror relationship. A set of load-sharing mirrors can have one or more destination volumes. You create separate SnapMirror relationships between the common source volume and each destination volume to create the set of load-sharing mirrors. If the destination volume is empty, it must be initialized using the snapmirror-initialize API. Destination volumes in a set of load-sharing mirrors must be initialized using the snapmirror-initialize-ls-set API. The snapmirror-create API must be issued on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 operating in Cluster-Mode.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> policy |  | string optional | Specifies the name of the snapmirror policy for the relationship. For SnapMirror relationships of type 'vault', the policy will also have rules to select snapshot copies that must be transferred. If no policy is specified, a default policy will be applied depending on the type of the SnapMirror relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
> relationship-type |  | string optional | Specifies the type of the SnapMirror relationship. Possible values: "data_protection" , "load_sharing" , "vault" , "restore" , "transition_data_protection"
> return-record |  | boolean optional | If set to true, returns the snapmirror on successful creation. Default: false
> schedule |  | string optional | Specifies the name of the cron schedule, which is used to update the SnapMirror relationship.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored.
> vserver |  | string optional | If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option and should not be used for queries. The destination-vserver parameter should be used to select the Vserver in a cluster context.
> Output Name | Range | Type | Description
> result |  | snapmirror-info optional | The snapmirror created (keys or the entire object if requested)

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPILICENSE |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_DEST_SAME |  |
> ESOURCE_ISNOT_RW_VOLUME |  |
> EDEST_ISNOT_LS_VOLUME |  |
> ESOURCE_IS_DIFFERENT |  |
> ERELATION_EXISTS |  |
> ESOURCE_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_DEST_VSERVERS_DIFFERENT |  |
> EDEST_IS_RW_VOLUME |  |
> ESOURCE_IS_STRIPED_VOLUME |  |
> EDEST_IS_STRIPED_VOLUME |  |
> EDEST_VOLUME_HAS_CACHE |  |
> ESOURCE_VOLUME_HAS_CACHE |  |
> EDEST_IS_EXISTING_DEST_VOLUME |  |
> EDEST_VOLUME_NOT_EMPTY |  |
> EDEST_IS_LS_VOLUME |  |
> EDEST_IS_VOLUME_CLONE |  |
> ENOSNAPSHOT_COPY |  |
> EVOLUMES_EMPTY |  |
> EVOLUMES_WITH_DIFF_STRIPES |  |
> ESCHEDULE_DOESNT_EXIST |  |
> EVSERVER_OP_NOT_ALLOWED |  |

> License
> SnapMirror

snapmirror-destroy | [top]

> The snapmirror-destroy API removes only the SnapMirror relationship of a source volume and a destination volume, the volumes are not destroyed and Snapshot copies on the volumes are not removed. You must specify the destination endpoint when using snapmirror-destroy. On Data ONTAP 8.1 operating in Cluster-Mode, the snapmirror-destroy API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. On Data ONTAP 8.2 operating in Cluster-Mode, the snapmirror-destroy API will attempt to abort any ongoing transfer. However, failure to abort the transfer will not cause the API to fail. A set of load-sharing mirrors might contain multiple destination volumes, each destination volume having a separate SnapMirror relationship with the common source volume. When used on one of the SnapMirror relationships from the set of load-sharing mirrors, the snapmirror-destroy API deletes the specified SnapMirror relationship from the set of load-sharing mirrors. The snapmirror-destroy API preserves the read-write or read-only attributes of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a read-write volume that was the source of a SnapMirror relationship retains its read-write attributes, and a data protection volume or a load-sharing volume that was a destination of a SnapMirror relationship retains its read-only attributes. Note: When a SnapMirror relationship from a set of load-sharing mirrors is deleted, the destination volume becomes a data protection volume and retains the read-only attributes of a data protection volume. On Data ONTAP 8.2 operating in Cluster-Mode, this API can only be issued on the destination Vserver. The SnapMirror relationship information is deleted from destination Vserver, but no cleanup or deletion is performed on the source Vserver. The snapmirror-release API must be issued on the source Vserver to delete the relationship information on the source Vserver. On Data ONTAP 8.1 operating in Cluster-Mode, this API can be issued on the source or on the destination cluster. When issued on the destination cluster, the SnapMirror relationship information on the source and destination clusters is deleted. When issued on the source cluster, only the SnapMirror relationship information on the source cluster is deleted. Note: If the SnapMirror relationship identified by the destination endpoint does not exist, this API will return success. This API is not supported if the destination end point is a Infinite Volume.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPILICENSE |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> ESOURCE_IS_DIFFERENT |  |
> ETRANSFER_IN_PROGRESS |  |
> EANOTHER_OP_ACTIVE |  |
> EDEST_VOL_LOCKED |  |

> License
> SnapMirror

snapmirror-destroy-async | [top]

> The snapmirror-destroy-async API removes only the SnapMirror relationship of a source and a destination Infinite Volume, the volumes are not destroyed and Snapshot copies on the volumes are not removed. You must specify the destination endpoint when using snapmirror-destroy-async. The snapmirror-destroy-async API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. The snapmirror-destroy-async API preserves the read-write or read-only attributes of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a read-write volume that was the source of a SnapMirror relationship retains its read-write attributes, and a data protection volume that was a destination of a SnapMirror relationship retains its read-only attributes. The snapmirror-destroy-async API should be used from the destination cluster. When used in this fashion, the destination-side information will be cleaned up. The destination will also attempt to cleanup source-side information. If the source cluster is not available, the destination-side information will still be cleaned up. This API is not supported if the destination end point is a flexible volume or an Infinite Volume constituent. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EVOLUME_TYPE_NOT_SUPPORTED |  |

> License
> SnapMirror

snapmirror-destroy-iter | [top]

> Removes one or several SnapMirror relationships. This API is not supported on Infinite Volume constituents.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-destroy-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-destroy-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

> License
> SnapMirror

snapmirror-get | [top]

> The snapmirror-get API returns information for a SnapMirror relationship. On Data ONTAP 8.1 operating in Cluster-Mode this API can be issued on the source cluster or destination cluster of the relatonship. On Data ONTAP 8.2 operating in Cluster-Mode, this API must be issued on the destination Vserver or the destination cluster of the relationship. The destination endpoint must be specified when using the snapmirror-get API.

> Input Name | Range | Type | Description
> desired-attributes |  | snapmirror-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> Output Name | Range | Type | Description
> attributes |  | snapmirror-info | The attributes of the snapmirror.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

snapmirror-get-destination | [top]

> The snapmirror-get-destination API returns information about a SnapMirror relationship whose source endpoint is on the cluster or Vserver it is issued on. The destination endpoint must be specified when using this API. The source endpoint can also be specified. The cluster or Vserver may have several entries for the specified endpoints, but with different relationship IDs. In this case the API returns information about the first entry. To get information about all the SnapMirror relationships matching the specified endpoints, the snapmirror-get-destination-iter API must be used. Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated. The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver. This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode. This API must be issued on the source Vserver or the source cluster of the relationship.

> Input Name | Range | Type | Description
> desired-attributes |  | snapmirror-destination-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The destination endpoint can be specified using the location format above, or by specifying the parameters for the name of the destination Vserver and the name of the destination volume.
> destination-volume |  | string optional | Specifies the name of destination volume for the SnapMirror relationshp. The name of the destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the relationship. The name of the destination volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The source endpoint can be specified using the location format above, or by specifying the parameters for the name of the source Vserver and the name of the source volume.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. The name of the source Vserver must also be specified if using this parameter.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. The name of the source volume must also be specified if using this parameter.
> Output Name | Range | Type | Description
> attributes |  | snapmirror-destination-info | The attributes of the snapmirror.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

snapmirror-get-destination-iter | [top]

> The snapmirror-get-destination-iter API returns information about, one or more SnapMirror relationships whose source endpoints are in the Vserver or the cluster the API is issued on. The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver. Stale information may result to several entries being returned with the same source and destination endpoints, but with different relationship IDs. Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated. This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode. It can be issued on a Vserver or a Cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | snapmirror-destination-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | snapmirror-destination-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the snapmirror object. All snapmirror objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | snapmirror-destination-info[] optional | The list of attributes of snapmirror objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more snapmirror objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-get-iter | [top]

> The snapmirror-get-iter API returns information for one or several SnapMirror relationships. On Data ONTAP 8.1 operating in Cluster-Mode, this API can be issued on a cluster. It returns all SnapMirror relationships that have a source or destination endpoint in that cluster, and that match the parameters specified. On Data ONTAP 8.2 operating in Cluster-Mode, this API can be issued on a Vserver or a cluster. It returns all the SnapMirror relationships, which have a destination endpoint in that Vserver or cluster, and that match the parameters specified.

> Input Name | Range | Type | Description
> desired-attributes |  | snapmirror-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | snapmirror-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the snapmirror object. All snapmirror objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | snapmirror-info[] optional | The list of attributes of snapmirror objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more snapmirror objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-get-total-records | [top]

> Obtain the total number of SnapMirror relationships. This is a point in time estimate and may be different on subsequent calls.

> Output Name | Range | Type | Description
> count | [0..2^64-1] | integer | The total number of snapmirror objects.

snapmirror-get-volume-status | [top]

> Returns SnapMirror status values for a given volume. Including whether: the volume is a source of a SnapMirror relationship; the volume is a destination of a SnapMirror relationship; a transfer is in progress; the relationship is broken off. On Data ONTAP 8.1 operating in Cluster-Mode, this API is provided for backward compatibility only. It will fail if the volume is the source or destination of a load-sharing SnapMirror relationship. It is recommended to use the snapmirror-get-iter API to get the same information. On Data ONTAP 8.1 operating in Cluster-Mode, this API must be issued on the cluster the volume belongs to. This API is not supported On Data ONTAP 8.2 or later operating in Cluster-Mode. You must use the snapmirror-get-iter and snapmirror-get-destination-iter APIs. If issued on Data ONTAP 8.2 or later operating in Cluster-Mode, this API will return EOPNOTSUPPORTED error.

> Input Name | Range | Type | Description
> volume |  | string | Name of the volume to be queried. On Data ONTAP operating in Cluster-Mode, specifies the location of the volume the following formats: [<cluster>:][//<vserver>/]<volume>
> Output Name | Range | Type | Description
> is-destination |  | boolean optional | true if it was determined that the volume is a destination of a SnapMirror relationship. false otherwise
> is-source |  | boolean optional | true if it was determined that the volume is a source of a SnapMirror relationship. false otherwise
> is-transfer-broken |  | boolean optional | true if it was determined that the volume is a destination of a SnapMirror relationship that was broken off. The volume allows reads and writes. false otherwise
> is-transfer-in-progress |  | boolean optional | true if it was determined that the volume is a source or a destination of a SnapMirror relationship that has a transfer going on. false otherwise

> Errno | Description
> EVOLUMEOFFLINE |  |
> EVOL_RESTRICTED |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMENOTLOCAL |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMEOFFLINE |  |
> EVOLUME_RELSTATUS_UNKNOWN |  |
> EOPNOTSUPPORTED |  |
> EVOL_RESTRICTED |  |

> License
> replicate

snapmirror-initialize | [top]

> Performs the initial update of a SnapMirror relationship. You must specify the destination endpoint when using snapmirror-initialize. This API must be used from the destination storage system on Data ONTAP operating in 7-Mode, from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and from the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode. On Data ONTAP operating in 7-Mode, If the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist. On Data ONTAP operating in Cluster-Mode, this API is usually used after the snapmirror-create API, but it can be used alone, that is, without the snapmirror-create API, to create and initially update a SnapMirror relationship. On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode (The relationship-control-plane field is set to 'v1'), a job will be spawned to operate on the SnapMirror relationship, and the job id will be returned. The progress of the job can be tracked using the job APIs. On Data ONTAP 8.2 or later operating in Cluster-Mode, for vault relationships, a 32-bit volume cannot be the source or destination of the relationship. On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API, except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. On Data ONTAP operating in 7-Mode, if the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist. This parameter is mandatory on Data ONTAP operating in 7-mode.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination volume. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP operating in Cluster-Mode, the max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode when specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. On Data ONTAP operating in 7-Mode, If the source-location is not specified, then the source in /etc/snapmirror.conf for the destination path is used.
> source-snapshot |  | string optional | Designates the source snapshot to use for a qtree update on Data ONTAP operating in 7-mode, and the snapshot on the source volume to use for the baseline transfer on Data ONTAP 8.2 or later operating in Cluster-Mode. The default creates new snapshot on the source for the transfer. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. The If using this parameter, the following parameters must also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source volume. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> transfer-priority |  | string optional | Specifies the priority at which the transfer runs. Possible values are: "normal", and "low". The default value is the value specified in the snapmirror policy which is associated with the relationship. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
> result-error-message |  | string optional | Error description, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job. This parameter is only returned by Data ONTAP 8.1 operating in Cluster-Mode.
> result-status |  | string optional | The operation status. Possible values: "succeeded", "in_progress", "failed". This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.

> Errno | Description
> ESNAPMIRROROFF |  |
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPILICENSE |  |
> EAPIMISSINGARGUMENT |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> EDEST_ISNOT_LS_VOLUME |  |
> ESOURCE_ISNOT_RW_VOLUME |  |
> ESOURCE_IS_EXISTING_DEST_VOLUME |  |
> EDEST_IS_EXISTING_DEST_VOLUME |  |
> EOP_FROM_NONMGR_VSERVER |  |
> EDEST_IS_RW_VOLUME |  |
> ESOURCE_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_DEST_VSERVERS_DIFFERENT |  |
> ESOURCE_IS_STRIPED_VOLUME |  |
> EDEST_VOLUME_NOT_EMPTY |  |
> ESOURCE_DEST_SAME |  |
> ENOSNAPSHOT_COPY |  |
> EVOLUMES_WITH_DIFF_STRIPES |  |
> ETRIES_COUNT_IS_ZERO |  |
> ERELATION_IS_QUIESCED |  |
> EANOTHER_OP_ACTIVE |  |
> EDEST_IS_STRIPED_VOLUME |  |
> EDEST_VOL_LOCKED |  |
> EVSERVER_OP_NOT_ALLOWED |  |

> License
> replicate

snapmirror-initialize-iter | [top]

> The snapmirror-initialize-iter API initializes the destination volume of one or more SnapMirror relationships. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> source-snapshot |  | string optional | Source Snapshot
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> transfer-priority |  | sm-transfer-priority-enum optional | Transfer Priority Possible values: "low" , "normal"
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-initialize-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
> success-list |  | snapmirror-initialize-iter-info[] optional | The snapmirror objects that were successfully processed or scheduled to be processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

> License
> SnapMirror

snapmirror-initialize-ls-set | [top]

> The snapmirror-initialize-ls-set API performs the initial manual update of a set of load-sharing mirrors. This API is usually used after the snapmirror-create API is used to create a SnapMirror relationship for each of the destination volumes in the set of load-sharing mirrors. You must specify the source endpoint when using snapmirror-initialize-ls-set. Data and Snapshot copies are transferred from the source volume to all up-to-date destination volumes in the set of load-sharing mirrors. Use the snapmirror-initialize API to add and initialize a new destination volume to an existing set of load-sharing mirrors. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter. This parameter is supported only in cluster context.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship. When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. The source cluster and source Vserver must also be specified if using this parameter. This parameter may be optional if executed outside cluster context.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. The source cluster and source volume must also be specified if using this parameter.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIMISSINGARGUMENT |  |
> EAPIPRIVILEGE |  |
> ESOURCE_IS_EXISTING_DEST_VOLUME |  |
> ETRIES_COUNT_IS_ZERO |  |
> ERELATION_IS_QUIESCED |  |
> EANOTHER_OP_ACTIVE |  |
> EVSERVER_OP_NOT_ALLOWED |  |

snapmirror-modify | [top]

> The snapmirror-modify API changes one or more parameters of a SnapMirror relationship. The key parameter that identifies any SnapMirror relationship is the destination volume. You must specify the destination endpoint when using the snapmirror-modify API. For load-sharing mirrors, a change to a parameter affects all of the SnapMirror relationships in the set of load-sharing mirrors. Destination volumes in a set of load-sharing mirrors do not have individual parameter settings. Changes made by the snapmirror-modify API do not take effect until the next manual or scheduled update of the SnapMirror relationship. Changes do not affect updates that have started and have not finished yet. On Data ONTAP 8.1 operating in Cluster-Mode this API must be issued on the destination Cluster. On Data ONTAP 8.2 operating in Cluster-Mode, this API must be issued on the destination Vserver if operating in a Vserver context and on the destination cluster if operating in a cluster context. This API is not supported on Infinite Volume constituents.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> policy |  | sm-policy optional | Specifies the name of the SnapMirror policy that applies to this relationship.
> schedule |  | string optional | Specifies the name of the cron schedule, used to update the SnapMirror relationship.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored.
> vserver |  | vserver-name optional | If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_DEST_SAME |  |
> ESOURCE_IS_DIFFERENT |  |
> EOP_FROM_NONMGR_VSERVER |  |
> ESCHEDULE_DOESNT_EXIST |  |
> EANOTHER_OP_ACTIVE |  |
> EVOLUME_TYPE_NOT_SUPPORTED |  |
> EVSERVER_OP_NOT_ALLOWED |  |

snapmirror-modify-iter | [top]

> The snapmirror-modify-iter API allows to change one or more parameters of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> policy |  | sm-policy optional | Specifies the name of the SnapMirror policy that applies to this relationship.
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> schedule |  | string optional | Specifies the name of the cron schedule, used to update the SnapMirror relationship.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored.
> vserver |  | vserver-name optional | If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-modify-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-modify-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-promote | [top]

> The snapmirror-promote API performs a failover to the destination volume of a load-sharing SnapMirror relationship. This API changes the destination volume from a load-sharing volume to a read-write volume and makes the destination volume assume the identity of the source volume. The API then destroys the original source volume. The destination volume must be a load-sharing volume. However, you can still perform 'snapmirror-promote' on a destination load-sharing volume that has been left in read-write state by a previously failed promote operation. You must specify the destination endpoint when using snapmirror-promote. Note: The source volume and destination volume must be on the same Vserver for the promote to work. Client accesses are redirected from the original source volume to the promoted destination volume. The view clients see on the promoted destination volume is the latest transferred Snapshot copy, which might lag behind the view clients had of the original source volume before the promote. The SnapMirror relationship is usually deleted as part of the promotion process. This is not true for a set of load-sharing mirrors that contain more than one destination volume. In this case, the promoted destination volume becomes the new source volume to the set of load-sharing mirrors. It is possible that the original source volume is the source of multiple SnapMirror relationships. For such a configuration, the promoted destination volume becomes the new source volume of the other SnapMirror relationships. The snapmirror-promote API fails if a SnapMirror transfer is in progress for any SnapMirror relationship involving the original source volume.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_ISNOT_RW_VOLUME |  |
> ESOURCE_DEST_SAME |  |
> ETRANSFER_IN_PROGRESS |  |
> EANOTHER_OP_ACTIVE |  |
> EDEST_VOL_LOCKED |  |
> ESRC_VOL_LOCKED |  |
> EVSERVER_OP_NOT_ALLOWED |  |

snapmirror-promote-iter | [top]

> The snapmirror-promote-iter API performs failover for one or more SnapMirror relationships.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-promote-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-promote-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-quiesce | [top]

> Disables future transfers to a SnapMirror destination. If there is no transfer in progress, the SnapMirror relationship becomes 'Quiesced'. If there is a transfer in progress, the SnapMirror relationship becomes 'Quiescing' until the transfer completes. If the current transfer aborts, it will be treated like a future transfer and will not restart. When a SnapMirror relationship is quiesced, it remains in that state across reboots and fail-overs. The relationship must exist on the destination and you must specify the destination endpoint when using snapmirror-quiesce. On Data ONTAP 8.1 operating in Cluster-Mode, if applied to a load-sharing (LS) SnapMirror relationship, all the relationships in the set will be quiesced. This API must be issued from the destination storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination volume. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format may change in the future. On Data ONTAP operating in Cluster-Mode, When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source volume. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_DEST_SAME |  |
> ESOURCE_IS_DIFFERENT |  |
> EOP_FROM_NONMGR_VSERVER |  |
> EANOTHER_OP_ACTIVE |  |
> EVSERVER_OP_NOT_ALLOWED |  |

> License
> replicate

snapmirror-quiesce-iter | [top]

> Disables future transfers for one or more SnapMirror relationships.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-quiesce-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-quiesce-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-release | [top]

> The snapmirror-release API removes a SnapMirror relationship on the source endpoint. It unlocks and cleanups the snapshots pertaining to the relationship. It does not destroy any volume. You must specify the destination endpoint when using snapmirror-release. Unless relationship-info-only is specified, this operation will fail if it is unable to reach the source volume and clean up snapshots. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be executed on the source Vserver or source cluster following the deletion of the relationship on the destination Vserver or destination cluster. It is possible to issue snapmirror-release on the source Vserver without deleting the relationship on the destination Vserver. However, the relationship will continue to exist because the destination is the authority. The relationship will reappear on the source on the next transfer. On Data ONTAP operating in 7-Mode, this API must be issued on the source storage system. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be issued on the source Vserver if operating in Vserver context and on the source cluster if operating in a cluster context. This API is not supported on Data ONTAP 8.1 operating in Cluster-Mode, or Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.

> Input Name | Range | Type | Description
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or destination Vserver and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the destination Vserver must also be specified.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the destination volume must also be specified.
> relationship-id |  | string optional | Specifies the relationship unique identifier of the SnapMirror relationship.
> relationship-info-only |  | boolean optional | If relationship-info-only is set to true then only relationship information is removed. By default it is false.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format may change in the future. On Data ONTAP operating in Cluster-Mode, When specifying a source endpoint, you must use either the source location, or the source Vserver, and source volume.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. If using this parameter, the source Vserver must also be specified:
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the source volume must also be specified.

> Errno | Description
> ESNAPMIRRORERR |  |
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPILICENSE |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> EVSERVER_OP_NOT_ALLOWED |  |

snapmirror-release-iter | [top]

> releases one or a group of SnapMirror relationships.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-destination-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-release-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-release-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

> License
> SnapMirror

snapmirror-restore | [top]

> The snapmirror-restore API restores the contents of a selected Snapshot copy from the source volume to the active file system of the destination volume. The destination volume is read write after the data is restored. The snapmirror-restore API creates a temporary SnapMirror relationship of the type RST. For this reason the destination volume cannot be the destination volume of another SnapMirror relationship. The temporary RST relationship is deleted after the operation completes successfully. If the destination volume is an empty data protection volume, the snapmirror-restore API performs a baseline restore. The baseline restore transfers the contents of the selected Snapshot copy from the source volume to the destination volume. If the destination volume is read-write and has at least one Snapshot which also appears on the source volume, an incremental restore is performed. The destination volume is made read only, if is not already read only. When the destination volume is made read only the latest snapshot on destination volume is made the exported snapshot. Note, that any data written to the destination volume since the last snapshot is lost during this operation. To save the contents of the active file system on the destination volume, stop all client access and take a snapshot before starting this operation. During an incremental restore a common Snapshot copy is selected. The snapshot chosen as the common snapshot must be on the source and destination volumes. The contents of the common Snapshot copy on the destination volume are copied to the active file system of the destination volume. Then the contents of the Snapshot copy to be restored are transferred from the source volume to the destination volume. Unless 'source-snapshot' is specified the most recent Snapshot copy on the source volume is restored. This API may be used to restart a failed snapmirror-restore operation. This API may be used to terminate an aborted or failed snapmirror-restore operation by specifying the 'clean-up-failure' parameter set to 'true'. Terminating an aborted or failed snapmirror-restore operation deletes any residual temporary RST relationship and converts the destination volume back to read-write if the destination volume was read-write prior to initial snapmirror-restore operation while removing any data transferred or copied during the snapmirror-restore operation. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> clean-up-failure |  | boolean optional | Use this parameter with the value of 'true' to recover from an aborted or failed restore operation. If the destination volume was read-write prior to the failed or aborted restore operation, it is converted back to read-write if necessary while removing all data transferred or copied during the restore operation. Any residual temporary RST relationship is also removed from the destination Vserver. An attempt is made to remove any residual temporary RST relationship from the source Vserver. The default value for this parameter is 'false'.
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> disable-storage-efficiency |  | boolean optional | The default behavior of restore is to preserve storage efficiency when possible. Use this parameter with a value of 'true' to turn off storage efficiency for data transferred over the wire and written to the destination volume. The default value for this parameter is false.
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
> source-snapshot |  | string optional | Specifies the Snapshot from the source to be restored.
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> transfer-priority |  | sm-transfer-priority-enum optional | Specifies the priority at which the transfer runs. Possible values are: 'normal', and 'low'. The default value for this parameter is 'normal'. Possible values: "low" , "normal"
> tries |  | string optional | Specifies the total number of attempts to transfer data. Valid input is a positive integer or 'unlimited'. The default is '8'.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIMISSINGARGUMENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> EDEST_IS_CACHE_VOLUME |  |
> EDEST_IS_VOLUME_CLONE |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_IS_LS_VOLUME |  |
> EDEST_VOL_LOCKED |  |

> License
> SnapMirror

snapmirror-resume | [top]

> Enables future transfers for a SnapMirror relationship that has been quiesced. If there is a scheduled transfer, it will be triggered on the next schedule. If there is a restart checkpoint, it will be re-used if possible. On Data ONTAP Cluster-Mode, If applied on a load-sharing SnapMirror relationship, transfers will resume for all the relationships of the set. When a quiesced SnapMirror relationship is resumed, it remains in that state across reboots and fail-overs. The relationship must exist on the destination and you must specify the destination end point when using snapmirror-resume. This API must be issued on the destination storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination volume. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format may change in the future. On Data ONTAP operating in Cluster-Mode, When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. The If using this parameter, the following parameters must also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source volume. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_DEST_SAME |  |
> ESOURCE_IS_DIFFERENT |  |
> EOP_FROM_NONMGR_VSERVER |  |
> ERELATION_NOT_QUIESCED |  |
> EANOTHER_OP_ACTIVE |  |
> EVSERVER_OP_NOT_ALLOWED |  |

> License
> replicate

snapmirror-resume-iter | [top]

> Enables future transfers for one or more SnapMirror relationships.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-resume-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed.
> success-list |  | snapmirror-resume-iter-info[] optional | The snapmirror objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-resync | [top]

> Re-establishes a mirroring relationship between a source volume and a destination volume, typically in the following cases: The destination mirror is broken (that is, the destination volume is a read-write volume and no longer a data protection mirror). After the snapmirror-resync API completes, the destination volume is made a data protection mirror and the mirror can be manually updated or scheduled for updates. A snapmirror-update API failed because the required common Snapshot copy was deleted on the source volume. After the operation completes, the destination volume is made a data protection mirror and the mirror can be manually updated or scheduled for updates. Attention: The snapmirror-resync API can cause data loss on the destination volume because the API can remove the exported Snapshot copy on the destination volume. The default behavior of the snapmirror-resync API is defined as follows: Finds the most recent common Snapshot copy between the source and destination volumes, removes Snapshot copies on the destination volume that are newer than the common Snapshot copy and mounts the destination volume as a DP volume with the common Snapshot copy as the exported Snapshot copy. For data protection relationships, takes a Snapshot copy of the source volume to capture the current image and transfers Snapshot copies that are newer than the common Snapshot copy from the source volume to the destination volume. For vault relationships, transfers Snapshot copies newer than the common Snapshot copy according to the relationship policy, i.e., Snapshot copies will match rules associated with the policy as defined by the snapmirror-policy API. On Data ONTAP 8.2 or later operating in Cluster-Mode, the snapmirror-resync API supports an optional parameter 'preserve'. The parameter 'preserve' is only supported for vault relationships. When used, the parameter 'preserve' changes the behavior of the snapmirror-resync API. The changed behavior can be described as follows: Finds the most recent common Snapshot copy between the source and destination volumes, preserves all Snapshot copies on the destination volume that are newer than the common Snapshot copy, and mounts the destination volume as a DP volume with the common Snapshot copy as the exported Snapshot copy. Performs a local rollback transfer to make a copy of the common Snapshot copy on the destination volume and establish it as the latest Snapshot copy on the destination volume. The command then transfers all Snapshot copies that are newer than the common Snapshot copy, from the source volume to the destination volume. The command only transfers Snapshot copies that match the vault relationship's policy, i.e., Snapshot copies will match rules associated with the policy as defined by the snapmirror-policy APIs. The snapmirror-resync API fails if the destination volume does not have a Snapshot copy in common with the source volume. On Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode, a job is spawned to operate for the SnapMirror relationship and the job id is returned. The progress of the operation can be tracked using the job APIs. On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP operating in 7-Mode, the update is asynchronously handled, and there is no guarantee that it succeeds. This requires that a schedule in /etc/snapmirror.conf is set for the destination. The API must be issued on the destination storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination volume. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> max-transfer-rate |  | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP operating in Cluster-Mode, the max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> preserve |  | boolean optional | This parameter is only available for Vault relationships. The default value is false which means all snapshots on the destination that are newer than the latest common snapshot will be deleted. If preserve is specified, newer snapshots are retained. If preserve is specified for a non-Vault relationship the API will fail. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode and for vault relationships.
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP Cluster-Mode when specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. On Data ONTAP operating in 7-Mode, If the source-location is not specified, then the source in /etc/snapmirror.conf for the destination path is used.
> source-snapshot |  | string optional | Designates the source snapshot to use for a qtree update on Data ONTAP operating in 7-Mode, and the snapshot on the source volume to use for the transfer on Data ONTAP 8.2 or later operating in Cluster-Mode. For data protection mirror relationships, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred. For vault relationships, Data ONTAP Cluster-Mode transfers the specified Snapshot copy instead of the ones that match its policy's rules. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source volume. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> transfer-priority |  | string optional | Specifies the priority at which the transfer runs. Possible values are: "normal", and "low". The default value is the value specified in the snapmirror policy which is associated with the relationship. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
> result-error-message |  | string optional | Error description, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode. This parameter should be used to monitor the transfer progress. But, on Data ONTAP 8.2 operating in Cluster-Mode, it should be ignored if the relationship-control-plane is not 'v1'. The snapmirror-get API should be used to monitor the progress of the transfer.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed". This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIMISSINGARGUMENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> EDEST_IS_CACHE_VOLUME |  |
> EDEST_IS_VOLUME_CLONE |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_IS_LS_VOLUME |  |
> ETRIES_COUNT_IS_ZERO |  |
> ERELATION_IS_QUIESCED |  |
> EANOTHER_OP_ACTIVE |  |
> ESOURCE_IS_STRIPED_VOLUME |  |
> EDEST_IS_STRIPED_VOLUME |  |
> EDEST_VOL_LOCKED |  |
> EVSERVER_OP_NOT_ALLOWED |  |

> License
> replicate

snapmirror-resync-iter | [top]

> The snapmirror-resync-iter API reestablishes one or more previously broken SnapMirror relationships. This API is not supported on Infinite Volume constituents. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> preserve |  | boolean optional | Preserve
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> source-snapshot |  | string optional | Source Snapshot
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> transfer-priority |  | sm-transfer-priority-enum optional | Transfer Priority Possible values: "low" , "normal"
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-resync-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
> success-list |  | snapmirror-resync-iter-info[] optional | The snapmirror objects that were successfully processed or scheduled to be processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

> License
> SnapMirror

snapmirror-snapshot-owner-get | [top]

> List all owners used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.

> Input Name | Range | Type | Description
> snapshot |  | snapshot-id | Snapshot Copy Name
> volume |  | volume-name | Volume Name
> vserver |  | vserver-name | Vserver Name
> Output Name | Range | Type | Description
> snapshot-owner-names |  | snapshot-owner-name[] | Returns the owner(s) used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |

snapmirror-snapshot-owner-get-snapshots | [top]

> List all Snapshot copies that are preserved for a SnapMirror mirror-to-vault cascade configuration.

> Input Name | Range | Type | Description
> volume |  | volume-name | Volume Name
> vserver |  | vserver-name | Vserver Name
> Output Name | Range | Type | Description
> snapshots |  | snapshot-id[] | Returns the Snapshot copies that are preserved using owners for a SnapMirror mirror-to-vault cascade configuration.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |

snapmirror-update | [top]

> Updates the destination endpoint of the SnapMirror relationship. The update is asynchronously handled, and there is no guarantee that it will succeed. On Data ONTAP operating in 7-Mode the snapmirror-get-status API can be used to check the status of the update. The API must be issued on the destination storage system. On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode and for relationships using a control plane compatible with Data 8.1 operating Cluster-Mode (relationship-control-plane set 'v1'), a job will be spawned to operate on the SnapMirror relationship, and the job id will be returned. The progress of the job can be tracked using the job APIs. On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API, except for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode. You must specify the destination endpoint when using snapmirror-update. The API makes the destination volume an up-to-date mirror of the source volume. This API must be used from the destination storage system on Data ONTAP 7-Mode, or from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and from the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode. On Data ONTAP operating in 7-Mode, if the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist. On Data ONTAP Cluster-Mode if the destination volume is empty, the snapmirror-update API will fail. The snapmirror-initialize API must be called to perform the baseline transfer before the the snapmirror-update can be called. For data protection relationships, the snapmirror-update API makes the destination volume an up-to-date mirror of the source volume with the following steps: If the source volume is read-write, takes a Snapshot copy on the source volume to capture the current image of the source volume. Finds the most recent Snapshot copy on the destination volume and validates that the corresponding Snapshot copy is on the source. Incrementally transfers Snapshot copies that are newer than the corresponding Snapshot copy to the destination volume. For vault relationships, the snapmirror-update API does not take a Snapshot copy on the source volume but transfers only selected Snapshot copies that are newer than the common Snapshot copy to the destination volume. Snapshot copies are selected by matching their 'snapmirror-label' with the 'snapmirror-label' of one of the rules from the corresponding SnapMirror policy associated to the SnapMirror relationship. All matching Snapshot copies are incrementally transferred to the destination volume. For vault relationships, the snapmirror-update API also manages expiration of Snapshot copies on the destination volume. It does so by deleting Snapshot copies that have exceeded the value of 'keep' for the matching rule from the corresponding SnapMirror policy associated with the SnapMirror relationship. Snapshot copies that match the same 'snapmirror-label' will be deleted in oldest-first order. For data protection relationships, the parameter 'source-snapshot' is optional and allows for the transfer of Snapshot copies newer than the common Snapshot copy up to the specified 'source-snapshot'. For vault relationships, the parameter 'source-snapshot' is optional and allows transfer of a Snapshot copy that is older than the common Snapshot copy and/or may not be selected for transfer based on policy-based selection of a scheduled update transfer. After the snapmirror-update API successfully completes, the last Snapshot copy transferred is made the new exported Snapshot copy on the destination volume. If an update to a vault relationship specifies a Snapshot copy using the 'source-snapshot' parameter that is older than the common snapshot, after the snapmirror-update API successfully completes, the exported Snapshot copy on the destination volume will remain unchanged. If the snapmirror-update does not finish successfully, due to a network failure or because a snapmirror-abort API was issued for example, a restart checkpoint might be recorded on the destination volume. If a restart checkpoint is recorded, the next update restarts and continues the transfer from the restart checkpoint. For vault relationships, the next update will restart and continue the old transfer regardless of whether it is a matching Snapshot copy or not. On Data ONTAP 8.1 operating in Cluster-Mode, you can use the snapmirror-update API to update a specific load-sharing mirror that lags behind up-to-date destination volumes in the set of load-sharing mirrors. An update to the lagging load-sharing mirror should bring it up to date with the other up-to-date destination volumes in the set of load-sharing mirrors. Note: You might have to run the snapmirror-update API more than once if the command does not finish before the next scheduled update of the set of load-sharing mirrors.

> Input Name | Range | Type | Description
> destination-cluster |  | string optional | Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. On Data ONTAP 7-Mode, if the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist. This parameter is mandatory on Data ONTAP 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the destination volume. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
> max-transfer-rate |  | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP operating in Cluster-Mode, the max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the following formats: <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers. This format may change in the future. On Data ONTAP Cluster-Mode when specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. On Data ONTAP 7-Mode, If the source-location is not specified, then the source in /etc/snapmirror.conf for the destination path is used.
> source-snapshot |  | string optional | Specifies the Snapshot copy on the source to use as the basis for the update. It is used for updates to Data ONTAP 7-mode qtree relationships and Data ONTAP Cluster-Mode relationships. For a qtree relationship, Data ONTAP 7-mode does not create a new Snapshot copy and transfers the specified Snapshot copy instead. For data protection mirror relationships, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred. For vault relationships, Data ONTAP Cluster-Mode transfers the specified Snapshot copy instead of the ones that match its policy's rules.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: The name of the source volume. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
> transfer-priority |  | string optional | Specifies the priority at which the transfer runs. Possible values are: "normal", and "low". The default value is the value specified in the snapmirror policy which is associated with the relationship. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
> result-error-message |  | string optional | Error description, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job. This parameter is only returned by Data ONTAP 8.1 operating in Cluster-Mode.
> result-status |  | string optional | The operation status. Possible values: "succeeded", "in_progress", "failed". This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> ESOURCE_IS_DIFFERENT |  |
> EDEST_ISNOT_LOCAL_VOLUME |  |
> EDEST_IS_LS_VOLUME |  |
> EOP_FROM_NONMGR_VSERVER |  |
> ESOURCE_DEST_SAME |  |
> ETRIES_COUNT_IS_ZERO |  |
> ERELATION_IS_QUIESCED |  |
> EDEST_VOL_LOCKED |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> ETRANSFER_IN_PROGRESS |  |

> License
> replicate

snapmirror-update-iter | [top]

> The snapmirror-update-iter API updates the destination volumes of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of snapmirror objects to be operated in this call. Default: 20
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
> query |  | snapmirror-info | If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> source-snapshot |  | string optional | Source Snapshot
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | snapmirror-update-iter-info[] optional | Information about snapmirror objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
> success-list |  | snapmirror-update-iter-info[] optional | The snapmirror objects that were successfully processed or scheduled to be processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

snapmirror-update-ls-set | [top]

> The snapmirror-update-ls-set API updates destination volumes of the set of load-sharing mirrors. The API makes destination volumes, in the group of load-sharing mirrors, up-to-date mirrors of the source volume. You must specify the source endpoint when using snapmirror-update-ls-set. Separate SnapMirror transfers are performed from the source volume to each of the up-to-date destination volumes in the set of load-sharing mirrors. Load-sharing mirrors that lag behind the up-to-date destination volumes might not be updated by the snapmirror-update-ls-set API. Use the snapmirror-update API to update a lagging load-sharing mirror. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> source-cluster |  | string optional | Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter. This parameter is supported only in cluster context.
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship. When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
> source-volume |  | string optional | Specifies the source volume of the SnapMirror relationship. The source cluster and source Vserver must also be specified if using this parameter.
> source-vserver |  | string optional | Specifies the source Vserver of the SnapMirror relationship. The source cluster and source volume must also be specified if using this parameter.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EAPIPRIVILEGE |  |
> EAPIMISSINGARGUMENT |  |
> ESOURCE_ISNOT_LOCAL_VOLUME |  |
> ESOURCE_IS_EXISTING_DEST_VOLUME |  |
> ETRIES_COUNT_IS_ZERO |  |
> ERELATION_IS_QUIESCED |  |
> EVSERVER_OP_NOT_ALLOWED |  |

Element definition: sm-policy | [top]

> SnapMirror Policy

> [none]

Element definition: sm-transfer-priority-enum | [top]

> low|normal Possible values: "low" , "normal"

> [none]

Element definition: snapmirror-abort-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-break-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-check-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.
> status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

Element definition: snapmirror-destination-info | [top]

> Information about a Destination of a SnapMirror Relationship Source When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The destination endpoint can be specified using the location format above, or by specifying the parameters for the name of the destination Vserver and the name of the destination volume. Attributes: key, non-creatable, non-modifiable
> destination-volume |  | string optional | Specifies the name of destination volume for the SnapMirror relationshp. The name of the destination Vserver must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the relationship. The name of the destination volume must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> is-constituent |  | boolean optional | Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. Attributes: non-creatable, non-modifiable
> progress-last-updated | [0..2^31-1] | integer optional | Specifies the timestamp indicating when the progress of the ongoing transfer was last updated. Attributes: non-creatable, non-modifiable
> relationship-id |  | string optional | Specifies the SnapMirror relationship ID. Attributes: key, non-creatable, non-modifiable
> relationship-status |  | string optional | Specifies the SnapMirror relationship status. This parameter is present only if at least one transfer has been performed since the node hosting the source volume joined the quorum. Possible values are: 'idle', 'transferring' Attributes: non-creatable, non-modifiable
> relationship-type |  | string optional | Specifies the SnapMirror relationship type. Attributes: non-creatable, non-modifiable Possible values: "data_protection" , "load_sharing" , "vault" , "restore" , "transition_data_protection"
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The source endpoint can be specified using the location format above, or by specifying the parameters for the name of the source Vserver and the name of the source volume. Attributes: key, non-creatable, non-modifiable
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. The name of the source Vserver must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> source-volume-node |  | string optional | Node which owns the source volume of the relationship. Attributes: non-creatable, non-modifiable
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. The name of the source volume must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> transfer-progress | [0..2^63-1] | integer optional | Specifies the number of bytes processed so far for the ongoing transfer. Attributes: non-creatable, non-modifiable

Element definition: snapmirror-destroy-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-info | [top]

> Information about the SnapMirror Relationship. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> current-max-transfer-rate | [0..2^32-1] | integer optional | The upper bound in kilobytes per second, at which data is transferred for the current transfer. This value can be the same as the 'max-transfer-rate' or different if overwritten when starting the transfer via the associated commands or APIs (snapmirror-initialize, snapmirror-update, snapmirror-resync, snapmirror-restore). This parameter is only valid when a transfer is in progress. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> current-transfer-error |  | string optional | A message describing the last retryable error encountered by the current transfer. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> current-transfer-priority |  | string optional | Priority assigned to the ongoing transfer. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if a transfer is in progress. Attributes: non-creatable, non-modifiable Possible values: "low" , "normal"
> current-transfer-type |  | string optional | The type of transfer taking place. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable Possible values: "initialize" , "update" , "resync" , "restore" , "check"
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode. Attributes: key, optional-for-create, non-modifiable
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> destination-volume-node |  | string optional | Node which owns the destination volume of the relationship. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> exported-snapshot |  | string optional | The name of the exported Snapshot copy on the destination volume. Attributes: non-creatable, non-modifiable
> exported-snapshot-timestamp | [0..2^31-1] | integer optional | The timestamp of the exported Snapshot copy on the destination volume, in seconds since Jan 1, 1970. Attributes: non-creatable, non-modifiable
> is-constituent |  | boolean optional | Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. Attributes: non-creatable, non-modifiable
> is-healthy |  | boolean optional | False if the last manual or scheduled update failed or was aborted, or if the last scheduled update was delayed. Otherwise true. Attributes: non-creatable, non-modifiable
> lag-time | [0..2^32-1] | integer optional | The amount of time in seconds by which the data on the mirror lags behind the source. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> last-transfer-duration | [0..2^32-1] | integer optional | The amount of time in seconds it took for the last transfer to complete. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was successful. Attributes: non-creatable, non-modifiable
> last-transfer-end-timestamp | [0..2^31-1] | integer optional | The Timestamp of the end of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> last-transfer-error |  | string optional | A message describing the cause of the last transfer failure. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode, if the relationship control plane is 'v2', and if the last transfer was unsuccessful. Attributes: non-creatable, non-modifiable
> last-transfer-error-codes | [0..2^32-1] | integer[] optional | List of codes providing additional information on the cause and context of the last transfer failure. These are Data ONTAP internal codes, not API errnos. This parameter is reserved for use only by vendor provided management tools, and is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was unsuccessful. Attributes: non-creatable, non-modifiable
> last-transfer-from |  | string optional | The source endpoint of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> last-transfer-size | [0..2^63-1] | integer optional | The total number of bytes transferred as part of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was successful. Attributes: non-creatable, non-modifiable
> last-transfer-type |  | string optional | The type of the previous transfer for the relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable Possible values: "initialize" , "update" , "resync" , "restore" , "check"
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster. Attributes: optional-for-create, modifiable
> mirror-state |  | string optional | Specifies the mirror state of the SnapMirror relationship. Possible values are: 'uninitialized' - Destination volume has not been initialized, 'snapmirrored' - Destination volume has been initialized and is ready to receive SnapMirror updates, 'broken-off' - Destination volume is RW and snapshots are present. Attributes: non-creatable, non-modifiable
> newest-snapshot |  | string optional | The name of the newest Snapshot copy on the destination volume. Attributes: non-creatable, non-modifiable
> newest-snapshot-timestamp | [0..2^31-1] | integer optional | The timestamp of the newest Snapshot copy on the destination volume, in seconds since Jan 1, 1970. Attributes: non-creatable, non-modifiable
> policy |  | string optional | Specifies the name of the snapmirror policy for the relationship. For SnapMirror relationships of type 'vault', the policy will also have rules to select snapshot copies that must be transferred. If no policy is specified, a default policy will be applied depending on the type of the SnapMirror relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: optional-for-create, modifiable
> progress-last-updated | [0..2^31-1] | integer optional | A timestamp indicating when the progress of the transfer was last updated. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if a transfer is in progress. Attributes: non-creatable, non-modifiable
> relationship-control-plane |  | string optional | The type of the control plane used for the relationship. Possible values are: 'v1' - Data ONTAP 8.1 compatible control plane. The endpoint location format [<cluster>:][//<vserver>/]<volume> must be used. Long operations such as initialize, update and resync will spawn a job, and return a job id. The job API must be used to track the progress of the operations. 'v2' - Data ONTAP 8.2 and later compatible control plane. The endpoint location format [<vserver>:]<volume> should be used. Long operations such as initialize, update, and resync do not spawn a job and do not return a job id. The snapmirror-get API must be used to track the progress of these operations. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode.' Attributes: non-creatable, non-modifiable
> relationship-id |  | string optional | A unique identifier assigned to the SnapMirror relationship when it is created. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> relationship-progress | [0..2^63-1] | integer optional | The total number of bytes that have been processed so far for the current activity of the relationship as returned in the relationship-status. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
> relationship-status |  | string optional | Specifies the status of the SnapMirror relationship. Possible values are: 'idle' - Transfers are enabled, and no transfer is in progress, 'transferring' - SnapMirror transfers are enabled and a transfer is in progress, 'checking'- The destination volume is undergoing a diagnostic check and no transfer is in progress. Only applicable for SnapMirror relationships with the relationship-control-plane field set to 'v1', 'quiescing' - A SnapMirror transfer is in progress, additional transfers are disabled, 'quiesced' - SnapMirror transfers are disabled, no transfer is in progress, 'queued' - SnapMirror transfers are enabled, and a transfer operation has been accepted and queued in the system, 'preparing' - SnapMirror transfers are enabled, currently in the pre-transfer phase for Vault incremental transfers, 'finalizing' - SnapMirror transfers are enabled, currently in the post-transfer phase for vault incremental transfers, 'aborting' - SnapMirror transfers are enabled, however a transfer abort operation that may include removal of the checkpoint is underway. Attributes: non-creatable, non-modifiable
> relationship-type |  | string optional | Specifies the type of the SnapMirror relationship. Attributes: optional-for-create, non-modifiable Possible values: "data_protection" , "load_sharing" , "vault" , "restore" , "transition_data_protection"
> schedule |  | string optional | Specifies the name of the cron schedule, which is used to update the SnapMirror relationship. Attributes: optional-for-create, modifiable
> snapshot-checkpoint | [0..2^63-1] | integer optional | The number of bytes transferred as recorded for the checkpoint of the current or most recent transfer snapshot. Attributes: non-creatable, non-modifiable
> snapshot-progress | [0..2^63-1] | integer optional | The number of bytes transferred for the transfer snapshot. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode. Attributes: key, optional-for-create, non-modifiable
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> transfer-snapshot |  | string optional | The name of the current snapshot copy being transferred. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored. Attributes: optional-for-create, modifiable
> unhealthy-reason |  | string optional | The reason the relationship is not healthy. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option and should not be used for queries. The destination-vserver parameter should be used to select the Vserver in a cluster context. Attributes: optional-for-create, modifiable

Element definition: snapmirror-initialize-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.
> status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

Element definition: snapmirror-modify-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-promote-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-quiesce-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-release-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-destination-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-resume-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.

Element definition: snapmirror-resync-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.
> status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

Element definition: snapmirror-update-iter-info | [top]

> Information about the operation that was attempted/performed against snapmirror object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> snapmirror-key |  | snapmirror-info | The keys for the snapmirror object to which the operation applies.
> status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

Element definition: snapshot-id | [top]

> Snapshot Id

> [none]

Element definition: snapshot-owner-name | [top]

> Snapshot Copy Owner Name

> [none]

Element definition: volume-name | [top]

> The name of the volume. Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name. Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'. For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

> [none]

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]

Element definition: snapmirror-destination-info | [top]

> Information about a Destination of a SnapMirror Relationship Source When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The destination endpoint can be specified using the location format above, or by specifying the parameters for the name of the destination Vserver and the name of the destination volume. Attributes: key, non-creatable, non-modifiable
> destination-volume |  | string optional | Specifies the name of destination volume for the SnapMirror relationshp. The name of the destination Vserver must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the relationship. The name of the destination volume must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> is-constituent |  | boolean optional | Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. Attributes: non-creatable, non-modifiable
> progress-last-updated | [0..2^31-1] | integer optional | Specifies the timestamp indicating when the progress of the ongoing transfer was last updated. Attributes: non-creatable, non-modifiable
> relationship-id |  | string optional | Specifies the SnapMirror relationship ID. Attributes: key, non-creatable, non-modifiable
> relationship-status |  | string optional | Specifies the SnapMirror relationship status. This parameter is present only if at least one transfer has been performed since the node hosting the source volume joined the quorum. Possible values are: 'idle', 'transferring' Attributes: non-creatable, non-modifiable
> relationship-type |  | string optional | Specifies the SnapMirror relationship type. Attributes: non-creatable, non-modifiable Possible values: "data_protection" , "load_sharing" , "vault" , "restore" , "transition_data_protection"
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The source endpoint can be specified using the location format above, or by specifying the parameters for the name of the source Vserver and the name of the source volume. Attributes: key, non-creatable, non-modifiable
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. The name of the source Vserver must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> source-volume-node |  | string optional | Node which owns the source volume of the relationship. Attributes: non-creatable, non-modifiable
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. The name of the source volume must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
> transfer-progress | [0..2^63-1] | integer optional | Specifies the number of bytes processed so far for the ongoing transfer. Attributes: non-creatable, non-modifiable

Element definition: snapmirror-info | [top]

> Information about the SnapMirror Relationship. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> current-max-transfer-rate | [0..2^32-1] | integer optional | The upper bound in kilobytes per second, at which data is transferred for the current transfer. This value can be the same as the 'max-transfer-rate' or different if overwritten when starting the transfer via the associated commands or APIs (snapmirror-initialize, snapmirror-update, snapmirror-resync, snapmirror-restore). This parameter is only valid when a transfer is in progress. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> current-transfer-error |  | string optional | A message describing the last retryable error encountered by the current transfer. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> current-transfer-priority |  | string optional | Priority assigned to the ongoing transfer. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if a transfer is in progress. Attributes: non-creatable, non-modifiable Possible values: "low" , "normal"
> current-transfer-type |  | string optional | The type of transfer taking place. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable Possible values: "initialize" , "update" , "resync" , "restore" , "check"
> destination-cluster |  | string optional | Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode. Attributes: key, optional-for-create, non-modifiable
> destination-volume |  | string optional | Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the destination Vserver. The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> destination-volume-node |  | string optional | Node which owns the destination volume of the relationship. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> destination-vserver |  | string optional | Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of destination volume. The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> exported-snapshot |  | string optional | The name of the exported Snapshot copy on the destination volume. Attributes: non-creatable, non-modifiable
> exported-snapshot-timestamp | [0..2^31-1] | integer optional | The timestamp of the exported Snapshot copy on the destination volume, in seconds since Jan 1, 1970. Attributes: non-creatable, non-modifiable
> is-constituent |  | boolean optional | Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. Attributes: non-creatable, non-modifiable
> is-healthy |  | boolean optional | False if the last manual or scheduled update failed or was aborted, or if the last scheduled update was delayed. Otherwise true. Attributes: non-creatable, non-modifiable
> lag-time | [0..2^32-1] | integer optional | The amount of time in seconds by which the data on the mirror lags behind the source. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> last-transfer-duration | [0..2^32-1] | integer optional | The amount of time in seconds it took for the last transfer to complete. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was successful. Attributes: non-creatable, non-modifiable
> last-transfer-end-timestamp | [0..2^31-1] | integer optional | The Timestamp of the end of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> last-transfer-error |  | string optional | A message describing the cause of the last transfer failure. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode, if the relationship control plane is 'v2', and if the last transfer was unsuccessful. Attributes: non-creatable, non-modifiable
> last-transfer-error-codes | [0..2^32-1] | integer[] optional | List of codes providing additional information on the cause and context of the last transfer failure. These are Data ONTAP internal codes, not API errnos. This parameter is reserved for use only by vendor provided management tools, and is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was unsuccessful. Attributes: non-creatable, non-modifiable
> last-transfer-from |  | string optional | The source endpoint of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> last-transfer-size | [0..2^63-1] | integer optional | The total number of bytes transferred as part of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was successful. Attributes: non-creatable, non-modifiable
> last-transfer-type |  | string optional | The type of the previous transfer for the relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable Possible values: "initialize" , "update" , "resync" , "restore" , "check"
> max-transfer-rate | [0..2^32-1] | integer optional | Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster. Attributes: optional-for-create, modifiable
> mirror-state |  | string optional | Specifies the mirror state of the SnapMirror relationship. Possible values are: 'uninitialized' - Destination volume has not been initialized, 'snapmirrored' - Destination volume has been initialized and is ready to receive SnapMirror updates, 'broken-off' - Destination volume is RW and snapshots are present. Attributes: non-creatable, non-modifiable
> newest-snapshot |  | string optional | The name of the newest Snapshot copy on the destination volume. Attributes: non-creatable, non-modifiable
> newest-snapshot-timestamp | [0..2^31-1] | integer optional | The timestamp of the newest Snapshot copy on the destination volume, in seconds since Jan 1, 1970. Attributes: non-creatable, non-modifiable
> policy |  | string optional | Specifies the name of the snapmirror policy for the relationship. For SnapMirror relationships of type 'vault', the policy will also have rules to select snapshot copies that must be transferred. If no policy is specified, a default policy will be applied depending on the type of the SnapMirror relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: optional-for-create, modifiable
> progress-last-updated | [0..2^31-1] | integer optional | A timestamp indicating when the progress of the transfer was last updated. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if a transfer is in progress. Attributes: non-creatable, non-modifiable
> relationship-control-plane |  | string optional | The type of the control plane used for the relationship. Possible values are: 'v1' - Data ONTAP 8.1 compatible control plane. The endpoint location format [<cluster>:][//<vserver>/]<volume> must be used. Long operations such as initialize, update and resync will spawn a job, and return a job id. The job API must be used to track the progress of the operations. 'v2' - Data ONTAP 8.2 and later compatible control plane. The endpoint location format [<vserver>:]<volume> should be used. Long operations such as initialize, update, and resync do not spawn a job and do not return a job id. The snapmirror-get API must be used to track the progress of these operations. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode.' Attributes: non-creatable, non-modifiable
> relationship-id |  | string optional | A unique identifier assigned to the SnapMirror relationship when it is created. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> relationship-progress | [0..2^63-1] | integer optional | The total number of bytes that have been processed so far for the current activity of the relationship as returned in the relationship-status. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
> relationship-status |  | string optional | Specifies the status of the SnapMirror relationship. Possible values are: 'idle' - Transfers are enabled, and no transfer is in progress, 'transferring' - SnapMirror transfers are enabled and a transfer is in progress, 'checking'- The destination volume is undergoing a diagnostic check and no transfer is in progress. Only applicable for SnapMirror relationships with the relationship-control-plane field set to 'v1', 'quiescing' - A SnapMirror transfer is in progress, additional transfers are disabled, 'quiesced' - SnapMirror transfers are disabled, no transfer is in progress, 'queued' - SnapMirror transfers are enabled, and a transfer operation has been accepted and queued in the system, 'preparing' - SnapMirror transfers are enabled, currently in the pre-transfer phase for Vault incremental transfers, 'finalizing' - SnapMirror transfers are enabled, currently in the post-transfer phase for vault incremental transfers, 'aborting' - SnapMirror transfers are enabled, however a transfer abort operation that may include removal of the checkpoint is underway. Attributes: non-creatable, non-modifiable
> relationship-type |  | string optional | Specifies the type of the SnapMirror relationship. Attributes: optional-for-create, non-modifiable Possible values: "data_protection" , "load_sharing" , "vault" , "restore" , "transition_data_protection"
> schedule |  | string optional | Specifies the name of the cron schedule, which is used to update the SnapMirror relationship. Attributes: optional-for-create, modifiable
> snapshot-checkpoint | [0..2^63-1] | integer optional | The number of bytes transferred as recorded for the checkpoint of the current or most recent transfer snapshot. Attributes: non-creatable, non-modifiable
> snapshot-progress | [0..2^63-1] | integer optional | The number of bytes transferred for the transfer snapshot. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
> source-cluster |  | string optional | Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: Data ONTAP 8.1 operating in Cluster-Mode. Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in one of the following formats: <system>:/vol/<volume>[/<qtree>] on Data ONTAP operating in 7-Mode. [<cluster>:]//<vserver>/<volume> on Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. <[vserver:]volume> on Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on Vserver peering setup between the source and destination Vservers. This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode. Attributes: key, optional-for-create, non-modifiable
> source-volume |  | string optional | Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of the source Vserver. The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> source-vserver |  | string optional | Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: The name of source volume. The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. Attributes: key, optional-for-create, non-modifiable
> transfer-snapshot |  | string optional | The name of the current snapshot copy being transferred. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored. Attributes: optional-for-create, modifiable
> unhealthy-reason |  | string optional | The reason the relationship is not healthy. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option and should not be used for queries. The destination-vserver parameter should be used to select the Vserver in a cluster context. Attributes: optional-for-create, modifiable