Vcenter Deployment get
Get the current status of the appliance deployment.
This operation was added in vSphere API 6.7.
Info structure containing the status information about the appliance.
{
"state": "string",
"progress": {
"total": 0,
"completed": 0,
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
},
"subtask_order": [
"string"
],
"subtasks": {
"subtasks": {
"progress": {
"total": 0,
"completed": 0,
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
},
"result": {
"info": [
{
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}
],
"warnings": [
{
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}
],
"errors": [
{
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}
]
},
"description": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"service": "string",
"operation": "string",
"parent": "string",
"target": {
"type": "string",
"id": "string"
},
"status": "string",
"cancelable": false,
"error": {},
"start_time": "string",
"end_time": "string",
"user": "string"
}
},
"description": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"service": "string",
"operation": "string",
"parent": "string",
"target": {
"type": "string",
"id": "string"
},
"status": "string",
"cancelable": false,
"error": {},
"start_time": "string",
"end_time": "string",
"user": "string"
}State of the vCenter Server Appliance.
For more information see: Vcenter Deployment ApplianceState.
This property was added in vSphere API 6.7.
The progress info of the current appliance status.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of CommonInfo#status is one of Cis Task Status.RUNNING, Cis Task Status.BLOCKED, Cis Task Status.SUCCEEDED, or Cis Task Status.FAILED.
The ordered list of subtasks for this deployment operation.
This property was added in vSphere API 6.7.
Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.
The map of the deployment subtasks and their status infomation.
This property was added in vSphere API 6.7.
Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.
Description of the operation associated with the task.
This property was added in vSphere API 6.7.
Identifier of the service containing the operation.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.service.
Identifier of the operation associated with the task.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.operation.
Parent of the current task.
This property was added in vSphere API 6.7.
This property will be missing or null if the task has no parent.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.task.
Identifier of the target created by the operation or an existing one the operation performed on.
This property was added in vSphere API 6.7.
This property will be missing or null if the operation has no target or multiple targets.
Status of the operation associated with the task.
For more information see: Cis Task Status.
This property was added in vSphere API 6.7.
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
This property was added in vSphere API 6.7.
Description of the error if the operation status is "FAILED".
This property was added in vSphere API 6.7.
If missing or null the description of why the operation failed will be included in the result of the operation (see Cis Task Info.result).
Time when the operation is started.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.RUNNING, Cis Task Status.BLOCKED, Cis Task Status.SUCCEEDED, or Cis Task Status.FAILED.
Time when the operation is completed.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.SUCCEEDED or Cis Task Status.FAILED.
Name of the user who performed the operation.
This property was added in vSphere API 6.7.
This property will be missing or null if the operation is performed by the system.
if the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if appliance state cannot be determined.
"Vapi Std Errors NotFound Object" curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/deployment