Retrieve the LDAP configuration for an SVM
Retrieves the LDAP configuration for an SVM to view all parameters associated with the LDAP setup. This is useful for verifying and managing LDAP settings within your storage environment.
HTTP method and endpoint
GET /name-services/ldap/{svm.uuid}
Introduced in
ONTAP 9.6
Usage notes
All parameters for the LDAP configuration are displayed by default.
Related ONTAP commands
-
ldap show -
ldap check -vserver vs0 -
ldap check-ipv6 -vserver vs0
Important notes
-
The status.code, status.dn_message, status.message, and status.state fields have the same status fields that are returned using the "ldap check" CLI command.
-
Refer to the ipv4 or ipv6 objects available in the status field to get specific information about the code, dn_messages, or message and state information for ipv4 or ipv6.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
ad_domain |
string |
This parameter specifies the name of the Active Directory domain
used to discover LDAP servers for use by this client.
This is mutually exclusive with |
base_dn |
string |
Specifies the default base DN for all searches. |
base_scope |
string |
Specifies the default search scope for LDAP queries:
|
bind_as_cifs_server |
boolean |
Specifies whether or not CIFS server's credentials are used to bind to the LDAP server. |
bind_dn |
string |
Specifies the user that binds to the LDAP servers. |
group_dn |
string |
Specifies the group Distinguished Name (DN) that is used as the starting point in the LDAP directory tree for group lookups. |
group_membership_filter |
string |
Specifies the custom filter used for group membership lookups from an LDAP server. |
group_scope |
string |
Specifies the default search scope for LDAP for group lookups:
|
is_netgroup_byhost_enabled |
boolean |
Specifies whether or not netgroup by host querying is enabled. |
is_owner |
boolean |
Specifies whether or not the SVM owns the LDAP client configuration. |
ldaps_enabled |
boolean |
Specifies whether or not LDAPS is enabled. |
min_bind_level |
string |
The minimum bind authentication level. Possible values are:
|
netgroup_byhost_dn |
string |
Specifies the netgroup Distinguished Name (DN) that is used as the starting point in the LDAP directory tree for netgroup by host lookups. |
netgroup_byhost_scope |
string |
Specifies the default search scope for LDAP for netgroup by host lookups:
|
netgroup_dn |
string |
Specifies the netgroup Distinguished Name (DN) that is used as the starting point in the LDAP directory tree for netgroup lookups. |
netgroup_scope |
string |
Specifies the default search scope for LDAP for netgroup lookups:
|
port |
integer |
The port used to connect to the LDAP Servers. |
preferred_ad_servers |
array[string] |
|
query_timeout |
integer |
Specifies the maximum time to wait for a query response from the LDAP server, in seconds. |
referral_enabled |
boolean |
Specifies whether or not LDAP referral is enabled. |
restrict_discovery_to_site |
boolean |
Specifies whether or not LDAP server discovery is restricted to site-scope. |
schema |
string |
The name of the schema template used by the SVM.
|
servers |
array[string] |
|
session_security |
string |
Specifies the level of security to be used for LDAP communications:
|
status |
||
svm |
SVM, applies only to SVM-scoped objects. |
|
try_channel_binding |
boolean |
Specifies whether or not channel binding is attempted in the case of TLS/LDAPS. |
use_start_tls |
boolean |
Specifies whether or not to use Start TLS over LDAP connections. |
user_dn |
string |
Specifies the user Distinguished Name (DN) that is used as the starting point in the LDAP directory tree for user lookups. |
user_scope |
string |
Specifies the default search scope for LDAP for user lookups:
|
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ad_domain": "example.com",
"base_dn": "dc=domainB,dc=example,dc=com",
"base_scope": "string",
"bind_dn": "cn=Administrators,cn=users,dc=domainB,dc=example,dc=com",
"group_dn": "cn=abc,users,dc=com",
"group_membership_filter": "",
"group_scope": "string",
"min_bind_level": "string",
"netgroup_byhost_dn": "cn=abc,users,dc=com",
"netgroup_byhost_scope": "string",
"netgroup_dn": "cn=abc,users,dc=com",
"netgroup_scope": "string",
"port": 389,
"preferred_ad_servers": [
"11.11.11.11"
],
"schema": "ad_idmu",
"servers": [
[
"10.10.10.10",
"domainB.example.com"
]
],
"session_security": "string",
"skip_config_validation": true,
"status": {
"code": 65537300,
"dn_message": [
"string"
],
"ipv4": {
"code": 65537300,
"dn_messages": [
"string"
],
"message": "string",
"state": "string"
},
"ipv4_state": "string",
"ipv6": {
"code": 65537300,
"dn_messages": [
"string"
],
"message": "string",
"state": "string"
},
"ipv6_state": "string",
"message": "string",
"state": "string"
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"user_dn": "cn=abc,users,dc=com",
"user_scope": "string"
}
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 |
|---|---|---|
self |
ipv4
| Name | Type | Description |
|---|---|---|
code |
integer |
Code corresponding to the error message. If there is no error, it is 0 to indicate success. |
dn_messages |
array[string] |
|
message |
string |
Provides additional details on the error. |
state |
string |
Status of the LDAP service. |
ipv6
| Name | Type | Description |
|---|---|---|
code |
integer |
Code corresponding to the error message. If there is no error, it is 0 to indicate success. |
dn_messages |
array[string] |
|
message |
string |
Provides additional details on the error. |
state |
string |
Status of the LDAP service. |
status
| Name | Type | Description |
|---|---|---|
code |
integer |
This field is no longer supported. Use ipv4.code or ipv6.code instead. |
dn_message |
array[string] |
|
ipv4 |
||
ipv4_state |
string |
This field is no longer supported. Use ipv4.state instead. |
ipv6 |
||
ipv6_state |
string |
This field is no longer supported. Use ipv6.state instead. |
message |
string |
This field is no longer supported. Use ipv4.message or ipv6.message instead. |
state |
string |
The status of the LDAP service for the SVM. The LDAP service is up if either |
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. |
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. |