APIs in Category: system | 7-Mode API version 1.21

system-api-get-elements system-api-list system-api-list-types system-available-replication-transfers system-get-info system-get-ontapi-version system-get-vendor-info system-get-version

NetApp Manage ONTAP

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-available-replication-transfers | [top]

> Provide a mechanism to calculate the number of replication operations that could be started. Returns the number of replication operations that could be started for each replication type. Another output is the maximum number of transfers for each replication type.

> Output Name | Range | Type | Description
> replication-transfer-table |  | replication-transfer-info[] | Table with entries mapping each replication operation to number of transfers which could be started.

> 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 Data ONTAP vendor information.

> Output Name | Range | Type | Description
> autosupport-email |  | string | Vendor's AutoSupport e-mail target.
> autosupport-url |  | string | Vendor's AutoSupport URL target.
> complete-name |  | string | Complete name of vendor.
> customer-support-contact |  | string | Vendor's technical support contact information.
> customer-support-name |  | string | Name of vendor's customer support organization.
> information-url |  | string | Vendor's AutoSupport information URL.
> ontap-oid-prefix |  | string | Vendor's starting SNMP OID prefix for Data ONTAP. The suffix that follows is the storage system 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 storage system MIB.
> product-url |  | string | Vendor's installed product information URL.
> short-name |  | string | Vendor's short name.

> Errno | Description
> EAPIERROR |  |

> Vfiler-enabled
> Yes

system-get-version | [top]

> Obtain the Data ONTAP version.

> Output Name | Range | Type | Description
> 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.

> Vfiler-enabled
> Yes

Element definition: api-list-info | [top]

> name of the API

> [none]

Element definition: replication-transfer-info | [top]

> Structure of each entry in the transfer accounting table

> Name | Range | Type | Description
> replication-available-transfers |  | integer | Number of transfers that could be started at this point in time, if we choose only this particular replication type. Range:[0..2^32-1]
> replication-maximum-transfers |  | integer | Maximum number of transfers that can be started, if we choose only this particular replication type. Range:[1..2^32-1]
> replication-type |  | string | Type of replication operation. Qtree-snapmirror/SnapVault have two core data transfer mechanisms which they can utilize for data transfer. One is the legacy engine and the other is the newer engine. By default Data ONTAP enables the new engine. The user can choose to flip between the new engine and legacy engine. options-get api with an input of replication.logical.transfer_limits can be used to detect the type of engine. "current" implies a new engine while "previous" implies the legacy engine. Open Systems SnapVault (OSSV) always uses the legacy engine for transfers. Legacy volume-snapmirror limits are used when data resides on a traditional volume. Possible values of a replication operation are "legacy_qtree_snapmirror_source"; "legacy_qtree_snapmirror_destination"; "qtree_snapmirror_source"; "qtree_snapmirror_destination"; "legacy_volume_snapmirror_source"; "legacy_volume_snapmirror_destination"; "volume_snapmirror_source"; "volume_snapmirror_destination"; "legacy_snapvault_source"; "legacy_snapvault_destination"; "snapvault_source"; "snapvault_destination"; "sync_snapmirror_source"; "sync_snapmirror_destination"; "volume_copy_source"; "volume_copy_destination";

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. 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 |  | integer | cpu's microcode version. Defined by the CPU manufacturer. Range: [0..2^31-1]
> 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.
> maximum-aggregate-size | [0..2^64-1] | integer optional | The platform's maximum aggregate size in bytes.
> maximum-flexible-volume-count | [0..2^32-1] | integer optional | The platform's maximum number of flexible volumes supported on this node. This does not include the number of volumes which can be supported when this node does a takeover of its partner node in a High Availability configuration.
> maximum-flexible-volume-size | [0..2^64-1] | integer optional | The platform's maximum flexible volume size in bytes.
> 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","gfiler" or "gateway" depending upon the vendor providing the raw storage.
> 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.
> vm-system-disks |  | vm-system-disks optional | Backing info for the Data ONTAP-v system disks
> vmhost-info |  | vmhost-info optional | Info block for the hypervisor physical node on Data ONTAP-v

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

Element definition: vm-system-disks | [top]

> Storage info block for the hypervisor physical node on Data ONTAP-v (VSA)

> Name | Range | Type | Description
> vm-bootdisk-area-name |  | string optional | The name of the hypervisor's storage area for the VMs bootdisk. For ESX this is the name of a datastore.
> vm-bootdisk-file-name |  | string optional | The hypervisor's filename for the VMs bootdisk.
> vm-coredisk-area-name |  | string optional | The name of the hypervisor's storage area for the VMs coredump and swap disk. For ESX this is the name of a datastore.
> vm-coredisk-file-name |  | string optional | The hypervisor's filename for the VMs coredump disk.
> vm-logdisk-area-name |  | string optional | The name of the hypervisor's storage area for the VMs log disk. For ESX this is the name of a datastore.
> vm-logdisk-file-name |  | string optional | The hypervisor's filename for the VMs log disk.

Element definition: vmhost-info | [top]

> Storage info block for the hypervisor physical node on Data ONTAP-v (VSA)

> Name | Range | Type | Description
> vmhost-bios-release-date |  | string optional | The BIOS release date of the hypervisor machine.
> vmhost-bios-version |  | string optional | The BIOS version of the hypervisor machine.
> vmhost-cpu-clock-rate | [0..2^32-1] | integer optional | The CPU speed of the hypervisor machine (in MHz).
> vmhost-cpu-core-count | [0..2^16-1] | integer optional | The number of CPU cores of the hypervisor machine.
> vmhost-cpu-socket-count | [0..2^16-1] | integer optional | The number of CPU sockets of the hypervisor machine.
> vmhost-cpu-thread-count | [0..2^16-1] | integer optional | The number of CPU threads of the hypervisor machine.
> vmhost-hardware-vendor |  | string optional | The hardware vendor of the hypervisor machine. No hypervisor login required.
> vmhost-hypervisor |  | string optional | The hypervisor version.
> vmhost-memory | [0..2^16-1] | integer optional | The amount of physical memory in the hypervisor machine (in bytes).
> vmhost-model |  | string optional | The hardware model of the hypervisor machine. No hypervisor login required.
> vmhost-name |  | string optional | The hostname of the hypervisor machine.
> vmhost-uuid |  | string optional | UUID, Universal Unique Identifier, of the hypervisor.