Get System Status

Get System Status

Retrieves system status information and overview statistics of system components such as Provider Gateways, Ip Spaces, Regions, Supervisors, Regional Networking Setting, and Content Library

Request
URI
GET
https://{api_host}/cloudapi/vcf/systemOverview/systemStatus
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SystemSetupStatus of type(s) application/json;version=40.0 
{
    "setupState": "string",
    "orgSetupStatus": "string",
    "tenantOrgRef": {
        "name": "string",
        "id": "string"
    },
    "componentSetupStatus": [
        {
            "componentType": "string",
            "count": 0
        }
    ]
}
string
setupState
Optional

Indicates the setup state of VCF. Possible values are:

  • NO_SUPERVISOR
  • NONE
  • PARTIAL
  • COMPLETE
If setup state is NO_SUPERVISOR, user cannot run Quick or Manual Setup and will be prompted to enable Supervisor in vCenter If setup state is NONE, both Quick and Manual Setup can be run. If setup state is PARTIAL, only Manual Setup can be run and componentSetupStatus property will indicate what components have been set up. If setup state is COMPLETE, neither Quick nor Manual Setup can be run
string
orgSetupStatus
Optional

Indicates Organization setup status

object
tenantOrgRef
Optional

Entity reference used to describe VCD entities

array of object
componentSetupStatus
Optional
Constraints: maxItems: 7

Indicates Provider Gateway, IP Space, Organization, Region, Supervisor, Regional Network Setting, and Content Library components and their counts.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/systemOverview/systemStatus
Availability
Added in 40.0
On This Page
System Overview Operations
POST
Initiate Quick Start
GET
Get System Status