|
APIs in Category: system |
API version 1.6 |
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-info | [top] |
Obtain appliance information which includes cpu and backplane information. The output contains the head information in a sysconfig -a command. I/O information is not included.
Output Name Range Type Description system-info system-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-vendor-info | [top] |
Obtain the ONTAP vendor information.
Output Name Range Type Description autosupport-email string
Vendor's autosupport e-mail target. Example is: "autosupport@netapp.com". autosupport-url string
Vendor's autosupport URL target. Example is: "http://support.netapp.com/asupprod/post/1.0/postAsup". complete-name string
Complete name of vendor. For example, "Network Appliance". customer-support-contact string
Vendor's technical support contact information. For example, "Please contact NetApp Global Services.". Could include a global phone number. customer-support-name string
Name of vendor's customer support organization. For example, "NetApp Global Services". information-url string
Vendor's information URL. For example, "http://now.netapp.com/autosupport/" ontap-oid-prefix string
Vendor's starting SNMP OID prefix for ONTAP. The suffix that follows is the Network Appliance MIB, netapp.mib. For example, ".1.3.6.1.4.1.789". To obtain the filer's model name, one would concatenate the OID prefix and ".1.1.5.0" from the Network Appliance MIB. product-url string
Vendor's product information URL. For example, "http://now.netapp.com/installedproducts/" short-name string
Vendor's short name. For example, "NetApp".
Errno Description EAPIERROR
Vfiler-enabled Yes
| system-get-version | [top] |
Obtain the ONTAP version.
Output Name Range Type Description version string
Current ONTAP version running on the appliance.
Vfiler-enabled Yes
| Element definition: api-list-info | [top] |
[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-info | [top] |
Information about the system
Name Range Type Description backplane-part-number string
optional
Part number of the backplane. backplane-revision string
optional
Revision of the backplane part number. backplane-serial-number string
optional
Backplane serial number. board-speed integer
Speed of the system board in mega Hertz. board-type string
Type of the system board. This is defined by Network Appliance. An example is: NetApp System Board VII D0. cpu-ciob-revision-id string
optional
Processor's CIOB (Champion I/O Bus) revision ID. Defined by the CPU manufacturer. cpu-firmware-release string
optional
Firmware release number. Defined by the CPU manufacturer. cpu-microcode-version string
optional
cpu's microcode version. Defined by the CPU manufacturer. cpu-part-number string
optional
CPU's part number. Defined by the CPU manufacturer. cpu-processor-id string
optional
Processor's ID. Defined by the CPU manufacturer. cpu-processor-type string
optional
Processor's Type. Defined by the CPU manufacturer. cpu-revision string
optional
CPU's part number revision. Defined by the CPU manufacturer. cpu-serial-number string
optional
CPU's serial number. Defined by the CPU manufacturer. memory-size integer
Memory size in megabytes. (1024*1024). number-of-processors integer
Number of processors in the appliance. partner-system-id string
optional
Partner's system ID. Displayed in a cluster environment. A string of 10 characters. partner-system-name string
optional
Partner's system name. Displayed in a cluster environment. Defined in the partner's setup. partner-system-serial-number string
optional
Partner System serial number. This is defined by Network Appliance. Currently a string of numbers. prod-type string
optional
Will be set to "V-Series" to indicate a v-series system, or to "gFiler" to indicate gFiler system for Network Appliance filers. For IBM filers, "gateway" will used. supports-raid-array boolean
Indicates whether the system supports raid arrays back-end connectivity or not. Possible values: "true" or "false". system-id string
System ID. This is defined by Network Appliance. Currently, it is a string of numbers system-machine-type string
Machine type of the system, like FAS3050 system-model string
Model name of the system, like FAS3050 system-name string
System name. This is the name defined during setup. system-revision string
optional
System revision. There revision id of the system board. Currently, a character followed by a number, B0. system-serial-number string
optional
System serial number. This is defined by Network Appliance. Currently a string of numbers. vendor-id string
Hardware vendor identifier. For example, "NetApp".
| 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