APIs in Category: snapmirror
 7-Mode API version 1.15

 
snapmirror-abort
snapmirror-break
snapmirror-delete-connection
snapmirror-delete-schedule
snapmirror-delete-sync-schedule
snapmirror-get-status
snapmirror-get-volume-status
snapmirror-initialize
snapmirror-list-connections
snapmirror-list-destinations
snapmirror-list-schedule
snapmirror-list-sync-schedule
snapmirror-off
snapmirror-on
snapmirror-quiesce
snapmirror-release
snapmirror-resume
snapmirror-resync
snapmirror-set-connection
snapmirror-set-schedule
snapmirror-set-sync-schedule
snapmirror-throttle
snapmirror-update
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
clear-checkpoint boolean
optional
If true, the restart checkpoint is cleared. The default is false, not cleared.
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
 Errno  Description
 ESNAPMIRRORERR
 EOBJECTNOTFOUND
 EINTERNALERROR
 EAPIPRIVILEGE
 EAPIMISSINGARGUMENT
 ESOURCE_IS_DIFFERENT
 EDEST_ISNOT_LS_VOLUME
 EANOTHER_OP_ACTIVE
 ENOTRANSFER_IN_PROGRESS
 Vfiler-enabled
 Yes

 
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-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
 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
 Vfiler-enabled
 Yes

 
snapmirror-delete-connection [top]
Deletes a connection specified by connection. This API must be executed on the destination filer. Currently, the connections are in: /etc/snapmirror.conf.
Input Name Range Type Description
connection string
Connection name to delete. The name is in ASCII and must begin with an alpha characater.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-delete-schedule [top]
Delete the schedule for a given destination. This API must be executed on the destination filer.
Input Name Range Type Description
destination-location string
The destination location of a schedule to delete. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-delete-sync-schedule [top]
Delete a synchronous schedule for a given destination. This API must be executed on the destination filer.
Input Name Range Type Description
destination-location string
The destination location of a schedule to delete. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-get-status [top]
Return the SnapMirror status. This API can be issued on either the source or destination filer.
Input Name Range Type Description
location string
optional
The source location or destination location of the SnapMirror pair. Possible types are volume or qtree only. If this input is provided, only the SnapMirror relationships with a matching source or destination will be reported. The argument is invalid if the named location doesn't exist. In this case, snapmirror-status-info output will not be present. The argument can also be invalid if it is a flexclone name. (Be aware that the snapmirror-list-destinations API can return flexclone names.) Then snapmirror-get-status API will return a snapmirror-status output value with a "state" of "unknown". If the argument is not specified, all source, destination SnapMirror pairs are returned.
 
Output Name Range Type Description
is-available boolean
True if SnapMirror is available.
snapmirror-status snapmirror-status-info[]
optional
An array of SnapMirror pair status. If there are no transfers or schedules, then snapmirror-status is not returned. Any and all pairs whose source or destination location matches the input location will be in the output.
 Vfiler-enabled
 Yes

 
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
 Vfiler-enabled
 Yes
 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-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-snapshot string
optional
Creates the specified snapshot (in addition to the regular SnapMirror snapshot) on the destination after the qtree SnapMirror transfer is over.
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-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-snapshot string
optional
Designates which source snapshot to use for a qtree update. The default creates new snapshot on the source for the transfer.
 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
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-list-connections [top]
Returns connection information for a given connection or all connections. The API must be executed on the destination filer. Currently, the connections are in: /etc/snapmirror.conf.
Input Name Range Type Description
connection string
optional
Connection name of the connection information to obtain. If the connections is not specified, then the connection information for all the connections is returned.
 
Output Name Range Type Description
snapmirror-connections snapmirror-connection-info[]
An array of SnapMirror connection information.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-list-destinations [top]
Returns a list of destination locations and information about SnapMirror relationships for given source locations, which can be a volume name or qtree path. This API must be issued on the source filer.
Input Name Range Type Description
source-location string
optional
Source location of the SnapMirror pair. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. If the source-location is not specified, then all source, destination SnapMirror pairs are returned.
 
Output Name Range Type Description
destinations destination-info[]
A list of currently-known destinations on a source filer.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-list-schedule [top]
Returns the schedule for a given destination or all destinations. The API must be executed on the destination filer. Currently, the schedules is in /etc/snapmirror.conf.
Input Name Range Type Description
destination-location string
optional
The destination location of a schedule to obtain. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. The <filer> must match the destination filer. If the destination-location is not specified, then all the destination schedules are returned.
 
Output Name Range Type Description
snapmirror-schedules snapmirror-schedule-info[]
An array of SnapMirror schedule.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-list-sync-schedule [top]
Returns a synchronous schedule for a given destination or all destinations. The API must be executed on the destination filer. Currently, the schedules is in /etc/snapmirror.conf.
Input Name Range Type Description
destination-location string
optional
The destination location of a schedule to obtain. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. The <filer> must match the destination filer. If the destination-location is not specified, then all the destination schedules are returned.
 
Output Name Range Type Description
snapmirror-sync-schedules snapmirror-sync-schedule-info[]
An array of SnapMirror schedule.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-off [top]
Disables SnapMirror data transfers and turns off the SnapMirror scheduler. Check the SnapMirror status with the snapmirror-get-status API for results.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-on [top]
Enables SnapMirror data transfers and turns on the SnapMirror scheduler. Check the SnapMirror status with the snapmirror-get-status API for results.
 Vfiler-enabled
 Yes
 License
 replicate

 
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-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
 Errno  Description
 EOBJECTNOTFOUND
 EINTERNALERROR
 EAPIPRIVILEGE
 EAPIMISSINGARGUMENT
 EDEST_ISNOT_LOCAL_VOLUME
 ESOURCE_DEST_SAME
 ESOURCE_IS_DIFFERENT
 EOP_FROM_NONMGR_VSERVER
 EANOTHER_OP_ACTIVE
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-release [top]
Informs SnapMirror that a direct mirror is no longer going to make requests. The API must be issued on the source filer.
Input Name Range Type Description
destination-location string
Destination location of the snapmirrored pair to release. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
source-location string
Source location of the SnapMirror pair to release. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
 Errno  Description
 ESNAPMIRRORERR
 Vfiler-enabled
 Yes

 
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-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
 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
 Vfiler-enabled
 Yes
 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-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-snapshot string
optional
Creates the specified snapshot (in addition to the regular SnapMirror snapshot) on the destination after the qtree SnapMirror transfer is over.
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-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-snapshot string
optional
Designates which source snapshot to use for a qtree update. If source-snapshot is not specfied, a new snapshot will be created.
 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
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-set-connection [top]
Sets up a connection. snapmirror-set-connection will add a new connection or modify an existing one. This API must be executed on the destination filer. Currently, the connections are in: /etc/snapmirror.conf.
Input Name Range Type Description
address-pair1 address-pair
The connection's first source and destination address pair. In multi mode, the first address pair provides a connection path; while in failover mode, the first address pair provides the prefer connection path.
address-pair2 address-pair
optional
The connection's second source and destination address pair. In multi mode the second address pair provides another connection path, while in failover mode, the second address pair provides a connection path in case the first path fails.
connection string
Name of the connection to add or modify. The name is in ASCII and must begin with an alpha character.
mode string
optional
Possible mode values are "multi" or "failover". If not specified, the default is "multi".
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-set-schedule [top]
Sets the schedule for a given destination. The API must be executed on the destination filer. Currently, the schedule is in /etc/snapmirror.conf.
Input Name Range Type Description
connection-mode string
optional
This option specifies the mode to be used for establising connection between source and destination. If this option is set to "inet6", connections between source and destination will be established using IPv6 addresses only. If there are no IPv6 addressess configured, then the connection will fail. If the option is set to "inet", connections between source and destination will be established using IPv4 addresses only. If there are no IPv4 addresses configured, then the connection will fail. When this option is not specified, Connection will be tried using both "inet6" and "inet". "inet6" will have higher precedence than "inet". If connection request using "inet6" fails, SnapMirror will retry the connection using "inet". This argument is not effective when an IP address is specified instead of source hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.
days-of-month string
Minutes in the hour for which the schedule is set. The form is crontab-like, with possible values of:
  • - := match nothing;
  • 1 := match day 1;
  • 1,3 := match day 1 and 3;
  • 2-5 := match day 2,3,4,5;
  • 1-30/7 := match day 1,8,15,22,29;
  • * := matches all possible legal values;
days-of-week string
Days in the week for which the schedule is set. 0 represents Sunday, and 6 represents Saturday. The form is crontab-like, with possible values of:
  • - := match nothing;
  • 1 := match day 1 (Mon);
  • 1,3 := match day 1 and 3 (Mon and Wed);
  • 2-5 := match day 2,3,4,5 (Tue,Wed,Thu,Fri);
  • * := matches all possible legal values;
destination-location string
The destination location of a schedule to set. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
hours string
Hours in the day for which the schedule is set. The form is crontab-like, with possible values of:
  • - := match nothing;
  • 1 := match hour 1;
  • 1,3 := match hour 1 and 3;
  • 2-5 := match hour 2,3,4,5;
  • 1-24/3 := match hour 1,4,7,10,13,16,19,22;
  • * := matches all possible legal values;
max-transfer-rate integer
optional
Maximum transfer rate in kilobytes per second. The default is as fast as the filer can transfer.
minutes string
Minutes in the hour for which the schedule is set. The form is crontab-like, with possible values of:
  • - := match nothing;
  • 1 := match minute 1;
  • 1,3 := match minute 1 and 3;
  • 2-5 := match minute 2,3,4,5;
  • 1-12/3 := match minute 1,4,7,10;
  • 0-55/5 := match minute 0,5,10,15,20,25,30,35,40,45,50,55;
  • * := matches all possible legal values;
restart string
optional
restart mode when transfer is interrupted. Possible values are "always", "never" and "restart". If value is set to "always", then an interrupted transfer will always restart, if it has a restart check point and the conditions are the same as before the transfer was interrupted. If value is set to "never", then an interrupted transfer will never restart, even if it has a restart checkpoint. If "restart" option is not specified,then it is set to "default" value; where snapmirror behaves like the "always" case, unless it has passed the next scheduled transfer time, in which case it will begin that scheduled transfer instead of restarting.
source-location string
The source location of a schedule to set. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
 Vfiler-enabled
 Yes
 License
 replicate

 
snapmirror-set-sync-schedule [top]
Establishes a synchronous or semi-synchronous schedule. Currently, the schedules are in: /etc/snapmirror.conf. Semi-synchronous mode is determined by specifing semi-sync.
Input Name Range Type Description
connection-mode string
optional
This option specifies the mode to be used for establising connection between source and destination. If this option is set to "inet6", connections between source and destination will be established using IPv6 addresses only. If there are no IPv6 addressess configured, then the connection will fail. If the option is set to "inet", connections between source and destination will be established using IPv4 addresses only. If there are no IPv4 addresses configured, then the connection will fail. When this option is not specified, Connection will be tried using both "inet6" and "inet". "inet6" will have higher precedence than "inet". If connection request using "inet6" fails, SnapMirror will retry the connection using "inet". This argument is not effective when an IP address is specified instead of source hostname. If the IP address format and connection-mode do not match, the operation will fail with proper error message.
destination-location string
The destination location of a schedule to set. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
ops-throttle string
optional
The number of outstanding operations allowed before blocking on the source. The format is a number follwed by the one of the following units: "ops", "s", or "ms". If the specified value is less than 10s, the mirror is configured to run in a fully synchronous mode. If the specified value is greater than or equal to 10s, the mirror is configured to run in semi-synchronous mode. This is a deprecated parameter. Use the sync-mode parameter instead to specify the sync mode.
source-location string
The source location of a schedule to set. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
sync-mode string
optional
This specfies whether the mirror should be configured in sync or in semi-sync mode. Possible values are: "full_sync" and "semi_sync". If the user wants to configure the mirror to run in fully synchronous mode, the user must specify "full_sync" as the value for this parameter. If the user wants to configure the mirror to run in semi-synchronous mode, the user must specify "semi_sync" as the value of this parameter. If not specified, the mirror will be configured to run in full synchronous mode. This parameter overrides the deprecated ops-throttle parameter.
visibility-frequency integer
Controls how often the source snapspot will be visible on the destination mirror. This input is used to control the value of visibility_interval in the snapmirror.conf file. The units are in seconds. A typical value to use for this input is 180.
 License
 replicate

 
snapmirror-throttle [top]
Changes the max transfer rate of an active transfer. The API can be issued to either the source or the destination filer.
Input Name Range Type Description
destination-location string
The destination location of the active transfer. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
max-transfer-rate integer
Maximum transfer rate in kilobytes per second. A value '0' disables the throttle, ie. the filer will transfer as fast as it can. Range: 0..2^32-1
 Errno  Description
 ESNAPMIRRORERR
 Vfiler-enabled
 Yes
 License
 replicate

 
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-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-snapshot string
optional
Creates the specified snapshot (in addition to the regular SnapMirror snapshot) on the destination after the qtree SnapMirror transfer is over.
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-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-snapshot string
optional
Designates which source snapshot to use for a qtree update. The default creates new snapshot on the source for the transfer.
 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
 Vfiler-enabled
 Yes
 License
 replicate

 
Element definition: address-pair [top]
Source and destination address pair.
Name Range Type Description
destination-addr string
Destination address in the form of filer name or IP address.
source-addr string
Source address in the form of filer name or IP address.

 
Element definition: destination-info [top]
Source location, destination location, and source snapshot of a snapmirrored pair.
Name Range Type Description
destination-location string
Destination location of the snapmirrored pair. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree> or the clone form: <filer>:<volume>->[clone:<clone_name>].
source-location string
The source location of the snapmirrored pair. The source location is of the volume form: <filer>:<volume>, or it is of the qtree form: <filer>:/vol/<volume>/<qtree>. In versions of ONTAP earlier than 7.0, there was a bug which ommited the filer name, so the volume form is: <volume>, and the qtree form is: /vol/<volume>/<qtree>.
source-snapshot string
The source snapshot.

 
Element definition: snapmirror-connection-info [top]
Information about one connection.
Name Range Type Description
address-pair1 address-pair
The first source and destination address pair.
address-pair2 address-pair
optional
The second source and destination address pair.
mode string
Connection mode. Possible values are: "multi" and "failover".
name string
Name of the connection. The name is in ASCII and must begin with an alpha character.
snapmirror-error snapmirror-error
optional
Present if there is an error for a snapmirror connection.

 
Element definition: snapmirror-schedule-info [top]
Contains the SnapMirror schedule per destination. If the schedule contains an error, only destination-location and snapmirror-error will be present.
Name Range Type Description
days-of-month string
optional
Days in the month for which the schedule is set. The form is crontab-like, with possible values of:
  • - := match nothing;
  • 1 := match day 1;
  • 1,3 := match day 1 and 3;
  • 2-5 := match day 2,3,4,5;
  • 1-30/7 := match day 1,8,15,22,29;
  • * := matches all possible legal values;
If there is an error, days-of-month will not be present and snapmirror-error will be present.
days-of-week string
optional
Days in the week for which the schedule is set. 0 represents Sunday, and 6 represents Saturday. The form is crontab-like, with possible values of:
  • - := match nothing.
  • 1 := match day 1 (Mon);
  • 1,3 := match day 1 and 3 (Mon and Wed);
  • 2-5 := match day 2,3,4,5 (Tue,Wed,Thu,Fri);
  • * := matches all possible legal values;
If there is an error, days-of-week will not be present and snapmirror-error will be present.
destination-location string
The destination location of the schedule. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
hours string
optional
Hours in the day for which the schedule is set. The form is crontab-like, with possible values of:
  • - := match nothing;
  • 1 := match hour 1;
  • 1,3 := match hour 1 and 3;
  • 2-5 := match hour 2,3,4,5;
  • 1-24/3 := match hour 1,4,7,10,13,16,19,22;
  • * := matches all possible legal values;
If there is an error, hours will not be present and snapmirror-error will be present.
max-transfer-rate integer
optional
Maximum transfer rate in kilobytes per second. If not present, then the transfer rate is as fast as the filer can transfer.
minutes string
optional
Minutes in the hour for which the schedule is set. The form is crontab-like, with possible values of:
  • - := match nothing;
  • 1 := match minute 1;
  • 1,3 := match minute 1 and 3;
  • 2-5 := match minute 2,3,4,5;
  • 1-12/3 := match minute 1,4,7,10;
  • 0-55/5 := match minute 0,5,10,15,20,25,30,35,40, 45,50,55;
  • * := matches all possible legal values;
If there is an error, minutes will not be present and snapmirror-error will be present.
snapmirror-error snapmirror-error
optional
Present if there is an error for a snapmirror schedule.
source-location string
optional
The source location of the schedule. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. If there is an error, source-location will not be present and snapmirror-error will be present.

 
Element definition: snapmirror-status-info [top]
The SnapMirror pair status.
Name Range Type Description
base-snapshot string
optional
Base snapshot name. Only present if available.
contents string
State of the active file system of snapmirror destinations. Possible values are: "replica", "transitioning", and "original".
current-transfer-error string
optional
A human readable transfer error of the current snampmirror transfer. Present when there is a current error.
current-transfer-type string
optional
Type of the current SnapMirror transfer. Possible values are: initialize, store, schedule, retry, retrieve, resync, and migrate. Only present when there is a transfer.
destination-location string
The destination location of the SnapMirror pair. The form is <filer>:<volume> or <filer>:/vol/<volume>/<qtree>.
inodes-replicated [0..2^64-1] integer
optional
Shows the number of inodes replicated. Present during directory processing phase.
lag-time integer
Amount of time since the last snapmirror transfer in seconds.
last-transfer-duration integer
Duration of the last SnapMirror transfer in seconds.
last-transfer-from string
Source location of the last SnapMirror transfer.
last-transfer-size integer
The size in kilo bytes (1024) of the last SnapMirror transfer.
last-transfer-type string
optional
Last SnapMirror transfer type. Possible values are: "initialize", "store", "schedule", "retry", "retrieve", "resync", and "migrate". Only present when there was a last transfer.
mirror-timestamp integer
Access time in seconds since Jan 1, 1970.
replication-ops [0..2^64-1] integer
optional
Counter that is incremented for every replication operation. Present during directory processing phase.
source-location string
The source location of the SnapMirror pair. The form is <filer>:<volume> or <filer>:/vol/<volume>/<qtree>.
state string
SnapMirror pair state. Possible values are: "uninitialized", "snapmirrored", "broken-off", "quiesced", "source", and "unknown".
status string
SnapMirror pair transfer status. Possible values are: "Idle, "Transferring", "Pending", "Aborting", "Migrating", "Quiescing", "Resyncing", "Waiting", "Syncing", "In-sync" and "Paused". In case the previous transfer was failed/aborted and had a restart checkpoint set, the status could be "Idle with restart checkpoint" or "Pending with restart checkpoint". In addition the status could be "Checking", "Fixing" and "Transferring, Checking" when "snapmirror check" command is being run on the destination volume.
transfer-progress integer
Number of kilo bytes (1024) transfered in a current on-going transfer.

 
Element definition: snapmirror-sync-schedule-info [top]
Contains the synchronous SnapMirror schedule per destination. If the schedule contains an error, only destination-location and snapmirror-error will be present.
Name Range Type Description
destination-location string
The destination location of the schedule. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
ops-throttle string
optional
The number of outstanding operations allowed before blocking on the source. The format is a number follwed by the one of the following units: "ops", "s", or "ms". If the specified value is less than 10s, the mirror is configured to run in a fully synchronous mode. If the specified value is greater than or equal to 10s, the mirror is configured to run in semi-synchronous mode.
snapmirror-error snapmirror-error
optional
Present if there is an error for a snapmirror schedule.
source-location string
optional
The source location of the schedule. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. If there is an error, source-location will not be present and snapmirror-error will be present.
sync-mode string
This specfies whether the mirror is configured in sync or in semi-sync mode. Possible values are: "full_sync" and "semi_sync". "full_sync" means that the mirror is configured to run in a fully synchronous mode. "semi_sync" means that the mirror is configured to run in a semi synchronous mode.
visibility-frequency integer
optional
Controls how often the source snapspot will be visible on the destination mirror.

 
Element definition: address-pair [top]
Source and destination address pair.
Name Range Type Description
destination-addr string
Destination address in the form of filer name or IP address.
source-addr string
Source address in the form of filer name or IP address.

 
Element definition: snapmirror-error [top]
Information about a single snapmirror schedule error.
Name Range Type Description
errno integer
The error number.
reason string
A human-readable concise reason for the error.