UpdateInfo

The Update.Info structure describes the state of the appliance update.

Properties

UpdateState Enum

state Required

The Update.State enumerated type defines the various states the appliance update can be in.
UP_TO_DATE : The appliance is up to date.
UPDATES_PENDING : A new update is available.
STAGE_IN_PROGRESS : The appliance update is in progress of downloading an update.
INSTALL_IN_PROGRESS : The appliance update is in progress of installing an update.
INSTALL_FAILED : The appliance update failed and cannot recover.
ROLLBACK_IN_PROGRESS : The appliance update failed and recovery is in progress.

Possible values are: UP_TO_DATE , UPDATES_PENDING , STAGE_IN_PROGRESS , INSTALL_IN_PROGRESS , INSTALL_FAILED , ROLLBACK_IN_PROGRESS

string

version Required

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

string as date-time

latest_query_time Optional

Timestamp of latest query to update repository. If unset the update was never queried

TaskInfo

task Optional

The running or completed update task.

JSON Example

Show optional properties

{
	"state": "UP_TO_DATE",
	"version": "string"
}

{
	"latest_query_time": "string",
	"state": "UP_TO_DATE",
	"task": {
		"cancelable": false,
		"description": {
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string",
			"localized": "string",
			"params": {
				"key": {
					"d": 0,
					"dt": "string",
					"format": "SHORT_DATE",
					"i": 0,
					"l": {
						"id": "string",
						"params": "StdLocalizationParam Object"
					},
					"precision": 0,
					"s": "string"
				}
			}
		},
		"end_time": "string",
		"operation": "string",
		"parent": "string",
		"progress": {
			"completed": 0,
			"message": {
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string",
				"localized": "string",
				"params": {
					"key": {
						"d": 0,
						"dt": "string",
						"format": "SHORT_DATE",
						"i": 0,
						"l": {
							"id": "string",
							"params": "StdLocalizationParam Object"
						},
						"precision": 0,
						"s": "string"
					}
				}
			},
			"total": 0
		},
		"service": "string",
		"start_time": "string",
		"status": "PENDING",
		"subtask_order": [
			"string"
		],
		"subtasks": {
			"key": {
				"cancelable": false,
				"description": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"end_time": "string",
				"operation": "string",
				"parent": "string",
				"progress": {
					"completed": 0,
					"message": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"total": 0
				},
				"result": {
					"errors": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"time": "string"
						}
					],
					"info": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"time": "string"
						}
					],
					"warnings": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"time": "string"
						}
					]
				},
				"service": "string",
				"start_time": "string",
				"status": "enum",
				"target": {
					"id": "string",
					"type": "string"
				},
				"user": "string"
			}
		},
		"target": {
			"id": "string",
			"type": "string"
		},
		"user": "string"
	},
	"version": "string"
}

Returned By

Get Update

UpdateInfo

Properties

JSON Example

Returned By

Was this page helpful?