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

    Overview: The cluster-wide upgrade information.

     Methods: GET

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

Method GET: Cluster wide upgrade status info.

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

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "description": "Cluster wide upgrade status info.", 
  "properties": {
    "cluster_overview": {
      "type": "object", 
      "description": "The cluster overview of an upgrade process.", 
      "properties": {
        "nodes_current": {
          "type": [
            "integer", 
            "null"
          ], 
          "description": "Number of nodes running the current OneFS version."
        }, 
        "nodes_transitioning": {
          "type": [
            "integer", 
            "null"
          ], 
          "description": "Number of nodes transitioning between OneFS versions. Null if the cluster_state is 'committed' or 'assessing.'"
        }, 
        "nodes_total": {
          "type": "integer", 
          "description": "Total number of nodes on the cluster."
        }, 
        "nodes_upgraded": {
          "type": [
            "integer", 
            "null"
          ], 
          "description": "Number of nodes running the upgraded OneFS version. Null if the cluster_state is 'committed' or 'assessing.'"
        }
      }
    }, 
    "install_image_path": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The location (path) of the upgrade image which must be within /ifs.\nNull if the cluster_state is 'committed' or 'upgraded.'"
    }, 
    "cluster_state": {
      "type": "string", 
      "description": "The different states of an upgrade, rollback, or assessment. One of the following values: 'committed', 'upgraded', 'partially upgraded', 'upgrading', 'rolling back', 'assessing', 'error'"
    }, 
    "onefs_version_current": {
      "type": "object", 
      "description": "The current OneFS version before upgrade.", 
      "properties": {
        "bugfix": {
          "type": "integer"
        }, 
        "major": {
          "type": "integer"
        }, 
        "version": {
          "type": "string", 
          "description": "hex representation of the OneFS version integer."
        }, 
        "minor": {
          "type": "integer"
        }, 
        "maintenance": {
          "type": "integer"
        }
      }
    }, 
    "finish_time": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The time when a rollback, assessment or upgrade has finished completely. Use ISO 8601 standard. Null if the cluster_state is not 'upgraded'."
    }, 
    "start_time": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The time when an upgrade, rollback, or assessment was started. Use ISO 8601 standard. Null if the cluster_state is 'committed' or 'partially upgraded.'"
    }, 
    "patch_name": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The patch with the most recent patch action."
    }, 
    "onefs_version_upgrade": {
      "type": [
        "object", 
        "null"
      ], 
      "description": "The OneFS version the user is attempting to upgrade to. Null if the cluster_state is 'committed' or 'assessing.'", 
      "properties": {
        "bugfix": {
          "type": "integer"
        }, 
        "major": {
          "type": "integer"
        }, 
        "version": {
          "type": "string", 
          "description": "hex representation of the OneFS version integer."
        }, 
        "minor": {
          "type": "integer"
        }, 
        "maintenance": {
          "type": "integer"
        }
      }
    }, 
    "patch_action": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The most recent patch action performed."
    }, 
    "upgrade_settings": {
      "type": [
        "object", 
        "null"
      ], 
      "description": "The settings neccessary when starting an upgrade. Null if the cluster_state is not 'upgrading' or 'partially upgraded.' or 'error'.", 
      "properties": {
        "nodes_to_rolling_upgrade": {
          "items": {
            "type": "integer", 
            "description": "The lnn of the node."
          }, 
          "type": [
            "array", 
            "string", 
            "null"
          ], 
          "description": "The nodes (to be) scheduled for upgrade ordered by queue position number. Null if the cluster_state is 'partially upgraded' or upgrade_type is 'simultaneous'. One of the following values: [<lnn-1>, <lnn-2>, ... ], 'All', null"
        }, 
        "upgrade_type": {
          "type": "string", 
          "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous'"
        }
      }
    }
  }
}
