NSX-T Data Center REST API

UpgradeUnitAggregateInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "UpgradeUnitAggregateInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "current_version": {
      "description": "This is component version e.g. if upgrade unit is of type edge, then this is edge version.", 
      "readonly": true, 
      "required": false, 
      "title": "Current version of upgrade unit", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": false, 
      "required": false, 
      "title": "Name of the upgrade unit", 
      "type": "string"
    }, 
    "error_details": {
      "items": {
        "$ref": "ErrorClass
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of detailed errors with error code that occurred during upgrade of this upgrade unit", 
      "type": "array"
    }, 
    "errors": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of errors occurred during upgrade of this upgrade unit", 
      "type": "array"
    }, 
    "group": {
      "$ref": "UpgradeUnitGroupInfo, 
      "readonly": true, 
      "required": false, 
      "title": "Info of the group to which this upgrade unit belongs"
    }, 
    "id": {
      "description": "Identifier of the upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "Identifier of the upgrade unit", 
      "type": "string"
    }, 
    "metadata": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Metadata about upgrade unit", 
      "type": "array"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "post_check_status": {
      "enum": [
        "NOT_STARTED", 
        "IN_PROGRESS", 
        "COMPLETED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Status of upgrade unit", 
      "type": "string"
    }, 
    "post_upgrade_checks": {
      "$ref": "UpgradeCheckListResults, 
      "readonly": true, 
      "required": false
    }, 
    "pre_upgrade_checks": {
      "$ref": "UpgradeCheckListResults, 
      "readonly": true, 
      "required": false
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade unit", 
      "type": "string"
    }, 
    "type": {
      "readonly": false, 
      "required": false, 
      "title": "Upgrade unit type", 
      "type": "string"
    }, 
    "warnings": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of warnings indicating issues with the upgrade unit that may result in upgrade failure", 
      "type": "array"
    }
  }, 
  "type": "object"
}