1. Operations
  2. appliance
  3. update
  4. pending

appliance update pending: precheck

Runs update precheck

Request:

HTTP request

POST https://{server}/rest/appliance/update/pending/{version}?action=precheck

Path Parameters

Name Type Description
Required
version string Update version.

Response:

HTTP Status Code: 200

Representation:

{
    "value": {
        "check_time": "2015-01-01T22:13:05.651Z",
        "estimated_time_to_install": 1,
        "estimated_time_to_rollback": 1,
        "issues": {
            "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"
                }
            ]
        },
        "questions": [
            {
                "allowed_values": [
                    "string",
                    "string"
                ],
                "data_item": "obj-103",
                "default_answer": "string",
                "description": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "regexp": "string",
                "text": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "type": "PLAIN_TEXT"
            },
            {
                "allowed_values": [
                    "string",
                    "string"
                ],
                "data_item": "obj-103",
                "default_answer": "string",
                "description": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "regexp": "string",
                "text": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "type": "PLAIN_TEXT"
            }
        ],
        "reboot_required": true
    }
}

Response Type:

Name Type Description
bold = required
value precheck_result PrecheckResult.
value.check_time date_time Time when this precheck was run
value.estimated_time_to_install long Rough estimate of time to install the update (minutes).

Optional. estimatedTimeToInstall If unset N/A.

value.estimated_time_to_rollback long Rough estimate of time to rollback the update (minutes).

Optional. estimatedTimeToRollback If unset N/A.

value.reboot_required boolean Is reboot required to install the update.
value.issues notifications Lists of the issues and warnings

Optional. issues If unset N/A.

value.issues.info notification[] Info notification messages reported. This attribute was added in vSphere API 6.7

Optional. Only set if an info was reported by the appliance task.
value.issues.info[].id string The notification id. This attribute was added in vSphere API 6.7
value.issues.info[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7

Optional. Only if the time information is available.
value.issues.info[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.issues.info[].message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.issues.info[].message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.issues.info[].message.args string[] Arguments to be substituted into a message template.
value.issues.info[].resolution localizable_message The resolution message, if any. This attribute was added in vSphere API 6.7

Optional. Only set for warnings and errors.
value.issues.info[].resolution.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.issues.info[].resolution.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.issues.info[].resolution.args string[] Arguments to be substituted into a message template.
value.issues.warnings notification[] Warning notification messages reported. This attribute was added in vSphere API 6.7

Optional. Only set if an warning was reported by the appliance task.
value.issues.warnings[].id string The notification id. This attribute was added in vSphere API 6.7
value.issues.warnings[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7

Optional. Only if the time information is available.
value.issues.warnings[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.issues.warnings[].message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.issues.warnings[].message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.issues.warnings[].message.args string[] Arguments to be substituted into a message template.
value.issues.warnings[].resolution localizable_message The resolution message, if any. This attribute was added in vSphere API 6.7

Optional. Only set for warnings and errors.
value.issues.warnings[].resolution.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.issues.warnings[].resolution.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.issues.warnings[].resolution.args string[] Arguments to be substituted into a message template.
value.issues.errors notification[] Error notification messages reported. This attribute was added in vSphere API 6.7

Optional. Only set if an error was reported by the appliance task.
value.issues.errors[].id string The notification id. This attribute was added in vSphere API 6.7
value.issues.errors[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7

Optional. Only if the time information is available.
value.issues.errors[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.issues.errors[].message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.issues.errors[].message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.issues.errors[].message.args string[] Arguments to be substituted into a message template.
value.issues.errors[].resolution localizable_message The resolution message, if any. This attribute was added in vSphere API 6.7

Optional. Only set for warnings and errors.
value.issues.errors[].resolution.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.issues.errors[].resolution.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.issues.errors[].resolution.args string[] Arguments to be substituted into a message template.
value.questions question[] List of questions that must be answered to install the update.
value.questions[].data_item string ID of the data item

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.
value.questions[].text localizable_message Label for the item to be used in GUI/CLI
value.questions[].text.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.questions[].text.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.questions[].text.args string[] Arguments to be substituted into a message template.
value.questions[].description localizable_message Description of the item
value.questions[].description.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.questions[].description.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.questions[].description.args string[] Arguments to be substituted into a message template.
value.questions[].type string How this field shoudl be represented in GUI or CLI

Defines representation of field fields in GUI or CLI Value is one of:
PLAIN_TEXT: plain text answer
BOOLEAN: Yes/No,On/Off,Checkbox answer
PASSWORD: Password (masked) answer
value.questions[].allowed_values string[] List of allowed values

Optional. It is only relevant when type has value [PLAIN_TEXT]. allowedValues If unset any value is valid.
value.questions[].regexp string Regexp to validate the input

Optional. It is only relevant when type has value [PLAIN_TEXT]. regexp If unset no validation will be performed.
value.questions[].default_answer string Default answer

Optional. It is only relevant when type has value [PLAIN_TEXT]. defaultAnswer If unset then there is no default answer, so an explicit answer must be provided.

Errors:

HTTP Status Code Type Description
500 error Generic error
401 unauthenticated session is not authenticated
403 unauthorized session is not authorized to perform this operation
404 not_found the update is not found
400 already_in_desired_state if this version is already installed
400 not_allowed_in_current_state if another operation is in progress