APIs in Category: cg | Vserver API version 1.20

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

user-timeout integer
optional
User specified timeout value in seconds. This option can be set if the user wants to specify timeout value other than the default timeouts. The API will return failure if both 'timeout' and 'user-timeout' are specified. The minimum value for this field is equal to the "urgent" timeout. The maximum timeout which can be specified is 120 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 the volume. Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name. Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'. For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

> [none]