Get Active Directory Configuration
Product version: 10.11
Last modified: 17 January 2024
Gets multiple ADs 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
Request Example
{
"action": "ADDomainManagement",
"method": "getListADDomains",
"data": [
{
"filter": {
"start": 0,
"count": 20,
"useUnlimitedCount": false,
"sort": "name",
"sortAsc": true,
"sorts": null,
"sortsAsc": null,
"criteria": [
{
"type": "OR",
"name": null,
"value": null,
"values": null,
"criteria": [
{
"type": "EQ",
"name": "STATE",
"value": "ENABLED",
"values": null,
"criteria": null
},
{
"type": "EQ",
"name": "STATE",
"value": "DISABLED",
"values": null,
"criteria": null
}
]
}
]
}
}
],
"type": "rpc",
"tid": 1
}
Request Fields
Field |
Type |
Value(s) |
---|---|---|
|
string |
|
|
string |
|
|
null |
|
|
string |
|
|
integer |
|
filter
Field |
Value |
Description |
|
int |
A start ID of the AD domains to be returned |
|
int |
Number of AD domains to be returned |
|
boolean |
If unlimited count is to be used, then true , false otherwise |
sort
|
string |
AD domain parameter to be sorted with |
|
boolean |
|
|
array |
Filter criteria. See the rows below |
|
string |
Type of criterion |
|
string |
Name of criterion |
|
string |
Type of the criterion. |
|
string |
Value of the criterion |
|
string |
Values of the criterion |
Response Sample
{
"action": "ADDomainManagement",
"method": "getListADDomains",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": {
"children": [{
"id": 5,
"domainName": "adtestvn.local",
"preferredDc": "10.30.30.1",
"username": "administrator",
"password": null,
"integratedGroups": "users,domain users",
"refreshInMinutes": 60,
"useLdaps": false,
"changeExistingPreferredDc": true,
"locked": false,
"lockReasons": [],
"disabled": false,
"connected": true,
"alertErrorCode": null,
"alertTitle": null,
"alertDescription": null
}],
"totalCount": 2}
}
Data
Field |
Value |
Description |
---|---|---|
|
string |
AD domain |
|
string |
Preferred DC/Host (optional) |
|
string |
Username |
password
|
string | Password |
|
string |
List of integrated groups |
|
number |
Number in minutes in which system will fetch data from AD |
useLdaps |
boolean | If LDAPs are to be used when connecting to the Active Directory, then true , false otherwise |
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". |
locked
|
boolean | Checks if the item is locked by some task |
lockReasons
|
boolean | Reasons why the item is locked by some task |
disabled
|
boolean | If the AD Domain is disabled, then true , false otherwise |
connected
|
boolean | If can connect to the AD Domain, then true , false otherwise |
alertErrorCode
|
null | |
alertTitle
|
null | |
alertDescription
|
null | |
totalCount
|
number | Number of returned AD domains |