Test a directory domain LDAP server connectivity

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.

Request:

Method:

POST

URI Path(s):

/api/v1/directory/ldap-server

Request Headers:

n/a

Query Parameters:

DirectoryLdapServerTestParameters+

Name	Description	Type	Notes
action	LDAP server test requested Type of LDAP server test to perform.	string	Required Enum: CONNECTIVITY

Request Body:

DirectoryLdapServer+

DirectoryLdapServer (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	Directory domain name Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.	string
host	LDAP server host name Directory LDAP server DNS host name or ip address which is reachable by NSX manager to be connected and do object synchronization.	string	Required
id	Unique identifier of this resource	string	Sortable
password	LDAP server password Directory LDAP server connection password.	string
port	LDAP server TCP/UDP port Directory LDAP server connection TCP/UDP port.	integer	Default: "389"
protocol	LDAP server protocol Directory LDAP server connection protocol which is either LDAP or LDAPS.	string	Enum: LDAP, LDAPS Default: "LDAP"
resource_type	Must be set to the value DirectoryLdapServer	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
thumbprint	LDAP server certificate thumbprint using SHA-256 algorithm Directory LDAP server certificate thumbprint used in secure LDAPS connection.	string
username	LDAP server username Directory LDAP server connection user name.	string

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", "enabled": true }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DirectoryLdapServerStatus+

Name	Description	Type	Notes
error_id	Error ID of the directory LDAP server status Error ID of the directory LDAP server status maintained by the NSX directory service.	integer
error_message	Error message of the directory LDAP server status Error message of the directory LDAP server status maintained by the NSX directory service.	string

Example Response:

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

Test a directory domain LDAP server connectivity

Request:

DirectoryLdapServerTestParameters (schema)

DirectoryLdapServer (schema)

Example Request:

Successful Response:

DirectoryLdapServerStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: