APIs in Category: snapvault | 7-Mode API version 1.21

snapvault-add-softlock snapvault-get-all-softlocked-snapshots snapvault-get-softlocks snapvault-primary-abort-snapshot-create snapvault-primary-abort-transfer snapvault-primary-delete-snapshot-schedule snapvault-primary-destinations-list-info snapvault-primary-get-relationship-status snapvault-primary-initiate-incremental-restore-transfer snapvault-primary-initiate-restore-transfer snapvault-primary-initiate-snapshot-create snapvault-primary-relationship-status-list-iter-end snapvault-primary-relationship-status-list-iter-next snapvault-primary-relationship-status-list-iter-start snapvault-primary-release-relationship snapvault-primary-set-snapshot-schedule snapvault-primary-snapshot-schedule-list-info snapvault-primary-snapshot-schedule-status-list-info snapvault-remove-softlock snapvault-secondary-abort-snapshot-create snapvault-secondary-abort-transfer snapvault-secondary-configuration-list-info snapvault-secondary-create-relationship snapvault-secondary-delete-relationship snapvault-secondary-delete-snapshot-schedule snapvault-secondary-destinations-list-info snapvault-secondary-get-configuration snapvault-secondary-get-relationship-status snapvault-secondary-initiate-incremental-transfer snapvault-secondary-initiate-snapshot-create snapvault-secondary-modify-configuration snapvault-secondary-relationship-status-list-iter-end snapvault-secondary-relationship-status-list-iter-next snapvault-secondary-relationship-status-list-iter-start snapvault-secondary-release-relationship snapvault-secondary-resync-relationship snapvault-secondary-set-snapshot-schedule snapvault-secondary-snapshot-schedule-list-info snapvault-secondary-snapshot-schedule-status-list-info | SnapVault functionality within Data ONTAP provides disk-to-disk remote backup, archival and recovery. Note that the value expected for volume-name is only the volume name string. The path arguments used in these APIs are of the form: /vol/<volume>/<qtree>.

NetApp Manage ONTAP

snapvault-add-softlock | [top]

> Request the system to add softlock for the specified snapshot. Softlocks can be added to preserve the snapshots which user wants to retain down the cascade.

> Input Name | Range | Type | Description
> snapshot |  | string | Name of the snapshot to be softlocked.
> softlock-name |  | string optional | Name of softlock which uniquely identifies the softlock for the snapshot. When not specified, softlock will be added with default name. Name of softlock can contain letters, numbers, and underscore character (_), and can be up to 64 characters long.
> volume |  | string | Name of the volume where the snapshot exists.

> Errno | Description
> ESNAPVAULTERR |  |

snapvault-get-all-softlocked-snapshots | [top]

> List all snapshots which are softlocked for snapvault by external means.

> Input Name | Range | Type | Description
> volume |  | string | Name of the volume for which softlocked snapshots to be listed.
> Output Name | Range | Type | Description
> snapshot-list |  | snapshot-name[] optional | List of snapshots which are softlocked by external means.

> Errno | Description
> ESNAPVAULTERR |  |

snapvault-get-softlocks | [top]

> List all snapvault softlocks on the given snapshot which are locked by external means.

> Input Name | Range | Type | Description
> snapshot |  | string | Name of the snapshot for which softlocks to be listed.
> volume |  | string | Name of the volume where the snapshot exists.
> Output Name | Range | Type | Description
> snapvault-softlocks |  | snapvault-softlock-info | snapvault softlock information for the snapshot.

> Errno | Description
> EAPIMISSINGARGUMENT |  |

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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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'.
> system-path |  | string | The system path which is the target of transfer.
> target-system |  | string optional | The system filer which is the target of transfer.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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. If a source path is provided, then the primary will return destinations information only for that source path. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-destinations-list-info

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> License
> snapvault_client

snapvault-primary-get-relationship-status | [top]

> Request the primary to return the status entries for desired relationships. The relationships whose status is desired must be specified using the system path. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-secondary-get-relationship-status

> Input Name | Range | Type | Description
> system-path |  | string | System path for relationships whose status is desired.
> Output Name | Range | Type | Description
> status |  | snapvault-status-info[] | Status entries for desired relationships.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> License
> snapvault_client

snapvault-primary-initiate-incremental-restore-transfer | [top]

> Request to initiate an incremental restore from a given secondary path to an existing primary path, using the specified secondary snapshot. The request will only initiate the restore and return. The actual restore operation will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-primary-get-relationship- status API should be used to determine progress of the restore operation. If the dataset contains LUNs, the restore will attempt to prevent disruptions to clients using those LUNs. Upon success, the primary path will have the exact same contents as the specified secondary path in the specified secondary snapshot.

> Input Name | Range | Type | Description
> connection-mode |  | string optional | This option specifies the mode to be used for establising connection between primary and secondary. If this option is set to "inet6", connections between primary and secondary 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 primary and secondary 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 secondary hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.
> max-transfer-rate |  | integer optional |
> no-lun-clone-expansion |  | boolean optional | This option dictates how a lun clone would be transferred from source to destination. If this option is "flase", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".
> primary-path |  | string | The pre-existing primary path to which data is being restored.
> 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.
> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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. If the primary path does not already exist, it will be created before starting the restore transfer. If it already exists, its contents will be overwritten by the restore transfer if overwrite-existing-content is set to true else an error is returned. If an existing primary path contains LUNs, then under certain conditions, restore will prevent disruptions to clients using those LUNs. 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
> connection-mode |  | string optional | This option specifies the mode to be used for establising connection between primary and secondary. If this option is set to "inet6", connections between primary and secondary 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 primary and secondary 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 secondary hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.
> 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^31-2]
> no-lun-clone-expansion |  | boolean optional | This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".
> overwrite-existing-content |  | boolean optional | This option specifies to overwrite an existing primary qtree or not. If specified primary qtree path already exists and the option is set to "true" the existing qtree will be overwritten and and previous data will be lost. If specified primary qtree path already exists and the option is set to "false" then an error is returned. The default value of the option is "true".
> primary-path |  | string | The primary path to which data is being restored. The primary path will be created during the restore if it doesn't already exist.
> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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
> options |  | snapvault-snapcreate-options optional | Describes options for snap create request.
> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

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

> Input Name | Range | Type | Description
> tag |  | string | Tag from the previous primary-relationship-status-list-iter-start.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-secondary-relationship-status-list-iter-next

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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. If the optional input schedule is skipped, the days-of-week is set to "mon-sun" and hours-of-day set to 0, i.e. midnight.

> Input Name | Range | Type | Description
> snapshot-schedule |  | snapvault-primary-snapshot-schedule-info | Specifies details of the schedule to be set.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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. When snapvault primary and secondary are licensed on the same filer, snapvault-secondary-snapshot-schedule-list-info and this API return the same number of schedules.

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-secondary-snapshot-schedule-status-list-info

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> License
> snapvault_client

snapvault-remove-softlock | [top]

> request the system to remove softlock for the given snapshot.

> Input Name | Range | Type | Description
> snapshot |  | string | Name of the snapshot for which softlock to be removed.
> softlock-name |  | string optional | Name of softlock which uniquely identifies the softlock for the snapshot. When not specified, softlock with default name will be removed. When softlock-name has value "-all", all softlocks on the snapshot will be removed. Name of softlock can contain letters, numbers, and underscore character (_), and can be up to 64 characters long.
> volume |  | string | Name of the volume where the snapshot exists.

> Errno | Description
> ESNAPVAULTERR |  |

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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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'.
> system-path |  | string | The system path which is the target of update.
> target-system |  | string optional | The system filer which is the target of transfer.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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' Data 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
> no-lun-clone-expansion |  | boolean optional | This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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' Data 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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
> delete-schedule-softlock |  | boolean optional | When set to 'true', snapvault will delete ACS softlock set by this schedule. The default value for this option is 'false'.
> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-destinations-list-info

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> License
> snapvault_server

snapvault-secondary-get-relationship-status | [top]

> Request the secondary to return the status entries for desired relationships. The relationships whose status is desired must be specified using the system path. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-get-relationship-status

> Input Name | Range | Type | Description
> system-path |  | string | System path for the relationships whose status is desired.
> Output Name | Range | Type | Description
> status |  | snapvault-status-info[] | Status entries for desired relationships.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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' Data 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^31-2]
> no-lun-clone-expansion |  | boolean optional | This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".
> primary-snapshot |  | string optional | Name of the primary snapshot to be used for this update transfer. This option is supported for only 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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
> lock-backing-snapshot |  | boolean optional | When set to 'true' any snapshots backing the LUN clones present in the snapshot being created will be locked down. As a result, the locked backing snapshots can't be deleted as long as the snapshot that is locking them exists. The default value for this option is 'false', which doesn't lock any backing snapshots.
> options |  | snapvault-snapcreate-options optional | Describes options for snap create request.
> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

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

> Input Name | Range | Type | Description
> tag |  | string | Tag from the previous secondary-relationship-status-list-iter-start.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-relationship-status-list-iter-next

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> License
> snapvault_server

snapvault-secondary-resync-relationship | [top]

> Request to resynchronize the relationship for an existing secondary path. This API is equivalent to the 'snapvault start -r' Data ONTAP command. In addition the configuration entry for this relationship will be updated with any parameters that are provided as input. Finally an update transfer to this secondary path will be started. The resynchronization is commonly used when the primary dataset has been migrated to a different location for e.g. via snapvault restore. This functionality is also required if the secondary path was made writable for e.g. via wafl iron. This request will only start the resync process and return. The process 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 this restore.

> Input Name | Range | Type | Description
> configuration |  | snapvault-configuration-info | Relationship configuration
> no-lun-clone-expansion |  | boolean optional | This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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. If the optional input schedule is skipped, the days-of-week is set to "mon-sun" and hours-of-day set to 0, i.e. midnight.

> Input Name | Range | Type | Description
> snapshot-schedule |  | snapvault-secondary-snapshot-schedule-info | Specifies details of the schedule to be set.

> Errno | Description
> ESNAPVAULTERR |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |
> ESNAPVAULTBUSY |  |

> Vfiler-enabled
> Yes

> 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. When snapvault primary and secondary are licensed on the same filer, snapvault-primary-snapshot-schedule-list-info and this API return the same number of schedules.

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> 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' Data ONTAP command. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-snapshot-schedule-status-list-info

> 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 |  |
> EAPILICENSE |  |
> ESNAPVAULTSETUP |  |
> ESNAPVAULTRESOURCE |  |

> Vfiler-enabled
> Yes

> License
> snapvault_server

Element definition: snapshot-name | [top]

> Name of snapshot.

> [none]

Element definition: snapvault-configuration-info | [top]

> Describes the elements of the snapvault configuration entry.

> Name | Range | Type | Description
> connection-mode |  | string optional | This option specifies the mode to be used for establising connection between primary and secondary. If this option is set to "inet6", connections between primary and secondary 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 primary and secondary 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 primary hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.
> is-access-time-change-ignored |  | boolean optional | Sets the ignore_atime option in snapvault configuration entry. When set to 'true', snapvault primary does not send files with only access time changes during incremental transfers. The default value is 'false'
> 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'.
> is-primary-path-utf8-encoded |  | boolean optional | Specifies encoding format for the primary pathname. A 'true' value indicates that the primary pathname is in UTF8 format. The default encoding format is ASCII/extended ASCII. The default value is 'false'.
> 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^31-2]
> primary-path |  | string | The primary path that will be used as the source for this relationship as well as for baseline transfer. This can be either in UTF8 or ASCII/extended ASCII depending on whether or not 'is-primary-path-utf8-encoded' flag is set. If option 'is-primary-path-utf8-encoded' is not specified, then the primary-path considered as in ASCII/extended ASCII.
> 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]
> use-compression |  | string optional | Specifies whether to compress the network data stream. Possible values are 'on', 'off', and 'default'. When the value is set to 'on', stream compression will be enabled. When the value is set to 'off', stream compression will be disabled. When the value is set to 'default' then the default value will be used. In case of snapvault create relationship API, when this option is not specified, the default value will be used. In case of snapvault modify API, when this option is not specified, the last configured value for this relationship will be used. The default value for this option is the value of global compression option.

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
> is-auto-update |  | boolean optional | Schedules that have is-auto-update set to 'true' will initiate update transfers for all relationships in that volume before creating a new snapshot. Default value is 'false'. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules.
> options |  | snapvault-schedule-options optional | Describes snapvault schedule options.
> preserve-snapshots |  | string optional | Allowed values are on/off/default. It prevents SnapVault from auto-deleting older snapshots from this SnapVault snapshot schedule to create new snapshots when set to on. When unspecified, value is set to default. When set to default, the behaviour of preserving snapshots is guided by the global snapvault.preservesnap option. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules.
> retention-count |  | integer | Denotes the maximum number of most recent snapshots that will be retained by this schedule. Range:[0..254]
> schedule |  | snapvault-schedule-info optional | 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.
> warn-at-count |  | integer optional | On SnapVault secondary, when preserve-snapshots is set, SnapVault sends a warning message when the number of remaining snapshots for this backup schedule is less than this input. Setting this to zero turns off the same warning. Default value is 0. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules. Range:[0..retention-count - 1]

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.
> options |  | snapvault-schedule-options optional | Describes schedule options.
> preserve-snapshots |  | string optional | Allowed values are on/off/default. It prevents SnapVault from auto-deleting older snapshots from this SnapVault snapshot schedule to create new snapshots when set to on. When unspecified, value is set to default. When set to default, the behaviour of preserving snapshots is guided by the global snapvault.preservesnap option. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules.
> retention-count |  | integer | Denotes the maximum number of most recent snapshots that will be retained by this schedule. Range:[0..254]
> schedule |  | snapvault-schedule-info optional | 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 have been configured.
> warn-at-count |  | integer optional | On SnapVault secondary, when preserve-snapshots is set, SnapVault sends a warning message when the number of remaining snapshots for this backup schedule is less than this input. Setting this to zero turns off the same warning. Default value is 0. Range:[0..retention-count - 1]

Element definition: snapvault-snapcreate-options | [top]

> Snap create options.

> Name | Range | Type | Description
> tries-count |  | integer | This option is similar to one in snapvault-schedule-options. Range:[-1..120]

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-softlock-info | [top]

> Structure of the snapvault softlock.

> Name | Range | Type | Description
> softlock-name |  | string | Name of the softlock. This field will be empty if softlock-name is not specified while adding softlock.
> type |  | string | Type of snapvault softlock. This indicates whether the softlock added using zapi or command line interface. Possible types are "cli", "api"

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.
> compressed-bytes |  | integer optional | Number of compressed bytes transferred if QSM compression is being used. This field is absent if the transfer is not compressed. Range:[0..2^64-1]
> contents |  | string optional | State of the active file system of the snapvault path on this system. Possible values are: "replica", "transitioning" and "original". This field is present only on the destination.
> 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.
> inodes-replicated | [0..2^64-1] | integer optional | Shows the number of inodes replicated. Present during directory processing phase.
> lag-time |  | integer optional | Amount of time in seconds since the beginning of the most recently successful transfer from source. This field is present only when there has been a successful baseline transfer. Range:[1..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 optional | Creation time of the snapshot used for the most recent successful transfer. Specified in seconds since Jan 1, 1970. This field is present only when there has been a successful baseline transfer. Range:[1..2^32-1]
> replication-ops | [0..2^64-1] | integer optional | Counter that is incremented for every replication operation. Present during directory processing phase.
> 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 optional | Number of kilobytes (1024 bytes) transferred so far. This field is valid only for active transfers. If there is no active transfer in progress, this field is absent. Range:[0..2^32-1]
> uncompressed-bytes |  | integer optional | Number of uncompressed bytes transferred if QSM compression is being used. This field is absent if the transfer is not compressed. Range:[0..2^64-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: - := matches no day of the week mon := matches Monday tue,thu := matches Tuesday and Thursday mon-fri := matches mon,tue,wed,thu,fri 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: 4 := matches 4 am. 0,13 := matches midnight and 1pm. 0-23 := matches all hours 0-8/2 := matches 'every 2 hours' starting from midnight until 8am. Default value is 0, i.e. midnight.

Element definition: snapvault-schedule-options | [top]

> Describes snapvault schedule options.

> Name | Range | Type | Description
> retention-period |  | string optional | This option is used to specify a retention period for snapshots, which are created by this schedule, for SnapLock volumes. The retention period is specified as a count followed by a suffix. the valid suffixes are d - for days m - for months y - for years For example a value of 6m represents a retention period of 6 months. THe maximum valid retention period is 30 years, or the maximum retention period set for the volume, whichever is shorter. The minimum valid retention period is 0 days, ir the minimum retention period set for the volume, whichever is longer. If the option value is default or the retention-period option is not specified, the snapshots will be created with retention period equal to the default retention period of the secondary SnapLock volume, or 30 years, whichever is shorter.
> tries-count |  | integer optional | Number of times SnapVault should try creating each scheduled snapshot before giving up. If the snapshot creation fails due to transient errors such as the volume being out of space, SnapVault will keep trying to create the snapshot every minute untill the request is fulfilled. The allowed range is from 0 to 120. The default value is unlimited. If tries-count is not use, then the value will remain unchanged and the already configured value will be used. The default value for this option is -1. Range:[-1..120]