REST API - decommission-task

vcenter topology nodes embedded: decommission-task

Decommission the vCenter Server node. Decommissioning a vCenter Server node from the topology is irreversible. Any workloads associated with the node will be lost. Make sure to move the workloads before decommissioning the vCenter Server node. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/rest/vcenter/topology/nodes/embedded/{hostname}?action=decommission&vmw-task=true

Path Parameters

Name	Type	Description
Required
hostname	string	FQDN or IP address of vCenter Server node to be decommissioned.

Request Body Structure:

{
    "repair_replication" : true,
    "only_precheck" : true,
    "spec" : {
        "sso_admin_password" : "secret string",
        "ssl_thumbprint" : "string",
        "ssl_verify" : true,
        "sso_admin_username" : "string"
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
spec	decommission_spec	Information needed to decommission the vCenter Server node.
spec.sso_admin_username	string	The SSO administrator username for example "[email protected]". Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.sso_admin_password	secret	The SSO administrator account password. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.ssl_thumbprint	string	SHA1 thumbprint of the vCenter Server node to be decommissioned that will be used for verification. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. This field is only relevant if `ssl_verify` is unset or has the value true. No verification will be performed if `ssl_verify` value is set to false.
spec.ssl_verify	boolean	SSL verification should be enabled or disabled. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, SSL verification will be enabled.
only_precheck	boolean	Optional. Flag indicating whether only a pre-check should be performed.
repair_replication	boolean	Optional. Flag indicating whether broken replication should be repaired after decommission.

Response:

HTTP Status Code: 200

Representation:

{
"value" : "obj-103"
}

Response Type:

Name	Type	Description
bold = required
value	string

Errors:

HTTP Status Code	Type	Description
500	error	if any other error occurs during the execution of the operation.
400	unsupported	if the appliance is in not a vCenter Server node.
400	invalid_argument	if passed arguments are invalid.
400	unverified_peer	If the SSL certificate of the foreign vCenter Server node cannot be validated. The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in CertificateInfo.
401	unauthenticated	if the caller is not authenticated.