NSX-T Data Center Global Manager REST API

UpgradeUnitGroupAggregateInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "UpgradeUnitGroupAggregateInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_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"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "computed": true, 
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "computed": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether upgrade of this group is enabled or not", 
      "type": "boolean"
    }, 
    "extended_configuration": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "Extended configuration for the group", 
      "type": "array"
    }, 
    "failed_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes in the upgrade unit group that failed upgrade", 
      "type": "int"
    }, 
    "group_level_failure": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Reports failures that occured at the group or cluster level.", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "parallel": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Upgrade method to specify whether the upgrade is to be performed in parallel or serially", 
      "type": "boolean"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "post_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Post-upgrade status of group"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of upgrade unit group", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "upgrade_unit_count": {
      "description": "Number of upgrade units in the group", 
      "readonly": true, 
      "required": false, 
      "title": "Count of upgrade units in the group", 
      "type": "int"
    }, 
    "upgrade_units": {
      "items": {
        "$ref": "UpgradeUnit
      }, 
      "maxItems": 512, 
      "readonly": false, 
      "required": false, 
      "title": "List of upgrade units in the group", 
      "type": "array"
    }
  }, 
  "type": "object"
}