APIs in Category: flexcache | Vserver API version 1.21

flexcache-create flexcache-delete flexcache-get flexcache-get-iter | These APIs control the following FlexCache entities: cache-policy: Manage policies that define caching parameters like file TTLs. flexcache: Create and delete cluster-wide caching.

NetApp Manage ONTAP

flexcache-create | [top]

> Create cluster-wide caching for a given volume.

> Input Name | Range | Type | Description
> origin-volume |  | string | Origin Volume Name
> vserver |  | string | Vserver

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

flexcache-delete | [top]

> Delete cluster-wide caching for a given volume.

> Input Name | Range | Type | Description
> origin-volume |  | string | Origin Volume Name
> vserver |  | string | Vserver Name

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

flexcache-get | [top]

> Get the attributes of the flexcache.

> Input Name | Range | Type | Description
> cache-volume |  | string | Cache Volume Name
> desired-attributes |  | flexcache-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> Output Name | Range | Type | Description
> attributes |  | flexcache-info | The attributes of the flexcache.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

flexcache-get-iter | [top]

> Iterate over a list of flexcache objects.

> Input Name | Range | Type | Description
> desired-attributes |  | flexcache-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | flexcache-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the flexcache object. All flexcache objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | flexcache-info[] optional | The list of attributes of flexcache objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more flexcache objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

Element definition: flexcache-info | [top]

> FlexCache Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> cache-aggregate |  | string optional | Cache Aggregate Name Attributes: non-creatable, non-modifiable
> cache-available | [0..2^63-1] | integer optional | Cache Available Size Attributes: non-creatable, non-modifiable
> cache-percent-used | [0..100] | integer optional | Cache Used Percentage Attributes: non-creatable, non-modifiable
> cache-size | [0..2^63-1] | integer optional | Cache Volume Size Attributes: non-creatable, non-modifiable
> cache-state |  | string optional | Cache Volume State Attributes: non-creatable, non-modifiable Possible values: "online" , "restricted" , "offline" , "force_online" , "force_offline" , "mixed"
> cache-volume |  | string optional | Cache Volume Name Attributes: key, non-creatable, non-modifiable
> connection-status |  | string optional | The status of the connection between the cache and the origin volumes. It can be 'connected', 'disconnected' or 'connecting'. Attributes: non-creatable, non-modifiable
> origin-aggregate |  | string optional | Origin Aggregate Name Attributes: non-creatable, non-modifiable
> origin-state |  | string optional | Origin Volume State Attributes: non-creatable, non-modifiable Possible values: "online" , "restricted" , "offline" , "force_online" , "force_offline" , "mixed"
> origin-volume |  | string optional | Origin volume name that contains the authoritative data. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | The name of the Vserver where the created cache is located. Maximum length is 255 characters. Attributes: key, non-creatable, non-modifiable