APIs in Category: snapshot | Cluster-Mode API version 1.15

snapshot-get-iter snapshot-policy-add-schedule snapshot-policy-create snapshot-policy-delete snapshot-policy-get snapshot-policy-get-iter snapshot-policy-modify snapshot-policy-modify-schedule snapshot-policy-remove-schedule snapshot-reserve-list-info

NetApp Manage ONTAP

snapshot-get-iter | [top]

> Iterate over a list of snapshot objects.

> Input Name | Range | Type | Description
> desired-attributes |  | snapshot-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | snapshot-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the snapshot object. All snapshot objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | snapshot-info[] optional | The list of attributes of snapshot objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more snapshot objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

snapshot-policy-add-schedule | [top]

> Add a new schedule to the Snapshot Policy

> Input Name | Range | Type | Description
> count | [0..255] | integer | The maximum number of snapshots to be retained for the schedule. The count of all the snapshots for to be retained for this policy cannot be more than 255.
> policy |  | snapshot-policy | A human readable string describing the name of the snapshot scheduling policy.
> prefix |  | string optional | The snapshot name prefix for the schedule. This field should be unique within the policy.
> schedule |  | string | A human readable string describing the name of a new schedule to be added inside the snapshot policy. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly', 'weekly' or 'daily' or it can be a user created schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOPNOTSUPPORTED |  |

snapshot-policy-create | [top]

> Create a new Snapshot Scheduling Policy

> Input Name | Range | Type | Description
> comment |  | string optional | A human readable description associated with the snapshot policy. The maximum length of this field can be 255 characters.
> count1 | [0..255] | integer | Retention count for the snapshots created by the first schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
> count2 | [0..255] | integer optional | Retention count for the snapshots created by the second schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
> count3 | [0..255] | integer optional | Retention count for the snapshots created by the third schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
> count4 | [0..255] | integer optional | Retention count for the snapshots created by the fourth schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
> count5 | [0..255] | integer optional | Retention count for the snapshots created by the fifth schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
> enabled |  | boolean | Status of the snapshot policy indicating whether the policy will be enabled or disabled. If set to true, the policy will be enabled.
> policy |  | string | The name of the snapshot scheduling policy which has to be created. This API creates a snapshot policy and adds the schedules to it. At the most 5 schedules can be added to the snapshot policy. Maximum length of this string can be 256 characters.
> prefix1 |  | string optional | Snapshot name prefix for the first schedule. Prefix name should be unique within the policy.
> prefix2 |  | string optional | Snapshot name prefix for the second schedule. Prefix name should be unique within the policy.
> prefix3 |  | string optional | Snapshot name prefix for the third schedule. Prefix name should be unique within the policy.
> prefix4 |  | string optional | Snapshot name prefix for the fourth schedule. Prefix name should be unique within the policy.
> prefix5 |  | string optional | Snapshot name prefix for the fifth schedule. Prefix name should be unique within the policy.
> schedule1 |  | string | First schedule to be added inside the policy. Atleast one schedule has to be added to create a policy.
> schedule2 |  | string optional | Second schedule to be added inside the policy.
> schedule3 |  | string optional | Third schedule to be added inside the policy.
> schedule4 |  | string optional | Fourth schedule to be added inside the policy.
> schedule5 |  | string optional | Fifth schedule to be added inside the policy.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOPNOTSUPPORTED |  |

snapshot-policy-delete | [top]

> Delete the specified Snapshot Scheduling Policy

> Input Name | Range | Type | Description
> policy |  | snapshot-policy | A human readable string describing the name of the snapshot scheduling policy.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |

snapshot-policy-get | [top]

> Get Information about a single Snapshot Policy

> Input Name | Range | Type | Description
> desired-attributes |  | snapshot-policy-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> policy |  | snapshot-policy | A human readable string describing the name of the snapshot scheduling policy.
> Output Name | Range | Type | Description
> attributes |  | snapshot-policy-info | The attributes of the snapshot.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |

snapshot-policy-get-iter | [top]

> Get Information about multiple Snapshot Policies

> Input Name | Range | Type | Description
> desired-attributes |  | snapshot-policy-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | snapshot-policy-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the snapshot object. All snapshot objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | snapshot-policy-info[] optional | The list of attributes of snapshot objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more snapshot objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |

snapshot-policy-modify | [top]

> Enable or Disable the specified Snapshot Scheduling Policy

> Input Name | Range | Type | Description
> enabled |  | boolean | The state of the snapshot policy. If true, the snapshot policy is enabled and scheduled snapshots will be created on the volume associated with this policy.
> policy |  | string | A human readable string describing the name of the snapshot scheduling policy.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDNPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |

snapshot-policy-modify-schedule | [top]

> Modify a snapshot policy

> Input Name | Range | Type | Description
> new-count | [0..255] | integer | The new retention count for the schedule.
> policy |  | snapshot-policy | A human readable string describing the name of the snapshot scheduling policy.
> schedule |  | string | A human readable string describing the name of a schedule whose retention count will be modified. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly','weekly' or 'daily' or it can be user created schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |

snapshot-policy-remove-schedule | [top]

> Remove a snapshot schedule from policy

> Input Name | Range | Type | Description
> policy |  | snapshot-policy | A human readable string describing the name of the snapshot scheduling policy.
> schedule |  | string | A human readable string describing the name of a schedule which will be removed from the snapshot policy. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly','weekly' or 'daily' or it can be a user created schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |

snapshot-reserve-list-info | [top]

> Gets the percentage of disk space that is reserved for snapshots in the indicated volume. If no volume is specified, this will return the percentage of disk space reserved for snapshots for each of the volumes in the system. Reserve space can be used only by snapshots and not by the active file system.

> Input Name | Range | Type | Description
> volume |  | string optional | Volume to get percentage of space reserved for snapshots.
> Output Name | Range | Type | Description
> snapshot-reserve-details |  | snapshot-reserve-detail-info[] | List of volumes along with their snapshot space reservation configuration.

> Errno | Description
> EVOLUMEDOESNOTEXIST |  |
> EVSERVERNOTFOUND |  |
> EVOLUMEBUSY |  |
> EOPNOTSUPPORTED |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOBJECTNOTFOUND |  |

Element definition: snapshot-info | [top]

> One snapshot contained in the specified volume.

> Name | Range | Type | Description
> access-time |  | integer | The volume access time when the snapshot was created in seconds since Jan 1, 1970. This value will not change even if the snapshot is accessed.
> busy |  | boolean | True if the snapshot is being used by an application.
> contains-lun-clones |  | boolean optional | This snapshots contains lun clones. If true, this snapshot contains lun clones. This is available only if the 'lun-clone-snapshot' option is specified.
> cumulative-percentage-of-total-blocks |  | integer | Percentage of blocks owned by this snapshot and all more recent snapshots, relative to the total number of blocks in the volume.
> cumulative-percentage-of-used-blocks |  | integer | Percentage of blocks owned by this snapshot and all more recent snapshots, relative to the number of blocks currently used in the volume.
> cumulative-total |  | integer | Cumulative total of 1024 byte blocks of this snapshot and previous snapshots. If the "terse" input is true, this value is omitted.
> dependency |  | string | Application(s) dependent on this snapshot. Possible values include "snapmirror", "snapvault", "dump", "vclone", "LUNs", "snaplock". Comma separated if more than one application depends on this snapshot.
> is-7-mode-snapshot |  | boolean optional | True if the snapshot is a 7-mode snapshot.
> name |  | string | Name of the snapshot to be listed.
> percentage-of-total-blocks |  | integer | Percentage of blocks owned by this snapshot, relative to the total number of blocks in the volume.
> percentage-of-used-blocks |  | integer | Percentage of blocks owned by this snapshot, relative to the number of blocks currently used in the volume.
> snapshot-instance-uuid |  | UUID optional | The 128 bit unique snapshot identifier expressed in the form of UUID. This field uniquely identifies the snapshot's physical data layout.
> snapshot-owners-list |  | snapshot-owner[] optional | The list of owners of a busy snapshot.
> snapshot-version-uuid |  | UUID optional | The 128 bit unique snapshot identifier expressed in the form of UUID. This field uniquely identifies the snapshot's logical data layout.
> total |  | integer | Number of 1024 byte blocks in the snapshot. If the "terse" input is true, this value is omitted.
> volume |  | string optional | Volume name.
> vserver |  | string optional | Name of the vserver to which this volume belongs. This field is returned only when request is sent to Admin Vserver LIF.

Element definition: snapshot-policy | [top]

> Snapshot Policy

> [none]

Element definition: snapshot-policy-info | [top]

> A typedef containing information about the Snapshot Scheduling Policies. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> comment |  | string optional | A human readable description associated with the snasphot policy. The maximum length of this field can be 255 characters. Attributes: optional-for-create, modifiable
> enabled |  | boolean optional | The state of the snapshot policy. If true, the snapshot policy is enabled and scheduled snapshots will be created on the volume associated with this policy. Attributes: required-for-create, modifiable
> policy |  | snapshot-policy optional | A human readable string describing the name of the snapshot scheduling policy. Attributes: key, required-for-create, non-modifiable
> snapshot-policy-schedules |  | snapshot-schedule-info[] optional | Information about individual snapshot schedules
> total-schedules | [0..5] | integer optional | Total Number of Schedules in this Policy Attributes: non-creatable, non-modifiable

Element definition: snapshot-reserve-detail-info | [top]

> Information about a volume's snapshot space reservation configuration.

> Name | Range | Type | Description
> percentage |  | integer | Percentage of volume reserved for snapshots. Range : [0 - 100].
> size |  | integer | Size in bytes of volume reserved for snapshots. Range : [0 - 2^64-1].
> volume |  | string | Name of volume.
> vserver |  | string optional | Name of the vserver to which this volume belongs. This field is returned only when request is sent to Admin Vserver LIF.

Element definition: UUID | [top]

> The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used. An example of an actual UUID is: 73a010ec-3d28-11df-84e8-123478563412

> [none]

Element definition: snapshot-owner | [top]

> owner of a busy snapshot

> Name | Range | Type | Description
> owner |  | string | Name of the owner of a busy snapshot

Element definition: snapshot-policy | [top]

> Snapshot Policy

> [none]

Element definition: snapshot-schedule-info | [top]

> Information about individual snapshot schedules

> Name | Range | Type | Description
> count | [0..2^32-1] | integer optional | Maximum number of snapshots to retain for the schedule present in the snapshot policy. Attributes: non-creatable, non-modifiable
> prefix |  | string optional | Snapshot name prefix for the schedule present in the snapshot policy. Prefix will be used in the snapshot name instead of the schedule name. If prefix is not provided, schedule name will be used in the snapshot name. For eg, if the prefix name 'hourly-even' is assigned to the schedule name 'hourly' then the snapshot name will look like 'hourly-even.2010-05-10_0205'. If no prefix is associated with the schedule 'hourly' then prefix will be set to 'hourly' as the default value. Attributes: non-creatable, non-modifiable
> schedule |  | string optional | A human readable string describing the name of a schedule present in the snapshot policy. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly', 'weekly','daily' or it can be a user created schedule. Attributes: non-creatable, non-modifiable