APIs in Category: snapshot |
API version 6.1 |
snapshot-expire |
Enables the user to display Snapshot copy locations and volume Snapshot metadata, and to set metadata values. |
snapshot-expire | [top] |
Deletes an existing volume snapshot. If the snapshot is currently active (e.g. involved in SnapMirror transfer, baseline snapshot of SnapVault etc.), then the snapshot will be marked as expired. Such expired snapshots will be deleted subsequently when no longer needed.
Input Name Range Type Description snapshot-resource-key resource-key
Resource key of the volume snapshot to expire. If the snapshot specified is not found on the storage system, ESNAPSHOTNOTFOUND is returned.
Errno Description EOBJECTNOTFOUND EINVALIDINPUT ESNAPSHOTNOTFOUND EINVALIDOBJECTTYPE
snapshot-get-location | [top] |
Gets location of the replicas of the requested Snapshot copies.
Input Name Range Type Description snapshot-identifiers snapshot-identifier[]
Information about the snapshot copies whose replica locations are being requested. Specified snapshot-identifier is first resolved to a version-uuid and then the snapshot copies for all the volumes currently in the input storage service and connected to the input volume, with the matching version-uuid are returned. You can specify the following combination of attributes in each snapshot-identifier: Any other combination of these attributes specified in the snapshot-identifier is invalid and EINVALIDINPUT error is returned. If an invalid version-uuid is specified in input snapshot-identifier, empty results will be returned for that identifier.
- version-uuid and volume-resource-key, or
- snapshot-resource-key only.
storage-service-node-resource-key resource-key
optional
Resource key of the storage service node. Location of snapshots are returned for only those volumes which are currently in this storage service node. storage-service-resource-key resource-key
Resource key of the storage service. Location of snapshots are returned for only those volumes which are currently in this storage service. Matching snapshot locations on the relationships that are relinquished, or on the relationships in a different storage service, are not returned. Output Name Range Type Description snapshot-location-results snapshot-location-result-info[]
Snapshot locations.
Errno Description EINVALIDINPUT EOBJECTNOTFOUND ESNAPSHOTNOTFOUND E_INVALID_RESOURCE_KEY EINVALIDOBJECTTYPE
snapshot-get-metadata | [top] |
Returns metadata associated with a snapshot.
Input Name Range Type Description snapshot-resource-key resource-key
Resource key of the volume snapshot associated with the metadata. Output Name Range Type Description metadata key-value-pair[]
Opaque metadata for this context. Metadata is usually set and interpreted by an external application. OnCommand Unified Manager does not look into the contents of the metadata.
Errno Description EOBJECTNOTFOUND EINVALIDINPUT
snapshot-has-expired | [top] |
Checks if the specified volume snapshot has expired.
Input Name Range Type Description snapshot-resource-key resource-key
Resource key of the volume snapshot whose expiration status is being determined. If the snapshot specified is not found on the storage system, ESNAPSHOTNOTFOUND is returned. Output Name Range Type Description expiration-status boolean
Returns true if the specified snapshot is currently marked as expired, false otherwise.
Errno Description EOBJECTNOTFOUND EINVALIDINPUT ESNAPSHOTNOTFOUND EINVALIDOBJECTTYPE
snapshot-set-metadata | [top] |
Sets metadata for an existing volume snapshot. The metadata is automatically deleted when associated snapshot is removed.
Input Name Range Type Description metadata key-value-pair[]
Opaque metadata for this snapshot. Metadata is usually set and interpreted by an external application. OnCommand Unified Manager does not look into the contents of metadata. Existing metadata will be removed if not included in the input. A maximum of 16 key value pairs are allowed per snapshot. If number of entries exceed this number, E_MAX_ENTRY_COUNT_EXCEEDED is returned.
Keys in each pair can be 1 to 255 characters in length and are case-sensitive. Duplicate keys are not allowed. Values are opaque to the server and must not exceed 16384 (16k) characters in length. If any of these rules are violated, EINVALIDINPUT error will be returned.
snapshot-resource-key resource-key
Resource key of the volume snapshot to be associated with the metadata.
Errno Description EOBJECTNOTFOUND EINVALIDINPUT E_MAX_ENTRY_COUNT_EXCEEDED
Element definition: key-value-pair | [top] |
The key/value for a generic object attribute.
Name Range Type Description key string
key of the generic object attribute value string
Value of the generic object attribute
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: snapshot-identifier | [top] |
Information used to identify a Snapshot copy within the storage system. In some cases the snapshot-identifier element might match multiple Snapshot copies. A unique match in the result is guaranteed, if 'snapshot-resource-key' is provided in the input of snapshot-identifier.
Name Range Type Description snapshot-name string
optional
Name of the Snapshot copy. A volume-resource-key value is required when snapshot-name is specified. snapshot-resource-key resource-key
optional
Resource key of the Snapshot copy. This is the immutable natural key to uniquely identify a snapshot on Data ONTAP. snapshot-version-uuid uuid
optional
A unique identifier of this Snapshot copy and its logical data layout. If any two Snapshot copies exist that have the same version UUID, their contents must be logically equivalent. Snapshot copies within the same volume might have the same snapshot-version-uuid. volume-resource-key resource-key
optional
Resource key of the original source volume where the Snapshot copy resides.
Element definition: snapshot-location-result-info | [top] |
Results for the replica locations of the specified snapshot copy.
Name Range Type Description requested-snapshot-identifier snapshot-identifier
Snapshot identifier as specified in the input. snapshot-locations snapshot-location-info[]
Information about where the replicas of the specified snapshot copy are located. List is empty if no replicas were found for the specified criteria.
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: snapshot-identifier | [top] |
Information used to identify a Snapshot copy within the storage system. In some cases the snapshot-identifier element might match multiple Snapshot copies. A unique match in the result is guaranteed, if 'snapshot-resource-key' is provided in the input of snapshot-identifier.
Name Range Type Description snapshot-name string
optional
Name of the Snapshot copy. A volume-resource-key value is required when snapshot-name is specified. snapshot-resource-key resource-key
optional
Resource key of the Snapshot copy. This is the immutable natural key to uniquely identify a snapshot on Data ONTAP. snapshot-version-uuid uuid
optional
A unique identifier of this Snapshot copy and its logical data layout. If any two Snapshot copies exist that have the same version UUID, their contents must be logically equivalent. Snapshot copies within the same volume might have the same snapshot-version-uuid. volume-resource-key resource-key
optional
Resource key of the original source volume where the Snapshot copy resides.
Element definition: snapshot-location-info | [top] |
Information about where a replica of the specified snapshot copy is located.
Name Range Type Description node-name obj-name
optional
Name of the storage service node that the volume is a member of. node-resource-key resource-key
optional
Resource key of the storage service node that the volume is a member of. snapshot-instance-uuid uuid
This ID uniquely identifies a snapshot copy and its physical data layout. If any two snapshot copies in the world have the same instance UUID, they must be different instances of the exact same snapshot copy. Snapshot copies within the same volume must have different snapshot-instance-uuids. snapshot-name string
Name of the snapshot copy that was found. snapshot-resource-key resource-key
Resource key of the snapshot copy that was found. snapshot-version-uuid uuid
This ID identifies a snapshot copy and its logical data layout. If any two snapshot copies in the world have the same version UUID, their contents must be logically equivalent. Snapshot copies within the same volume may have the same snapshot-version-uuid. storage-service-name obj-name
Name of the storage service that the volume is a member of. storage-service-resource-key resource-key
Resource key of the storage service that the volume is a member of. volume-name obj-full-name
Name of the volume which holds the snapshot copy that was found. volume-resource-key resource-key
The resource key for the volume which holds the snapshot copy that was found.
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 5 groupings separated by '-'s. The first grouping consists of 8 hex characters, the second through fourth groupings consist of 4 hex characters each, and the fifth and final grouping consists of 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: obj-full-name | [top] |
Full name of an object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long. Full names are created by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows:
For any object not listed above, the obj-name and obj-full-name are identical.
- cluster full names are the either the fully-qualified domain name or the IP address of the cluster.
- cluster-node full names are the either the fully-qualified domain name or the IP address of the cluster.
- aggregate full names are the cluster-node name and the aggregate name, separated by a colon, e.g. cluster-node:aggr0.
- volume full names are the vserver name and the volume name, separated by ":/", e.g. vserver:/volume. Note this does not include the "/vol" prefix. Volume and aggregate full names are distinguished by the presence of a forward slash after the colon.
- qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. vserver:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. vserver:/volume/-.
- lun full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. vserver:/volume/LUN or vserver:/volume/qtree/LUN.
- initiator-group full names are vserver name and the initiator group name, separated by a colon, e.g. vserver:igroup.
- export-policy full names are vserver name and the policy name, separated by a colon, e.g. vserver:policy-name.
- lif full names are a cluster, cluster-node, or vserver name and the interface name, separated by a colon, e.g. cluster-name|cluster-node-name|vserver-name:lif.
- port-set full names are the vserver name and the portset name, separated by a colon, e.g. vserver:portset.
- fcp-target full names are the cluster-node name and the target name, separated by a colon, e.g. cluster-node:target.
[none]
Element definition: obj-name | [top] |
Name of an object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format: The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules:
- It must contain between 1 and 64 characters.
- It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
- In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all.
A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior.
- If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUT. Note that because EINVALIDINPUT is such a common error code, ZAPI specifications are not required to document cases when they may return it.
- If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code.
If an input name element is used to refer to an existing object, then the ZAPI specification must specify which object type (e.g. cluster, vserver, volume etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats.
Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name.
[none]
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]