Host Active Directory Authentication Leave Current Domain Task

Host Active Directory Authentication Leave Current Domain Task

Removes the host from the Active Directory domain to which it belongs.

Required privileges: Host.Config.AuthenticationStore

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostActiveDirectoryAuthentication/{moId}/LeaveCurrentDomain_Task
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostActiveDirectoryAuthentication/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body
LeaveCurrentDomainRequestType of type(s) application/json
Required 
{
    "force": false
}
boolean
force
Required

If True, any existing permissions on managed entities for Active Directory users will be deleted. If False and such permissions exist, the operation will fail.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject 
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

InvalidState: if the host is not in a domain or there are active permissions for Active Directory users.

NonADUserRequired: only non Active Directory users can initiate the leave domain operation.

AuthMinimumAdminPermission: if this change would leave the system with no Administrator permission on the root node.

ActiveDirectoryFault: for any problem that is not handled with a specific fault.

TaskInProgress: if the ActiveDirectoryAuthentication object is busy.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Infrastructure Operations
POST
Host Active Directory Authentication Disable Smart Card Authentication
POST
Host Active Directory Authentication Enable Smart Card Authentication
GET
Host Active Directory Authentication Get Info
POST
Host Active Directory Authentication Import Certificate For CAM Task
POST
Host Active Directory Authentication Install Smart Card Trust Anchor
POST
Host Active Directory Authentication Join Domain Task
POST
Host Active Directory Authentication Join Domain With CAM Task
POST
Host Active Directory Authentication Leave Current Domain Task
POST
Host Active Directory Authentication List Smart Card Trust Anchors
POST
Host Active Directory Authentication Remove Smart Card Trust Anchor
POST
Host Active Directory Authentication Remove Smart Card Trust Anchor By Fingerprint
POST
Host Active Directory Authentication Replace Smart Card Trust Anchors