Skip to main content
ONTAP 9.10.1 ONTAPI-to-REST mapping
A newer release of this product is available.

metrocluster

Contributors
Suggest changes

metrocluster-add-disks

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

metrocluster-check-aggregate-eligibility-get

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

metrocluster-check-aggregate-eligibility-get-iter

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

metrocluster-check-aggregate-get-iter

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

metrocluster-check-capture-status-get

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

metrocluster-check-cluster-get-iter

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

metrocluster-check-config-replication-get

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

metrocluster-check-get-iter

GET /api/cluster/metrocluster/diagnostics

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

additional-info

No REST Equivalent

component

No REST Equivalent

Component is listed as a property in the metrocluster_diagnostics object

result

No REST Equivalent

Components result is listed as state in the metrocluster_diagnostics object

timestamp

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-check-lif-repair-placement

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

metrocluster-check-lif-update-vserver-name

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

metrocluster-check-node-get-iter

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

metrocluster-check-run

POST /api/cluster/metrocluster/diagnostics

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

skip-dr-simulation

No REST Equivalent

In the REST API, skip-dr-simulation is "true".

start-on-node-and-skip-node-version-checks

No REST Equivalent

metrocluster-check-volume-get-iter

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

metrocluster-config-diff-get

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

metrocluster-config-diff-get-iter

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

metrocluster-config-replication-cluster-storage-configuration-get

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

metrocluster-config-replication-cluster-storage-configuration-modify

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

metrocluster-config-replication-resync-status-get

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

metrocluster-configure

POST /api/cluster/metrocluster

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

node-name

No REST Equivalent

refresh

No REST Equivalent

start-on-node-and-skip-node-version-checks

No REST Equivalent

metrocluster-create-periodic-job

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

metrocluster-delete-periodic-job

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

metrocluster-disable

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

metrocluster-disable-periodic-check

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

metrocluster-enable-periodic-check

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

metrocluster-get

GET /api/cluster/metrocluster

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

configuration-type

No REST Equivalent

Available as metrocluster in the GET /api/cluster/nodes endpoint response.

local-auso-failure-domain

No REST Equivalent

local-cluster-name

local.cluster.name

local-configuration-state

local.configuration_state

local-mode

local.mode

local-periodic-check-enabled

local.periodic_check_enabled

remote-auso-failure-domain

No REST Equivalent

remote-cluster-name

remote.cluster.name

remote-configuration-state

remote.configuration_state

remote-mode

remote.mode

remote-periodic-check-enabled

No REST Equivalent

metrocluster-heal

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

metrocluster-interconnect-adapter-auto-reset-on-error-modify

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

metrocluster-interconnect-adapter-get-iter

GET /api/cluster/metrocluster/interconnects

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

adapter-name

adapter

adapter-type

No REST Equivalent

firmware-version

No REST Equivalent

ip-address

No REST Equivalent

is-ood-enabled

No REST Equivalent

link-speed

No REST Equivalent

link-speed-neg-type

No REST Equivalent

node-name

No REST Equivalent

physical-link-status

No REST Equivalent

port-name

No REST Equivalent

port-wwn

No REST Equivalent

remote-adapter-list

No REST Equivalent

switch-model

No REST Equivalent

switch-name

No REST Equivalent

switch-port-name

No REST Equivalent

switch-port-wwn

No REST Equivalent

switch-status

No REST Equivalent

switch-vendor

No REST Equivalent

switch-wwn

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-interconnect-adapter-modify

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

metrocluster-interconnect-adapter-reset

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

metrocluster-interconnect-ipfo-get-iter

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

metrocluster-interconnect-mirror-get-iter

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

metrocluster-interconnect-mirror-modify

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

metrocluster-interconnect-mirror-multipath-get-iter

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

metrocluster-interconnect-remotecluster-get-iter

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

metrocluster-is-configured

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

metrocluster-node-get-iter

GET /api/cluster/metrocluster/nodes

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

additional-configuration-info

No REST Equivalent

automatic-uso

automatic_uso

cluster-name

cluster.name

configuration-state

configuration_state

dr-auxiliary-cluster-uuid

No REST Equivalent

dr-auxiliary-partner-node-name

No REST Equivalent

dr-auxiliary-partner-uuid

No REST Equivalent

dr-auxiliary-systemid

No REST Equivalent

dr-cluster-name

No REST Equivalent

dr-group-id

dr_group_id

dr-mirroring-state

dr_mirroring_state

dr-operation-duration

No REST Equivalent

dr-operation-state

dr_operation_state

dr-partner-cluster-uuid

No REST Equivalent

dr-partner-node-name

No REST Equivalent

Node and dr-partner-node is available in the GET /api/cluster/metrocluster/dr-groups endpoint response.

dr-partner-systemid

No REST Equivalent

dr-partner-uuid

No REST Equivalent

force-node-object-limit

No REST Equivalent

ha-partner-cluster-uuid

No REST Equivalent

ha-partner-node-name

No REST Equivalent

ha-partner-systemid

No REST Equivalent

ha-partner-uuid

No REST Equivalent

mccip-node

No REST Equivalent

node-cluster-uuid

No REST Equivalent

node-name

node.name

node-systemid

No REST Equivalent

node-uuid

node.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-operation-get-iter

GET /api/cluster/metrocluster/operations

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

additional-info

additional_info

cluster-name

No REST Equivalent

command-line

command_line

end-time

end_time

error-list

errors

job-id

No REST Equivalent

node-name

node.name

operation

type

operation-uuid

uuid

start-time

start_time

state

state

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-operation-statistics-get-iter

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

metrocluster-progress-table-get-iter

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

metrocluster-remove-dr-group

DELETE /api/cluster/metrocluster/dr-groups

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

dr-group-id

id

start-on-node-and-skip-node-version-checks

No REST Equivalent

metrocluster-show-lif-placement-failures-get-iter

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

metrocluster-switchback

PATCH /api/cluster/metrocluster

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

override-cluster-stream-resync-errors

No REST Equivalent

override-vetoes

No REST Equivalent

override-vserver-stream-resync-errors

No REST Equivalent

simulate

action

start-on-node-and-skip-node-version-checks

No REST Equivalent

metrocluster-switchover

PATCH /api/cluster/metrocluster

Note: Refer to the ONTAP REST API documentation for the usage of switchover.

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

automatic

No REST Equivalent

controller-replacement

No REST Equivalent

force-nvfail-all

No REST Equivalent

forced-on-disaster

No REST Equivalent

To perform switchover on disaster, you can specify the action value as switchover

override-vetoes

No REST Equivalent

retry-failed-nodes

No REST Equivalent

simulate

No REST Equivalent

To perform simulate switchover, you can specify the action value as negotiated_switchover_simulate

start-on-node-and-skip-node-version-checks

No REST Equivalent

metrocluster-tracelog-dump

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

metrocluster-unconfigure

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

metrocluster-vserver-get-iter

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

metrocluster-vserver-resync

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