|
APIs in Category: system |
Vserver API version 1.15 |
system-api-get-elements |
| system-api-get-elements | [top] |
get elements for specified apis
Input Name Range Type Description api-list api-list-info[]
list of apis to retrieve Output Name Range Type Description api-entries system-api-entry-info[]
Errno Description EAPIERROR
Vfiler-enabled Yes
| system-api-list | [top] |
get list of apis. This returns the names only - to get the parameter info, use system-api-get-elements
Output Name Range Type Description apis system-api-info[]
Errno Description EAPIERROR
Vfiler-enabled Yes
| system-api-list-types | [top] |
get list and description of typedefs
Output Name Range Type Description type-entries system-api-type-entry-info[]
Vfiler-enabled Yes
| system-get-ontapi-version | [top] |
Obtain the current ONTAPI major and minor versions.
Output Name Range Type Description major-version integer
Current ONTAPI major version supported by this appliance. minor-version integer
Current ONTAPI minor version supported by this appliance.
Vfiler-enabled Yes
| system-get-version | [top] |
Obtain the Data ONTAP version.
Output Name Range Type Description build-timestamp integer
optional
Time of build creation, in seconds since January 1, 1970, of the image running on the appliance or of the build whose Data ONTAP version is lowest across the cluster. This field is available in Data ONTAP 8.1 or later. is-clustered boolean
If true, indicates Data ONTAP Cluster-Mode, else Data ONTAP 7-Mode. This field is available in Data ONTAP 8.1 or later. version string
Current Data ONTAP version running on the appliance. If the cluster is currently operating with more than one version of Data ONTAP, then the lowest version of all is returned. version-tuple system-version-tuple
optional
The Data ONTAP version tuple, lowest across the cluster i.e. the effective cluster version. This field is available in Data ONTAP 8.1 or later.
Vfiler-enabled Yes
| Element definition: api-list-info | [top] |
name of the API
[none]
| Element definition: system-api-entry-info | [top] |
list of api names and their elements
Name Range Type Description api-elements system-api-element-info[]
list of api elements name string
api name
| Element definition: system-api-info | [top] |
api information
Name Range Type Description is-streaming boolean
optional
does api stream data? license string
optional
license needed if any name string
name of api
| Element definition: system-api-type-entry-info | [top] |
list of type names and their elements
Name Range Type Description name string
type name type-elements system-api-element-info[]
list of type elements
| Element definition: system-version-tuple | [top] |
Contains the Data ONTAP version tuple corresponding to the lowest version across the cluster.
Name Range Type Description generation integer
First integer of the Data ONTAP version tuple corresponding the lowest version across the cluster. major integer
Second integer of the Data ONTAP version tuple corresponding the lowest version across the cluster. minor integer
Third integer of the Data ONTAP version tuple corresponding the lowest version across the cluster.
| Element definition: system-api-element-info | [top] |
api element description. This can be a simple type or a reference to another typedef (as defined in the 'type' element. Arrays are signified by having '[]' appended to the type name.
Name Range Type Description encrypted string
optional
encryption type. If missing the parameter isn't encrypted is-nonempty boolean
optional
must element be non-empty. If false or missing element value may be empty. is-optional boolean
optional
is element optional. If false or missing element is required. is-output boolean
optional
is element an output element. If false or missing then is an input element is-validated boolean
optional
argument will have strong validation done by the server (e.g. integer range). If false or empty, no validation will be done. name string
name of element type string
type of variable possible values: "string", "integer", "boolean", type-name