APIs in Category: consistency | 7-Mode API version 1.17

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.

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

> Vfiler-enabled
> Yes

cg-delete | [top]

> Deletes the snaps assiciated with a CG checkpoint in this filer.

> 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 |  |
> ECGSNAPERR |  |
> 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 snap create operation in these volumes. If the API returns "success", this operation SHOULD be followed by a call to cg-commit (below).

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

> Vfiler-enabled
> Yes

Element definition: volume-name | [top]

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

> [none]