NSX-T Data Center REST API

ComponentUpgradeStatus (type)

{
  "additionalProperties": false,
  "id": "ComponentUpgradeStatus",
  "module_id": "Upgrade",
  "properties": {
    "can_rollback": {
      "description": "This field indicates whether we can perform upgrade rollback.",
      "readonly": true,
      "required": false,
      "title": "Can perform rollback",
      "type": "boolean"
    },
    "can_skip": {
      "readonly": true,
      "required": false,
      "title": "Can the upgrade of the remaining units in this component be skipped",
      "type": "boolean"
    },
    "component_type": {
      "readonly": true,
      "required": false,
      "title": "Component type for the upgrade status",
      "type": "string"
    },
    "current_version_node_summary": {
      "$ref": "NodeSummaryList",
      "readonly": true,
      "required": false,
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    },
    "details": {
      "readonly": true,
      "required": false,
      "title": "Details about the upgrade status",
      "type": "string"
    },
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version",
      "readonly": true,
      "required": false,
      "title": "Count of nodes at target component version",
      "type": "int"
    },
    "percent_complete": {
      "readonly": true,
      "required": true,
      "title": "Indicator of upgrade progress in percentage",
      "type": "number"
    },
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus",
      "readonly": true,
      "required": false,
      "title": "Pre-upgrade status of the component-type"
    },
    "status": {
      "enum": [
        "SUCCESS",
        "FAILED",
        "IN_PROGRESS",
        "NOT_STARTED",
        "PAUSING",
        "PAUSED"
      ],
      "readonly": true,
      "required": true,
      "title": "Upgrade status of component",
      "type": "string"
    },
    "target_component_version": {
      "readonly": true,
      "required": false,
      "title": "Target component version",
      "type": "string"
    }
  },
  "type": "object"
}