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.
refresh=<boolean> Re-gather firmware status. Default is false.
package=<boolean> Show package. If false, this returns an empty list. Default
                  is false.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "description": "The firmware status for the cluster.", 
      "properties": {
        "total": {
          "type": "integer", 
          "description": "The total number of nodes responding."
        }, 
        "nodes": {
          "items": {
            "type": "object", 
            "description": "The firmware status for the node.", 
            "properties": {
              "status": {
                "required": false, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Status of the HTTP response from this node if not 200.  If 200, this field does not appear.", 
                "maximum": 4294967295
              }, 
              "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."
              }, 
              "node_unavailable": {
                "type": "boolean", 
                "description": "Node is unavailable."
              }, 
              "devices": {
                "items": {
                  "type": "object", 
                  "description": "The firmware status for a hardware component on the node.", 
                  "properties": {
                    "target_version": {
                      "type": [
                        "string", 
                        "null"
                      ], 
                      "description": "The target firmware version."
                    }, 
                    "mismatch": {
                      "type": [
                        "boolean", 
                        "null"
                      ], 
                      "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."
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this information.", 
                "maximum": 4294967295
              }, 
              "error": {
                "required": false, 
                "type": "string", 
                "description": "Error message, if the HTTP status returned from this node was not 200."
              }, 
              "id": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Node ID of the node reporting this information.", 
                "maximum": 4294967295
              }
            }
          }, 
          "type": "array", 
          "description": "The responses from the individual nodes involved in this request."
        }, 
        "errors": {
          "items": {
            "type": "object", 
            "properties": {
              "status": {
                "minimum": 0, 
                "type": "integer", 
                "description": "HTTP Status code returned by this node.", 
                "maximum": 4294967295
              }, 
              "message": {
                "type": "string", 
                "description": "More detailed description of the error."
              }, 
              "code": {
                "type": "string", 
                "description": "The general meaning of the status code."
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this error.", 
                "maximum": 4294967295
              }
            }
          }, 
          "type": "array", 
          "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors."
        }
      }
    }
  ]
}
