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

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

get list and description of typedefs

Output Name	Range	Type	Description
type-entries		system-api-type-entry-info[]

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. System refers to a node in a cluster.

Input Name	Range	Type	Description
desired-attributes		system-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		system-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the system-info object. All system-info 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		system-info[] optional	The list of attributes of system-info objects.
next-tag		string optional	Tag for the next call. Not present when there are no more system-info objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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.
node-ontapi-details		node-ontapi-detail-info[] optional	List of nodes along with the ONTAPI versions supported by each of them.

Obtain the Data 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, "NetApp".
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 Data ONTAP. The suffix that follows is the NetApp 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 NetApp 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

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.
node-version-details		node-version-detail-info[] optional	List of node names along with the Data ONTAP version running on each node. This field is returned only if the cluster is currently operating with more than one version of Data ONTAP.
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.

Fetch a file from a URL. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.

Input Name	Range	Type	Description
node		string	Node
package		string	Package URL
rename-package		string optional	Rename the File
replace-package		boolean optional	Replace the Local File

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Display software image information

Input Name	Range	Type	Description
desired-attributes		system-image-attributes 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		system-image-attributes optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the system object. All system 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		system-image-attributes[] optional	The list of attributes of system objects.
next-tag		string optional	Tag for the next call. Not present when there are no more system objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Perform software image fresh install

Input Name	Range	Type	Description
node		string	Node
package		string	Package URL
rename-package		string optional	Rename the File
replace-package		boolean optional	Replace the Local File

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Modify software image configuration

Input Name	Range	Type	Description
image		string	Image Name
is-default		boolean optional	Is Default Image
node		string	Node

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Delete a software package

Input Name	Range	Type	Description
node		string	Node
package		string	Package File Name

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Display software information for all packages

Input Name	Range	Type	Description
desired-attributes		system-image-package-attributes 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		system-image-package-attributes optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the system object. All system 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		system-image-package-attributes[] optional	The list of attributes of system objects.
next-tag		string optional	Tag for the next call. Not present when there are no more system objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Perform software image upgrade/downgrade. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.

Input Name	Range	Type	Description
ignore-compatibility		boolean optional	Ignore Version Compatibility Checking
node		string	Node
package		string	Package URL
rename-package		string optional	Rename the File
replace		string optional	Image to Replace
replace-package		boolean optional	Replace the Local File
setdefault		boolean optional	Set Newly Updated Image as Default

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Show progress information for current or previous update

Input Name	Range	Type	Description
node		node-name	Node
Output Name	Range	Type	Description
exit-message		string	Exit Message
exit-status		string	Exit Status
last-message		string	Internal message
phase		string	Phase
run-status		string	Run Status

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Obtain the node information when the node is part of a cluster. Information returned includes details like location, serial-number, asset tag, uptime, vendor name etc.

Input Name	Range	Type	Description
desired-attributes		node-details-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.
node		string	The node name. This is the name defined during setup. The node name could be a maximum of 253 characters long.
Output Name	Range	Type	Description
attributes		node-details-info	The attributes of the system-node.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Obtain the node information when the node is a part of the cluster in an iteration.

Input Name	Range	Type	Description
desired-attributes		node-details-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		node-details-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the system-node object. All system-node 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		node-details-info[] optional	The list of attributes of system-node objects.
next-tag		string optional	Tag for the next call. Not present when there are no more system-node objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Reboot the specified node. Only an admin can reboot the node. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.

Input Name	Range	Type	Description
node		string	The node name. This is the name defined during setup. The node name could be a maximum of 253 characters long.

Errno	Description
EOBJECTNOTFOUND
EAPIPRIVILEGE
EINTERNALERROR

Rename the specified node to a new name specified by 'new-name'

Input Name	Range	Type	Description
new-name		string	New Name
node		string	The node name. This is the name defined during setup. The node name could be a maximum of 253 characters long.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Shut down a node. Only an admin can initiate a node shutdown. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.

Input Name	Range	Type	Description
node		string	The node name. This is the name defined during setup. The node name could be a maximum of 253 characters long.

Errno	Description
EOBJECTNOTFOUND
EAPIPRIVILEGE
EINTERNALERROR

name of the API

[none]

Contains information about a specific node 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
node		string optional	The node name. This is the name defined during setup. The node name could be a maximum of 253 characters long. Attributes: key, non-creatable, non-modifiable
node-asset-tag		string optional	The asset tag of the node. This is defined by the vendor. Currently, a string of numbers. Attributes: non-creatable, modifiable
node-location		string optional	The physical location of the node. For example, Sunnyvale. Attributes: non-creatable, modifiable
node-model		string optional	The model of the node. For example, FAS3070. Attributes: non-creatable, non-modifiable
node-nvram-id		integer optional	Vendor specific NVRAM ID of the node. Attributes: non-creatable, non-modifiable
node-owner		string optional	The owner of the node. Attributes: non-creatable, modifiable
node-serial-number		string optional	The serial number of the node. This is defined by the vendor. Currently, a string of numbers. Attributes: non-creatable, non-modifiable
node-uptime	[0..2^32-1]	integer optional	Total time, in seconds, that the node has been up. Attributes: non-creatable, non-modifiable
node-uuid		string optional	The univerally unique identifier for the node. It is a 36-character string composed of 32 hexadecimal characters. For example, '542366ea-a024-11dd-9caa-7302e474c5ae'. Attributes: non-creatable, non-modifiable
node-vendor		string optional	The hardware vendor of the node. Attributes: non-creatable, non-modifiable

The node's name

[none]

The node names along with the ONTAPI version on the respective node.

Name	Range	Type	Description
major-version		integer	Current ONTAPI major version supported by this node. Range: [0..2^31-1].
minor-version		integer	Current ONTAPI minor version supported by this node. Range: [0..2^31-1].
node-name		string	Name of the node.
node-uuid		string	UUID, Universal Unique IDentifier, of the node.

The node names along with the ONTAP version on the respective node.

Name	Range	Type	Description
build-timestamp		integer optional	Time of build creation, in seconds since January 1, 1970, of the image running on the node. This field is available in Data ONTAP 8.1 or later.
node-name		string	Name of the node.
node-uuid		string	UUID, Universal Unique IDentifier, of the node.
version		string	Data ONTAP version running on the node.

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

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

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

These attributes describe or modify the configuration of the nodes's boot images. 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
image		string optional	Image Name Attributes: key, non-creatable, non-modifiable
install-time		datetime optional	Install Date Attributes: non-creatable, non-modifiable
is-current		boolean optional	Is Current Image Attributes: non-creatable, non-modifiable
is-default		boolean optional	Is Default Image Attributes: non-creatable, modifiable
kernel-path		string optional	Kernel Image Path Attributes: non-creatable, non-modifiable
node		string optional	Node Attributes: key, non-creatable, non-modifiable
rootfs-path		string optional	Root Filesystem Image Path Attributes: non-creatable, non-modifiable
version		string optional	Software Version Attributes: non-creatable, non-modifiable

These attributes provide details about the software packages available on the system. 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
node		string optional	Node Attributes: key, non-creatable, non-modifiable
package		string optional	Package File Name Attributes: key, optional-for-create, non-modifiable

Information about the system. Here system refers to a cluster node when running in cluster mode.

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 the vendor
controller-address		string optional	The location of the controller in a multi-controller platform. Defined by the platform layer. Possible values: A,B,C,...
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. Currently a string of numbers.
prod-type		string optional	Will be set to "V-Series" to indicate a v-series system for NetApp 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 the vendor. 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.Currently a string of numbers.
vendor-id		string	Hardware vendor identifier. For example, "NetApp".

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.

The number of seconds since January 1, 1970. Range : [0..2^31-1].

[none]

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