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

cluster-peer

Contributors
Suggest changes

cluster-peer-active-address-insert

PATCH /api/cluster/peers/{uuid}

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

ONTAPI attribute REST attribute Comment

active-address

remote.ip_addresses

cluster-name

name

cluster-peer-active-addresses-get

GET /api/cluster/peers

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

ONTAPI attribute REST attribute Comment

cluster-name

name

peer-addresses

remote.ip_addresses

cluster-peer-active-addresses-register

Note: This is an unsupported ONTAPI operation.

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

cluster-peer-authn-offer-cancel

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

cluster-peer-authn-offer-get

GET /api/cluster/peers/{uuid}

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

ONTAPI attribute REST attribute Comment

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

encryption-protocol-proposed

encryption.proposed

initial-allowed-vserver-peers

initial_allowed_svms

offer-creation

No REST Equivalent

offer-expiration

authentication.expiry_time

peer-cluster-name

name

peer-cluster-uuid

uuid

cluster-peer-authn-offer-get-iter

GET /api/cluster/peers

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

ONTAPI attribute REST attribute Comment

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

encryption-protocol-proposed

encryption.proposed

initial-allowed-vserver-peers

initial_allowed_svms

offer-creation

No REST Equivalent

offer-expiration

authentication.expiry_time

peer-cluster-name

name

peer-cluster-uuid

uuid

max-records

max_records

Specifies the maximum number of records to return before paging

cluster-peer-authn-offer-modify

PATCH /api/cluster/peers/{uuid}

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

ONTAPI attribute REST attribute Comment

initial-allowed-vserver-peers

initial_allowed_svms

offer-expiration

authentication.expiry_time

peer-cluster-name

name

cluster-peer-connection-destroy

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

cluster-peer-connections-get

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

cluster-peer-connections-get-iter

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

cluster-peer-create

POST /api/cluster/peers

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

ONTAPI attribute REST attribute Comment

address-family

No REST Equivalent

applications

peer_applications

encryption-protocol-proposed

encryption.proposed

generate-passphrase

authentication.generate_passphrase

initial-allowed-vserver-peers

initial_allowed_svms

ipspace-name

ipspace.name

local-name

remote.name

offer-expiration

authentication.expiry_time

passphrase

authentication.passphrase

password

No REST Equivalent

peer-addresses

remote.ip_addresses

rpc-connect-timeout

No REST Equivalent

timeout

No REST Equivalent

update-ping-timeout

No REST Equivalent

user-name

No REST Equivalent

cluster-peer-delete

DELETE /api/cluster/peers/{uuid}

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

ONTAPI attribute REST attribute Comment

cluster-name

No REST Equivalent

cluster-peer-get

GET /api/cluster/peers/{uuid}

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

ONTAPI attribute REST attribute Comment

cluster-name

name

active-addresses

remote.ip_addresses

address-family

No REST Equivalent

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

availability

status.state

cluster-uuid

uuid

encryption-protocol

encryption.state

encryption-protocol-proposed

encryption.proposed

ipspace-name

ipspace.name

is-cluster-healthy

No REST Equivalent

last-updated

status.update_time

peer-addresses

remote.ip_addresses

psk-algorithm

No REST Equivalent

remote-cluster-name

remote.name

remote-cluster-nodes

No REST Equivalent

rpc-connect-timeout

No REST Equivalent

serial-number

remote.serial_number

timeout

No REST Equivalent

unreachable-local-nodes

No REST Equivalent

update-ping-timeout

No REST Equivalent

cluster-peer-get-iter

GET /api/cluster/peers

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

ONTAPI attribute REST attribute Comment

active-addresses

remote.ip_addresses

address-family

No REST Equivalent

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

availability

status.state

cluster-name

name

cluster-uuid

uuid

encryption-protocol

encryption.state

encryption-protocol-proposed

encryption.proposed

ipspace-name

ipspace.name

is-cluster-healthy

No REST Equivalent

last-updated

status.update_time

peer-addresses

remote.ip_addresses

psk-algorithm

No REST Equivalent

remote-cluster-name

remote.name

remote-cluster-nodes

No REST Equivalent

rpc-connect-timeout

No REST Equivalent

serial-number

remote.serial_number

timeout

No REST Equivalent

unreachable-local-nodes

No REST Equivalent

update-ping-timeout

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-peer-health-info-get

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

cluster-peer-health-info-get-iter

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

cluster-peer-modify

PATCH /api/cluster/peers/{uuid}

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

ONTAPI attribute REST attribute Comment

address-family

No REST Equivalent

auth-status-admin

authentication.in_use

cluster-name

name

encryption-protocol-proposed

encryption.proposed

generate-passphrase

authentication.generate_passphrase

ipspace-name

ipspace.name

offer-expiration

authentication.expiry_time

passphrase

authentication.passphrase

peer-addresses

remote.ip_addresses

rpc-connect-timeout

No REST Equivalent

timeout

No REST Equivalent

update-ping-timeout

No REST Equivalent

cluster-peer-modify-local-name

PATCH /api/cluster/peers/{uuid}

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

ONTAPI attribute REST attribute Comment

cluster-name

No REST Equivalent

new-name

name

cluster-peer-ping-iter

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

cluster-peer-policy-get

GET /api/cluster

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

ONTAPI attribute REST attribute Comment

is-unauthenticated-access-permitted

peering_policy.authentication_required

is-unencrypted-access-permitted

peering_policy.encryption_required

passphrase-minimum-length

peering_policy.minimum_passphrase_length

cluster-peer-policy-modify

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

cluster-peer-stable-addresses-get

Note: This is an unsupported ONTAPI operation.

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