appliance update: info
The
info structure describes the state of the appliance update. This structure was added in vSphere API 6.7Representation:
{
"latest_query_time": "2015-01-01T22:13:05.651Z",
"state": "UP_TO_DATE",
"task": {
"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",
"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"
},
"version": "string"
}
"latest_query_time": "2015-01-01T22:13:05.651Z",
"state": "UP_TO_DATE",
"task": {
"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",
"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"
},
"version": "string"
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| state | string | State of the appliance update. This attribute was added in vSphere API 6.7 Defines the various states the appliance update can be in. This enumeration was added in vSphere API 6.7 Value is one of: UP_TO_DATE: The appliance is up to date. This constant was added in vSphere API 6.7 UPDATES_PENDING: A new update is available. This constant was added in vSphere API 6.7 STAGE_IN_PROGRESS: The appliance update is in progress of downloading an update. This constant was added in vSphere API 6.7 INSTALL_IN_PROGRESS: The appliance update is in progress of installing an update. This constant was added in vSphere API 6.7 INSTALL_FAILED: The appliance update failed and cannot recover. This constant was added in vSphere API 6.7 ROLLBACK_IN_PROGRESS: The appliance update failed and recovery is in progress. This constant was added in vSphere API 6.7 |
| version | string | Version of base appliance if state is UP_TO_DATE Version of update being staged or installed if state is INSTALL_IN_PROGRESS or STAGE_IN_PROGRESS Version of update staged if state is UPDATES_PENDING Version of update failed if state is INSTALL_FAILED or ROLLBACK_IN_PROGRESS. This attribute was added in vSphere API 6.7 |
| Optional | ||
| task | task_info | The running or completed update task. This attribute was added in vSphere API 6.7 Optional. |
| latest_query_time | date_time | Timestamp of latest query to update repository. This attribute was added in vSphere API 6.7 Optional. If unset the update was never queried. |