Update_Info

Update_Info
Update_Info

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

JSON Example
{
    "state": "string",
    "task": {
        "progress": {
            "total": 0,
            "completed": 0,
            "message": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": {
                            "id": "string",
                            "params": {
                                "params": "Std_LocalizationParam Object"
                            }
                        },
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        },
        "subtask_order": [
            "string"
        ],
        "subtasks": {
            "subtasks": {
                "progress": "Task_Progress Object",
                "result": {
                    "info": [
                        {
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object"
                        }
                    ],
                    "warnings": [
                        {
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object"
                        }
                    ],
                    "errors": [
                        {
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object"
                        }
                    ]
                },
                "description": "Std_LocalizableMessage Object",
                "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": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam 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"
    },
    "version": "string",
    "latest_query_time": "string"
}
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.

task
Optional

The TaskInfo structure contains information about an appliance task and the subtasks of which it consists.

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