NSX-T Data Center REST API

UpgradeUnitGroupAggregateInfo (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

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.
string Readonly
_revision Generation of this resource config

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.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
enabled Flag to indicate whether upgrade of this group is enabled or not boolean Default: "True"
extended_configuration Extended configuration for the group array of KeyValuePair Maximum items: 100
failed_count Number of nodes in the upgrade unit group that failed upgrade int Readonly
group_level_failure Reports failures that occured at the group or cluster level. array of string Readonly
id Unique identifier of this resource string Sortable
parallel Upgrade method to specify whether the upgrade is to be performed in parallel or serially boolean Default: "True"
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
post_upgrade_status Post-upgrade status of group UpgradeChecksExecutionStatus Readonly
resource_type Must be set to the value UpgradeUnitGroupAggregateInfo string
status Upgrade status of upgrade unit group string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
type Component type string Required
upgrade_unit_count Count of upgrade units in the group

Number of upgrade units in the group
int Readonly
upgrade_units List of upgrade units in the group array of UpgradeUnit Maximum items: 512