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

appliance update pending: validate

Validates the user provided data before the update installation.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
version string Update version.

Request Body Structure:

{
    "user_data": [
        {
            "key": "obj-103",
            "value": "string"
        }
    ]
}

Request Body Parameters:

Name Type Description
bold = required
user_data list map of user provided data with IDs. List of {"key": string, "value": string}
user_data[].key string
user_data[].value string

Response:

HTTP Status Code: 200

Representation:

{
    "value": {
        "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"
            }
        ]
    }
}

Response Type:

Name Type Description
bold = required
value notifications Issues struct with the issues found during the validation.
value.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.info[].id string The notification id. This attribute was added in vSphere API 6.7
value.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.info[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.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.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.info[].message.args string[] Arguments to be substituted into a message template.
value.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.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.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.info[].resolution.args string[] Arguments to be substituted into a message template.
value.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.warnings[].id string The notification id. This attribute was added in vSphere API 6.7
value.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.warnings[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.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.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.warnings[].message.args string[] Arguments to be substituted into a message template.
value.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.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.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.warnings[].resolution.args string[] Arguments to be substituted into a message template.
value.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.errors[].id string The notification id. This attribute was added in vSphere API 6.7
value.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.errors[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.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.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.errors[].message.args string[] Arguments to be substituted into a message template.
value.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.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.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.errors[].resolution.args string[] Arguments to be substituted into a message template.

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 if the update is not found
400 already_in_desired_state if the update of this version is already installed
400 not_allowed_in_current_state if appliance update state prevents running an check