APIs in Category: wafl | Vserver API version 1.21

wafl-get-sync-status wafl-sync

NetApp Manage ONTAP

wafl-get-sync-status | [top]

> Returns the status of the previously issued asynchronous Consistency Point operations.

> Input Name | Range | Type | Description
> sync-handle |  | wafl-sync-handle | Handle representing a previously issued wafl-sync operation.
> Output Name | Range | Type | Description
> status |  | string optional | Status information about the previous CP request on volume. Possible values: "failed", "in_progress", "succeeded".

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

wafl-sync | [top]

> Forces a WAFL consistency point (CP) in order to reduce the time for succeeding fence and snapshot related operations. In Data ONTAP 7-Mode this call is synchronous and will not return until the CP has completed. In Data ONTAP Cluster-Mode this API is asynchronous and will return immediately as soon as the CP is scheduled. The wafl-get-sync-status API can be used to check status of the previously scheduled CP. Two uses of this API are to predict how fast a successive consistency group based operation will finish, to improve performance of succeeding consistency group primitives.

> Input Name | Range | Type | Description
> volumes |  | volume-name[] optional | A list of volume names to take a CP on. In Data ONTAP 7-Mode, the CP operation will be performed on all the volumes on the controller if no volumes are specified. In Data ONTAP Cluster-Mode, "volumes" is a required input and all specified volumes must belong to the same Vserver. If an error is encountered when processing the sync request for a volume, the operation is aborted and sync operation will not be performed on the rest of the volumes specified.
> Output Name | Range | Type | Description
> handles |  | wafl-sync-handle[] optional | List of handles to be used to query the sync status using 'wafl-get-sync-status' ZAPI.

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

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

Element definition: wafl-sync-handle | [top]

> Handle representing a specific wafl-sync operation on a volume.

> Name | Range | Type | Description
> handle | [0..2^32-1] | integer | Opaque handle that represents a specific wafl-sync operation.
> volume |  | volume-name optional | Volume name on which wafl-sync operation being performed.
> volume-uuid |  | uuid optional | Volume UUID on which wafl-sync operation being performed.

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.

> [none]

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]