Bind

Bind

All the listed privileges are required -

Privileges Description
GLOBAL_CONFIG_MANAGEMENT Caller should have permission to this privilege, to perform this operation.
Request
URI
POST
https://{api_host}/rest/external/v1/ad-domains/action/bind
COPY
Request Body
ADDomainSpec of type(s) application/json
Required 
{
    "ad_domain_advanced_settings": {
        "ad_domain_auto_discovery": true,
        "ad_domain_context": "dc=abc,dc=com",
        "ad_domain_controllers": [
            "example.com",
            "example1.com"
        ],
        "ad_domain_preferred_site": "Bengaluru",
        "port": 389
    },
    "dns_name": "example.com",
    "netbios_name": "EXAMPLE",
    "primary_account": {
        "password": [
            "<password>"
        ],
        "username": "Administrator"
    }
}
ADDomainAdvancedSettings
ad_domain_advanced_settings
Required

ad_domain_advanced_settings

string As ^((?!-)[A-Za-z0-9-]{1,63}(?<!-)\.)+[A-Za-z0-9]{2,63}$
dns_name
Required

The DNS name of the domain.

string
netbios_name
Required

The NetBIOS name of the domain.

ADDomainServiceAccountSpec
primary_account
Required

primary_account

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns ADDomainBindInfo of type(s) */* 
{
    "id": "S-1-5-21-3861703653-2745738756-3849765893"
}
string
id
Optional

Unique ID representing the AD domain.


400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

409

Conflict

Operation doesn't return any data structure

On This Page
External Operations
POST
Add Auxiliary Accounts
GET
Audit Events Extended Attributes
POST
Bind
POST
Bulk Hold User Or Group
POST
Bulk Hold User Or Group V2
POST
Bulk Release Hold User Or Group
POST
Bulk Release Hold User Or Group V2
POST
Change User Password
POST
Compute Space Requirements
POST
Compute Vsan Cost
POST
Delete Auxiliary Accounts
GET
Get AD Container
GET
Get AD User Or Group Info
GET
Get Agent Upgrade History
GET
Get Base V Ms V2
GET
Get Default AD Container
GET
List AD Containers
GET
List AD Domains
GET
List AD Domains V2
GET
List AD Domains V3
GET
List AD User Or Group Summary
GET
List Audit Events
GET
List Audit Events V2
GET
List Base Snapshots
GET
List Base Snapshots V2
GET
List Base V Ms
GET
List Base V Ms V2
GET
List Customization Specs
GET
List Datacenters
GET
List Datastore Clusters
GET
List Datastore Paths
GET
Listdatastores
GET
List Domains
GET
List Held Users Or Groups
GET
List Hosts Or Clusters
GET
List Network Interface Cards
GET
List Network Interface Cards V2
GET
List Network Labels
GET
List Resource Pools
GET
List Virtual Disks
GET
List Virtual Machines
GET
List VM Folders
GET
List VM Templates
POST
Unbind
POST
Update
POST
Update Auxiliary Accounts
POST
Validate AD User Encrypted Credentials