1. Operations
  2. vcenter
  3. deployment
  4. install
  5. psc
  6. standalone

vcenter deployment install psc standalone: check

Checks that the information to configure a non-replicated PSC satisfies the requirements. This operation was added in vSphere API 6.7

Request:

HTTP request

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

Request Body Structure:

{
    "spec": {
        "sso_admin_password": "string",
        "sso_domain_name": "string",
        "sso_site_name": "string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec standalone_psc_spec Information to configure a non-replicated PSC.
spec.sso_site_name string The SSO site name used for this PSC. This attribute was added in vSphere API 6.7

Optional. If unset, default-first-site will be used.
spec.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7
spec.sso_domain_name string The SSO domain name to be used to configure this appliance. This attribute was added in vSphere API 6.7

Optional. If unset, vsphere.local 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.