vcenter deployment install remote psc: check

Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC. This operation was added in vSphere API 6.7

Request:

HTTP request

POST https://{server}/rest/vcenter/deployment/install/remote-psc?action=check

Request Body Structure:

{
    "spec"{
        "https_port"1,
        "psc_hostname""string",
        "ssl_thumbprint""string",
        "ssl_verify"true,
        "sso_admin_password""string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec remote_psc_spec Information to connect to the remote PSC.
spec.psc_hostname string The IP address or DNS resolvable name of the remote PSC to which this configuring vCenter Server will be registered to. This attribute was added in vSphere API 6.7

spec.https_port long The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7

Optional. If unset, port 443 will be used.

spec.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7

spec.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate will be used for verification when ssl_verify field is set to true. 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.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.

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 Information about the success or failure of the checks that were performed.
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.