Developer Documentation

UpgradeSourceApplianceSpec

The Upgrade.SourceApplianceSpec structure contains information used to connect to the appliance used as the source for an upgrade.


Properties

Required Property Name Type Description
required hostname string

The IP address or DNS resolvable name of the source appliance.

optional https_port integer

The HTTPS port of the source appliance. If unset, port 443 will be used.

required root_password string

The password of the root user on the source appliance.

optional ssh_thumbprint string

MD5 thumbprint of the server SSH key will be used for verification. This field is only relevant if Upgrade.SourceApplianceSpec.ssh-verify is unset or has the value true.

optional 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. If unset, ssh_verify true will be used.

optional ssl_thumbprint string

SHA1 thumbprint of the server SSL certificate will be used for verification. This field is only relevant if Upgrade.SourceApplianceSpec.ssl-verify is unset or has the value true.

optional 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. If unset, ssl_verify true will be used.

required sso_admin_password string

The SSO administrator account password.

required sso_admin_username string

The SSO administrator account on the source appliance.

Feedback

Was this page helpful?