|
APIs in Category: flexcache |
Cluster-Mode API version 1.15 |
flexcache-cache-policy-get-iter |
These APIs manage the following FlexCache entities: |
| flexcache-cache-policy-get-iter | [top] |
Iterate over a list of flexcache-cache-policy objects.
Input Name Range Type Description desired-attributes flexcache-cache-policy-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..100] integer
optional
The maximum number of records to return in this call. Default: 20 query flexcache-cache-policy-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the flexcache-cache-policy object. All flexcache-cache-policy 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-cache-policy-info[]
optional
The list of attributes of flexcache-cache-policy objects. next-tag string
optional
Tag for the next call. Not present when there are no more flexcache-cache-policy objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| 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 Name
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-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..100] 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..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| flexcache-options-get | [top] |
Get the cluster-wide attributes of FlexCache.
Input Name Range Type Description desired-attributes flexcache-options-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-options-info
The attributes of the flexcache-options.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| flexcache-options-modify | [top] |
Modify the cluster-wide attributes of FlexCache.
Input Name Range Type Description delegations-high-watermark [0..2^32-1] integer
optional
This is the maximum number of delegations that can be given out per node in the cluster. When this limit is reached, no further delegations can be given out to Cache clients. delegations-low-watermark [0..2^32-1] integer
optional
This is the number of delegations per node, at which the node resumes giving out delegations to Cache clients. per-cache-statistics boolean
optional
Keep statistics per cache volume basis
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| Element definition: flexcache-cache-policy-info | [top] |
FlexCache Cache Policy 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-policy-name string
optional
The name of the FlexCache Cache Policy being created, modified or deleted. The maximum length is 255 characters. Attributes: key, required-for-create, non-modifiable time-to-live-directories [0..2^32-1] integer
optional
The Time To Live (TTL) for Directories represents the time, in seconds, that attributes and data of a Directory are fetched from the Cache volume, rather than going to the Origin Volume. Attributes: optional-for-create, modifiable time-to-live-files [0..2^32-1] integer
optional
The Time To Live (TTL) for files represents the time, in seconds, that attributes and data of a file are fetched from the Cache volume, rather than going to the Origin Volume. Attributes: optional-for-create, modifiable vserver string
optional
The name of the managing Vserver. Maximum length is 255 characters. Attributes: key, non-creatable, non-modifiable
| 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"
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"
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
| Element definition: flexcache-options-info | [top] |
FlexCache Options 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 delegations-high-watermark [0..2^32-1] integer
optional
This is the maximum number of delegations that can be given out per node in the cluster. When this limit is reached, no further delegations can be given out to Cache clients. Attributes: non-creatable, modifiable delegations-low-watermark [0..2^32-1] integer
optional
This is the number of delegations per node, at which the node resumes giving out delegations to Cache clients. Attributes: non-creatable, modifiable per-cache-statistics boolean
optional
Keep statistics per cache volume basis Attributes: non-creatable, modifiable