Resource URL: /platform/<<version=3>>/upgrade/cluster/firmware/status

    Overview: The firmware status for the cluster.

     Methods: GET

********************************************************************************

Method GET: The firmware status for the cluster.

       URL: GET /platform/<<version=3>>/upgrade/cluster/firmware/status

Query arguments:
devices=<boolean> Show devices. If false, this returns an empty list. Default
                  is false.
package=<boolean> Show package. If false, this returns an empty list.Default is
                  false.

GET response body schema:
{
  "type": "object", 
  "description": "The firmware status for the cluster.", 
  "properties": {
    "nodes": {
      "items": {
        "type": "object", 
        "description": "The firmware status for the node.", 
        "properties": {
          "lnn": {
            "type": "integer", 
            "description": "The lnn of the node."
          }, 
          "devices": {
            "items": {
              "type": "object", 
              "description": "The firmware status for a hardware component on the node.", 
              "properties": {
                "target_version": {
                  "type": "string", 
                  "description": "The target firmware version."
                }, 
                "mismatch": {
                  "type": "boolean", 
                  "description": "Is the firmware up-to-date for this component."
                }, 
                "version": {
                  "type": "string", 
                  "description": "The current firmware version."
                }, 
                "upgrade_status": {
                  "type": "string", 
                  "description": "The current state of the firmware upgrade for this component. One of the following values: 'queued', 'upgrading', 'upgraded', 'error'. or 'null'.'null' indicates that the upgrade status is unknown."
                }, 
                "device": {
                  "type": "string", 
                  "description": "The name of the device."
                }, 
                "type": {
                  "type": "string", 
                  "description": "The device type."
                }
              }
            }, 
            "type": "array", 
            "description": "List of the firmware status for hardware components on the node."
          }, 
          "package": {
            "items": {
              "type": "object", 
              "description": "The firmware binary information.", 
              "properties": {
                "checksum": {
                  "type": "string", 
                  "description": "Valid checksum string for binary. One of the following: 'ok', 'bad', 'file_missing', or 'na'"
                }, 
                "firmware": {
                  "type": "string", 
                  "description": "The name of the firmware binary."
                }, 
                "version": {
                  "type": "string", 
                  "description": "The version string for the binary."
                }
              }
            }, 
            "type": "array", 
            "description": "List of the firmware binary information for the installed firmware package."
          }
        }
      }, 
      "type": "array", 
      "description": "List of the firmware status information for all the nodes in the cluster."
    }
  }
}
