FAS Recipes and Procedures

Use the Firmware Action Service (FAS) to update the firmware on supported hardware devices. Each procedure includes the prerequisites and example recipes required to update the firmware.

When updating an entire system, walk down the device hierarchy component type by component type, starting first with routers (switches), proceeding to chassis, and then finally to nodes. While this is not strictly necessary, it does help eliminate confusion.

NOTE: Any node that is locked remains in the state inProgress with the stateHelper message of "failed to lock" until the action times out, or the lock is released. If the action is timed out, these nodes report as failed with the stateHelper message of "time expired; could not complete update". This includes NCNs which are manually locked to prevent accidental rebooting and firmware updates.

Refer to FAS Filters for more information on the content used in the example JSON files.

NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

Prerequisites

  • The Cray command line interface (CLI) tool is initialized and configured on the system. See Configure the Cray CLI.

The following procedures are included in this section:

NOTE: To update switch Controllers (sC) or RouterBMCs, refer to the Rosetta documentation.

Update liquid-cooled nodes BMC, AccFPGA0, management Ethernet, AccVBIOS, AccUC and node BIOS

Update firmware for a liquid-cooled node controller (nC) using FAS. This section includes templates for JSON files that can be used and the procedure for running the update.

All of the example JSON files below are set to run a dry-run. Update the overrideDryrun value to true to update the firmware.

This procedure updates node controller (nC) firmware.

NOTE:: AccFPGA0 and AccUC updates requires HFP release 23.12 or later. Previous versions did not contain these firmware.

Liquid-cooled nodes update procedures

Manufacturer: Cray | Device Type: NodeBMC | Target: BMC

BMC firmware with FPGA updates require the nodes to be off. If the nodes are not off when the update command is issued, the update will get deferred until the next power cycle of the BMC, which may be a long period of time.

{
"stateComponentFilter": {

    "deviceTypes": [ "nodeBMC" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "cray"
    },
"targetFilter": {
    "targets": [ "BMC" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of Olympus node BMCs"
  }
}

Manufacturer: Cray | Device Type: NodeBMC | Target: Redstone FPGA AccFPGA0

NOTE: Redstone FPGAs requires HFP release 23.12 or later. Previous versions did not contain the Redstone FPGA firmware.

IMPORTANT: The nodes themselves must be powered on in order to update the firmware of the Redstone FPGA on the nodes.

{
"stateComponentFilter": {

    "deviceTypes": [ "nodeBMC" ]
  },
"inventoryHardwareFilter": {
    "manufacturer": "cray"
    },
"targetFilter": {
    "targets": [
      "Node0.AccFPGA0",
      "Node1.AccFPGA0"
    ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of Node Redstone FPGA"
  }
}

Manufacturer: Cray | Device Type: NodeBMC | Target: AccUC

NOTE: AccUC requires HFP release 23.12 or later. Previous versions did not contain the this firmware.

{
"stateComponentFilter": {

    "deviceTypes": [ "nodeBMC" ]
  },
"inventoryHardwareFilter": {
    "manufacturer": "cray"
    },
"targetFilter": {
    "targets": [ "Node0.AccUC" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of Node AccUC"
  }
}

Manufacturer: Cray | Device Type: NodeBMC | Target: Management Ethernet

{
"stateComponentFilter": {

    "deviceTypes": [ "nodeBMC" ]
  },
"inventoryHardwareFilter": {
    "manufacturer": "cray"
    },
"targetFilter": {
    "targets": [
      "Node0.ManagementEthernet",
      "Node1.ManagementEthernet"
    ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of Node Management Ethernet"
  }
}

Manufacturer: Cray | Device Type: NodeBMC | Target: AccVBIOS

{
"stateComponentFilter": {

    "deviceTypes": [ "nodeBMC" ]
  },
"inventoryHardwareFilter": {
    "manufacturer": "cray"
    },
"targetFilter": {
    "targets": [ "Node0.AccVBIOS" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of Node AccVBIOS"
  }
}

Manufacturer: Cray | Device Type : NodeBMC | Target : NodeBIOS

There may be more than one node that must be updated on each BMC; these have the targets Node0.BIOS and Node1.BIOS, etc. The targets can be run in the same action (as shown in the example) or run separately by only including one target in the action. On larger systems, it is recommended to run as separate actions one after each other as the output will be shorter.

IMPORTANT: The Cray nodeBMC device needs to be updated before the nodeBIOS because the nodeBMC adds a new Redfish field (softwareId) that the NodeX.BIOS update will require. See Update liquid-cooled node firmware for more information.

IMPORTANT: The nodes themselves must be powered off in order to update the BIOS on the nodes. The BMC will still have power and will perform the update. If nodes are not off when the update command is issued, it will report as a failed update.

IMPORTANT: When the BMC is updated or rebooted after updating the Node0.BIOS and/or Node1.BIOS liquid-cooled nodes, the node BIOS version will not report the new version string until the nodes are powered back on. It is recommended that the Node0/1 BIOS be updated in a separate action, after a BMC update. It is also recommended that the nodes be powered back on after the updates are completed. If the nodes have never been powered on in the system before (they are being added during a hardware add procedure), then use the Boot Orchestration Service (BOS) to power them on. Using BOS will prepare the initial boot artifacts required to boot them. If this is not the first time they have been powered on in this system, then you can use the Power Control Service (PCS) to power them on.

{
"stateComponentFilter": {

    "deviceTypes": [ "nodeBMC" ]
  },
"inventoryHardwareFilter": {
    "manufacturer": "cray"
    },
"targetFilter": {
    "targets": [
      "Node0.BIOS",
      "Node1.BIOS"
    ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of Node BIOS"
  }
}
Cray node firmware and BIOS update procedure

NOTE: The FASUpdate.py script can be used to perform default updates to firmware and BIOS. Use the file cray_nodeBMC_BMC.json for node BMC updates, cray_nodeBMC_nodeBIOS.json (or cray_nodeBMC_node[0-4]BIOS.json) for node BIOS updates, or cray_nodeBMC_nodeAccFPGA0.json (or cray_nodeBMC_node[0-1]AccFPGA0.json) for FPG updates, or cray_nodeBMC_nodeManagementEthernet.json (or cray_nodeBMC_node[0-3]ManagementEthernet.json) for Management Ethernet updates, or cray_nodeBMC_nodeAccUC.json for AccUC updates.

  1. Create a JSON file using one of the example recipes with the command parameters required for updating the firmware or node BIOS.

  2. Initiate a dry-run to verify that the firmware can be updated. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

    1. (ncn#) Create the dry-run session.

      The overrideDryrun = false value indicates that the command will do a dry run.

      cray fas actions create nodeBMC.json --format toml

      Example output:

      overrideDryrun = false
actionID = "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d"

    2. (ncn#) Describe the actionID for firmware update dry-run job.

      Replace the actionID value with the string returned in the previous step. In this example, "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d" is used.

      cray fas actions describe {actionID} --format toml

      Example output:

      blockedBy = []
state = "completed"
actionID = "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d"
startTime = "2020-08-31 15:49:44.568271843 +0000 UTC"
snapshotID = "00000000-0000-0000-0000-000000000000"
endTime = "2020-08-31 15:51:35.426714612 +0000 UTC"

[command]
description = "Update Cray Node BMCs Dryrun"
tag = "default"
restoreNotPossibleOverride = true
timeLimit = 10000
version = "latest"
overrideDryrun = false

      If state = "completed", the dry-run has found and checked all the nodes. Check the following sections for more information:

      • Lists the nodes that have a valid image for updating:

        [operationSummary.succeeded]

      • Lists the nodes that will not be updated because they are already at the correct version:

        [operationSummary.noOperation]

      • Lists the nodes that had an error when attempting to update:

        [operationSummary.failed]

      • Lists the nodes that do not have a valid image for updating:

        [operationSummary.noSolution]

  3. Update the firmware after verifying that the dry-run worked as expected. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

    1. Edit the JSON file and update the values so an actual firmware update can be run.

      The following example is for the nodeBMC.json file. Update the following values:

      "overrideDryrun":true,
"description":"Update Cray Node BMCs"

    2. (ncn#) Run the firmware update.

      The output overrideDryrun = true indicates that an actual firmware update job was created. A new actionID will also be displayed.

      cray fas actions create nodeBMC.json --format toml

      Example output:

      overrideDryrun = true
actionID = "bc40f10a-e50c-4178-9288-8234b336077b"

      The time it takes for a firmware action to finish varies. It can be a few minutes or over 20 minutes depending on response time.

      The liquid-cooled node BMC automatically reboots after the BMC firmware has been loaded.

  4. Retrieve the operationID and verify that the update is complete.

    cray fas actions describe {actionID} --format toml

    Example output:

    [operationSummary.failed]
[[operationSummary.failed.operationKeys]]
stateHelper = "unexpected change detected in firmware version. Expected nc.1.3.10-shasta-release.arm.2020-07-21T23:58:22+00:00.d479f59 got: nc.cronomatic-dev.arm.2019-09-24T13:20:24+00:00.9d0f8280"
fromFirmwareVersion = "nc.cronomatic-dev.arm.2019-09-24T13:20:24+00:00.9d0f8280"
xname = "x1005c6s4b0"
target = "BMC"
operationID = "e910c6ad-db98-44fc-bdc5-90477b23386f"

  5. (ncn#) View more details for an operation using the operationID from the previous step.

    Check the list of nodes for the failed or completed state.

    cray fas operations describe {operationID}

    For example:

    cray fas operations describe "e910c6ad-db98-44fc-bdc5-90477b23386f" --format toml

    Example output:

    fromFirmwareVersion = "nc.cronomatic-dev.arm.2019-09-24T13:20:24+00:00.9d0f8280"
fromTag = ""
fromImageURL = ""
endTime = "2020-08-31 16:40:13.464321212 +0000 UTC"
actionID = "bc40f10a-e50c-4178-9288-8234b336077b"
startTime = "2020-08-31 16:28:01.228524446 +0000 UTC"
fromSemanticFirmwareVersion = ""
toImageURL = ""
model = "WNC_REV_B"
operationID = "e910c6ad-db98-44fc-bdc5-90477b23386f"
fromImageID = "00000000-0000-0000-0000-000000000000"
target = "BMC"
toImageID = "39c0e553-281d-4776-b68e-c46a2993485e"
toSemanticFirmwareVersion = "1.3.10"
refreshTime = "2020-08-31 16:40:13.464325422 +0000 UTC"
blockedBy = []
toTag = ""
state = "failed"
stateHelper = "unexpected change detected in firmware version. Expected nc.1.3.10-shasta-release.arm.2020-07-21T23:58:22+00:00.d479f59 got: nc.cronomatic-dev.arm.2019-09-24T13:20:24+00:00.9d0f8280"
deviceType = "NodeBMC"

    Once firmware and BIOS are updated, the compute nodes can be turned back on. If the nodes have never been powered on in the system before (they are being added during a hardware add procedure), then use Boot Orchestration Service (BOS) to power them on. Using BOS will prepare the initial boot artifacts required to boot them. If this is not the first time they have been powered on in this system, then you can use the Power Control Service (PCS) to power them on.

Update Chassis Management Module firmware

Update the Chassis Management Module (CMM) controller (cC) firmware using FAS. This procedure uses the dry-run feature to verify that the update will be successful.

The CMM firmware update process also checks and updates the Cabinet Environmental Controller (CEC) firmware.

Manufacturer: Cray | Device Type: ChassisBMC | Target: BMC

IMPORTANT: Before updating a CMM, make sure all slot and rectifier power is off and the discovery job is stopped (see procedure below).

{
"inventoryHardwareFilter": {
    "manufacturer": "cray"
    },
"stateComponentFilter": {
    "deviceTypes": [ "chassisBMC" ]
},
"targetFilter": {
    "targets": [ "BMC" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of Cray Chassis Controllers"
  }
}

Cray chassis BMC update procedure

NOTE: The FASUpdate.py script can be used to perform default updates to firmware and BIOS. Use the file cray_chassisBMC_BMC.json for chassis BMC updates.

  1. (ncn#) Power off the liquid-cooled chassis slots and chassis rectifiers.

    1. Disable the hms-discovery Kubernetes cronjob:

      kubectl -n services patch cronjobs hms-discovery -p '{"spec" : {"suspend" : true }}'

    2. Power off all the components. For example, in chassis 0-7, cabinets 1000-1003:

      cray power transition off --xnames x[1000-1003]c[0-7] --include children

      This command powers off all the node cards, then all the compute blades, then all the Slingshot switch modules, and finally all the chassis enclosures in cabinets 1000-1003.

      When power is removed from a chassis, the high-voltage DC rectifiers that support the chassis are powered off.

  2. Create a JSON file using the example recipe above with the command parameters required for updating the CMM firmware.

  3. (ncn#) Initiate a dry-run to verify that the firmware can be updated. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

    1. Create the dry-run session.

      The overrideDryrun = false value indicates that the command will do a dry-run.

      cray fas actions create chassisBMC.json --format toml

      Example output:

      overrideDryrun = false
actionID = "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d"

    2. (ncn#) Describe the actionID to see the firmware update dry-run job status.

      Replace the actionID value with the string returned in the previous step. In this example, "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d" is used.

      cray fas actions describe {actionID} --format toml

      Example output:

      blockedBy = []
state = "completed"
actionID = "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d"
startTime = "2020-08-31 15:49:44.568271843 +0000 UTC"
snapshotID = "00000000-0000-0000-0000-000000000000"
endTime = "2020-08-31 15:51:35.426714612 +0000 UTC"

[command]
description = "Update Cray Chassis Management Module controllers Dryrun"
tag = "default"
restoreNotPossibleOverride = true
timeLimit = 10000
version = "latest"
overrideDryrun = false

      If state = "completed", the dry-run has found and checked all the nodes. Check the following sections for more information:

      • Lists the nodes that have a valid image for updating:

        [operationSummary.succeeded]

      • Lists the nodes that will not be updated because they are already at the correct version:

        [operationSummary.noOperation]

      • Lists the nodes that had an error when attempting to update:

        [operationSummary.failed]

      • Lists the nodes that do not have a valid image for updating:

        [operationSummary.noSolution]

  4. Update the firmware after verifying that the dry-run worked as expected. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

    1. Edit the JSON file and update the values so an actual firmware update can be run.

      The following example is for the chassisBMC.json file. Update the following values:

      "overrideDryrun":true,
"description":"Update Cray Chassis Management Module controllers"

    2. (ncn#) Run the firmware update.

      The output overrideDryrun = true indicates that an actual firmware update job was created. A new actionID will also be displayed.

      cray fas actions create chassisBMC.json --format toml

      Example output:

      overrideDryrun = true
actionID = "bc40f10a-e50c-4178-9288-8234b336077b"

      The time it takes for a firmware update varies. It can be a few minutes or over 20 minutes depending on response time.

  5. (ncn#) Restart the hms-discovery cronjob.

    kubectl -n services patch cronjobs hms-discovery -p '{"spec" : {"suspend" : false }}'

    The hms-discovery cronjob will run within 5 minutes of being unsuspended and start powering on the chassis enclosures, switches, and compute blades. If components are not being powered back on, then power them on manually:

    cray power transition on --xnames x[1000-1003]c[0-7]r[0-7],x[1000-1003]c[0-7]s[0-7] --include parents

    The --include parents option ensures all required components are powered on first.

  6. After the required components have powered on, the nodes can be powered on and booted using the Boot Orchestration Service (BOS).

Update air-cooled compute node BMC, BIOS, iLO 5, iLO 6, and system ROM

Firmware and BIOS for Gigabyte and HPE compute nodes can be updated with FAS. This section includes templates for JSON files that can be used for updates, and the procedure for running the updates.

All of the example JSON files below are set to run a dry-run. Update the overrideDryrun value to true to update the firmware.

After updating the BIOS or System ROM, the compute node will need to be rebooted before the new version will be displayed in the Redfish output.

This procedure updates node controller (nC) firmware.

Gigabyte

Manufacturer: Gigabyte | Device Type: Compute NodeBMC | Target: BMC

{
"stateComponentFilter": {
    "deviceTypes": [ "nodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "gigabyte"
    },
"targetFilter": {
    "targets": [ "BMC" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 4000,
    "description": "Dryrun upgrade of Gigabyte node BMCs"
  }
}

IMPORTANT: The timeLimit is 4000 because the Gigabytes can take a lot longer to update.

Troubleshooting:

A node may fail to update with the output:

stateHelper = "Firmware Update Information Returned Downloading – See /redfish/v1/UpdateService"

FAS has incorrectly marked this node as failed. It most likely will complete the update successfully.

To resolve this issue, do either of the following actions:

  • Check the update status by looking at the Redfish FirmwareInventory (/redfish/v1/UpdateService/FirmwareInventory/BMC).
  • Rerun FAS to verify that the BMC firmware was updated.

Make sure to wait for the current firmware to be updated before starting a new FAS action on the same node.

Manufacturer: Gigabyte | Device Type: Compute NodeBMC | Target: BIOS

{
"stateComponentFilter": {
    "deviceTypes": [ "nodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "gigabyte"
    },
"targetFilter": {
    "targets": [ "BIOS" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 4000,
    "description": "Dryrun upgrade of Gigabyte node BIOS"
  }
}

IMPORTANT: The timeLimit is 4000 because the Gigabytes can take a lot longer to update.

HPE

Manufacturer: HPE | Device Type: Compute NodeBMC | Target: iLO 5 aka BMC

IMPORTANT: Updating to iLO 5 version above 2.78 requires an install of 2.78 first. See FAS Update iLO 5 to 2.78

{
"stateComponentFilter": {
    "deviceTypes": [ "nodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "hpe"
    },
"targetFilter": {
    "targets": [ "iLO 5" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of HPE node iLO 5"
  }
}

Manufacturer: HPE | Device Type: Compute NodeBMC | Target: iLO 6 aka BMC

{
"stateComponentFilter": {
    "deviceTypes": [ "nodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "hpe"
    },
"targetFilter": {
    "targets": [ "iLO 6" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of HPE node iLO 6"
  }
}

Manufacturer: HPE | Device Type: Compute NodeBMC | Target: System ROM aka BIOS

IMPORTANT: If updating the System ROM of an NCN, the NTP and DNS server values will be lost and must be restored. For NCNs other than ncn-m001 this can be done using the /opt/cray/csm/scripts/node_management/set-bmc-ntp-dns.sh script. Use the -h option to get a list of command line options required to restore the NTP and DNS values. See Configure DNS and NTP on Each BMC.

{
"stateComponentFilter": {
    "deviceTypes": [ "NodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "hpe"
    },
"targetFilter": {
    "targets": [ "System ROM" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of HPE node system rom"
  }
}

HPE and Gigabyte compute node update procedure

NOTE: The FASUpdate.py script can be used to perform default updates to firmware and BIOS. Use the file gigabyte_nodeBMC_BMC.json for Gigabyte node BMC updates, the file gigabyte_nodeBMC_BIOS.json for Gigabyte node BIOS updates, the file hpe_nodeBMC_iLO5.json for HPE node iLO 5 updates, the file hpe_nodeBMC_iLO6.json for HPE node iLO 6 updates, or the file hpe_nodeBMC_systemRom.json for HPE node System ROM updates.

IMPORTANT: Updating to iLO 5 version above 2.78 requires an install of 2.78 first. See FAS Update iLO 5 to 2.78

  1. Create a JSON file using one of the example recipes with the command parameters required for updating the firmware or node BIOS.

  2. (ncn#) Initiate a dry-run to verify that the firmware can be updated.

    1. Create the dry-run session. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

      The overrideDryrun = false value indicates that the command will do a dry run.

      cray fas actions create nodeBMC.json --format toml

      Example output:

      overrideDryrun = false
actionID = "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d"

    2. Describe the actionID for firmware update dry-run job.

      Replace the actionID value with the string returned in the previous step. In this example, "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d" is used.

      cray fas actions describe {actionID} --format toml

      Example output:

      blockedBy = []
state = "completed"
actionID = "fddd0025-f5ff-4f59-9e73-1ca2ef2a432d"
startTime = "2020-08-31 15:49:44.568271843 +0000 UTC"
snapshotID = "00000000-0000-0000-0000-000000000000"
endTime = "2020-08-31 15:51:35.426714612 +0000 UTC"

[command]
description = "Update of HPE Node iLO5"
tag = "default"
restoreNotPossibleOverride = true
timeLimit = 10000
version = "latest"
overrideDryrun = false

      If state = "completed", the dry-run has found and checked all the nodes. Check the following sections for more information:

      • Lists the nodes that have a valid image for updating:

        [operationSummary.succeeded]

      • Lists the nodes that will not be updated because they are already at the correct version:

        [operationSummary.noOperation]

      • Lists the nodes that had an error when attempting to update:

        [operationSummary.failed]

      • Lists the nodes that do not have a valid image for updating:

        [operationSummary.noSolution]

  3. (ncn#) Update the firmware after verifying that the dry-run worked as expected. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

    1. Edit the JSON file and update the values so an actual firmware update can be run.

      The following example is for the nodeBMC.json file. Update the following values:

      "overrideDryrun":true,
"description":"Update of HPE node iLO 5"

    2. Run the firmware update.

      The returned overrideDryrun = true indicates that an actual firmware update job was created. A new actionID will also be returned.

      cray fas actions create nodeBMC.json --format toml

      Example output:

      overrideDryrun = true
actionID = "bc40f10a-e50c-4178-9288-8234b336077b"

      The time it takes for a firmware action to finish varies. It can be a few minutes or over 20 minutes depending on response time.

      The air-cooled node BMC automatically reboots after the BMC, iLO 5, or iLO 6 firmware has been loaded.

  4. Retrieve the operationID and verify that the update is complete.

    cray fas actions describe {actionID} --format toml

    Example output:

    [operationSummary.failed]
[[operationSummary.failed.operationKeys]]
stateHelper = "unexpected change detected in firmware version. Expected 2.46 May 11 2021 got: 2.32 Apr 27 2020"
fromFirmwareVersion = "2.32 Apr 27 2020"
xname = "x1005c6s4b0"
target = "iLO 5"
operationID = "e910c6ad-db98-44fc-bdc5-90477b23386f"

  5. View more details for an operation using the operationID from the previous step.

    Check the list of nodes for the failed or completed state.

    cray fas operations describe {operationID}

    For example:

    cray fas operations describe "e910c6ad-db98-44fc-bdc5-90477b23386f" --format toml

    Example output:

    fromFirmwareVersion = "2.32 Apr 27 2020"
fromTag = ""
fromImageURL = ""
endTime = "2020-08-31 16:40:13.464321212 +0000 UTC"
actionID = "bc40f10a-e50c-4178-9288-8234b336077b"
startTime = "2020-08-31 16:28:01.228524446 +0000 UTC"
fromSemanticFirmwareVersion = ""
toImageURL = ""
model = "ProLiant DL325 Gen10 Plus"
operationID = "e910c6ad-db98-44fc-bdc5-90477b23386f"
fromImageID = "00000000-0000-0000-0000-000000000000"
target = "iLO 5"
toImageID = "39c0e553-281d-4776-b68e-c46a2993485e"
toSemanticFirmwareVersion = "2.46.0"
refreshTime = "2020-08-31 16:40:13.464325422 +0000 UTC"
blockedBy = []
toTag = ""
state = "failed"
stateHelper = "unexpected change detected in firmware version. Expected 2.46 May 11 2021 got: 2.32 Apr 27 2020"
deviceType = "NodeBMC"

Update Non-Compute Node (NCN) BIOS and BMC firmware

Gigabyte and HPE non-compute nodes (NCNs) firmware can be updated with FAS. This section includes templates for JSON files that can be used to update firmware with the cray fas actions create command.

After creating the JSON file for the device being upgraded, use the following command to run the FAS job:

cray fas actions create CUSTOM_DEVICE_PARAMETERS.json

All of the example JSON files below are set to run a dry-run. Update the overrideDryrun value to True to update the firmware.

WARNING: Rebooting more than one NCN at a time MAY cause system instability. Be sure to follow the correct process for updating NCNs. Firmware updates have the capacity to harm the system.

After updating the BIOS, the NCN will need to be rebooted. Follow the Reboot NCNs procedure.

Due to networking, FAS cannot update ncn-m001. See Updating Firmware on ncn-m001

Gigabyte NCNs

Manufacturer: Gigabyte | Device Type: NCN NodeBMC | Target: BMC

{
"stateComponentFilter": {
    "deviceTypes": [ "nodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "gigabyte"
    },
"targetFilter": {
    "targets": [ "BMC" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 4000,
    "description": "Dryrun upgrade of Gigabyte node BMCs"
  }
}

IMPORTANT: The timeLimit is 4000 because the Gigabytes can take a lot longer to update.

Troubleshooting: It may report that a node failed to update with the output: stateHelper = "Firmware Update Information Returned Downloading – See /redfish/v1/UpdateService" FAS has incorrectly marked this node as failed. It most likely will complete the update successfully. To resolve this issue, do either of the following actions:

  • Check the update status by looking at the Redfish FirmwareInventory (/redfish/v1/UpdateService/FirmwareInventory/BMC)
  • Rerun FAS to verify that the BMC firmware was updated.

Make sure you have waited for the current firmware to be updated before starting a new FAS action on the same node.

Manufacturer: Gigabyte | Device Type: NCN NodeBMC | Target: BIOS

{
"stateComponentFilter": {
    "deviceTypes": [ "nodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "gigabyte"
    },
"targetFilter": {
    "targets": [ "BIOS" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 4000,
    "description": "Dryrun upgrade of Gigabyte node BIOS"
  }
}

IMPORTANT: The timeLimit is 4000 because the Gigabytes can take a lot longer to update.

HPE NCNs

Manufacturer: HPE | Device Type: NCN NodeBMC | Target: iLO 5 aka BMC

IMPORTANT: Updating to iLO 5 version above 2.78 requires an install of 2.78 first. See FAS Update iLO 5 to 2.78

{
"stateComponentFilter": {
    "deviceTypes": [ "nodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "hpe"
    },
"targetFilter": {
    "targets": [ "iLO 5" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of HPE node iLO 5"
  }
}

Manufacturer: HPE | Device Type: NCN NodeBMC | Target: System ROM aka BIOS

IMPORTANT: If updating the System ROM of an NCN, the NTP and DNS server values will be lost and must be restored. For NCNs other than ncn-m001 this can be done using the /opt/cray/csm/scripts/node_management/set-bmc-ntp-dns.sh script. Use the -h option to get a list of command line options required to restore the NTP and DNS values. See Configure DNS and NTP on Each BMC.

{
"stateComponentFilter": {
    "deviceTypes": [ "NodeBMC" ],
    "xnames": [ "x3000c0s1b0" ]
},
"inventoryHardwareFilter": {
    "manufacturer": "hpe"
    },
"targetFilter": {
    "targets": [ "System ROM" ]
  },
"command": {
    "version": "latest",
    "tag": "default",
    "overrideDryrun": false,
    "restoreNotPossibleOverride": true,
    "timeLimit": 1000,
    "description": "Dryrun upgrade of HPE node system rom"
  }
}

The NCN must be rebooted after updating the BIOS firmware. Follow the Reboot NCNs procedure.

Procedure for NCN updates

IMPORTANT: Updating to iLO 5 version above 2.78 requires an install of 2.78 first. See FAS Update iLO 5 to 2.78

NOTE: The FASUpdate.py script can be used to perform default updates to firmware and BIOS. Use the file gigabyte_nodeBMC_BMC.json for Gigabyte node BMC updates, the file gigabyte_nodeBMC_BIOS.json for Gigabyte node BIOS updates, the file hpe_nodeBMC_iLO5.json for HPE node iLO 5 updates, the file hpe_nodeBMC_iLO6.json for HPE node iLO 6 updates, or the file hpe_nodeBMC_systemRom.json for HPE node System ROM updates. The script flag --xnames can be used to limit the updates to certain xnames. NOTE: Use the xname of the BMC not the node.

(ncn#) To get a list of NCNs on a system:

BMC_XNAMES=$(cray bss bootparameters list --format=json | jq -c '.[] | { "hostname" : ."cloud-init"."meta-data"."local-hostname", "xname" : .hosts[0] }' | grep -v :null | jq -r .xname | sed s/n[0-9]// | paste -d',' -s)
echo $BMC_XNAMES

This can be used with the FASUpdate.py --xnames $BMC_XNAMES script to limit the xnames to just the NCNs. NOTE: Use the xname of the BMC not the node. Example output:

x3000c0s13b0,x3000c0s14b0,x3000c0s18b0,x3000c0s1b0,x3000c0s2b0,x3000c0s3b0,x3000c0s4b0,x3000c0s5b0,x3000c0s6b0,x3000c0s7b0,x3000c0s8b0,x3000c0s9b0

  1. For HPE NCNs, check the DNS servers by running the script /opt/cray/csm/scripts/node_management/set-bmc-ntp-dns.sh ilo -H XNAME -s. Replace XNAME with the xname of the NCN BMC. If the DNS server is incorrect, the node will not be able to download the firmware. See Configure DNS and NTP on Each BMC for more information.

  2. Run a dryrun for all NCNs first to determine which NCNs and targets need updating. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.

    NOTE: Update of BMC, iLO 5 and iLO 6 will not affect the nodes.

  3. For each NCN requiring updates to target BMC, iLO 5, or iLO 6:

    1. Unlock the NCN BMC. See Lock and Unlock Management Nodes.
    2. Run the FAS action on the NCN. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.
    3. Relock the NCN BMC. See Lock and Unlock Management Nodes.

  4. For each NCN requiring updates to target BIOS or System ROM:

    1. Unlock the NCN BMC. See Lock and Unlock Management Nodes.
    2. Run the FAS action on the NCN. NEW: The FASUpdate.py script can be used to perform default updates to firmware and BIOS.
    3. Reboot the node. The node must be rebooted for the new BIOS to be used. You may reboot the node(s) at a later time, but the BIOS version will not reflect the updated version until rebooted. Make sure to run the next step for HPE NCNs after rebooting the node. See Reboot NCNs.
    4. For HPE NCNs, run the script /opt/cray/csm/scripts/node_management/set-bmc-ntp-dns.sh. See Configure DNS and NTP on Each BMC.
    5. Relock the NCN BMC. See Lock and Unlock Management Nodes.

Compute node BIOS workaround for HPE CRAY EX425

Correct an issue where the model of the liquid-cooled compute node BIOS is the incorrect name. The name has changed from WNC-ROME to HPE CRAY EX425 or HPE CRAY EX425 (ROME).

Prerequisites:

  • The system is running HPE Cray EX release v1.4 or higher.

  • A firmware upgrade has been done following Update liquid-cooled compute node BIOS firmware.

    • The result of the upgrade is that the NodeX.BIOS has failed as noSolution and the stateHelper field for the operation states is "No Image Available".
    • The BIOS in question is running a version less than or equal to 1.2.5 as reported by Redfish or described by the noSolution operation in FAS.

  • The hardware model reported by Redfish is wnc-rome, which is now designated as HPE CRAY EX425.

    (ncn#) If the Redfish model is different (ignoring casing) and the blades in question are not Windom, contact customer support. To find the model reported by Redfish, run the following:

    cray fas operations describe {operationID} --format json

    Example output:

    {
  "operationID":"102c949f-e662-4019-bc04-9e4b433ab45e",
  "actionID":"9088f9a2-953a-498d-8266-e2013ba2d15d",
  "state":"noSolution",
  "stateHelper":"No Image available",
  "startTime":"2021-03-08 13:13:14.688500503 +0000 UTC",
  "endTime":"2021-03-08 13:13:14.688508333 +0000 UTC",
  "refreshTime":"2021-03-08 13:13:14.722345901 +0000 UTC",
  "expirationTime":"2021-03-08 15:59:54.688500753 +0000 UTC",
  "xname":"x9000c1s0b0",
  "deviceType":"NodeBMC",
  "target":"Node1.BIOS",
  "targetName":"Node1.BIOS",
  "manufacturer":"cray",
  "model":"WNC-Rome",
  "softwareId":"",
  "fromImageID":"00000000-0000-0000-0000-000000000000",
  "fromSemanticFirmwareVersion":"",
  "fromFirmwareVersion":"wnc.bios-1.2.5",
  "fromImageURL":"",
  "fromTag":"",
  "toImageID":"00000000-0000-0000-0000-000000000000",
  "toSemanticFirmwareVersion":"",
  "toFirmwareVersion":"",
  "toImageURL":"",
  "toTag":"",
  "blockedBy":[
    ]
}

    The model in this example is WNC-Rome and the firmware version currently running is wnc.bios-1.2.5.

Compute node BIOS workaround for HPE CRAY EX425 procedure

  1. (ncn#) Search for a FAS image record with cray as the manufacturer, Node1.BIOS as the target, and HPE CRAY EX425 as the model.

    cray fas images list --format json | jq '.images[] | select(.manufacturer=="cray") \
| select(.target=="Node1.BIOS") | select(any(.models[]; contains("EX425")))'

    Example output:

    {
    "imageID": "e23f5465-ed29-4b18-9389-f8cf0580ca60",
    "createTime": "2021-03-04T00:04:05Z",
    "deviceType": "nodeBMC",
    "manufacturer": "cray",
    "models": [
      "HPE CRAY EX425"
    ],
    "softwareIds": [
      "bios.ex425.."
    ],
    "target": "Node1.BIOS",
    "tags": [
      "default"
    ],
    "firmwareVersion": "ex425.bios-1.4.3",
    "semanticFirmwareVersion": "1.4.3",
    "pollingSpeedSeconds": 30,
    "s3URL": "s3:/fw-update/2227040f7c7d11eb9fa00e2f2e08fd5d/ex425.bios-1.4.3.tar.gz"
  }

    Take note of the returned imageID value to use in the next step.

  2. Create a JSON file to override the existing image with the corrected values.

    IMPORTANT: The imageID must be changed to match the identified imageID in the previous step.

    {
   "stateComponentFilter":{
      "deviceTypes":[ "nodeBMC" ]
   },
   "inventoryHardwareFilter":{
      "manufacturer":"cray"
   },
   "targetFilter":{
      "targets":[
         "Node0.BIOS",
         "Node1.BIOS"
      ]
   },
   "imageFilter":{
      "imageID":"e23f5465-ed29-4b18-9389-f8cf0580ca60",
      "overrideImage":true
   },
   "command":{
      "version":"latest",
      "tag":"default",
      "overrideDryrun":true,
      "restoreNotPossibleOverride":true,
      "timeLimit":1000,
      "description":" upgrade of Node BIOS"
   }
}

  3. (ncn#) Run a firmware upgrade using the updated parameters defined in the new JSON file.

    cray fas actions create UPDATED_COMMAND.json

  4. (ncn#) Get a high-level summary of the job to verify the changes corrected the issue.

    Use the returned actionID from the cray fas actions create command.

    cray fas actions create UPDATED_COMMAND.json