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

    Overview: Upgrade firmware on OneFS cluster.

     Methods: POST

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

Method POST: The settings necessary to start a firmware upgrade.

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

There are no query arguments for this method.

POST request body schema:
{
  "type": "object", 
  "description": "The settings necessary to start a firmware upgrade.", 
  "properties": {
    "nodes_to_upgrade": {
      "items": {
        "type": "integer", 
        "description": "The lnn of the node."
      }, 
      "type": [
        "array", 
        "string", 
        "null"
      ], 
      "description": "The nodes scheduled for upgrade. Order in array determines queue position number. 'All' and null option will upgrade all nodes in <lnn> order."
    }, 
    "exclude_device": {
      "type": "string", 
      "description": "Exclude the specified devices in the firmware upgrade."
    }, 
    "include_type": {
      "type": "string", 
      "description": "Include the specified device type in the firmware upgrade."
    }, 
    "exclude_type": {
      "type": "string", 
      "description": "Exclude the specified device type in the firmware upgrade."
    }, 
    "no_reboot": {
      "type": "boolean", 
      "description": "Do not reboot the node after an upgrade"
    }, 
    "no_verify": {
      "type": "boolean", 
      "description": "Do not verify the firmware upgrade after an upgrade."
    }, 
    "no_burn": {
      "type": "boolean", 
      "description": "Do not burn the firmware."
    }, 
    "include_device": {
      "type": "string", 
      "description": "Include the specified devices in the firmware upgrade."
    }
  }
}

POST 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": "Any empty JSON object is required.", 
      "properties": {}
    }
  ]
}
