Patching Firmware

Caution:

Ensure that all preparation steps for system patching have been completed. For instructions, see Prepare for Patching.

Firmware is included in the ISO image for all component ILOMs, for the Oracle ZFS Storage Appliance, and for the switches. Select the instructions below for the component type you want to patch.

Note:

In software version 3.0.2-b892153 and later all patch operations are based on the upgrade plan, which is generated when the pre-upgrade command is executed. For more information, see Prepare for Patching. When a component is already at the required version, the patch operation is skipped. However, patching with the same version can be forced using the Service Web UI or Service CLI command option (force=True), if necessary.

Obtaining an ILOM IP Address

Using the Service Web UI

In the navigation menu, click Rack Units.
Click on the name of the component you are patching.
Select the Rack Unit Information tab.
Record the IP Address listed under ILOM IPs.

Using the Service CLI

Note:

If the appliance is running software version 3.0.2-b892153 or earlier, use the third option from this list.

To list the ILOM IP addresses of all management nodes or compute nodes, use these commands:

PCA-ADMIN> getCNIloms
Data:
  status = success
  data 1 = 100.96.0.66
  data 2 = 100.96.0.64
  data 3 = 100.96.0.65

PCA-ADMIN> getMNIloms
Data:
  status = success
  data 1 = 100.96.0.33
  data 2 = 100.96.0.34
  data 3 = 100.96.0.35

To obtain the ILOM IP address that corresponds with a specific node host name, use the following command:

PCA-ADMIN> getServerILOMIP hostName=<node_name>

For example:

PCA-ADMIN> getServerILOMIP hostName=pcacn002
Data:
  status = success
  data = 100.96.0.65

PCA-ADMIN> getServerILOMIP hostName=pcamn03
Data:
  status = success
  data = 100.96.0.35

To obtain the ID, IP addresses, and other key information about compute nodes or management nodes, use the following commands:

PCA-ADMIN> list managementNode fields hostname,ipAddress,ilomIp,state,firmwareVersion orderby hostname ASCENDING
Data:
  id                                     Hostname   Ip Address    ILOM Ip Address   State   Firmware Version
  --                                     --------   ----------    ---------------   -----   ----------------
  22ae47d8-a57a-433c-988d-df62fd3548e1   pcamn01    100.96.2.33   100.96.0.33       On      5.0.2.23
  042693b6-3ddb-4fb0-914d-f3deea838c8f   pcamn02    100.96.2.34   100.96.0.34       On      5.0.2.23
  bd2563b8-e310-4fca-ba1b-0e19b8040fc6   pcamn03    100.96.2.35   100.96.0.35       On      5.0.2.23

PCA-ADMIN> list computeNode fields hostname,ipAddress,ilomIp,state,firmwareVersion,provisioningLocked,maintenanceLocked orderby hostname ASCENDING
Data:
  id                                     Hostname   Ip Address    ILOM Ip Address   State   Firmware Version           Provisioning Locked   Maintenance Locked
  --                                     --------   ----------    ---------------   -----   ----------------           -------------------   ------------------
  cf488903-fef8-4a51-8a41-c6990e4755c5   pcacn001   100.96.2.64   100.96.0.64       On      PCA Hypervisor:3.0.2-681   false                 false             
  42a7594d-1173-4dbd-4755-07810cc2d527   pcacn002   100.96.2.65   100.96.0.65       On      PCA Hypervisor:3.0.2-681   false                 false             
  bc0f37d5-ba77-423e-bc11-017704b47e59   pcacn003   100.96.2.66   100.96.0.66       On      PCA Hypervisor:3.0.2-681   false                 false             
  2e5ac527-01f5-4230-ae41-0522fcb57c9a   pcacn004   100.96.2.67   100.96.0.67       On      PCA Hypervisor:3.0.2-681   false                 false             
  5a6b61cf-7e99-4df2-87e4-b37c5fb0bfb8   pcacn005   100.96.2.68   100.96.0.68       On      PCA Hypervisor:3.0.2-681   false                 false             
  885f2aa4-f017-41e8-b2bc-e588cc0c6162   pcacn006   100.96.2.69   100.96.0.69       On      PCA Hypervisor:3.0.2-681   false                 false

Patching ILOMs

Note:

In case a server node needs both the host operating system and the ILOM to be patched, you can avoid having to reboot the same node twice by combining the two patch operations. Instructions are provided in the following sections:

ILOM patches can be applied to management nodes and compute nodes; the firmware packages might be different per component type. You must patch ILOMs one at a time, using each one's internal IP address as a command parameter.

Caution:

You must NOT patch the ILOM of the management node that holds the management virtual IP address, and thus the primary role in the cluster. To determine which management node has the primary role in the cluster, and make another node the primary, use the following Service CLI commands:

PCA-ADMIN> getPrimaryMgmtNode
  status = success
  data = pcamn01

PCA-ADMIN> updatePrimaryNode node=pcamn02
Data:
  status = success
  message = Successfully issued update primary node command

PCA-ADMIN> getPrimaryMgmtNode
  status = success
  data = pcamn02

Using the Service Web UI

In the navigation menu, click Upgrade & Patching.
In the top-right corner of the Upgrade Jobs page, click Create Upgrade or Patch.

The Create Request window appears. Choose Patch as the Request Type.
Select the appropriate patch request type: Patch ILOM.
Fill out the patch parameters:
- ULN: This parameter is deprecated.
- Host IP: Enter the component's assigned IP address in the ILOM network.
- Advanced Options JSON: Not available.
- Log Level: Optionally, select a specific log level for the upgrade log file. The default log level is "Information". For maximum detail, select "Debug".
Click Create Request.

The new patch request appears in the Upgrade Jobs table.

Using the Service CLI

Get the IP address of the ILOM for which you intend to patch the firmware.

Enter the patch command.

Syntax (entered on a single line):

patchIlom
hostIp=<ilom-ip>

Example:

PCA-ADMIN> patchIlom hostIp=100.96.0.62
Command: patchIlom hostIp=100.96.0.62
Status: Success
Time: 2022-01-24 18:18:31,044 UTC
Data:
  Service request has been submitted. Upgrade Job Id = 1620921089806-ilom-21480 Upgrade Request Id = UWS-732d6fce-9f06-4329-b972-d093bee40010

Use the request ID and the job ID to check the status of the upgrade process.

PCA-ADMIN> getUpgradeJobs
  id                               upgradeRequestId                           commandName   result
  --                               ----------------                           -----------   ------
  1620921089806-ilom-21480         UWS-732d6fce-9f06-4329-b972-d093bee40010   ilom          Passed

PCA-ADMIN> getUpgradeJob upgradeJobId=1620921089806-ilom-21480
Command: getUpgradeJob upgradeJobId=1620921089806-ilom-21480
Status: Success
Time: 2023-01-18 18:23:39,690 UTC
Data:
  Upgrade Request Id = UWS-732d6fce-9f06-4329-b972-d093bee40010
  Name = ilom
[...]

Use the syncHardwareData command to update the hardware attributes in the system hardware database.
Note:

The syncHardwareData command is also used for internal automated system tasks. If this automated task is running when you issue the syncHardwareData command manually, a lock will prevent your command from running and you could see this error:
```
This command cannot be performed at this time. Please try again.
```
Wait a few moments, then re-issue the syncHardwareData command.

At the end of the patch, the ILOM itself is rebooted automatically. However, the server component also needs to be rebooted for all changes to take effect. Wait 5 minutes to allow the ILOM workflow to complete first.

For minimum operational impact, schedule the compute node and management node reboot operations after all ILOMs have been patched. Take into account that rebooting the compute nodes requires migrating the compute instances. For more information, refer to "Performing Compute Node Operations" in the Hardware Administration chapter of the Oracle Private Cloud Appliance Administrator Guide.

Patching the ZFS Storage Appliance Operating Software

To patch the operating software of the system's ZFS Storage Appliance, you only need to provide the path to the ULN mirror. The IP addresses of the storage controllers are known, and a single command initiates a rolling patch of both controllers.

Caution:

Ensure that no users are not logged in to the ZFS Storage Appliance or the storage controller ILOMs during the patching process.

Do not make storage configuration changes while an upgrade is in progress. While controllers are running different software versions, configuration changes made to one controller are not propagated to its peer controller.

During firmware patching the storage controllers are placed in active/passive mode. They automatically return to active/active after patching is completed.

Note:

ZFS Storage Appliance updates may include ILOM and BIOS firmware. If an update to the BIOS firmware is required, there will be a note in the Upgrader log indicating that the BIOS will be updated the next time the storage controller is rebooted.

Before You Begin

Before you start patching a ZFS Storage Appliance, you must disable the node state service to prevent errors in node states after the patch operation.

From a management node, set the provisioning lock by issuing this command:
```
pca-admin locks set system provisioning
```
Perform the ZFS Storage Appliance patch operation using either the Service Web UI or the Service CLI procedure below.
Release the provisioning lock.
```
pca-admin locks unset system provisioning
```
Confirm the lock state.
```
pca-admin locks show system
```

Using the Service Web UI

In the navigation menu, click Upgrade & Patching.
In the top-right corner of the Upgrade Jobs page, click Create Upgrade or Patch.

The Create Request window appears. Choose Patch as the Request Type.
Select the appropriate patch request type: Patch Zfssa.
Fill out the patch parameters:
- ULN: This parameter is deprecated.
- Advanced Options JSON: Not available.
- Log Level: Optionally, select a specific log level for the upgrade log file. The default log level is "Information". For maximum detail, select "Debug".
Click Create Request.

The new patch request appears in the Upgrade Jobs table.

Using the Service CLI

Enter the patch command.

PCA-ADMIN> patchZfssa
Command: patchZfssa
Status: Success
Time: 2022-01-24 18:15:07,453 UTC
Data:
  Service request has been submitted. Upgrade Job Id = 1643035466051-zfssa-62915 Upgrade Request Id = UWS-831fd008-cc32-428d-8e76-91c43081f6e7

Use the request ID and the job ID to check the status of the upgrade process.

PCA-ADMIN> getUpgradeJobs
Status: Success
Time: 2023-01-24 18:19:29,731 UTC
Data:
  id                               upgradeRequestId                           commandName   result
  --                               ----------------                           -----------   ------
  1643035466051-zfssa-62915        UWS-831fd008-cc32-428d-8e76-91c43081f6e7   zfssa         Passed
 
PCA-ADMIN> getUpgradeJob upgradeJobId=1643035466051-zfssa-62915
Command: getUpgradeJob upgradeJobId=1643035466051-zfssa-62915
Status: Success
Time: 2022-01-24 18:21:52,775 UTC
Data:
  Upgrade Request Id = UWS-831fd008-cc32-428d-8e76-91c43081f6e7
  Name = zfssa
[...]

Patching the Switch Software

The appliance rack contains three categories of Cisco Nexus switches: a management switch, two leaf switches, and two spine switches. They all run the same Cisco NX-OS network operating software. You must apply the patches in this order: leaf switches first, then spine switches, and finally the management switch. Only one command per switch category is required, meaning that the leaf switches and the spine switches are patched in pairs.

Some versions of the network operating software consist of two files: a binary file and an additional EPLD (electronic programmable logic device) image. Both are automatically retrieved from their designated location during the patch process, and applied in the correct order.

Using the Service Web UI

In the navigation menu, click Upgrade & Patching.
In the top-right corner of the Upgrade Jobs page, click Create Upgrade or Patch.

The Create Request window appears. Choose Patch as the Request Type.
Select the appropriate patch request type: Patch Switch.
Fill out the patch parameters:
- ULN: This parameter is deprecated.
- Advanced Options JSON: Not available.
- Log Level: Optionally, select a specific log level for the upgrade log file. The default log level is "Information". For maximum detail, select "Debug".
- Switch Type: Select the switch type you intend to patch. The preferred order is as follows: leaf switches first, then spine switches, and finally the management switch.
Click Create Request.

The new patch request appears in the Upgrade Jobs table.
When the patch has completed successfully, but other switches in the system still need to be patched, repeat this procedure for any other type of switch that requires patching.

Using the Service CLI

Determine the type of switch to patch (spine, leaf, management).

Enter the patch command.

Syntax (entered on a single line):

patchSwitch 
switchType=[MGMT, SPINE, LEAF]

Example:

PCA-ADMIN> patchSwitch switchType=LEAF
Command: patchSwitch switchType=LEAF
Status: Success
Time: 2023-01-24 18:16:54,704 UTC
Data:
  Service request has been submitted. Upgrade Job Id = 1630511206512-cisco-20299 Upgrade Request Id = UWS-44688fe5-b4f8-407f-a1b5-8cd1b685c2c3

Use the request ID and the job ID to check the status of the upgrade process.

PCA-ADMIN> getUpgradeJobs
Status: Success
Time: 2023-01-24 18:19:29,731 UTC
Data:
  id                               upgradeRequestId                           commandName   result
  --                               ----------------                           -----------   ------
  1632914107346-zfssa-83002        UWS-881af57f-5dfb-4c75-8026-9f00cf3eb7c9   zfssa         Passed
  1630511206512-cisco-20299        UWS-44688fe5-b4f8-407f-a1b5-8cd1b685c2c3   cisco         Passed
  1620921089806-ilom-21480         UWS-732d6fce-9f06-4329-b972-d093bee40010   ilom          Passed
 
PCA-ADMIN> getUpgradeJob upgradeJobId=1630511206512-cisco-20299
Command: getUpgradeJob upgradeJobId=1630511206512-cisco-20299
Status: Success
Time: 2023-01-24 18:27:52,083 UTC
Data:
  Upgrade Request Id = UWS-44688fe5-b4f8-407f-a1b5-8cd1b685c2c3
  Name = cisco
[...]

Use the syncHardwareData command to update the hardware attributes in the system hardware database.
Note:

The syncHardwareData command is also used for internal automated system tasks. If this automated task is running when you issue the syncHardwareData command manually, a lock will prevent your command from running and you could see this error:
```
This command cannot be performed at this time. Please try again.
```
Wait a few moments, then re-issue the syncHardwareData command.