Retrieve the cluster software profile

cluster image show
cluster image show-update-progress

Learn more

DOC /cluster/software

Parameters

Name	Type	In	Required	Description
max_records	integer	query	False	Limit the number of records returned.
return_records	boolean	query	False	The default is true for GET calls. When set to false, only the number of records is returned. Default value: 1
order_by	array[string]	query	False	Order results by specified fields and optional [asc
desc] direction. Default direction is 'asc' for ascending.	fields	array[string]	query	False
Specify the fields to return.	return_timeout	integer	query	False

Name

Type

In

Required

Description

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Specify the fields to return.

return_timeout

integer

query

False

Response

Status: 200, Ok

Name	Type	Description
_links	_links
action	string	User triggered action to apply to the install operation
elapsed_duration	integer	Elapsed time during the upgrade or validation operation
estimated_duration	integer	Estimated time remaining until completion of the upgrade or validation operation.
metrocluster	metrocluster
nodes	array[software_node_reference]	List of nodes, active versions, and firmware update progressions.
pending_version	string	Version being installed on the system. example: ONTAP_X_1 readOnly: 1 Introduced in: 9.6
post_update_checks	array[software_validation_reference]	List of failed post-update checks' warnings, errors, and advice.
state	string	Operational state of the upgrade
status_details	array[software_status_details_reference]	Display status details.
update_details	array[software_update_details_reference]	Display update progress details.
validation_results	array[software_validation_reference]	List of validation warnings, errors, and advice.
version	string	Version of ONTAP installed and currently active on the system. During PATCH, using the 'validate_only' parameter on the request executes pre-checks, but does not perform the full installation. example: ONTAP_X Introduced in: 9.6

Name

Type

Description

_links

action

string

User triggered action to apply to the install operation

elapsed_duration

integer

Elapsed time during the upgrade or validation operation

estimated_duration

integer

Estimated time remaining until completion of the upgrade or validation operation.

metrocluster

nodes

array[software_node_reference]

List of nodes, active versions, and firmware update progressions.

pending_version

string

Version being installed on the system.

example: ONTAP_X_1
readOnly: 1
Introduced in: 9.6

post_update_checks

array[software_validation_reference]

List of failed post-update checks' warnings, errors, and advice.

state

string

Operational state of the upgrade

status_details

array[software_status_details_reference]

Display status details.

update_details

array[software_update_details_reference]

Display update progress details.

validation_results

array[software_validation_reference]

List of validation warnings, errors, and advice.

version

string

Version of ONTAP installed and currently active on the system. During PATCH, using the 'validate_only' parameter on the request executes pre-checks, but does not perform the full installation.

example: ONTAP_X
Introduced in: 9.6

Example response

{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "action": "pause",
  "elapsed_duration": "2140",
  "estimated_duration": "5220",
  "metrocluster": {
    "clusters": {
      "elapsed_duration": "2140",
      "estimated_duration": "3480",
      "name": "cluster_A",
      "state": "in_progress"
    },
    "progress_details": {
      "message": "Switchover in progress"
    },
    "progress_summary": {
      "message": "MetroCluster updated successfully."
    }
  },
  "nodes": {
    "firmware": {
      "cluster_fw_progress": {
        "job": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "uuid": "string"
        },
        "update_states": {
          "attempts": "3",
          "code": "2228325",
          "message": "Cannot open local staging ZIP file disk_firmware.zip",
          "status": "idle",
          "worker_node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        },
        "zip_file_name": "disk_firmware.zip"
      },
      "disk": {
        "average_duration_per_disk": "120",
        "num_waiting_download": "0",
        "total_completion_estimate": "0",
        "update_status": "running"
      },
      "dqp": {
        "file_name": "qual_devices_v3",
        "record_count": {
          "alias": "200",
          "device": "29",
          "drive": "680",
          "system": "3"
        },
        "revision": "20200117",
        "version": "3.18"
      },
      "shelf": {
        "in_progress_count": "2",
        "update_status": "running"
      },
      "sp_bmc": {
        "autoupdte": "",
        "end_time": "2020-05-17T20:00:00Z",
        "fw_type": "SP",
        "image": "primary",
        "is_current": 1,
        "last_update_state": "passed",
        "percent_done": "100",
        "running_version": "1.2.3.4",
        "start_time": "2020-05-17T20:00:00Z",
        "state": "installed"
      }
    },
    "name": "node1",
    "version": "ONTAP_X"
  },
  "pending_version": "ONTAP_X_1",
  "post_update_checks": {
    "action": {
      "message": "Use NFS hard mounts, if possible."
    },
    "issue": {
      "message": "Cluster HA is not configured in the cluster."
    },
    "status": "warning",
    "update_check": "nfs_mounts"
  },
  "state": "completed",
  "status_details": {
    "end_time": "2019-02-02T19:00:00Z",
    "issue": {
      "code": "10551399",
      "message": "Image update complete"
    },
    "name": "initialize",
    "node": {
      "name": "node1"
    },
    "start_time": "2019-02-02T19:00:00Z",
    "state": "failed"
  },
  "update_details": {
    "elapsed_duration": "2100",
    "estimated_duration": "4620",
    "node": {
      "name": "node1"
    },
    "phase": "Pre-update checks",
    "state": "failed"
  },
  "validation_results": {
    "action": {
      "message": "Use NFS hard mounts, if possible."
    },
    "issue": {
      "message": "Cluster HA is not configured in the cluster."
    },
    "status": "warning",
    "update_check": "nfs_mounts"
  },
  "version": "ONTAP_X"
}

Error

Status: Default, Error

Name	Type	Description
error	error

Name

Type

Description

error

Example error

{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

Name	Type	Description
self	href

Name

Type

Description

self

href

software_mcc_reference

Name	Type	Description
elapsed_duration	integer	Elapsed duration of update time (in seconds) of MetroCluster.
estimated_duration	integer	Estimated duration of update time (in seconds) of MetroCluster.
name	string	Name of the site in MetroCluster.
state		Upgrade state of MetroCluster.

Name

Type

Description

elapsed_duration

integer

Elapsed duration of update time (in seconds) of MetroCluster.

estimated_duration

integer

Estimated duration of update time (in seconds) of MetroCluster.

name

string

Name of the site in MetroCluster.

state

Upgrade state of MetroCluster.

progress_details

Name	Type	Description
message	string	MetroCluster update progress details.

Name

Type

Description

message

string

MetroCluster update progress details.

progress_summary

Name	Type	Description
message	string	MetroCluster update progress summary.

Name

Type

Description

message

string

MetroCluster update progress summary.

metrocluster

Name	Type	Description
clusters	array[software_mcc_reference]	List of MetroCluster sites, statuses, and active ONTAP versions. readOnly: 1 Introduced in: 9.6
progress_details	progress_details
progress_summary	progress_summary

Name

Type

Description

clusters

array[software_mcc_reference]

List of MetroCluster sites, statuses, and active ONTAP versions.

readOnly: 1
Introduced in: 9.6

progress_details

progress_summary

job_link

Name	Type	Description
_links	_links
uuid	string	The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

Name

Type

Description

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

worker_node

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

firmware_update_progress_state

Name	Type	Description
attempts	integer
code	integer	Code corresponding to the status message.
message	string	Error message returned when a cluster firmware update job fails.
status	string
worker_node	worker_node

Name

Type

Description

attempts

integer

code

integer

Code corresponding to the status message.

message

string

Error message returned when a cluster firmware update job fails.

status

string

worker_node

firmware_update_progress

Name	Type	Description
job	job_link
update_states	array[firmware_update_progress_state]
zip_file_name	string

Name

Type

Description

job

job_link

update_states

array[firmware_update_progress_state]

zip_file_name

string

firmware_disk

Name	Type	Description
average_duration_per_disk	integer	Average firmware update duration per disk (in seconds).
num_waiting_download	integer	The number of disks waiting to download the firmware update.
total_completion_estimate	integer	Estimated firmware update duration to completion (in minutes).
update_status		Status of the background disk firmware update.

Name

Type

Description

average_duration_per_disk

integer

Average firmware update duration per disk (in seconds).

num_waiting_download

integer

The number of disks waiting to download the firmware update.

total_completion_estimate

integer

Estimated firmware update duration to completion (in minutes).

update_status

Status of the background disk firmware update.

firmware_dqp_record_count

Name	Type	Description
alias	integer	Alias record count
device	integer	Device record count
drive	integer	Drive record count
system	integer	System record count

Name

Type

Description

alias

integer

Alias record count

device

integer

Device record count

drive

integer

Drive record count

system

integer

System record count

firmware_dqp

Name	Type	Description
file_name	string	Firmware file name
record_count	firmware_dqp_record_count
revision	string	Firmware revision
version	string	Firmware version

Name

Type

Description

file_name

string

Firmware file name

record_count

firmware_dqp_record_count

revision

string

Firmware revision

version

string

Firmware version

firmware_shelf

Name	Type	Description
in_progress_count	integer
update_status		Status of the shelf firmware update.

Name

Type

Description

in_progress_count

integer

update_status

Status of the shelf firmware update.

firmware_sp_bmc

Name	Type	Description
autoupdte	boolean
end_time	string
fw_type	string
image	string
in_progress	boolean
is_current	boolean
last_update_state	string
percent_done	integer
running_version	string
start_time	string
state	string

Name

Type

Description

autoupdte

boolean

end_time

string

fw_type

string

image

string

in_progress

boolean

is_current

boolean

last_update_state

string

percent_done

integer

running_version

string

start_time

string

state

string

firmware

Name	Type	Description
cluster_fw_progress	array[firmware_update_progress]
disk	firmware_disk
dqp	firmware_dqp
shelf	firmware_shelf
sp_bmc	firmware_sp_bmc

Name

Type

Description

cluster_fw_progress

array[firmware_update_progress]

disk

dqp

shelf

sp_bmc

software_node_reference

Name	Type	Description
firmware	firmware
name	string	Name of the node.
version	string	ONTAP version of the node. example: ONTAP_X readOnly: 1 Introduced in: 9.6

Name

Type

Description

firmware

name

string

Name of the node.

version

string

ONTAP version of the node.

example: ONTAP_X
readOnly: 1
Introduced in: 9.6

action

Name	Type	Description
message	string	Specifies the corrective action to take to resolve an error.

Name

Type

Description

message

string

Specifies the corrective action to take to resolve an error.

issue

Name	Type	Description
message	string	Details of the error or warning encountered by the update checks.

Name

Type

Description

message

string

Details of the error or warning encountered by the update checks.

software_validation_reference

Name	Type	Description
action	action
issue	issue
status	string	Status of the update check.
update_check	string	Name of the update check.

Name

Type

Description

action

issue

status

string

Status of the update check.

update_check

string

Name of the update check.

action

Name	Type	Description
code	integer	Error code corresponding the status error
message	string	Corrective action to be taken to resolve the status error.

Name

Type

Description

code

integer

Error code corresponding the status error

message

string

Corrective action to be taken to resolve the status error.

issue

Name	Type	Description
code	integer	Error code corresponding to update status
message	string	Update status details

Name

Type

Description

code

integer

Error code corresponding to update status

message

string

Update status details

node

Name	Type	Description
name	string	Name of the node to be retrieved for status details.

Name

Type

Description

name

string

Name of the node to be retrieved for status details.

software_status_details_reference

Name	Type	Description
action	action
end_time	string	End time for each status phase.
issue	issue
name	string	Name of the phase to be retrieved for status details.
node	node
start_time	string	Start time for each status phase.
state	string	Status of the phase

Name

Type

Description

action

end_time

string

End time for each status phase.

issue

name

string

Name of the phase to be retrieved for status details.

node

start_time

string

Start time for each status phase.

state

string

Status of the phase

node

Name	Type	Description
name	string	Name of the node to be retrieved for update details.

Name

Type

Description

name

string

Name of the node to be retrieved for update details.

software_update_details_reference

Name	Type	Description
elapsed_duration	integer	Elapsed duration for each update phase
estimated_duration	integer	Estimated duration for each update phase
node	node
phase	string	Phase details
state	string	State of the update phase

Name

Type

Description

elapsed_duration

integer

Elapsed duration for each update phase

estimated_duration

integer

Estimated duration for each update phase

node

phase

string

Phase details

state

string

State of the update phase

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

error

Name	Type	Description
arguments	array[error_arguments]	Message arguments
code	string	Error code
message	string	Error message
target	string	The target parameter that caused the error.

Name

Type

Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.

Retrieve the cluster software profile

Creating your file...

Related ONTAP commands

Learn more

Parameters

Response

Error

Definitions