|
APIs in Category: snapvault |
API version 1.6 |
| snapvault-primary-abort-snapshot-create | [top] |
Request the primary to abort a snapshot creation that is already in progress. The snapshot schedule for which the snapshot creation is in progress must be specified as input.
Input Name Range Type Description schedule-name string
Name of the schedule used for snapshot creation. volume-name string
Primary volume in which snapshot create is in progress.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-abort-transfer | [top] |
Request the primary system to abort an active transfer. The abort can be hard abort, which means the transfer will not be restartable. Or it could be a soft abort, which will not clean the restart checkpoints. In that case the transfer may be restartable. An aborted transfer may be restarted by using the same API used to initiate the transfer in the previous attempt. If that request cannot restart the aborted transfer, then it will initiate a fresh new transfer.
Input Name Range Type Description is-hard-abort boolean
optional
When set to 'true' a hard abort is performed. In that case the restart checkpoints are cleared. Default value is 'false'. primary-path string
The primary path which is the target of restore.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-delete-snapshot-schedule | [top] |
Request the primary system to delete the specified snapshot schedules. The snapshot schedules that match the volume name and if specified the schedule name, will be deleted.
Input Name Range Type Description schedule-name string
optional
Name of the schedule to be deleted. volume-name string
The primary volume for which the schedules are to be deleted.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-destinations-list-info | [top] |
Request the primary to list all snapvault destinations that have been replicated from any source path on this primary system. Typically this request will return the destinations created by snapvault restore. If a source path is provided, then the primary will return destinations information only for that source path.
Input Name Range Type Description source-path string
optional
Source path on this primary for which the destination information is desired. Output Name Range Type Description destinations snapvault-destination-info[]
List of all snapvault destinations known to this primary.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-get-relationship-status | [top] |
Request the primary to return the status entry for a specified relationship. The relationship whose status is desired must be specified using the primary path.
Input Name Range Type Description primary-path string
Primary path location for the relationship whose status is desired. Output Name Range Type Description status snapvault-status-info[]
List of status entries, one for each snapshot schedule.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-initiate-restore-transfer | [top] |
Request the primary system to begin a baseline restore transfer from the given secondary path to the given primary path. The primary path will be created during the restore and therefore must not exist when issuing this request. The request will only start the restore transfer and return. The actual transfer will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-primary-get-relationship-status API should be used to check the status of the restore.
Input Name Range Type Description max-transfer-rate integer
optional
The maximum transfer rate in kilobytes (1024 bytes) per second to be applied only for this update transfer. If this option is not provided the default behavior will be to allow the transfer to proceed as fast as possible. Range:[1..2^32-1] primary-path string
The primary path to which data is being restored. The primary path will be created during the restore and hence it must not exist when issuing this request. secondary-path string
The secondary path to restore from. secondary-snapshot string
optional
Name of the secondary snapshot to be used for this restore transfer. If this option is not provided, the secondary system will choose the snapshot that contains the most recent back-up for this secondary path. secondary-system string
The secondary system to restore from. This input will be used by the primary system to establish contact with the secondary. Therefore it is expected to be a hostname that the primary can resolve.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-initiate-snapshot-create | [top] |
Request the primary to force a snapshot creation for a specified snapshot schedule. The snapshot schedule must be identified by the volume name and the snapshot prefix. All the properties of the specified schedule will be applied to the snapshot creation. This API should be used when it is desirable to create snapshots right away, without having to wait for the pre-configured scheduled time. This API returns after only initiating the snapshot creation, and there is no guarantee that the snapshot creation will succeed. The snapvault-primary-snapshot-schedule-status-list-info API should be used to track progress of the snapshot creation.
Input Name Range Type Description schedule-name string
The name of the schedule to be used for this snapshot creation. volume-name string
The primary volume for which the snapshot schedule was configured.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-relationship-status-list-iter-end | [top] |
Terminate the status list iteration set up by the snapvault-primary-relationship-status-list-iter-start API. The primary will clean up any saved info for this iteration.
Output Name Range Type Description tag string
Tag from the previous primary-relationship-status-list-iter-start.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-relationship-status-list-iter-next | [top] |
Request the primary to continue the iteration set up with the snapvault-primary-relationship-status-list-iter-start API. A list consisting of a number of status entries, upto the specified maximum, will be returned.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. Range:[0..2^32-1] tag string
Tag from a previous primary-relationship-status-list-iter-start. Output Name Range Type Description records integer
The number of records being returned by this particular request. When this value is 0, there are no more records to be returned. Range:[0..2^32-1] status-list snapvault-status-info[]
optional
List of entries, each representing status entry for a relationship.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-relationship-status-list-iter-start | [top] |
Request the primary to start an iteration through the list of the status entries for all relationships.
Output Name Range Type Description records integer
This tells you the number of items that have been saved for future retrieval with primary-relationship-status-list-iter-next. Range:[0..2^32-1] tag string
Tag to be used in subsequent iterations.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-release-relationship | [top] |
Request the release of a snapvault relationship formed by a "create-relationship" or "resync-relationship" operation. This operation deletes the registry entry and the softlocks on the source snapshot.
Input Name Range Type Description primary-path string
The primary path for the relationship. secondary-path string
The secondary path for the relationship. secondary-system string
The secondary system for the relationship.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-set-snapshot-schedule | [top] |
Request the primary system to configure the specified snapshot schedule. It can also update existing snapshot schedules.
Input Name Range Type Description snapshot-schedule snapvault-primary-snapshot-schedule-info
Specifies details of the schedule to be set.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-snapshot-schedule-list-info | [top] |
Request the primary to return a list of configured snapshot schedules. Without any input arguments this request returns the list of all snapshot schedules configured on the primary. If a volume is specified then only the list of schedules configured for that volume will be returned.
Input Name Range Type Description volume-name string
optional
The primary volume for which the list of snapshot schedules are desired. Output Name Range Type Description snapshot-schedules snapvault-primary-snapshot-schedule-info[]
optional
List of snapshot schedule entries.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-primary-snapshot-schedule-status-list-info | [top] |
Request the primary to return status for all configured snapshot schedules. If a specific volume is provided as input, this API will return only the status for schedules within that volume.
Input Name Range Type Description volume-name string
optional
Primary volume for which snapshot schedule status is desired. Output Name Range Type Description snapshot-schedule-status snapvault-snapshot-schedule-status-info[]
List of status entries, one for each snapshot schedule.
Errno Description ESNAPVAULTERR
License snapvault_client
| snapvault-secondary-abort-snapshot-create | [top] |
Request the secondary to abort a snapshot creation that is already in progress. The snapshot schedule for which the snapshot creation is in progress must be specified as input.
Input Name Range Type Description schedule-name string
The name of the schedule used by the snapshot creation. volume-name string
The secondary volume in which snapshot create is in progress.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-abort-transfer | [top] |
Request the secondary system to abort the current transfer. The abort can be hard abort, which means the transfer will not be restartable. By default, a soft abort is used, which means the transfer is restartable. An aborted transfer may be restarted by using the same API used to initiate the transfer in the previous attempt. If that request cannot restart the aborted transfer, then it will initiate a fresh new transfer.
Input Name Range Type Description is-hard-abort boolean
optional
When set to 'true' a hard abort is performed. In that case the restart checkpoints are cleared. Default value is 'false'. secondary-path string
The secondary path which is the target of update.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-configuration-list-info | [top] |
Request to return a list of all configuration entries found on the secondary system.
Output Name Range Type Description configurations snapvault-configuration-info[]
optional
List of configuration entries.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-create-relationship | [top] |
Request the secondary system to configure a new snapvault relationship with the given primary and secondary systems and paths. This API is equivalent to the 'snapvault start' Ontap command. All the inputs provided with this request will be stored in the configuration entry maintained by the secondary system. These values will be used as default settings for further incremental update transfers for this relationship. The snapvault-secondary-modify-configuration API can be used to change these configured settings. A successful configuration will automatically be followed by a baseline transfer from the primary to the secondary. The secondary path will be created during the baseline transfer hence it is required that the secondary path must not exist when issuing this request. This request will only begin the baseline transfer and return. The transfer will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-get-relationship-status API should be used to check the status of the transfer.
Input Name Range Type Description configuration snapvault-configuration-info
Relationship configuration
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-delete-relationship | [top] |
Request the secondary system to unconfigure and delete the relationship permanently. The secondary path will be deleted. But none of the snapshots that capture this secondary path will be deleted. This API corresponds to the 'snapvault stop' Ontap command.
Input Name Range Type Description secondary-path string
The secondary-path to be deleted. The path will be unconfigured and deleted.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-delete-snapshot-schedule | [top] |
Request the secondary system to delete the specified snapshot schedules. The snapshot schedules that match the volume name and the snapshot prefix when specified, will be deleted.
Input Name Range Type Description schedule-name string
optional
The name of the schedule to be deleted. volume-name string
The secondary volume for which the schedule is to be deleted.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-destinations-list-info | [top] |
Request the secondary to list all snapvault destinations that have been replicated from any source path on this secondary system. If a source path is provided, then the secondary will return destinations information only for that source path. Typically this request will return the destinations created by snapvault restore.
Input Name Range Type Description source-path string
optional
Source path on this secondary for which the destination information is desired. Output Name Range Type Description destinations snapvault-destination-info[]
List of all snapvault destinations known to this secondary.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-get-configuration | [top] |
Request the secondary to return the configuration entry for a relationship. The relationship must be specified by providing the secondary path as input.
Input Name Range Type Description secondary-path string
The secondary path for the relationship whose configuration entry is desired. Output Name Range Type Description configuration snapvault-configuration-info
optional
A single configuration entry.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-get-relationship-status | [top] |
Request the secondary to return the status entry for specified relationship. The relationship whose status is desired must be specified using the secondary path.
Input Name Range Type Description secondary-path string
Secondary path for the relationship whose status is desired. Output Name Range Type Description status snapvault-status-info
Status entry for the specified relationship.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-initiate-incremental-transfer | [top] |
Request the snapvault secondary system to begin an incremental transfer to the given secondary path. This API is equivalent to the 'snapvault update' Ontap command. It is required that this secondary path has already been configured as part of a snapvault relationship. The primary system and path configured in that relationship will be used as the source for this transfer. The request will only start the transfer and return. The actual transfer will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-secondary-get-relationship-status API should be used to check the status of the update.
Input Name Range Type Description max-transfer-rate integer
optional
The maximum transfer rate in kilobytes (1024 bytes) per second to be applied only for this update transfer. If this option is not provided the default behavior will be to allow the transfer to proceed as fast as possible. Range:[1.. 2^32-1] primary-snapshot string
optional
Name of the primary snapshot to be used for this update transfer. This option is supported for only Netapp primary systems. If this option is not provided, the primary system will create a new source snapshot for this transfer. secondary-path string
The secondary path that will be used as the destination for this update transfer. It is required that this secondary path is already a part of some configured snapvault relationship.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-initiate-snapshot-create | [top] |
Request the secondary to force a snapshot creation for a specified snapshot schedule. The snapshot schedule must be identified by the volume name and the schedule name. All the properties of the specified schedule will be applied to the snapshot creation. This API should be used when it is desirable to create snapshots right away, without having to wait for the pre-configured scheduled time. This API returns after only initiating the snapshot creation, and there is no guarantee that the snapshot creation will succeed. The snapvault-secondary-snapshot-schedule-status-list-info API should be used to track progress of the snapshot creation.
Input Name Range Type Description schedule-name string
The name of the schedule to be used for creating the snapshot. The schedule-name will be used as a prefix in the name of each snapshot created by this schedule. If an empty string is provided, the snapshot creation process will be started, but a snapshot will not be created. This is useful to bring all the relationships of a secondary volume to a consistent state. volume-name string
The secondary volume in which the snapshot is to be created.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-modify-configuration | [top] |
Request change in one or more configuration parameters of an existing snapvault relationship identified by the secondary path provided. Only the parameters that are specified as input will be changed for this configuration.
Input Name Range Type Description configuration snapvault-configuration-info
Relationship configuration
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-relationship-status-list-iter-end | [top] |
Terminate the status list iteration set up by the snapvault-secondary-relationship-status-list-iter-start API. The secondary will clean up any saved info for this iteration.
Output Name Range Type Description tag string
Tag from the previous secondary-relationship-status-list-iter-start.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-relationship-status-list-iter-next | [top] |
Request the secondary to continue the iteration set up with the snapvault-secondary-relationship-status-list-iter-start API. A list consisting of a number of status entries, upto the specified maximum, will be returned.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. Range:[0..2^32-1] tag string
Tag from a previous secondary-relationship-status-list-iter-start. Output Name Range Type Description records integer
The number of records being returned by this particular request. When this value is 0, there are no more records to be returned. Range:[0..2^32-1] status-list snapvault-status-info[]
optional
List of entries, each representing status entry for a relationship.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-relationship-status-list-iter-start | [top] |
Request the secondary to start an iteration through the list of the status entries for all relationships. This list will also include entries for snapvault restores from this secondary.
Output Name Range Type Description records integer
This tells you the number of items that have been saved for future retrieval with secondary-relationship-status-list-iter-next. Range:[0..2^32-1] tag string
Tag to be used in subsequent iterations.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-release-relationship | [top] |
Request the release of a snapvault relationship formed after a restore operation on the primary system. This operation deletes the registry entry and removes the softlock on the source base snapshot.
Input Name Range Type Description primary-path string
The primary path that had been used for the restore. primary-system string
The primary system which had performed the restore. secondary-path string
The secondary path that was used as source for restore.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-resync-relationship | [top] |
Input Name Range Type Description configuration snapvault-configuration-info
Relationship configuration
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-set-snapshot-schedule | [top] |
Request the secondary system to configure the specified snapshot schedule. If this request is made for an existing snapshot schedule, then that snapshot schedule is updated with any new values specified.
Input Name Range Type Description snapshot-schedule snapvault-secondary-snapshot-schedule-info
Specifies details of the schedule to be set.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-snapshot-schedule-list-info | [top] |
Request the secondary to return a list of configured snapshot schedules. Without any input arguments this request returns the list of all snapshot schedules configured on the secondary. If a volume is specified then only the list of schedules configured for that volume will be returned.
Input Name Range Type Description volume-name string
optional
The secondary volume for which the list of snapshot schedules are desired. Output Name Range Type Description snapshot-schedules snapvault-secondary-snapshot-schedule-info[]
optional
List of snapshot schedule entries.
Errno Description ESNAPVAULTERR
License snapvault_server
| snapvault-secondary-snapshot-schedule-status-list-info | [top] |
Request the secondary to return status for all configured snapshot schedules. If a specific volume is provided as input, this API will return only the status for schedules within that volume. This API corresponds to the 'snapvault status -s' Ontap command.
Input Name Range Type Description volume-name string
optional
Secondary volume for which snapshot schedule status is desired. Output Name Range Type Description snapshot-schedule-status snapvault-snapshot-schedule-status-info[]
List of status entries, one for each snapshot schedule.
Errno Description ESNAPVAULTERR
License snapvault_server
| Element definition: snapvault-configuration-info | [top] |
Describes the elements of the snapvault configuration entry.
Name Range Type Description is-open-file-backup-allowed boolean
optional
Sets the back_up_open_files option in the snapvault configuration entry. This option is used to allow or disallow the inclusion of open files on the primary system at the time of the transfer. This option is currently applicable only for OSSV relationships. When set to 'false' the OSSV primary agents will exclude files that are open from the transfer. The default value for this parameter is 'true'. max-transfer-rate integer
optional
The maximum transfer rate in kilobytes (1024 bytes) per second that will be used for this relationship as well as baseline transfer. The default value for this parameter will allow transfers to proceed as fast as possible. Range:[1..2^32-1] primary-path string
The primary path that will be used as the source for this relationship as well as for baseline transfer. primary-system string
The primary system for this relationship as well as for the baseline transfer. This input will be used by the secondary system to establish contact with the primary. Therefore this input is expected to be a hostname that the primary can resolve. secondary-path string
The secondary path that will be used as destination for this relationship as well as baseline transfer. The secondary path will be created during the baseline transfer and hence it must not exist when issuing this request. tries-count integer
optional
The maximum number of times a transfer will be tried. Transfers that are retried using this mechanism may be capable of restarting from where the previous attempt failed. If a transfer does not succeed even after those many attempts, then the secondary will give up. All the data that was transferred during previous tries for this transfer will be discarded. The default value for this parameter is 2. When set to 0, the relationship will become dormant. In other words no transfers will be allowed to this secondary path. The maximum value accepted for this input is 120. Range:[0..120]
| Element definition: snapvault-destination-info | [top] |
Structure of each entry of destinations list.
Name Range Type Description chained-destinations snapvault-chained-destination-info[]
List of destinations that form a dependency chain starting from the source-path. This list will contain only one element for non-cascaded configurations. The last element of this list represents the destination for which the snapshot returned in source-snapshot has been preserved on the source system. source-path string
The source path for this destination. source-snapshot string
The source snapshot that has been preserved on the source system for the destination.
| Element definition: snapvault-primary-snapshot-schedule-info | [top] |
Structure of each snapshot schedule.
Name Range Type Description retention-count integer
Denotes the maximum number of most recent snapshots that will be retained by this schedule. Maximum value allowed is equal to the maximum number of snapshots supported on the primary system, which is currently set to 255. Range:[0..255] schedule snapvault-schedule-info
Describes the actual schedule. schedule-name string
Uniquely identifies this schedule within a primary volume. The schedule-name will be used as a prefix in the name of each snapshot created by this schedule. volume-name string
The primary volume for which this schedule has been configured.
| Element definition: snapvault-secondary-snapshot-schedule-info | [top] |
Snapshot schedules for each volume.
Name Range Type Description is-auto-update boolean
Schedules that have is-auto-update set to 'true' will initiate update transfers for all relationships in that volume before creating a new snapshot. retention-count integer
Denotes the maximum number of most recent snapshots that will be retained by this schedule. Range:[0..255] schedule snapvault-schedule-info
Describes the actual schedule. schedule-name string
Uniquely identifies the schedule within a secondary volume. The schedule-name is used as a prefix in the name of each snapshot created by this schedule. volume-name string
The secondary volume for which these schedules havei been configured.
| Element definition: snapvault-snapshot-schedule-status-info | [top] |
Structure of the snapshot schedule status entry.
Name Range Type Description schedule-name string
Uniquely identifies schedule within a volume. status string
Status of this schedule. Possible values are: "Idle", "Active", "Aborting", "Queued", "Saving". volume-name string
Volume for which this schedule is configured.
| Element definition: snapvault-status-info | [top] |
Format of each status entry.
Name Range Type Description base-snapshot string
optional
Snapshot the relationship is currently based upon. contents string
State of the active file system of the snapvault path on this system. Possible values are: "replica", "transitioning" and "original". current-transfer-error string
optional
A human readable error string for the current transfer. current-transfer-type string
optional
Type of the current transfer. Possible values are: "initialize", "update", "retry", "resync". Only available for active transfers. destination-path string
Destination path. destination-system string
Destination hostname. lag-time integer
Amount of time in seconds since the beginning of the most recently successful transfer from source. Range:[0..2^32-1] last-transfer-duration integer
optional
Duration of last transfer in seconds. Range:[0..2^32-1] last-transfer-from-path string
optional
Source path used for the last transfer. last-transfer-from-system string
optional
Source system used for the last transfer. last-transfer-size integer
optional
Size in kilobytes (1024 bytes) of the last transfer. Range:[0..2^32-1] last-transfer-type string
optional
Last transfer type. Possible values are: "initialize", "update", "retry", "resync". mirror-timestamp integer
Creation time of the snapshot used for the most recent successful transfer. Specified in seconds since Jan 1, 1970. Range:[0..2^32-1] source-path string
Source path. source-system string
Source hostname. state string
State of this relationship. Possible values are: "uninitialized","snapvaulted","broken-off","unknown", "source","restoring","quiesced". status string
Transfer status for this relationship. Possible values are: "idle", "transferring", "pending", "aborting", "quiescing", "resyncing", "restoring". transfer-progress integer
Number of kilobytes (1024 bytes) transferred so far. This field is valid only for active transfers. Range:[0..2^32-1]
| Element definition: snapvault-chained-destination-info | [top] |
Structure of each entry of destinations-chain.
Name Range Type Description destination-path string
Destination path. destination-system string
optional
Hostname of the destination system.
| Element definition: snapvault-schedule-info | [top] |
Representation of the scheduling information.
Name Range Type Description days-of-week string
optional
Days of the week for which this schedule has been set. This is a comma separated list of days, where a day is specified by the first three letters of the day. Day ranges are also allowed. Here are the possible formats: <ul> <li> - := matches no day of the week <li> mon := matches Monday <li> tue,thu := matches Tuesday and Thursday <li> mon-fri := matches mon,tue,wed,thu,fri </ul> Default value is mon-sun, i.e. every day. hours-of-day string
optional
Hours of the day for which this schedule has been set. This is a comma separated list of the hours during the day where hours are specified as integers from 0 to 23. Hour ranges are also allowed. Step values are allowed in conjunction with ranges. Here are the possible formats: <ul> <li> 4 := matches 4 am. <li> 0,13 := matches midnight and 1pm. <li> 0-23 := matches all hours <li> 0-8/2 := matches 'every 2 hours' starting from midnight until 8am. </ul> Default value is 0, i.e. midnight.