APIs in Category: cg | 7-Mode API version 1.20

cg-commit cg-delete cg-start

NetApp Manage ONTAP

cg-commit | [top]

> Commits the snapshots that were started during the preceeding cg-start call that returned the cg-id key, and unfences the volumes that were fenced. If cg-commit API times out, then it means that either too many volumes were specified to the cg-start api or the timeout value for the cg-start api was very small. In this situation, the caller should try to perform the cg-start operation by specifying lesser volumes or by specifying higher timeout value.

> Input Name | Range | Type | Description
> cg-id |  | integer | Key to identify the ongoing cg operation.

> Errno | Description
> EONTAPI_EINVAL |  |
> EVOLUMENOTONLINE |  |
> ECGOFF |  |
> ECGSNAPERR |  |
> ECGERROR |  |
> EONTAPI_ETIMEDOUT |  |
> EVOLUMEBUSY |  |
> ELOCALREVERT |  |
> EVOLUMEREADONLY |  |
> EONTAPI_EVOLOPNOTSUPP |  |
> ENOSPC |  |

> Vfiler-enabled
> Yes

cg-delete | [top]

> Deletes the snaps associated with a CG checkpoint in this filer. This API is deprecated as of Data ONTAP 8.2. Applications using this API should transition to snapshot-multidelete API as appropriate.

> Input Name | Range | Type | Description
> snapshot |  | string | The name of the snapshot that is deleted in each volume.
> volumes |  | volume-name[] | A list of volumes in this filer that is part of this CG operation.

> Errno | Description
> ECGOFF |  |
> EONTAPI_EINVAL |  |
> EVOLUMENOTONLINE |  |
> ECGSNAPDELERR |  |
> ECGERROR |  |

cg-start | [top]

> Starts the checkpoint cycle for externally synchronized checkpoints in the filer. This operation fences the specified volumes and returns "success" (if successful). If the API returns "success", the call starts a snapshot create operation in these volumes. If the API returns "success", this operation SHOULD be followed by a call to cg-commit (below). This API is not supported on Infinite Volume.

> Input Name | Range | Type | Description
> snapshot |  | string | The provided name of the snapshot that is created in each volume. This name is the unique identifier by which the calling agent identifies the snapshots that constitute a checkpoint. The maximum length is 255 characters. (= MAXNAMLEN)
> timeout |  | string optional | Timeout selector. Possible vaules are "urgent", "medium" or "relaxed". If no value is specified, the default value is "medium". Following are the timeout values: "urgent" : 5 seconds "medium" : 7 seconds "relaxed" : 20 seconds

volumes volume-name[]
A list of volumes in this filer that is part of this CG operation.
Output Name Range Type Description
cg-id integer
Identifier of the started cg-start operation. This identifier is used in the succeeding cg-commit call to identify the operation to be commited.

> Errno | Description
> EONTAPI_EINVAL |  |
> EONTAPI_EAGAIN |  |
> EVOLUMENOTONLINE |  |
> EVOLUMEBUSY |  |
> ECGERROR |  |
> EONTAPI_ETIMEDOUT |  |
> EVOLUMEBUSY |  |
> ELOCALREVERT |  |
> EDUPLICATEDSID |  |
> EVOLUMEREADONLY |  |
> EVOLUMEBUSY |  |
> EONTAPI_EVOLOPNOTSUPP |  |

> Vfiler-enabled
> Yes

Element definition: volume-name | [top]

> The name of a volume. The maximum string length is 256 characters.

> [none]