APIs in Category: snapmirror | API version 1.6

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

NetApp Manage ONTAP

snapmirror-abort | [top]

> Cancels any transfer for a destination. The API can be issued from either the source or destination filer.

> 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 | The destination location of the transfer to abort. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.

> Errno | Description
> ESNAPMIRRORERR |  |

> License
> replicate

snapmirror-break | [top]

> Breaks a snapmirrored relationship. No checking on whether the operation is legal, or whether it is successful. I.e. you need to query status afterward by using snapmirror-get-status. The snapmirror-break API must be issued on the destination filer.

> Input Name | Range | Type | Description
> destination-location |  | string | Destination location of the snapmirrored pair to break. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. If the destination-location is in the qtree form, it must first be quiesced using snapmirror-quiesce.

> Errno | Description
> ESNAPMIRRORERR |  |

> Vfiler-enabled
> Yes

> License
> replicate

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.

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

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

> 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. If not specified, then 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

> License
> replicate

snapmirror-get-volume-status | [top]

> Return SnapMirror status values for a given volume. All of the status values are returned simultaneously.

> Input Name | Range | Type | Description
> volume |  | string | Name of the volume to be queried.
> Output Name | Range | Type | Description
> is-destination |  | boolean | True if the volume is a SnapMirror destination.
> is-source |  | boolean | True if the volume is a SnapMirror source.
> is-transfer-broken |  | boolean | True if a SnapMirror transfer state as a destination volume has been stopped due the snapmirror break command or the snapmirror-break API.
> is-transfer-in-progress |  | boolean | True if a SnapMirror transfer as a destinaion or source volume is currently in progress.

> Errno | Description
> EVOLUMEOFFLINE |  |
> EVOLUMEDOESNOTEXIST |  |

> Vfiler-enabled
> Yes

> License
> replicate

snapmirror-initialize | [top]

> Starts an initial transfer over the network for a specific destination. The API must be issued to the destination filer.

> Input Name | Range | Type | Description
> destination-location |  | string | The destination location of the initial transfer. 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 in the volume form, the volume must be in the restricted state. If the destination-location is the qtree form, the qtree must not already exist.
> 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 | Maximum transfer rate in kilobytes per second. The default is as fast as the filer can transfer.
> source-location |  | string optional | The source location of the initial transfer. 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 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 |  |

> 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 |  | connection-info[] | An array of SnapMirror connection information.

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

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

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

> License
> replicate

snapmirror-quiesce | [top]

> Pauses transfers to the destination. The API must be issued on the destination filer. The status of the path must be checked to discover when the path is quiesced.

> Input Name | Range | Type | Description
> destination-location |  | string | The destination location of the snapmirrored pair to resume. which is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.

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

> License
> replicate

snapmirror-resume | [top]

> Resumes transfers to the destination that were quiesced. This API must be issued on the destination filer.

> Input Name | Range | Type | Description
> destination-location |  | string | The destination location of the snapmirrored pair to resume. which is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.

> License
> replicate

snapmirror-resync | [top]

> Kicks off a resync of a broken snapmirrored pair. 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.

> Input Name | Range | Type | Description
> destination-location |  | string | Destination location of the snapmirrored pair to break, The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
> 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 | Maximum transfer rate in kilobytes per second. The default is as fast as the filer can transfer.
> source-location |  | string optional | Source location of the transfer. The source location is is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. 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.

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

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

> 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
> 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". "ops" represents the number of operations before the source blocks. Both "s" and "ms" represent time: seconds and milliseconds respectively. When outstanding-units is in time, the source blocks after doing operations for the amount of time. If present then snapmirror is in semi-sychronous mode, else in full synchronous 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>.
> 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-update | [top]

> Starts a transfer over the network for a specific destination. The update is asynchronously handled, and there is no guarantee that it succeeds. The snapmirror-get-status API can be used to check the status of the update. The API must be issued on the destination filer.

> Input Name | Range | Type | Description
> destination-location |  | string | The destination location of the update transfer. 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 in the volume form, the volume must be in the restricted state. If the destination-location is the qtree form, the qtree must not already exist.
> 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 | Maximum transfer rate in kilobytes per second. The default is as fast as the filer can transfer.
> source-location |  | string optional | The source location of the update transfer. 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 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.

> 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: 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: 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>.
> 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-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>.
> 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.
> 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". "ops" represents the number of operations before the source blocks. Both "s" and "ms" represent time: seconds and milliseconds respectively. When outstanding-units is in time, the source blocks after doing operations for the amount of time. If present then snapmirror is in semi-sychronous mode, else in full 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.
> 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.