Get Installer Type

Get the VCF Installer mode that specifies whether the VCF Installer appliance is collocated with the VCF (or VVF) installation or is located externally.

Request

URI

POST

https://{api_host}/v1/sddcs/installer-mode

COPY

Request Body

SddcInstallerRequest of type(s) application/json

Required

Show optional properties

{
    "endpoints": [
        {
            "hostname": "esx-1"
        }
    ],
    "subdomain": "vcf.broadcom.com"
}

{
    "endpoints": [
        {
            "hostname": "esx-1",
            "credentials": {
                "username": "root",
                "password": "string"
            },
            "sshThumbprint": "SHA256:rVPNWOKE2tZjvmYvKPhtc3ghJ41Vc0G3MwASf4+8+yc",
            "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
        }
    ],
    "subdomain": "vcf.broadcom.com"
}

array of object

endpoints

Required

List of ESXi/vCenter in which the appliance will check for itself

string As ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$

subdomain

Required

Tenant Sub domain. Includes the full domain suffix

Responses

200

Returns InstallerSpec of type(s) application/json

"InstallerSpec Object"

string

applianceFqdn

Optional

Appliance FQDN

string

type

Optional

Installer type

Possible values are : Internal, External, Internal, External,

500

InternalServerError

Returns Error of type(s) application/json

"Error Object"

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string

label

Optional

The localized label message

string

remediationUrl

Optional

The URL string for remediation documentation link

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"endpoints":["object"],"subdomain:"string"}' https://{api_host}/v1/sddcs/installer-mode

On This Page

Description

Request

Request Body

Response

200 Response Body

Errors

Vcf Installer Operations