NSX-T Data Center REST API

Test a directory domain LDAP server connectivity (Deprecated)

This API tests a LDAP server connectivity before the actual domain or LDAP server is configured. If the connectivity is good, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned. Deprecated:
Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-store-ldap-server

Request:

Method:
POST
URI Path(s):
/api/v1/directory/ldap-server
Request Headers:
n/a
Query Parameters:
DirectoryLdapServerTestParameters+
Request Body:
DirectoryLdapServer+

Example Request:

POST https://<nsx-mgr>/api/v1/directory/ldap-server?action=CONNECTIVITY { "domain_name": "nimbustest.com", "username": "dummy", "password": "dummy", "host": "10.161.34.143", "display_name": "nimbus LDAP", "thumbprint": "3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e", "port": 389, "protocol": "LDAP" }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
DirectoryLdapServerStatus+

Example Response:

{ "error_id": 38519, "error_message": "LDAP server 1.1.1.1 connection failed during verification." }

Required Permissions:

crud

Feature:

directory_service

Additional Errors: