Create And Update Active Directory Domain

Product version: 10.11

Last modified: 8 January 2024

Creates and updates AD Domain.

Note

In case NAKIVO Backup & Replication was installed in Multi-tenant mode, the use of API is possible only for the Master tenant.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl

Copy

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data {
        "action": "ADDomainManagement",
        "method": "saveDomain",
        "data": [
            null,
            {
            "domainName": "adtestvn.local",
            "preferredDc": "10.30.30.1",
            "username": "administrator",
            "password": "password",
            "integratedGroups": "users,domain users"
            "refreshInMinutes": 60,
            "changeExistingPreferredDc": true,
             }],
        "type": "rpc",
        "tid": 1 }

Request Fields

Field	Type	Value(s)
`action`	string	`ADDomainManagement`
`method`	string	`saveDomain`
`data`	null
`type`	string	`rpc`
`tid`	integer	`1`

Data

Field	Value	Description
`domainName`	string	AD domain
`preferredDc`	string	Preferred DC/Host (optional)
`username`	string	Username
`password`	string	Password
`integratedGroups`	string	List of integrated groups
`refreshInMinutes`	number	number in minutes in which system will fetch data from AD
`changeExistingPreferredDc`	boolean	Allows deleting old data from old existing configuration. It is relevant only if you change value of 'preferred DC' but keep value in 'domain name'.

Response Sample

curl

Copy

{
    "action": "ADDomainManagement", 
    "method": "saveDomain",
    "tid": "1", 
    "type": "rpc",    
    "message": null,     
    "where": null,     
    "cause": null, 
    "data": null     
}

Response Fields

Field	Type	Value(s)
`action`	string	`ADDomainManagement`
`method`	string	`saveDomain`
`tid`	integer	`1`
`type`	string	`rpc`
`message`	null
`where`	null
`cause`	null
`data`	null