DirectoryLdapServer (schema)

LDAP server of directory domain

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