Skip to main content
A newer release of this product is available.

cluster-image

Contributors
Suggest changes
PDFs

cluster-image-get

GET /api/cluster/software

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

ONTAPI attribute REST attribute Comment

current-version

nodes.version

date-installed

No REST Equivalent

cluster-image-get-download-progress

GET /api/cluster/software/download

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

ONTAPI attribute REST attribute Comment

progress-details

message

'message' holds details of all the cases including failure case

progress-status

state

'state' will have simplier values than 'progress-status'

failure-reason

message

'message' will hold reason of failure only in case of package download failed or aborted.

cluster-image-get-iter

GET /api/cluster/software

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

ONTAPI attribute REST attribute Comment

current-version

nodes.version

date-installed

No REST Equivalent

cluster-image-get-upgrade-plan

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

cluster-image-metrocluster-update-progress-info-get

GET /api/cluster/software

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

ONTAPI attribute REST attribute Comment

completed-node-count

No REST Equivalent

dr-validation-reports

No REST Equivalent

intermediate-version

No REST Equivalent

is-two-stage-upgrade

No REST Equivalent

is-validation-done-by-update

No REST Equivalent

metrocluster

metrocluster.clusters

This attribute is specific to Two node Metrocluster Configuration

ndu-node-update-list

nodes

node-estimated-duration

update_details.estimated_duration

overall-elapsed-duration

elapsed_duration

overall-estimated-duration

estimated_duration

overall-status

state

package-version

pending_version

paused-node-count

No REST Equivalent

phase-comments

No REST Equivalent

progress-detail

metrocluster.progress_details

This attribute is specific to Two node Metrocluster Configuration

progress-summary

metrocluster.progress_summary

This attribute is specific to Two node Metrocluster Configuration

source-version

version

target-version

pending_version

total-node-count

No REST Equivalent

upgrade-stage

No REST Equivalent

validation-reports

update_check_list

cluster-image-node-update-progress-info

GET /api/cluster/software?status_details.node={node}

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

ONTAPI attribute REST attribute Comment

node-name

generic_status_details.node

node-update-task-info-list

generic_status_details

cluster-image-package-delete

DELETE /api/cluster/software/packages/{version}

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

ONTAPI attribute REST attribute Comment

package-version

version

cluster-image-package-download

POST /api/cluster/software/download

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

ONTAPI attribute REST attribute Comment

package-url

url

replace-package

No REST Equivalent

cluster-image-package-download-abort

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

cluster-image-package-local-get

GET /api/cluster/software/packages/{version}

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

ONTAPI attribute REST attribute Comment

package-build-time

create_time

package-details

No REST Equivalent

package-version

version

cluster-image-package-local-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

package-build-time

create_time

package-details

No REST Equivalent

package-version

version

num-records

num_records

Specifies the maximum number of records to return before paging.

cluster-image-update

PATCH /api/cluster/software?stabilize_minutes={minutes}&skip_warnings={skip}

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

ONTAPI attribute REST attribute Comment

estimate-only

No REST Equivalent

force-rolling

No REST Equivalent

ignore-validation-warning

skip_warnings

nodes

No REST Equivalent

package-version

pending_version

pause-after

No REST Equivalent

stabilize-minutes

stabilize_minutes

cluster-image-update-cancel

PATCH /api/cluster/software?action=cancel

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

ONTAPI attribute REST attribute Comment

action

Value of attribute must be: cancel

cluster-image-update-history-get-iter

GET /api/cluster/software/history

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

ONTAPI attribute REST attribute Comment

completion-time

end_time

component-id

node.name

component-name

No REST Equivalent

package-version

No REST Equivalent

previous-version

from_version

start-time

start_time

update-status

state

updated-version

to_version

num-records

num_records

Specifies the maximum number of records to return before paging.

cluster-image-update-log-get-iter

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

cluster-image-update-pause

PATCH /api/cluster/software?action=pause

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

ONTAPI attribute REST attribute Comment

action

Value of attribute must be: pause

cluster-image-update-progress-get-iter

GET /api/cluster/software

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

ONTAPI attribute REST attribute Comment

duration

update_details.elapsed_duration

ndu-phase

update_details.phase

phase-comments

No REST Equivalent

If an error has occurred, this attribute describes the required recovery action. If the phase is completed, it provides the duration of the phase.

phase-status

update_details.state

num-records

num_records

Specifies the maximum number of records to return before paging.

cluster-image-update-progress-info

GET /api/cluster/software

Note: The REST API GET method contains some of this information, but not all, and not in the desired format.

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

ONTAPI attribute REST attribute Comment

completed-node-count

No REST Equivalent

intermediate-version

No REST Equivalent

is-two-stage-upgrade

No REST Equivalent

is-validation-done-by-update

No REST Equivalent

node-name

update_details.node.name

node-status

update_details.state

node-estimated-duration

update_details.estimated_duration

overall-elapsed-duration

elapsed_duration

overall-estimated-duration

estimated_duration

overall-status

state

package-version

pending_version

paused-node-count

No REST Equivalent

phase-comments

No REST Equivalent

source-version

No REST Equivalent

target-version

No REST Equivalent

total-node-count

No REST Equivalent

upgrade-stage

No REST Equivalent

validation-reports

update_check_list

cluster-image-update-resume

PATCH /api/cluster/software?action=resume

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

ONTAPI attribute REST attribute Comment

action

Value of attribute must be: resume

cluster-image-validate

GET /api/cluster/software

Note: To GET below attributes values PATCH "api/cluster/software?validate=true" is required at first

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

ONTAPI attribute REST attribute Comment

ndu-check

update_check_list.update_check

ndu-status

update_check_list.status

error

update_check_list.issue.message

action

No REST Equivalent

Not a ui attribute

advice

update_check_list.action.message