NSX-T Data Center Global Manager REST API

FederationUpgradeSummary (type)

{
  "additionalProperties": false,
  "description": "Provides upgrade summary for a specific site.",
  "id": "FederationUpgradeSummary",
  "module_id": "FederationUpgrade",
  "properties": {
    "component_status": {
      "items": {
        "$ref": "FederationComponentUpgradeStatus"
      },
      "readonly": true,
      "required": true,
      "title": "List of component statuses",
      "type": "array"
    },
    "current_version": {
      "description": "This is NSX version for the site.",
      "readonly": true,
      "required": true,
      "title": "Current version of the site",
      "type": "string"
    },
    "gpm_name": {
      "description": "Name of the global manager if present.",
      "readonly": true,
      "required": false,
      "title": "Name of the global manager",
      "type": "string"
    },
    "id": {
      "description": "Unique identifier of this resource.",
      "readonly": true,
      "required": true,
      "title": "UUID of this resource",
      "type": "string"
    },
    "last_upgrade_timestamp": {
      "description": "Indicates the time when the site was upgraded.",
      "readonly": true,
      "required": false,
      "title": "Last upgrade timestamp",
      "type": "string"
    },
    "name": {
      "description": "Name of the site.",
      "readonly": true,
      "required": false,
      "title": "Name of the site",
      "type": "string"
    },
    "overall_upgrade_status": {
      "enum": [
        "SUCCESS",
        "FAILED",
        "IN_PROGRESS",
        "NOT_STARTED",
        "PAUSED"
      ],
      "readonly": true,
      "required": true,
      "title": "Status of upgrade",
      "type": "string"
    },
    "site_id": {
      "description": "This is the Site Manager generated UUID for every NSX deployment.",
      "readonly": true,
      "required": true,
      "title": "UUID of the site",
      "type": "string"
    },
    "site_ip": {
      "description": "IP address of the site.",
      "readonly": true,
      "required": true,
      "title": "Site IP",
      "type": "string"
    },
    "site_type": {
      "description": "Type of this site.",
      "enum": [
        "ACTIVE_GM_SITE",
        "STANDBY_GM_SITE",
        "NON_GM_SITE"
      ],
      "readonly": true,
      "required": true,
      "title": "Site type",
      "type": "string"
    },
    "target_version": {
      "description": "This is NSX target version for the site, if it is undergoing upgrade.",
      "readonly": true,
      "required": false,
      "title": "Target version for the site",
      "type": "string"
    }
  },
  "title": "Upgrade Summary",
  "type": "object"
}