Skip to main content
ONTAP 9.12.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

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

aggregate.details.checks.additional_info

aggregate

aggregate.details.aggregate.name

check

aggregate.details.checks.name

cluster-name

aggregate.details.cluster.name

node-name

aggregate.details.node.name

result

aggregate.details.checks.result

timestamp

aggregate.details.timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-check-capture-status-get

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

metrocluster-check-cluster-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

cluster.details.checks.additional_info

check

cluster.details.checks.name

cluster-name

cluster.details.cluster.name

result

cluster.details.checks.result

timestamp

cluster.details.timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-check-config-replication-get

GET /api/cluster/metrocluster/diagnostics

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

ONTAPI attribute REST attribute Comment

cluster-recovery-steps

cluster.summary

cluster-streams

No REST Equivalent

heartbeat-recovery-steps

No REST Equivalent

is-enabled

No REST Equivalent

is-running

No REST Equivalent

last-heartbeat-received

No REST Equivalent

last-heartbeat-sent

No REST Equivalent

recovery-steps

config-replication.summary

remote-heartbeat

No REST Equivalent

storage-in-use

No REST Equivalent

storage-non-healthy-reason

No REST Equivalent

storage-recovery-steps

No REST Equivalent

storage-status

No REST Equivalent

vserver-recovery-steps

No REST Equivalent

vserver-streams

No REST Equivalent

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's additional-info is listed as summary in the metrocluster_diagnostics object

component

No REST Equivalent

Component is listed as a property in the metrocluster_diagnostics object

result

state

timestamp

timestamp

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

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

node.details.checks.additional_info

check

node.details.checks.name

cluster-name

node.details.cluster.name

node-name

node.details.node.name

result

node.details.checks.result

timestamp

node.details.timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

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

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

volume.summary

check

No REST Equivalent

result

volume.state

timestamp

volume.timestamp

volume

No REST Equivalent

vserver

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

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

configuration_type

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

remote.periodic_check_enabled

metrocluster-heal

PATCH /api/cluster/metrocluster

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

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

ONTAPI attribute REST attribute Comment

healing-phase

No REST Equivalent

To perform heal aggregates, you can specify the action value as heal_aggregates, and specify heal_root_aggregates to perform heal root aggregates.

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

No REST Equivalent

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

type

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

node.name

physical-link-status

state

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

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

type

mirroring-admin-status

mirror.enabled

mirroring-oper-status

mirror.state

node-name

node.name

partner-name

No REST Equivalent

partner-type

partner_type

physical-link-status

state

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-interconnect-mirror-modify

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

metrocluster-interconnect-mirror-multipath-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

multipath-policy

multipath_policy

node-name

node.name

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-interconnect-remotecluster-get-iter

GET /api/cluster/metrocluster

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

ONTAPI attribute REST attribute Comment

is-remote-cluster-reachable

local.partner_cluster_reachable

node

No REST Equivalent

node-uuid

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-is-configured

GET /api/cluster/metrocluster

Note: Listed as local.configuration_state in the GET of /api/cluster/metrocluster

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

There are no attributes defined for this ONTAPI 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

dr_auxiliary_cluster.uuid

dr-auxiliary-partner-node-name

dr_auxiliary_partner.name

dr-auxiliary-partner-uuid

dr_auxiliary_partner.uuid

dr-auxiliary-systemid

dr_auxiliary_partner.system_id

dr-cluster-name

dr_partner_cluster.name

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

dr_partner_cluster.uuid

dr-partner-node-name

dr_partner.name

dr-partner-systemid

dr_partner.system_id

dr-partner-uuid

dr_partner.uuid

force-node-object-limit

limit_enforcement

ha-partner-cluster-uuid

ha_partner_cluster.uuid

ha-partner-node-name

ha_partner.name

ha-partner-systemid

ha_partner.system_id

ha-partner-uuid

ha_partner.uuid

mccip-node

is_mccip

node-cluster-uuid

cluster.uuid

node-name

node.name

node-systemid

node.system_id

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

GET /api/cluster/metrocluster/svms

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

ONTAPI attribute REST attribute Comment

cluster

cluster_name

configuration-state

configuration_state

failed-reason

failed_reason

failed-row

No REST Equivalent

partner-vserver

partner_svm_name

vserver

svm_name

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-vserver-resync

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