system

Contributors

external-cache-dumplog

This ONTAPI call does not have an equivalent REST API call.

external-cache-get

This ONTAPI call does not have an equivalent REST API call.

external-cache-modify

This ONTAPI call does not have an equivalent REST API call.

external-cache-reconstruct

This ONTAPI call does not have an equivalent REST API call.

external-cache-reset

This ONTAPI call does not have an equivalent REST API call.

external-cache-snapshot

This ONTAPI call does not have an equivalent REST API call.

system-api-change-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-api-get-elements

This ONTAPI call does not have an equivalent REST API call.

system-api-list

This ONTAPI call does not have an equivalent REST API call.

system-api-list-types

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-disable

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-enable

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-get

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-get-node-info-iter

GET /api/cluster/nodes

Note: Get the nodes in the cluster

ONTAPI attribute REST attribute Comment

backplane-part-number

No REST Equivalent

backplane-revision

No REST Equivalent

backplane-serial-number

No REST Equivalent

board-speed

No REST Equivalent

board-type

No REST Equivalent

controller-address

No REST Equivalent

cpu-firmware-release

No REST Equivalent

cpu-microcode-version

No REST Equivalent

cpu-part-number

No REST Equivalent

cpu-processor-id

No REST Equivalent

cpu-processor-type

No REST Equivalent

cpu-revision

No REST Equivalent

cpu-serial-number

No REST Equivalent

maximum-aggregate-size

No REST Equivalent

maximum-flexible-volume-count

No REST Equivalent

maximum-flexible-volume-size

No REST Equivalent

memory-size

No REST Equivalent

number-of-processors

No REST Equivalent

partner-system-id

ha.partners.uuid

Partner system-id

partner-system-name

ha.partners.name

Partner system-name

partner-system-serial-number

No REST Equivalent

prod-type

No REST Equivalent

storage-configuration

No REST Equivalent

supports-raid-array

No REST Equivalent

system-id

system_id

system-machine-type

system_machine_type

OEM system machine type.

system-model

model

system-name

name

system-revision

version

system-serial-number

serial_number

vendor-data1

vendor_serial_number

OEM vendor serial number.

vendor-data2

No REST Equivalent

vendor-data3

No REST Equivalent

vendor-id

No REST Equivalent

vm-system-disks

No REST Equivalent

vmhost-info

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

system-get-ontapi-version

This ONTAPI call does not have an equivalent REST API call.

system-get-vendor-info

This ONTAPI call does not have an equivalent REST API call.

system-get-version

GET /api/cluster/nodes/{uuid}

ONTAPI attribute REST attribute Comment

build-timestamp

version.full

version

version.full

is-clustered

No REST Equivalent

node-version-details

version

node-version-detail-info.build-timestamp → version.full
node-version-detail-info.node-name → name
node-version-detail-info.node-uuid → uuid
node-version-detail-info.version → version.full

version-tuple

version

version → version.full
system-version-tuple.generation → version.generation
system-version-tuple.major → version.major
system-version-tuple.minor → version.minor

system-hypervisor-host-config-create

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-destroy

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-get

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-modify

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-create

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-destroy

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-get

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-modify

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

system-image-external-package-delete

This ONTAPI call does not have an equivalent REST API call.

system-image-external-package-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-image-fetch-package

This ONTAPI call does not have an equivalent REST API call.

system-image-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-image-modify

This ONTAPI call does not have an equivalent REST API call.

system-image-package-delete

This ONTAPI call does not have an equivalent REST API call.

system-image-package-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-image-update

This ONTAPI call does not have an equivalent REST API call.

system-image-update-get-abort

This ONTAPI call does not have an equivalent REST API call.

system-image-update-progress-get

This ONTAPI call does not have an equivalent REST API call.

system-netconsole-get

This ONTAPI call does not have an equivalent REST API call.

system-netconsole-modify

This ONTAPI call does not have an equivalent REST API call.

system-node-discovery-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-node-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute REST attribute Comment

cpu-busytime

No REST Equivalent

cpu-firmware-release

No REST Equivalent

env-failed-fan-count

No REST Equivalent

env-failed-fan-message

No REST Equivalent

env-failed-power-supply-count

No REST Equivalent

env-failed-power-supply-message

No REST Equivalent

env-over-temperature

controller.over_temperature

Specifies whether the hardware is currently operating outside of its recommended temperature range. The hardware shuts down if the temperature exceeds critical thresholds.

is-all-flash-optimized

is_all_flash_optimized

Specifies whether node is all flash optimized.

is-all-flash-select-optimized

is_all_flash_select_optimized

Specifies whether node is all flash select optimized.

is-capacity-optimized

is_capacity_optimized

Specifies whether node is capacity optimized.

is-cloud-optimized

No REST Equivalent

is-diff-svcs

No REST Equivalent

is-epsilon-node

No REST Equivalent

is-node-cluster-eligible

No REST Equivalent

is-node-healthy

state

State of the node:
* unknown - Node or its HA partner cannot be contacted and there is no information on the node’s state.
* down - Node has stopped or is dumping core.
* booting - Node is booting up.
* up - Node is up and operational.
* waiting_for_giveback - Node has been taken over by its HA partner and is waiting for the HA partner to giveback disks.
* taken_over - Node has been taken over by its HA partner and is not yet waiting for giveback.
* degraded - Node has one or more critical services offline.

is-perf-optimized

is_performance_optimized

Specifies whether node is performance optimized

maximum-aggregate-size

No REST Equivalent

maximum-number-of-volumes

No REST Equivalent

maximum-volume-size

No REST Equivalent

node

name

node-asset-tag

No REST Equivalent

node-location

location

node-model

model

node-nvram-id

No REST Equivalent

node-owner

No REST Equivalent

node-serial-number

serial_number

node-storage-configuration

No REST Equivalent

node-system-id

system_id

node-uptime

uptime

The total time, in seconds, that the node has been up.

node-uuid

uuid

node-vendor

No REST Equivalent

No REST Equivalent

nvram-battery-status

No REST Equivalent

product-version

version

sas2-sas3-mixed-stack-support

No REST Equivalent

vm-system-disks

No REST Equivalent

vmhost-info

vm.provider_type

The cloud provider where the VM is hosted.

system-node-get-iter

GET /api/cluster/nodes

ONTAPI attribute REST attribute Comment

cpu-busytime

No REST Equivalent

cpu-firmware-release

No REST Equivalent

env-failed-fan-count

No REST Equivalent

env-failed-fan-message

No REST Equivalent

env-failed-power-supply-count

No REST Equivalent

env-failed-power-supply-message

No REST Equivalent

env-over-temperature

controller.over_temperature

Specifies whether the hardware is currently operating outside of its recommended temperature range. The hardware shuts down if the temperature exceeds critical thresholds.

is-all-flash-optimized

is_all_flash_optimized

Specifies whether node is all flash optimized.

is-all-flash-select-optimized

is_all_flash_select_optimized

Specifies whether node is all flash select optimized.

is-capacity-optimized

is_capacity_optimized

Specifies whether node is capacity optimized.

is-cloud-optimized

No REST Equivalent

is-diff-svcs

No REST Equivalent

is-epsilon-node

No REST Equivalent

is-node-cluster-eligible

No REST Equivalent

is-node-healthy

state

State of the node:
* unknown - Node or its HA partner cannot be contacted and there is no information on the node’s state.
* down - Node has stopped or is dumping core.
* booting - Node is booting up.
* up - Node is up and operational.
* waiting_for_giveback - Node has been taken over by its HA partner and is waiting for the HA partner to giveback disks.
* taken_over - Node has been taken over by its HA partner and is not yet waiting for giveback.
* degraded - Node has one or more critical services offline.

is-perf-optimized

is_performance_optimized

Specifies whether node is performance optimized

maximum-aggregate-size

No REST Equivalent

maximum-number-of-volumes

No REST Equivalent

maximum-volume-size

No REST Equivalent

node

name

node-asset-tag

No REST Equivalent

node-location

location

node-model

model

node-nvram-id

No REST Equivalent

node-owner

No REST Equivalent

node-serial-number

serial_number

node-storage-configuration

No REST Equivalent

node-system-id

system_id

node-uptime

uptime

The total time, in seconds, that the node has been up.

node-uuid

uuid

node-vendor

vendor_serial_number

OEM vendor serial number.

nvram-battery-status

No REST Equivalent

product-version

version

sas2-sas3-mixed-stack-support

No REST Equivalent

vm-system-disks

No REST Equivalent

vmhost-info

vm.provider_type

The cloud provider where the VM is hosted.

max-records

max_records

The maximum number of records to return before paging

system-node-modify

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute REST attribute Comment

is-diff-svcs

No REST Equivalent

node

name

node-asset-tag

No REST Equivalent

node-location

location

node-owner

No REST Equivalent

system-node-power-cycle

This ONTAPI call does not have an equivalent REST API call.

system-node-power-get

This ONTAPI call does not have an equivalent REST API call.

system-node-power-off

This ONTAPI call does not have an equivalent REST API call.

system-node-power-on

This ONTAPI call does not have an equivalent REST API call.

system-node-reboot

PATCH /api/cluster/nodes/{uuid}

Note: Passing 'reboot' to the 'action' parameter, reboots the node and transfers storage control to its HA group if storage failover is enabled.

ONTAPI attribute REST attribute Comment

ignore-quorum-warnings

No REST Equivalent

ignore-strict-sync-warnings

No REST Equivalent

is-dump

No REST Equivalent

is-inhibit-takeover

allow_data_outage

This only applies when an action of reboot or shutdown is provided. It allows storage failover to be bypassed along with any failures related to mainintaing quorum in the cluster.

is-skip-lif-migration-before-reboot

No REST Equivalent

node

uuid

reason

shutdown_reboot_reason

The reason for the reboot or shutdown. This only applies when an action of reboot or shutdown is provided.

system-node-rename

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute REST attribute Comment

new-name

name

node

name

This will be part of the query. Ex. ?name=node1

system-node-reset

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute REST attribute Comment

firmware

No REST Equivalent

node

name

This will be part of the query. Ex. ?name=node1

system-node-revert-to

This ONTAPI call does not have an equivalent REST API call.

system-node-shutdown

PATCH /api/cluster/nodes/{uuid}

Note: Passing 'shutdown' to the 'action' parameter, shuts the node down and transfers storage control to its HA group if storage failover is enabled.

ONTAPI attribute REST attribute Comment

ignore-quorum-warnings

No REST Equivalent

ignore-strict-sync-warnings

No REST Equivalent

is-dump

No REST Equivalent

is-inhibit-takeover

allow_data_outage

This only applies when an action of reboot or shutdown is provided. It allows storage failover to be bypassed along with any failures related to mainintaing quorum in the cluster.

is-skip-lif-migration-before-shutdown

No REST Equivalent

node

name

reason

shutdown_reboot_reason

The reason for the reboot or shutdown. This only applies when an action of reboot or shutdown is provided.

system-ontapi-limits-get

This ONTAPI call does not have an equivalent REST API call.

system-ontapi-limits-set

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-config-get

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-config-modify

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-delete-file

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-get

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-get-total-records

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-move-file

This ONTAPI call does not have an equivalent REST API call.

system-services-web-get

This ONTAPI call does not have an equivalent REST API call.

system-services-web-node-get

This ONTAPI call does not have an equivalent REST API call.

system-services-web-node-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-status-hypervisor-get

This ONTAPI call does not have an equivalent REST API call.

system-status-hypervisor-modify

This ONTAPI call does not have an equivalent REST API call.

system-status-restart-restart-service

This ONTAPI call does not have an equivalent REST API call.

system-status-service-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-user-capability-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-zapi-quarantine-queue-stats-get

This ONTAPI call does not have an equivalent REST API call.

system-zapi-quarantine-queue-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-counts-get

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-counts-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-times-get

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-times-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-cli

Note: This is a special generic call, where it can take any valid resource endpoint and method. Refer to the "Using the private CLI passthrough with the ONTAP REST API" section of Swagger UI for more information.
Example
In order to see all the volumes: vol show
using this API call:

curl -k -s -X GET -u admin:{password} 'https://{ip-address}/api/private/cli/volume'

This ONTAPI call does not have an equivalent REST API call.