Retrieve Active Directory accounts for all SVMs
Accesses Active Directory accounts associated with all Storage Virtual Machines (SVMs). This helps you manage and review Active Directory configurations within your storage environment.
HTTP method and endpoint
GET /protocols/active-directory
Introduced in
ONTAP 9.12
Usage notes
Retrieves Active Directory accounts for all SVMs.
Related ONTAP commands
-
vserver active-directory show -
vserver active-directory preferred-dc show -
vserver active-directory discovered-servers show -
vserver cifs security show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
discovered_servers.state |
string |
query |
False |
Filter by discovered_servers.state |
discovered_servers.server.name |
string |
query |
False |
Filter by discovered_servers.server.name |
discovered_servers.server.ip |
string |
query |
False |
Filter by discovered_servers.server.ip |
discovered_servers.server.type |
string |
query |
False |
Filter by discovered_servers.server.type |
discovered_servers.node.uuid |
string |
query |
False |
Filter by discovered_servers.node.uuid |
discovered_servers.node.name |
string |
query |
False |
Filter by discovered_servers.node.name |
discovered_servers.domain |
string |
query |
False |
Filter by discovered_servers.domain |
discovered_servers.preference |
string |
query |
False |
Filter by discovered_servers.preference |
preferred_dcs.fqdn |
string |
query |
False |
Filter by preferred_dcs.fqdn
|
preferred_dcs.server_ip |
string |
query |
False |
Filter by preferred_dcs.server_ip |
svm.name |
string |
query |
False |
Filter by svm.name |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
organizational_unit |
string |
query |
False |
Filter by organizational_unit |
fqdn |
string |
query |
False |
Filter by fqdn
|
security.advertised_kdc_encryptions |
string |
query |
False |
Filter by security.advertised_kdc_encryptions
|
name |
string |
query |
False |
Filter by name
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
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.
|
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 records. |
records |
array[active_directory] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"discovered_servers": [
{
"domain": "server1.com",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"preference": "preferred",
"server": {
"ip": "7.4.3.1",
"name": "scspk0659102001",
"type": "kerberos"
},
"state": "ok"
}
],
"force_account_overwrite": "",
"fqdn": "server1.com",
"name": "account1",
"organizational_unit": "CN=Test",
"preferred_dcs": [
{
"fqdn": "test.com",
"server_ip": "4.4.4.4"
}
],
"security": {
"advertised_kdc_encryptions": [
"string"
]
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
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 |
_links
| Name | Type | Description |
|---|---|---|
self |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
active_directory_discovered_server_reference
| Name | Type | Description |
|---|---|---|
ip |
string |
The IP address of the server that was discovered. |
name |
string |
Server Name |
type |
string |
The type of the server that was discovered. |
discovered_servers
| Name | Type | Description |
|---|---|---|
domain |
string |
The Active Directory domain that the discovered server is a member of. |
node |
||
preference |
string |
The preference level of the server that was discovered. |
server |
||
state |
string |
The status of the connection to the server that was discovered. |
preferred_dcs
| 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. |
active_directory_security
| Name | Type | Description |
|---|---|---|
advertised_kdc_encryptions |
array[string] |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
active_directory
| Name | Type | Description |
|---|---|---|
discovered_servers |
array[discovered_servers] |
Specifies the discovered servers records. |
fqdn |
string |
Fully qualified domain name. |
name |
string |
Active Directory (AD) account NetBIOS name. |
organizational_unit |
string |
Organizational unit under which the Active Directory account will be created. |
preferred_dcs |
array[preferred_dcs] |
Specifies the preferred domain controller (DC) records. |
security |
||
svm |
SVM, applies only to SVM-scoped objects. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |