system
Suggest changes
PDFs
external-cache-dumplog
This ONTAPI call does not have an equivalent REST API call.
external-cache-get
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-enabled |
external_cache.is_enabled |
|
is-hya-enabled |
external_cache.is_hya_enabled |
|
is-rewarm-enabled |
external_cache.is_rewarm_enabled |
|
node |
name |
|
pcs-size |
external_cache.pcs_size |
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
Note: This is an unsupported ONTAPI operation.
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: Retrieve the nodes in the cluster.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| 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 |
controller.board |
Type of the system board. This is defined by the vendor. |
controller-address |
No REST Equivalent |
|
cpu-firmware-release |
controller.cpu.firmware_release |
Firmware release number. Defined by the CPU manufacturer. |
cpu-microcode-version |
No REST Equivalent |
|
cpu-part-number |
No REST Equivalent |
|
cpu-processor-id |
No REST Equivalent |
|
cpu-processor-type |
controller.cpu.processor |
CPU type on the node. |
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 |
controller.memory_size |
Memory available on the node, in bytes. |
number-of-processors |
controller.cpu.count |
Number of CPUs on the node. |
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 |
storage_configuration |
|
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 |
Specifies 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}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| 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 |
version-tuple |
version |
version → version.full |
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.
system-hypervisor-uplink-mapping-create
This ONTAPI call does not have an equivalent REST API call.
system-hypervisor-uplink-mapping-destroy
This ONTAPI call does not have an equivalent REST API call.
system-hypervisor-uplink-mapping-get
This ONTAPI call does not have an equivalent REST API call.
system-hypervisor-uplink-mapping-modify
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
GET /api/cluster/software/packages
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
image |
No REST Equivalent |
|
install-time |
No REST Equivalent |
|
is-current |
No REST Equivalent |
|
is-default |
No REST Equivalent |
|
kernel-path |
No REST Equivalent |
|
node |
No REST Equivalent |
|
rootfs-path |
No REST Equivalent |
|
version |
version |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
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
GET /api/cluster/software
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
node |
nodes.name |
|
package |
nodes.sw_images.package |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
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
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-node-discovery-get-iter
GET /api/cluster/nodes?membership=available
Note: A query for nodes with available membership returns the discovered nodes that are not included by default.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cluster-ip-addresses |
cluster_interfaces.ip |
|
cluster-name |
No REST Equivalent |
|
cluster-netmask |
No REST Equivalent |
|
cluster-uuid |
No REST Equivalent |
|
is-node-in-cluster |
membership |
|
node |
name |
|
node-model |
model |
|
node-nvram-id |
nvram.id |
Vendor specific NVRAM ID of the node. |
node-serial-number |
serial_number |
|
partner-nvram-id |
No REST Equivalent |
|
version |
version |
|
max-records |
No REST Equivalent |
system-node-get
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cpu-busytime |
No REST Equivalent |
|
cpu-firmware-release |
controller.cpu.firmware_release |
Firmware release number. Defined by the CPU manufacturer. |
env-failed-fan-count |
controller.failed_fan.count |
Specifies a count of the number of chassis fans that are not operating within the recommended RPM range. |
env-failed-fan-message |
controller.failed_fan.message |
Message describing the current condition of chassis fans. It is only of use when "failed_fan.count" is not zero. |
env-failed-power-supply-count |
controller.failed_power_supply.count |
Number of failed power supply units. |
env-failed-power-supply-message |
controller.failed_power_supply.message |
Message describing the state of any power supplies that are currently degraded. It is only of use when "failed_power_supply.count" is not zero. |
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: |
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 |
nvram.id |
Vendor specific NVRAM ID of the node. |
node-owner |
owner |
|
node-serial-number |
serial_number |
|
node-storage-configuration |
storage_configuration |
|
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 |
nvram.battery_state |
|
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
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cpu-busytime |
No REST Equivalent |
|
cpu-firmware-release |
controller.cpu.firmware_release |
Firmware release number. Defined by the CPU manufacturer. |
env-failed-fan-count |
controller.failed_fan.count |
Specifies a count of the number of chassis fans that are not operating within the recommended RPM range. |
env-failed-fan-message |
controller.failed_fan.message |
Message describing the current condition of chassis fans. It is only of use when "failed_fan.count" is not zero. |
env-failed-power-supply-count |
controller.failed_power_supply.count |
Number of failed power supply units. |
env-failed-power-supply-message |
controller.failed_power_supply.message |
Message describing the state of any power supplies that are currently degraded. It is only of use when "failed_power_supply.count" is not zero. |
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: |
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 |
nvram.id |
|
node-owner |
owner |
|
node-serial-number |
serial_number |
|
node-storage-configuration |
storage_configuration |
|
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 |
nvram.battery_state |
|
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 |
Specifies the maximum number of records to return before paging. |
system-node-modify
PATCH /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-diff-svcs |
No REST Equivalent |
|
node |
name |
|
node-asset-tag |
No REST Equivalent |
|
node-location |
location |
|
node-owner |
owner |
system-node-power-cycle
This ONTAPI call does not have an equivalent REST API call.
system-node-power-get
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
node |
name |
The target node. |
status |
state |
|
node |
No REST Equivalent |
The requesting node is the one that the GET call was made to. |
system-node-power-off
PATCH /api/cluster/nodes/{uuid}
Note: Pass "power_off" to the "action" parameter to perform an SP assisted shutdown of the node.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
node |
name |
system-node-power-on
PATCH /api/cluster/nodes/{uuid}
Note: Pass "power_on" to the "action" parameter to perform an SP assisted power on of the node.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
node |
name |
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.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| 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 you provide an action of reboot or shutdown. It allows storage failover to be bypassed along with any failures related to maintaining 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 you provide an action of reboot or shutdown. |
system-node-rename
PATCH /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
new-name |
name |
|
node |
name |
Part of the query: Ex. ?name=node1 |
system-node-reset
This ONTAPI call does not have an equivalent REST API call.
system-node-revert-to
Note: This is an unsupported ONTAPI operation.
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.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| 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 you provide an action of reboot or shutdown. It allows storage failover to be bypassed along with any failures related to maintaining 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 you provide an action of reboot or shutdown. |
system-ontapi-limits-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-ontapi-limits-set
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-services-web-file-uploads-config-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-services-web-file-uploads-config-modify
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-services-web-file-uploads-delete-file
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-services-web-file-uploads-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-services-web-file-uploads-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-services-web-file-uploads-get-total-records
Note: This is an unsupported ONTAPI operation.
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
GET /api/cluster/web
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
csrf-protection-enabled |
csrf.protection_enabled |
Indicates whether CSRF protection is enabled. |
csrf-token-absolute-timeout |
csrf.token.max_timeout |
Time for which an unused CSRF token, regardless of usage is retained, in seconds. |
csrf-token-concurrent-limit |
csrf.token.concurrent_limit |
Maximum number of concurrent CSRF tokens. |
csrf-token-idle-timeout |
csrf.token.idle_timeout |
Time for which an unused CSRF token is retained, in seconds. |
external |
enabled |
Indicates whether remote clients can connect to the web services. |
http-enabled |
http_enabled |
Indicates whether HTTP is enabled. |
http-port |
http_port |
HTTP port for cluster-level web services. |
https-port |
https_port |
HTTPS port for cluster-level web services. |
per-address-limit |
per_address_limit |
The number of connections that can be processed concurrently from the same remote address. |
ssl-fips-enabled |
No REST Equivalent |
See "fips.enabled" in GET /api/security. |
sslv3-enabled |
No REST Equivalent |
See "tls.protocol_versions" in GET /api/security. |
status |
state |
State of the cluster-level web services. |
tlsv1-enabled |
No REST Equivalent |
See "tls.protocol_versions" in GET /api/security. |
wait-queue-capacity |
wait_queue_capacity |
The maximum size of the wait queue for connection exceeding the per-address-limit. |
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
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-zapi-quarantine-queue-stats-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-zapi-queue-counts-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-zapi-queue-counts-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-zapi-queue-times-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-zapi-queue-times-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
system-cli
GET|POST|PATCH|DELETE /api/private/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 the Swagger UI for more information.
Example:
In order to see all the volumes: vol show
using this API call: +
curl -iku admin:<password> "https://<ip-address>/api/private/cli/volume"
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
privilege_level |
No REST Equivalent |
The REST API privileges/login needed (for example, admin) — see example |
args |
No REST Equivalent |
Arguments are passed into the REST API as part of the path or body depending on the verb — see the REST API documentation for clarification. The example shown is passing as part of the path. |