vcenter deployment: info
The
info structure contains fields to describe the state of the appliance. This structure was added in vSphere API 6.7Representation:
{
"cancelable": true,
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"end_time": "2015-01-01T22:13:05.651Z",
"error": {},
"operation": "obj-103",
"parent": "obj-103",
"progress": {
"completed": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"total": 1
},
"service": "obj-103",
"start_time": "2015-01-01T22:13:05.651Z",
"state": "NOT_INITIALIZED",
"status": "PENDING",
"subtask_order": [
"string",
"string"
],
"subtasks": [
{
"key": "string",
"value": {
"cancelable": true,
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"end_time": "2015-01-01T22:13:05.651Z",
"error": {},
"operation": "obj-103",
"parent": "obj-103",
"progress": {
"completed": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"total": 1
},
"result": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
},
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
},
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
},
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
}
]
},
"service": "obj-103",
"start_time": "2015-01-01T22:13:05.651Z",
"status": "PENDING",
"target": {
"id": "obj-103",
"type": "string"
},
"user": "string"
}
}
],
"target": {
"id": "obj-103",
"type": "string"
},
"user": "string"
}
"cancelable": true,
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"end_time": "2015-01-01T22:13:05.651Z",
"error": {},
"operation": "obj-103",
"parent": "obj-103",
"progress": {
"completed": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"total": 1
},
"service": "obj-103",
"start_time": "2015-01-01T22:13:05.651Z",
"state": "NOT_INITIALIZED",
"status": "PENDING",
"subtask_order": [
"string",
"string"
],
"subtasks": [
{
"key": "string",
"value": {
"cancelable": true,
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"end_time": "2015-01-01T22:13:05.651Z",
"error": {},
"operation": "obj-103",
"parent": "obj-103",
"progress": {
"completed": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"total": 1
},
"result": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
},
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
},
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
},
{
"id": "string",
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"resolution": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"time": "2015-01-01T22:13:05.651Z"
}
]
},
"service": "obj-103",
"start_time": "2015-01-01T22:13:05.651Z",
"status": "PENDING",
"target": {
"id": "obj-103",
"type": "string"
},
"user": "string"
}
}
],
"target": {
"id": "obj-103",
"type": "string"
},
"user": "string"
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| state | string | State of the vCenter Server Appliance. This attribute was added in vSphere API 6.7 Defines the various states the vCenter Appliance can be in. This enumeration was added in vSphere API 6.7 Value is one of: NOT_INITIALIZED: The appliance is in the process of being initialized and not ready for configuration. This constant was added in vSphere API 6.7 INITIALIZED: The appliance is initialized and ready to be configured. This constant was added in vSphere API 6.7 CONFIG_IN_PROGRESS: The appliance is in the process of being configured. This constant was added in vSphere API 6.7 QUESTION_RAISED: The deployment script has raised a question and is waiting for an answer to continue with the appliance configuration. This constant was added in vSphere API 6.7 FAILED: The appliance configuration has failed. This constant was added in vSphere API 6.7 CONFIGURED: The appliance has been configured. This constant was added in vSphere API 6.7 |
| description | localizable_message | Description of the operation associated with the task. This attribute was added in vSphere API 6.7 |
| service | string | Name of the service containing the operation. This attribute was added in vSphere API 6.7 When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.service. |
| operation | string | Name of the operation associated with the task. This attribute was added in vSphere API 6.7 When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation. |
| status | string | Status of the operation associated with the task. This attribute was added in vSphere API 6.7 Defines the status values that can be reported for an operation. This enumeration was added in vSphere API 6.7 Value is one of: PENDING: The operation is in pending state. This constant was added in vSphere API 6.7 RUNNING: The operation is in progress. This constant was added in vSphere API 6.7 BLOCKED: The operation is blocked. This constant was added in vSphere API 6.7 SUCCEEDED: The operation completed successfully. This constant was added in vSphere API 6.7 FAILED: The operation failed. This constant was added in vSphere API 6.7 |
| cancelable | boolean | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This attribute was added in vSphere API 6.7 |
| Optional | ||
| progress | progress | The progress info of the current appliance status. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of #status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED. |
| subtask_order | string[] | The ordered list of subtasks for this deployment operation. This attribute was added in vSphere API 6.7 Optional. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED. |
| subtasks | list | The map of the deployment subtasks and their status infomation. This attribute was added in vSphere API 6.7 Optional. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED. |
| parent | string | Parent of the current task. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the task has no parent.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.task. |
| target | dynamic_ID | Identifier of the target created by the operation or an existing one the operation performed on. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation has no target or multiple targets. |
| error | exception | Description of the error if the operation status is "FAILED". This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see cis.task.info.result). |
| start_time | date_time | Time when the operation is started. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED. |
| end_time | date_time | Time when the operation is completed. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED or FAILED. |
| user | string | Name of the user who performed the operation. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation is performed by the system. |