This API has a deprecated equivalent from v7.0U1.
Disconnect Host
DescriptionDisconnect the host corresponding to host from the vCenter server
Request
URLURL
https://{api_host}/api/vcenter/host/{host}?action=disconnect
Path Parameters
Path Parameters
string
host
Required
Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: HostSystem.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.already_in_desired_state : if the host associated with host is already disconnected.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if there is no host associated with host in the system.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-DisconnectHost -Host "MyHost"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/host/{host}?action=disconnect
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/host/{host}/disconnect
x-vmw-doc-operation: disconnect
Availability
Added in 7.0U2
