REST API - join
  1. Operations
  2. vcenter
  3. activedirectory
  4. active directory

vcenter activedirectory active directory: join

Join the appliance to given domain.

Request:

HTTP request

POST https://{server}/rest/vcenter/system/active-directory

Request Body Structure:

{
    "domain_spec" : {
        "domain_name" : "string",
        "user_spec" : {
            "password" : "secret string",
            "username" : "string"
        },
        "organizational_unit" : "string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
domain_spec domain_spec DomainSpec contains information of domain to be joined.
domain_spec.domain_name string Domain name to join
domain_spec.user_spec user_spec User information
domain_spec.user_spec.username string Username of user authorized to join the appliance to the domain. Username can be either in UPN (ex: [email protected]) or netbios (ex: domain\name) format.
domain_spec.user_spec.password secret Password of user authorized to join the appliance to the domain
domain_spec.organizational_unit string Organizational Unit where the user, group, computer objects reside ex. CN=Computers,OU=something,dc=ssolabs,dc=com

Optional. If set we pass it to cli using -ou flag.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
400 already_in_desired_state
404 not_found
401 unauthenticated if user is unauthenticated to use the API.
403 unauthorized if user is unauthorized to use the API.
500 error