Page tree

Gets AD configuration.

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
curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header ""content-type: application/json"" \
    --cookie @cookies.txt \
    --data {
        "action": "ADDomainManagement",
        "method": "getADConfiguration",
        "data": null,
        "type": ""rpc"",
        "tid": 1 }"

Request Fields

Field

Type

Value(s)

action

string

ADDomainManagement

method

string

getADConfiguration

data

null

type

string

rpc

tid

integer

1

Response Sample

{
"action": "ADDomainManagement",
"method": "getADConfiguration",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": { "domainName": "adtestvn.local", "preferredDc": "10.30.30.1", "username": "administrator", "password": null, "integratedGroups": "users,domain users", "refreshInMinutes": 60, "changeExistingPreferredDc": true, "locked": false }
}

Data

Field

Value

Description

domainName

string

AD domain

preferredDc

string

Preferred DC/Host (optional)

username

string

Username

passwordstringPassword

integratedGroups

string

List of integrated groups

refreshInMinutes

number

number in minutes in which system will fetch data from AD

changeExistingPreferredDcboolean

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'.

lockedbooleanChecks if the item is locked by some task
  • No labels