Skip to main content

Retrieve status of all automatic updates

Contributors
PDFs

GET /support/auto-update/updates

Introduced In: 9.10

Retrieves the status of all updates.

Parameters

Name Type In Required Description

percent_complete

integer

query

False

Filter by percent_complete

end_time

string

query

False

Filter by end_time

scheduled_time

string

query

False

Filter by scheduled_time

description

string

query

False

Filter by description

last_state_change_time

string

query

False

Filter by last_state_change_time

content_type

string

query

False

Filter by content_type

state

string

query

False

Filter by state

creation_time

string

query

False

Filter by creation_time

uuid

string

query

False

Filter by uuid

status.code

string

query

False

Filter by status.code

status.message

string

query

False

Filter by status.message

status.arguments.message

string

query

False

Filter by status.arguments.message

status.arguments.code

string

query

False

Filter by status.arguments.code

start_time

string

query

False

Filter by start_time

package_id

string

query

False

Filter by package_id

expiry_time

string

query

False

Filter by expiry_time

content_category

string

query

False

Filter by content_category

remaining_time

string

query

False

Filter by remaining_time

fields

array[string]

query

False

Specify the fields to return.

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

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[auto_update_status]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "self": {
            "href": "/api/resourcelink"
          }
        }
      },
      "action": "schedule_now",
      "content_category": "Firmware",
      "content_type": "disk_fw",
      "creation_time": "2020-12-01 04:12:23 -0500",
      "description": "disk_fw version 3.0",
      "end_time": "2020-12-01 04:12:23 -0500",
      "expiry_time": "2021-06-01 05:12:23 -0400",
      "last_state_change_time": "2020-12-01 04:12:23 -0500",
      "package_id": "572361f3-e769-439d-9c04-2ba48a08ff47",
      "percent_complete": 85,
      "remaining_time": "PT1H45M13S",
      "schedule_time": "2020-12-20 16:00:00 -0500",
      "scheduled_time": "2020-12-05 04:12:23 -0500",
      "start_time": "2020-12-01 04:12:23 -0500",
      "state": "pending_confirmation",
      "status": {
        "arguments": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "code": "4",
        "message": "entry doesn't exist"
      },
      "uuid": "440ae2e4-fd8f-4225-9bee-94e2da3f9d8d"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_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

_links

Name Type Description

next

href

self

href

self

Name Type Description

self

href

_links

Name Type Description

self

self

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

status

Status of the update. ONTAP Message Codes

Code Description

8650878

Get-url request to AutoSupport OnDemand Server failed.

131072105

Package installation successful.

131072106

Package installation failed.

131072107

Package installation is in progress.

131072108

An internal error occurred.

131072109

No errors found.

131072110

Failed to extract package.

131072111

Failed to create entry in status table.

131072209

Failed to download package.

131072210

Failed to obtain download links. Will be retried.

131072211

Installation cannot start because the following nodes are not up. Will be retried.

131072212

Automatic update cannot start. Will be retried.

131072213

Installation complete.

131072214

Installation in progress.

131072215

Scheduled to start.

131072301

Unable to create directory.

131072302

Update not required. It is already on the target firmware version.

131072303

Unable to move installable to installation location.

131072304

Successfully updated. All nodes already updated and skipped.

131072306

Firmware distribution starting.

131072307

Firmware distribution restarting.

131072308

Firmware distribution failed.

131072309

Firmware installation successful on node.

131072310

Firmware installable is corrupt on node.

131072311

Could not apply firmware update on nodes.

131072312

Firmware update operation failed.

131072313

Install failed to initiate on node.

131072314

Install initiated on node.

131072315

Install failed on node.

131072316

Update in progress on node.

131072317

Unexpected state occurred during firmware installation on node.

131072318

Successfully updated SP/BMC firmware.

131072319

Backup SP image is running. Firmware installation failed prematurely on node.

131072320

SP rebooted with an unexpected firmware version on node.

131072321

Waiting for shelf firmware to update.

131072322

Update complete.

131072323

Shelf update timed out.

131072324

Successfully updated shelves on nodes.

131072325

Waiting for disk firmware to update.

131072326

Disk update completed.

131072327

Disk update timed out.

131072328

Successfully updated disks on nodes.

131072329

Waiting for DQP firmware to update.

131072330

Successfully updated DQP on nodes.

131072331

DQP update timed out.

131072332

Failed to copy firmware.
Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

auto_update_status

Name Type Description

_links

_links

action

string

Action to be applied to the automatic update.

content_category

string

Category of the update

content_type

string

Image or package type.

creation_time

string

The date and time at which the update request was received.

description

string

Description of the update.

end_time

string

The date and time at which the update request processing ended.

expiry_time

string

The date and time at which the update request will expire.

last_state_change_time

string

The date and time at which the state of the update changed last.

package_id

string

Unique identifier provided by the back-end.

percent_complete

integer

Percentage of update completed

remaining_time

string

The time remaining for the update processing to complete in an ISO-8601 duration formatted string.

schedule_time

string

Date and time when an automatic update action is scheduled. This field is required when the action field is set to "schedule".

scheduled_time

string

The date and time at which the update request is currently scheduled for.

start_time

string

The date and time at which the update request processing started.

state

string

Current state of the update.

status

status

Status of the update.

ONTAP Message Codes

Code — Description

8650878 — Get-url request to AutoSupport OnDemand Server failed.

131072105 — Package installation successful.

131072106 — Package installation failed.

131072107 — Package installation is in progress.

131072108 — An internal error occurred.

131072109 — No errors found.

131072110 — Failed to extract package.

131072111 — Failed to create entry in status table.

131072209 — Failed to download package.

131072210 — Failed to obtain download links. Will be retried.

131072211 — Installation cannot start because the following nodes are not up. Will be retried.

131072212 — Automatic update cannot start. Will be retried.

131072213 — Installation complete.

131072214 — Installation in progress.

131072215 — Scheduled to start.

131072301 — Unable to create directory.

131072302 — Update not required. It is already on the target firmware version.

131072303 — Unable to move installable to installation location.

131072304 — Successfully updated. All nodes already updated and skipped.

131072306 — Firmware distribution starting.

131072307 — Firmware distribution restarting.

131072308 — Firmware distribution failed.

131072309 — Firmware installation successful on node.

131072310 — Firmware installable is corrupt on node.

131072311 — Could not apply firmware update on nodes.

131072312 — Firmware update operation failed.

131072313 — Install failed to initiate on node.

131072314 — Install initiated on node.

131072315 — Install failed on node.

131072316 — Update in progress on node.

131072317 — Unexpected state occurred during firmware installation on node.

131072318 — Successfully updated SP/BMC firmware.

131072319 — Backup SP image is running. Firmware installation failed prematurely on node.

131072320 — SP rebooted with an unexpected firmware version on node.

131072321 — Waiting for shelf firmware to update.

131072322 — Update complete.

131072323 — Shelf update timed out.

131072324 — Successfully updated shelves on nodes.

131072325 — Waiting for disk firmware to update.

131072326 — Disk update completed.

131072327 — Disk update timed out.

131072328 — Successfully updated disks on nodes.

131072329 — Waiting for DQP firmware to update.

131072330 — Successfully updated DQP on nodes.

131072331 — DQP update timed out.

131072332 — Failed to copy firmware.

uuid

string

Unique identifier for this update.

returned_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.