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

snapmirror-abort snapmirror-abort-iter snapmirror-break snapmirror-break-iter snapmirror-check snapmirror-check-iter snapmirror-create snapmirror-destroy snapmirror-destroy-iter snapmirror-get 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-resume snapmirror-resync snapmirror-resync-iter snapmirror-update snapmirror-update-iter snapmirror-update-ls-set | This set of APIs allows to manage SnapMirror relationships on Data ONTAP 7-Mode and and Data ONTAP 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 7-Mode, the endpoint can be a volume or a qtree. On Data ONTAP Cluster-Mode the endpoint can only be a volume. You can specify an endpoint by providing its location in a path format. The format depends on the version of Data ONTAP: On Data ONTAP 7-Mode the format is: <filer>:/vol/<volume>[/<qtree>] where 'filer' is the name of the filer; 'volume' is the name of the volume, and 'qtree' the name of the qtree. On Data ONTAP Cluster-Mode, the format of the path 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 Cluster-Mode it is also possible to specify the names of the cluster, Vserver, and volume as 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 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 filer on Data ONTAP 7-Mode, and from the destination cluster on Data ONTAP Cluster-Mode.

> 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>]; Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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. This parameter is mandatory on Data ONTAP 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 format: [<cluster>:]//<vserver>/<volume<. This format may change in the future. 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 | 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.
> 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.

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

snapmirror-abort-iter | [top]

> The snapmirror-abort-iter API aborts SnapMirror transfers for one or more SnapMirror relationships.

> 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..100] | 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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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 7-Mode, no check to determined whether the operation is legal or successful is done. 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 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 filer on Data ONTAP 7-Mode, and on the destination cluster on Data ONTAP 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>] Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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 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. The destination cluster and destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 format: [<cluster>:]//<vserver>/<volume>. This format may change in the future. 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.

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

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..100] | 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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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 of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter. This parameter is supported only in cluster context.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 in the format: [cluster:]//vserver/volume. This format may change in the future. 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 when 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.
> 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..100] | 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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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 volume. You can create either a load-sharing relationship or a data protection relationship using this API. You must specify the source endpoint and destination endpoint when using snapmirror-create. Before you can use this command you should have created a source and destination volume using the volume create command. The source volume should be in the online state and a read-write (RW) type. The destination volume should be in the online state and a data protection (DP) 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. You must also take the volume style into consideration when creating SnapMirror relationships. Source and destination volumes might be required to be either both regular volumes or both striped volumes. Striped volumes might have the further restriction of requiring the same striping geometry on both the source and destination volume, and restriping volumes might be disallowed. Load-sharing mirrors have the following restrictions: They only use regular style volumes, no striped volumes. They are confined to a single Vserver; they are not allowed to span Vservers. 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 optional schedule is specified, the destination volume is initialized on the first scheduled update. The destination volume can also be initialized using the snapmirror-initialize API and the destination volumes in a set of load-sharing mirrors are initialized using the snapmirror-initialize-ls-set API. The snapmirror-create API must be used from the destination cluster.

> 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. This parameter is supported only in cluster context.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 mirrors and other SnapMirror relationships confined to a single cluster.
> relationship-type |  | string optional | Specifies the type of SnapMirror relationship. Possible values: "data_protection" , "load_sharing"
> return-record |  | boolean optional | If set to true, returns the snapmirror on successful creation. Default: false
> schedule |  | string optional | Specifies the name of the schedule which is used to update the SnapMirror relationship. Format is: .
> 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 in the format: [cluster:]//vserver/volume. This format may change in the future. 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 when 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.
> tries | [0..2^32-1] | integer 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.
> 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.
> 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 |  |

> License
> SnapMirror_DP

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. The snapmirror-destroy API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. 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. You can use this API from the source or from the destination cluster. When used from the destination cluster, the SnapMirror relationship information on the source and destination clusters is deleted. When used from the source cluster, only the SnapMirror relationship information on the source cluster is deleted.

> 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. This parameter is supported only in cluster context.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 in the format: [cluster:]//vserver/volume. This format may change in the future. 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 when 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.

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

> License
> SnapMirror_DP

snapmirror-destroy-iter | [top]

> Removes 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..100] | 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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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_DP

snapmirror-get | [top]

> Get the attributes of a SnapMirror relationship. You must specify the destination endpoint when using snapmirror-get.

> 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 of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter. This parameter is supported only in cluster context.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 in the format: [cluster:]//vserver/volume. This format may change in the future. 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 when 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
> attributes |  | snapmirror-info | The attributes of the snapmirror.

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

snapmirror-get-iter | [top]

> Iterate over a list of SnapMirror relationships.

> 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..100] | 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..100] | 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 Cluster-Mode, this API is provided for backward compatibility only. It will fail if the volume is the source or destination of a non Data Protection (DP) SnapMirror relationship. On Data ONTAP Cluster-Mode, this API must be issued on the cluster the volume belongs to.

> Input Name | Range | Type | Description
> volume |  | string | Name of the volume to be queried. On Data ONTAP Cluster-Mode, specifies the location of the volume in the format: [<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 Data Protection SnapMirror relationship. false otherwise
> is-source |  | boolean optional | true if it was determined that the volume is a source of a Data Protection SnapMirror relationship. false otherwise
> is-transfer-broken |  | boolean optional | true if it was determined that the volume is a destination of a Data Protection 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 Data Protection 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 filer on Data ONTAP 7-Mode, or from the destination cluster on Data ONTAP Cluster-Mode. 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. On Data ONTAP 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. 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.

> 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>] Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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. The destination cluster and destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> max-transfer-rate | [0..2^32-1] | integer optional | Specified the upper bound, in kilobytes per second, at which data is transferred between clusters on Data ONTAP Cluster-Mode, or between filers on ata ONTAP 7-Mode. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP Cluster-Mode, the max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>]; Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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-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
> 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 |  |

> 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..100] | 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 | Specified 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 mirrors and other SnapMirror relationships 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
> 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-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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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_DP

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

snapmirror-modify | [top]

> The snapmirror-modify API allows you to change 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 snapmirror-modify. 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. The snapmirror-modify API must be used from the destination cluster.

> 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. This parameter is supported only in cluster context.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> max-transfer-rate | [0..2^32-1] | integer optional | Specified 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 mirrors and other SnapMirror relationships confined to a single cluster.
> schedule |  | string optional | Name of the schedule on which the relationship operates.
> 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 in the format: [cluster:]//vserver/volume. This format may change in the future. 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 when 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.
> tries | [0..2^32-1] | integer 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.
> 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 |  |

snapmirror-modify-iter | [top]

> The snapmirror-modify-iter API allows you to change one or more parameters of 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..100] | 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 | Specified 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 mirrors and other SnapMirror relationships 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. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
> schedule |  | string optional | Name of the schedule on which the relationship operates.
> 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 | [0..2^32-1] | integer 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.
> 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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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 of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter. This parameter is supported only in cluster context.
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume.
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 in the format: [cluster:]//vserver/volume. This format may change in the future. 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 when 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.

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

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..100] | 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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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 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 on the destination filer on Data ONTAP 7-Mode, and on the destination cluster on Data ONTAP 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>] Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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. This parameter is mandatory on Data ONTAP 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 format: [<cluster>:]//<vserver>/<volume<. This format may change in the future. 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.

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

> License
> replicate

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 filer on Data ONTAP 7-Mode, and on the destination cluster on Data ONTAP 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>]; Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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. This parameter is mandatory on Data ONTAP 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> 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 format: [<cluster>:]//<vserver>/<volume<. This format may change in the future. 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 when executed
> 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.

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

> License
> replicate

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. 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 snapmirror-resync API operates by finding 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 makes the common Snapshot copy the temporary exported Snapshot copy on the destination volume. The API next 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. The snapmirror-resync API finally makes the newest Snapshot copy on the destination volume the new exported Snapshot copy. The snapmirror-resync API fails if the destination volume does not have a Snapshot copy in common with the source volume. On Data ONTAP Cluster-Mode a job is spawned to operate on the SnapMirror relationship and the job id is returned. The progress of the job can be tracked using the job APIs. On Data ONTAP 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 filer on Data ONTAP 7-Mode, and on the destination cluster on Data ONTAP 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>/<qtree> Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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. This parameter is mandatory on Data ONTAP 7-mode
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> max-transfer-rate |  | integer optional | Specified the upper bound, in kilobytes per second, at which data is transferred between clusters on Data ONTAP Cluster-Mode, or between filers on ata ONTAP 7-Mode. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP Cluster-Mode, the max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>] Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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-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 |  |
> 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 |  |

> License
> replicate

snapmirror-resync-iter | [top]

> The snapmirror-resync-iter API reestablishes one or more previously broken 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..100] | 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 | Specified 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 mirrors and other SnapMirror relationships 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
> 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-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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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_DP

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 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 filer. On Data ONTAP Cluster-Mode a job is spawned to operate on the SnapMirror relationship and the job id is returned. The progress of the job can be tracked using the job APIs. 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 filer on Data ONTAP 7-Mode, or from the destination cluster on Data ONTAP Cluster-Mode. 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. On Data ONTAP Cluster-Mode if the destination volume is empty, the snapmirror-update API performs a baseline transfer, that is, the API transfers all of the Snapshot copies on the source volume to the destination volume. During a baseline transfer, the first Snapshot copy transferred becomes the temporary exported Snapshot copy on the destination volume. The exported Snapshot copy is the view to which clients are redirected on the destination volume while succeeding Snapshot copies are transferred. If the destination volume is not empty, the snapmirror-update API performs an incremental transfer. During an incremental transfer, Data ONTAP takes a Snapshot copy on the source volume to capture the current image of the source volume, finds the most recent common Snapshot copy between the source and destination volumes, and incrementally transfers Snapshot copies that are newer than the common Snapshot copy to the destination volume. After the snapmirror-update API successfully completes, the last Snapshot copy transferred is made the new exported Snapshot copy on the destination volume. 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. On Data ONTAP 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. The snapmirror-update API must be used from the destination cluster.

> 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>] Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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. The destination cluster and destination Vserver must also be specified if using this parameter.
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter.
> max-transfer-rate |  | integer optional | Specified the upper bound, in kilobytes per second, at which data is transferred between clusters on Data ONTAP Cluster-Mode, or between filers on ata ONTAP 7-Mode. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP Cluster-Mode, the max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships 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 format depending on Data ONTAP: 7-Mode:<filer>:/vol/<volume>[/<qtree>] Cluster-Mode: [<cluster>:]//<vserver>/<volume> 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-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_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 |  |

> License
> replicate

snapmirror-update-iter | [top]

> The snapmirror-update-iter API updates the destination volumes 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..100] | 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 | Specified 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 mirrors and other SnapMirror relationships 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
> 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..100] | integer optional | The number of snapmirror objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..100] | 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 |  |

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-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
> 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. This parameter is supported only in cluster context. Attributes: key, optional-for-create, non-modifiable
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. Attributes: key, optional-for-create, non-modifiable
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context. Attributes: key, optional-for-create, non-modifiable
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter. Attributes: key, optional-for-create, non-modifiable
> exported-snapshot |  | string optional | The name of the exported Snapshot copy on the destination volume. Format is: . 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-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
> 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 mirrors and other SnapMirror relationships 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', 'snapmirrored', 'broken-off'. Attributes: non-creatable, non-modifiable
> newest-snapshot |  | string optional | The name of the newest Snapshot copy on the destination volume. Format is: . 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
> 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 activity is in progress. Attributes: non-creatable, non-modifiable
> relationship-status |  | string optional | Specifies the status of the SnapMirror relationship. Possible values are: 'idle', 'transferring', 'checking', 'quiescing', 'quiesced'. Attributes: non-creatable, non-modifiable
> relationship-type |  | string optional | Specifies the type of SnapMirror relationship. Attributes: optional-for-create, non-modifiable Possible values: "data_protection" , "load_sharing"
> schedule |  | string optional | Specifies the name of the schedule which is used to update the SnapMirror relationship. Format is: . 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 activity is in progress. Attributes: non-creatable, non-modifiable
> 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. Attributes: key, optional-for-create, non-modifiable
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. Attributes: key, optional-for-create, non-modifiable
> 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 when executed outside cluster context. Attributes: key, optional-for-create, non-modifiable
> 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. 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 activity is in progress. Format is: . Attributes: non-creatable, non-modifiable
> tries | [0..2^32-1] | integer 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. Attributes: optional-for-create, 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. 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-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: vserver-name | [top]

> The name of the Vserver.

> [none]

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
> 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. This parameter is supported only in cluster context. Attributes: key, optional-for-create, non-modifiable
> destination-location |  | string optional | Specifies the destination endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. Attributes: key, optional-for-create, non-modifiable
> destination-volume |  | string optional | Specifies the destination volume of the SnapMirror relationship. The destination cluster and destination Vserver must also be specified if using this parameter. This parameter may be optional when executed outside cluster context. Attributes: key, optional-for-create, non-modifiable
> destination-vserver |  | string optional | Specifies the destination Vserver of the SnapMirror relationship. The destination cluster and destination volume must also be specified if using this parameter. Attributes: key, optional-for-create, non-modifiable
> exported-snapshot |  | string optional | The name of the exported Snapshot copy on the destination volume. Format is: . 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-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
> 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 mirrors and other SnapMirror relationships 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', 'snapmirrored', 'broken-off'. Attributes: non-creatable, non-modifiable
> newest-snapshot |  | string optional | The name of the newest Snapshot copy on the destination volume. Format is: . 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
> 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 activity is in progress. Attributes: non-creatable, non-modifiable
> relationship-status |  | string optional | Specifies the status of the SnapMirror relationship. Possible values are: 'idle', 'transferring', 'checking', 'quiescing', 'quiesced'. Attributes: non-creatable, non-modifiable
> relationship-type |  | string optional | Specifies the type of SnapMirror relationship. Attributes: optional-for-create, non-modifiable Possible values: "data_protection" , "load_sharing"
> schedule |  | string optional | Specifies the name of the schedule which is used to update the SnapMirror relationship. Format is: . 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 activity is in progress. Attributes: non-creatable, non-modifiable
> 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. Attributes: key, optional-for-create, non-modifiable
> source-location |  | string optional | Specifies the source endpoint of the SnapMirror relationship in the format: [cluster:]//vserver/volume. This format may change in the future. When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. Attributes: key, optional-for-create, non-modifiable
> 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 when executed outside cluster context. Attributes: key, optional-for-create, non-modifiable
> 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. 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 activity is in progress. Format is: . Attributes: non-creatable, non-modifiable
> tries | [0..2^32-1] | integer 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. Attributes: optional-for-create, 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. Attributes: optional-for-create, modifiable