APIs in Category: snapmirror
 API version 1.1

 
snapmirror-abort
snapmirror-break
snapmirror-get-status
snapmirror-get-volume-status
snapmirror-initialize
snapmirror-list-destinations
snapmirror-list-schedule
snapmirror-off
snapmirror-on
snapmirror-quiesce
snapmirror-release
snapmirror-resume
snapmirror-resync
snapmirror-set-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
 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.
 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.
 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.
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.
 Errno  Description
 ESNAPMIRROROFF
 License
 replicate

 
snapmirror-list-destinations [top]
Returns a list of the destinations for a given location, 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.
 License
 replicate

 
snapmirror-list-schedule [top]
Returns 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
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-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>.
 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>.
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-snapshort is not specfied, a new snapshot will be created.
 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;
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);
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;
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;
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-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.
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..
 License
 replicate

 
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 the qtree form: <filer>:/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;
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);
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;
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;
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 string
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", and "waiting".
transfer-progress integer
Number of kilo bytes (1024) transfered in a current on-going transfer.

 
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.