Remote Firmware Update CPC element object

Edit online

A Remote Firmware Update element object defines a firmware update operation that is scheduled to occur on the CPC at a future time.

Table 1. CPC object - Remote Firmware Update element object properties
Name Qualifier Type Description
element-id — String (36) The unique identifier for the remote firmware update instance.
element-uri — String/ URI The canonical URI path for the remote firmware update object, of the form /api/cpcs/{cpc-id}/remote-firmware-updates/{remote-firmware-update-id}, where {cpc-id} is the object-id of the containing CPC, and {remote-firmware-update-id} is the element-id of this remote firmware update.
parent — String/ URI The parent of a remote firmware update is conceptually its owning CPC, and so the parent value is the canonical URI path for the CPC.
class — String (22) The class of a Remote Firmware Update element is "remote-firmware-update".
creation-time — Timestamp The time at which the remote firmware update was scheduled.
scheduled-execution-time — Timestamp The time at which the remote firmware update will begin.
execution-window — Integer The number of minutes the operation will wait if it is blocked at its scheduled execution time, for example due to a busy condition.
execution-percentage (pc) Integer (0-100) The current percentage of this firmware update operation that has completed.

[Added by feature rcl-progress]
execution-steps (pc) Array of Remote Firmware Update Execution Step CPC objects Array of objects that describe the steps in this firmware update operation.

[Added by feature rcl-progress]
target-bundle — String The target bundle level for the firmware update.
state (pc) String Enum The execution state of the scheduled operation.

Values:

  • "scheduled" - The current time is not beyond the "scheduled-execution-time".
  • "running" - The operation is currently executing.
  • "scheduled-on-peer" - The operation is currently in a "scheduled" state on the peer. This state is only applicable when the target of the operation is a console defined as an HMA.
  • "running-on-peer" - The operation is currently in a "running" state on the peer. This state is only applicable when the target of the operation is a console defined as an HMA.
  • "pending" - The operation is complete pending a condition. In order to compete the operation, an additional action specified within the "pending-conditions" property will have to be fulfilled. [Added by feature rcl-history]
  • "succeeded" - The operation completed successfully. If the target of the operation is a specified CPC, then the state value also indicates that the operation completed without any pending conditions. [Added by feature rcl-history]
  • "failed" - The operation failed. The execution-steps list should contain a Remote Firmware Update Execution Step CPC object with a state value of "failed" to indicate the precise step of failure. [Added by feature rcl-history]
pending-conditions (pc) Array of String Enum

The list of conditions that are pending upon the completion of the remote firmware update. Even if the following condition(s) are completed, the state of the operation will still remain as "pending". The value of this property will be an empty array if the state of the operation is not "pending".

  • "cryptos-or-channels-currently-pending-config-off-on" - One or more channels and/or cryptos require a configure off followed by a configure on to apply the new firmware. See the Manage Adapter Firmware UI task.

  • "coupling-facility-partitions-pending-reactivation" - One or more coupling facility partitions require an activation to apply the new firmware. See the Query Coupling Facility Partition Reactivations task.

  • "cpc-changes-pending-power-on-reset" - The system requires a power-on reset to apply the new firmware. See the Query Internal Code Changes Pending Power On Reset task.

  • "pci-partitions-pending-update" - One or more PCI partitions require an update to apply the new firmware. See the Manage PCI System Services task.

  • "pci-adapters-pending-update" - One or more PCI adapters require an update to apply the new firmware. See the Update PCI Adapter Internal Code task.

[Added by feature rcl-history]
scheduling-console-name — String Name of the console from which the remote firmware update was scheduled.

[Added by feature rcl-progress]
service-contact-name — String The name of the service representative that scheduled the operation.

The value may be empty.
service-contact-telephone-number — String The telephone number of the service representative that scheduled the operation.

The value may be empty.
service-contact-email-address — String The email address of the service representative that scheduled the operation.

The value may be empty.