APIs in Category: snapshot
API version 1.0

 
snapshot-create
snapshot-delete
snapshot-get-reserve
snapshot-get-schedule
snapshot-list
snapshot-rename

NetApp Manage ONTAP
 
snapshot-create [top]

Create a new snapshot on a specified volume.
Input Name Range Type Description
snapshot string
This is the name of the snapshot to be created.
volume string
This is the name of the volume on which the snapshot is to be created.
 Errno  Description
 EAPIMISSINGARGUMENT
 SNAPSHOTEXISTS
 EVOLUMENOEXISTS
 EVOLUMEMOUNTING
 EVOLUMEOFFLINE
 EAPIERROR

 
snapshot-delete [top]
Delete a snapshot on a specified volume. NOTE: Don't know what happens when deleting a busy snapshot.
Input Name Range Type Description
snapshot string
This is name of snapshot to be deleted on the specified volume.
volume string
This is the name of the volume on which the snapshot is to be deleted.
 Errno  Description
 EAPIMISSINGARGUMENT
 SNAPSHOTNOEXIST
 EVOLUMENOEXISTS
 EVOLUMEMOUNTING
 EVOLUMEOFFLINE
 EAPIERROR

 
snapshot-get-reserve [top]
Obtain the current snapshot reserve on a specified volume. Error Returns: Invalid volume name.
Input Name Range Type Description
volume string
This is the volume name that contains the snapshot reserve.
 
Output Name Range Type Description
blocks-reserved integer
The number of 1024 byte blocks that has been set aside as reserve for snapshot usage.
percent-reserved integer
The percentage of disk space that has been set aside as reserve for snapshot usage.
 Errno  Description
 EAPIMISSINGARGUMENT
 SNAPSHOTNOEXIST
 EVOLUMENOEXISTS
 EVOLUMEMOUNTING
 EVOLUMEOFFLINE

 
snapshot-get-schedule [top]
Obtain the current snapshot schedule on a specified volume. Error Returns: Invalid volume name.
Input Name Range Type Description
volume integer
This the volume name where the snapshots are located.
 
Output Name Range Type Description
days integer
The number of snapshots taken daily to keep on line.
hours integer
The number of snapshots taken hourly to keep on line.
minutes integer
The number of snapshots taken minutely to keep on line.
weeks integer
The number of snapshots taken weekly to keep on line.
which-hours string
A list of the hours at which the hourly snapshots are created.
which-minutes string
A list of the minutes at which the minutely snapshots are created.
 Errno  Description
 EAPIMISSINGARGUMENT
 SNAPSHOTNOEXIST
 EVOLUMENOEXISTS
 EVOLUMEMOUNTING
 EVOLUMEOFFLINE

 
snapshot-list [top]
Return snapshot information for a specified volume. A list of snapshots and information about each snapshot is returned.
Input Name Range Type Description
volume string
This is the name of the volume on which to list the snaplist information.
 
Output Name Range Type Description
snapshots snapshot-info[]
 Errno  Description
 EAPIMISSINGARGUMENT
 SNAPSHOTNOEXIST
 EVOLUMENOEXISTS
 EVOLUMEMOUNTING
 EVOLUMEOFFLINE
 EAPIERROR

 
snapshot-rename [top]
Rename a specified snapshot to a new name on a specified volume.
Input Name Range Type Description
current-name string
The name of snapshot to be renamed.
new-name string
The new name of snapshot as a result to the rename.
volume string
This is the volume name where the current snapshot and the new snapshot are located.

 
Element definition: snapshot-info [top]
One snapshot contained in the specified volume.
Name Range Type Description
access-time integer
This is the access time in seconds since Jan 1, 1970.
busy string
If the snapshot is busy being used by an application, then busy is set to "true". If the snapshot is not busy, then "false" is set.
cumulative-total integer
This is the cumulative total of 1024 byte blocks of this snapshot and previous snapshots.
dependency string
Application that is dependent on this snapshot. The possible values are snapmirror and snapvault.
name string
This is the name of the snapshot to be listed.
total integer
This is the number of 1024 byte blocks in the snapshot.