1. Operations
  2. vcenter
  3. deployment
  4. upgrade

vcenter deployment upgrade: check

Run sanity checks using the UpgradeSpec parameters passed. This operation was added in vSphere API 6.7

Request:

HTTP request

POST https://{server}/rest/vcenter/deployment/upgrade?action=check

Request Body Structure:

{
    "spec": {
        "auto_answer": true,
        "history": {
            "data_set": "EVENTS_TASKS",
            "defer_import": true
        },
        "psc": {
            "ceip_enabled": true
        },
        "source_appliance": {
            "hostname": "string",
            "https_port": 1,
            "root_password": "secret string",
            "ssh_thumbprint": "string",
            "ssh_verify": true,
            "ssl_thumbprint": "string",
            "ssl_verify": true,
            "sso_admin_password": "secret string",
            "sso_admin_username": "string"
        },
        "source_location": {
            "hostname": "string",
            "https_port": 1,
            "password": "secret string",
            "ssl_thumbprint": "string",
            "ssl_verify": true,
            "username": "string"
        },
        "vcsa_embedded": {
            "ceip_enabled": true
        }
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec upgrade_spec UpgradeSpec parameters to run sanity check on.
spec.source_appliance source_appliance_spec Source appliance spec. This attribute was added in vSphere API 6.7
spec.source_appliance.hostname string The IP address or DNS resolvable name of the source appliance. This attribute was added in vSphere API 6.7
spec.source_appliance.https_port long The HTTPS port of the source appliance. This attribute was added in vSphere API 6.7

Optional. If unset, port 443 will be used.
spec.source_appliance.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7

Optional. This field is only relevant if ssl_verify is unset or has the value true.
spec.source_appliance.ssl_verify boolean SSL verification should be enabled or disabled for the source appliance validations. By default it is enabled and will use SSL certificate for verification. If thumbprint is provided, will use thumbprint for the verification. This attribute was added in vSphere API 6.7

Optional. If unset, ssl_verify true will be used.
spec.source_appliance.sso_admin_username string The SSO administrator account on the source appliance. This attribute was added in vSphere API 6.7
spec.source_appliance.sso_admin_password secret The SSO administrator account password. This attribute was added in vSphere API 6.7
spec.source_appliance.root_password secret The password of the root user on the source appliance. This attribute was added in vSphere API 6.7
spec.source_appliance.ssh_verify boolean Appliance SSH verification should be enabled or disabled. By default it is disabled and will not use any verification. If thumbprint is provided, thumbprint verification will be performed. This attribute was added in vSphere API 6.7

Optional. If unset, ssh_verify true will be used.
spec.source_appliance.ssh_thumbprint string MD5 thumbprint of the server SSH key will be used for verification. This attribute was added in vSphere API 6.7

Optional. This field is only relevant if ssh_verify is unset or has the value true.
spec.source_location location_spec Source location spec. This attribute was added in vSphere API 6.7
spec.source_location.hostname string The IP address or DNS resolvable name of the container. This attribute was added in vSphere API 6.7
spec.source_location.https_port long The HTTPS port of the container. This attribute was added in vSphere API 6.7

Optional. If unset, port 443 will be used.
spec.source_location.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7

Optional. This field is only relevant if ssl_verify is unset or has the value true.
spec.source_location.ssl_verify boolean SSL verification should be enabled or disabled. If ssl_verify is true and and ssl_thumbprint is unset, the CA certificate will be used for verification. If ssl_verify is true and ssl_thumbprint is set then the thumbprint will be used for verification. No verification will be performed if ssl_verify value is set to false. This attribute was added in vSphere API 6.7

Optional. If unset, ssl_verify true will be used.
spec.source_location.username string The administrator account on the host. This attribute was added in vSphere API 6.7
spec.source_location.password secret The administrator account password. This attribute was added in vSphere API 6.7
spec.history history_migration_spec Determines how vCenter history will be migrated during the upgrade process. vCenter history consists of:
  • Statistics
  • Events
  • Tasks
By default only core data will be migrated. Use this spec to define which part of vCenter history data will be migrated and when. This attribute was added in vSphere API 6.7

Optional. If unset, only core database content will be migrated.
spec.history.data_set string Defines what part of vCenter historical data will be migrated along with core data. This attribute was added in vSphere API 6.7

Defines the vCenter history migration option choices. This enumeration was added in vSphere API 6.7 Value is one of:
EVENTS_TASKS: Only event data and task data will be migrated along with the core data. This constant was added in vSphere API 6.7
ALL: All history data will be migrated along with the core data. This constant was added in vSphere API 6.7
spec.history.defer_import boolean Defines how vCenter history will be migrated. If set to true, vCenter history will be migrated separately after successful upgrade or migration, otherwise it will be migrated along with core data during the upgrade or migration process. This attribute was added in vSphere API 6.7

Optional. If unset, vCenter historical data won't be deferred and will be migrated along with core data.
spec.vcsa_embedded vcsa_embedded_spec Information that are specific to this embedded vCenter Server. This attribute was added in vSphere API 6.7

Optional. If unset, ceip_enabled for embedded vcenter server upgrade will default to enabled.
spec.vcsa_embedded.ceip_enabled boolean Customer experience improvement program should be enabled or disabled for this embedded vCenter Server upgrade. This attribute was added in vSphere API 6.7
spec.psc psc_spec Information that are specific to this Platform Services Controller. This attribute was added in vSphere API 6.7

Optional. If unset, ceip_enabled for psc upgrade will default to enabled.
spec.psc.ceip_enabled boolean Customer experience improvement program should be enabled or disabled for this Platform Services Controller upgrade. This attribute was added in vSphere API 6.7
spec.auto_answer boolean Use the default option for any questions that may come up during appliance configuration. This attribute was added in vSphere API 6.7

Optional. If unset, will default to false.

Response:

HTTP Status Code: 200

Representation:

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

Response Type:

Name Type Description
bold = required
value check_info CheckInfo containing the check results.
value.status string Status of the check. This attribute was added in vSphere API 6.7

Defines the status of the checks. This enumeration was added in vSphere API 6.7 Value is one of:
SUCCESS: All checks have completed successfully. This constant was added in vSphere API 6.7
FAILED: A fatal error was encountered when running the sanity checks. This constant was added in vSphere API 6.7
value.result notifications Result of the check. This attribute was added in vSphere API 6.7

Optional. This field will be unset if result is not available at the current step of the task.
value.result.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 task.
value.result.info[].id string The notification id. This attribute was added in vSphere API 6.7
value.result.info[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7

Optional. Only set if the time information is available.
value.result.info[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.result.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.result.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.result.info[].message.args string[] Arguments to be substituted into a message template.
value.result.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.result.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.result.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.result.info[].resolution.args string[] Arguments to be substituted into a message template.
value.result.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 task.
value.result.warnings[].id string The notification id. This attribute was added in vSphere API 6.7
value.result.warnings[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7

Optional. Only set if the time information is available.
value.result.warnings[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.result.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.result.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.result.warnings[].message.args string[] Arguments to be substituted into a message template.
value.result.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.result.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.result.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.result.warnings[].resolution.args string[] Arguments to be substituted into a message template.
value.result.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 task.
value.result.errors[].id string The notification id. This attribute was added in vSphere API 6.7
value.result.errors[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7

Optional. Only set if the time information is available.
value.result.errors[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value.result.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.result.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.result.errors[].message.args string[] Arguments to be substituted into a message template.
value.result.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.result.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.result.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.result.errors[].resolution.args string[] Arguments to be substituted into a message template.

Errors:

HTTP Status Code Type Description
401 unauthenticated if the caller is not authenticated.
400 invalid_argument if passed arguments are invalid.
400 not_allowed_in_current_state if the appliance is not in INITIALIZED state.