Retrieve the Active Directory preferred DC configuration for an SVM
Retrieves the Active Directory preferred domain controller configuration for an SVM. This is useful to review the current settings and ensure the SVM is aligned with your Active Directory environment.
HTTP method and endpoint
GET /protocols/active-directory/{svm.uuid}/preferred-domain-controllers
Introduced in
ONTAP 9.12
Usage notes
Retrieves the Active Directory preferred DC configuration of an SVM.
Related ONTAP commands
-
vserver active-directory preferred-dc show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fqdn |
string |
query |
False |
Filter by fqdn
|
server_ip |
string |
query |
False |
Filter by server_ip |
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
fields |
array[string] |
query |
False |
Specify the fields to return. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
max_records |
integer |
query |
False |
Limit the number of records returned. |
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of Active Directory preferred DC records. |
records |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"fqdn": "test.com",
"server_ip": "4.4.4.4"
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
active_directory_preferred_dc
| Name | Type | Description |
|---|---|---|
fqdn |
string |
Fully Qualified Domain Name. |
server_ip |
string |
IP address of the preferred DC. The address can be either an IPv4 or an IPv6 address. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |