cluster

Contributors

cluster-add-node

POST /api/cluster/nodes

Note: Many of the ONTAPI attributes are parallel lists of values. For the REST API, the input is a list of node objects, so each individual attribute is singular.

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

ONTAPI attribute REST attribute Comment

cluster-ips

cluster_interface.ip.address

discovery-timeout

No REST Equivalent

Sending a GET on /api/cluster/nodes?return_timeout=n when in precluster mode will look for nodes for up to n seconds.

node-count

No REST Equivalent

The node count is implicit by the number of node objects that are passed to the endpoint.

node-ip

management_interface.ip.address

node-names

name

node-uuids

No REST Equivalent

uuid is not a POSTable field

retry

No REST Equivalent

cluster-add-node-status-get-iter

Note: You can track the node add job at the job URL returned by the POST /api/cluster/nodes call.

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

cluster-application-record-create

POST /api/private/cluster/notes

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

ONTAPI attribute REST attribute Comment

record-name

name

record-value

value

return-record

return_records

vserver

owner.name

cluster-application-record-delete

DELETE /api/private/cluster/notes/{owner.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

record-name

name

vserver

owner.uuid

cluster-application-record-delete-iter

DELETE /api/private/cluster/notes

Note: Specify at least one field in the query.

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

ONTAPI attribute REST attribute Comment

continue-on-failure

continue_on_failure

max-failure-count

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.name

Can also use owner.uuid

return-failure-list

No REST Equivalent

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

return-success-list

No REST Equivalent

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

cluster-application-record-get-iter

GET /api/private/cluster/notes

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

ONTAPI attribute REST attribute Comment

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.name

Can also use owner.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-application-record-modify

PATCH /api/private/cluster/notes/{owner.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

record-name

name

record-value

value

vserver

owner.uuid

cluster-application-record-modify-iter

PATCH /api/private/cluster/notes

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

ONTAPI attribute REST attribute Comment

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.uuid

continue-on-failure

continue_on_failure

max-failure-count

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.name

Can also use owner.uuid

return-failure-list

No REST Equivalent

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

return-success-list

No REST Equivalent

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

cluster-contact-get

GET /api/cluster

Note: The cluster.contact field is a free-form string that can contain any data necessary. Most commonly, this might just be an email address.

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

ONTAPI attribute REST attribute Comment

address

No REST Equivalent

business-name

No REST Equivalent

city

No REST Equivalent

country

No REST Equivalent

primary-alt-phone

No REST Equivalent

primary-email

contact

primary-name

No REST Equivalent

primary-phone

No REST Equivalent

secondary-alt-phone

No REST Equivalent

secondary-email

No REST Equivalent

secondary-name

No REST Equivalent

secondary-phone

No REST Equivalent

state

No REST Equivalent

zip-code

No REST Equivalent

cluster-contact-modify

PATCH /api/cluster

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

ONTAPI attribute REST attribute Comment

address

No REST Equivalent

business-name

No REST Equivalent

city

No REST Equivalent

country

No REST Equivalent

primary-alt-phone

No REST Equivalent

primary-email

contact

primary-name

No REST Equivalent

primary-phone

No REST Equivalent

secondary-alt-phone

No REST Equivalent

secondary-email

No REST Equivalent

secondary-name

No REST Equivalent

secondary-phone

No REST Equivalent

state

No REST Equivalent

zip-code

No REST Equivalent

cluster-create

POST /api/cluster

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

ONTAPI attribute REST attribute Comment

cluster-ips

nodes.cluster_interface.ip.address

cluster-name

name

discovery-timeout

No REST Equivalent

keep-precluster-cert

No REST Equivalent

license

license.keys

node-count

nodes

node-names

nodes.name

node-uuids

No REST Equivalent

retry

No REST Equivalent

single-node-cluster

single_node_cluster

single_node_cluster is a query parameter

cluster-create-join-progress-get

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

cluster-ha-get

GET /api/cluster

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

ONTAPI attribute REST attribute Comment

ha-configured

nodes.ha.enabled

cluster-ha-modify

Note: This is an unsupported ONTAPI operation.

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

cluster-identity-get

GET /api/cluster

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

ONTAPI attribute REST attribute Comment

cluster-contact

contact

cluster-location

location

cluster-name

name

cluster-serial-number

No REST Equivalent

cluster-uuid

uuid

rdb-uuid

No REST Equivalent

cluster-identity-modify

PATCH /api/cluster

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

ONTAPI attribute REST attribute Comment

cluster-contact

contact

cluster-location

location

cluster-name

name

cluster-join

POST /api/cluster/nodes

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

ONTAPI attribute REST attribute Comment

cluster-ip-address

cluster_interface.ip.address

cluster-name

No REST Equivalent

cluster-log-forward-create

POST /api/security/audit/destinations

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

ONTAPI attribute REST attribute Comment

destination

address

facility

facility

force

force

force is a query parameter

port

port

protocol

protocol

return-record

return_records

verify-server

verify_server

cluster-log-forward-destroy

DELETE /api/security/audit/destinations/{address}/{port}

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

ONTAPI attribute REST attribute Comment

destination

address

port

port

cluster-log-forward-get

GET /api/security/audit/destinations/{address}/{port}

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

ONTAPI attribute REST attribute Comment

destination

address

facility

facility

force

No REST Equivalent

port

port

protocol

protocol

verify-server

verify_server

cluster-log-forward-get-iter

GET /api/security/audit/destinations

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

ONTAPI attribute REST attribute Comment

destination

address

facility

facility

force

No REST Equivalent

port

port

protocol

protocol

verify-server

verify_server

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-log-forward-modify

PATCH /api/security/audit/destinations/{address}/{port}

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

ONTAPI attribute REST attribute Comment

destination

address

facility

facility

port

port

verify-server

verify_server

cluster-log-forward-statistics-get

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

cluster-log-forward-statistics-get-iter

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

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

is-node-eligible

No REST Equivalent

is-node-epsilon

No REST Equivalent

is-node-healthy

state

Specifies the health of the node. In the REST API, the node is healthy if the state is "up". If the state is "booting", the node might still indicate "up" state after it has booted.

node-name

name

node-uuid

uuid

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

is-node-eligible

No REST Equivalent

is-node-epsilon

No REST Equivalent

is-node-healthy

state

node-name

name

node-uuid

uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-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-node-eligible

No REST Equivalent

is-node-epsilon

No REST Equivalent

node-name

name

skip-quorum-check-before-eligible

allow_data_outage

skip-quorum-check-before-ineligible

allow_data_outage

cluster-remove-node

DELETE /api/cluster/nodes/{uuid}

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

ONTAPI attribute REST attribute Comment

cluster-ip

cluster_interface.ip.address

force

force

node

name

node-uuid

uuid

skip-epsilon-transition-before-unjoin

No REST Equivalent

Always false in REST API.

skip-last-low-version-node-check

No REST Equivalent

Always true in REST API.

skip-quorum-check-before-unjoin

No REST Equivalent

Always false in REST API.

cluster-unjoin

DELETE /api/cluster/nodes/{uuid}

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

ONTAPI attribute REST attribute Comment

force

force

node

uuid

skip-quorum-check-before-unjoin

No REST Equivalent

Always false in REST API.

cluster-zoneinfo-get

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

cluster-zoneinfo-load-from-uri

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