com.vmware.nsx.directory.domains

Interface LdapServers

All Superinterfaces:

LdapServersTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

LdapServersStub

public interface LdapServers
extends com.vmware.vapi.bindings.Service, LdapServersTypes

Field Summary

Fields inherited from interface com.vmware.nsx.directory.domains.LdapServersTypes

_VAPI_SERVICE_ID, CREATE_0_ACTION_CONNECTIVITY

Method Summary

Modifier and Type	Method and Description
DirectoryLdapServer	create(java.lang.String domainId, DirectoryLdapServer directoryLdapServer) Deprecated.
void	create(java.lang.String domainId, DirectoryLdapServer directoryLdapServer, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback) Deprecated.
void	create(java.lang.String domainId, DirectoryLdapServer directoryLdapServer, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServer	create(java.lang.String domainId, DirectoryLdapServer directoryLdapServer, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	create0(java.lang.String domainId, java.lang.String serverId, java.lang.String action) Deprecated.
void	create0(java.lang.String domainId, java.lang.String serverId, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	create0(java.lang.String domainId, java.lang.String serverId, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	create0(java.lang.String domainId, java.lang.String serverId, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String domainId, java.lang.String serverId) Deprecated.
void	delete(java.lang.String domainId, java.lang.String serverId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String domainId, java.lang.String serverId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String domainId, java.lang.String serverId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServer	get(java.lang.String domainId, java.lang.String serverId) Deprecated.
void	get(java.lang.String domainId, java.lang.String serverId, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback) Deprecated.
void	get(java.lang.String domainId, java.lang.String serverId, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServer	get(java.lang.String domainId, java.lang.String serverId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServerListResults	list(java.lang.String domainId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Deprecated.
void	list(java.lang.String domainId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerListResults> asyncCallback) Deprecated.
void	list(java.lang.String domainId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerListResults> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServerListResults	list(java.lang.String domainId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServer	update(java.lang.String domainId, java.lang.String serverId, DirectoryLdapServer directoryLdapServer) Deprecated.
void	update(java.lang.String domainId, java.lang.String serverId, DirectoryLdapServer directoryLdapServer, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback) Deprecated.
void	update(java.lang.String domainId, java.lang.String serverId, DirectoryLdapServer directoryLdapServer, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServer	update(java.lang.String domainId, java.lang.String serverId, DirectoryLdapServer directoryLdapServer, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
DirectoryLdapServer create(java.lang.String domainId,
                                       DirectoryLdapServer directoryLdapServer)

Deprecated.

More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects. If more than one LDAP server is configured, NSX will try all the servers until it is able to successfully connect to one.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

domainId - Directory domain identifier (required)

directoryLdapServer - (required)

Returns:

com.vmware.nsx.model.DirectoryLdapServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

@Deprecated
DirectoryLdapServer create(java.lang.String domainId,
                                       DirectoryLdapServer directoryLdapServer,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects. If more than one LDAP server is configured, NSX will try all the servers until it is able to successfully connect to one.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

domainId - Directory domain identifier (required)

directoryLdapServer - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DirectoryLdapServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

@Deprecated
void create(java.lang.String domainId,
                        DirectoryLdapServer directoryLdapServer,
                        com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback)

Deprecated.

More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects. If more than one LDAP server is configured, NSX will try all the servers until it is able to successfully connect to one.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

directoryLdapServer - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

@Deprecated
void create(java.lang.String domainId,
                        DirectoryLdapServer directoryLdapServer,
                        com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects. If more than one LDAP server is configured, NSX will try all the servers until it is able to successfully connect to one.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

directoryLdapServer - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

create0

@Deprecated
void create0(java.lang.String domainId,
                         java.lang.String serverId,
                         java.lang.String action)

Deprecated.

The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

action - LDAP server test requested (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create0

@Deprecated
void create0(java.lang.String domainId,
                         java.lang.String serverId,
                         java.lang.String action,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

action - LDAP server test requested (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create0

@Deprecated
void create0(java.lang.String domainId,
                         java.lang.String serverId,
                         java.lang.String action,
                         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

action - LDAP server test requested (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create0

@Deprecated
void create0(java.lang.String domainId,
                         java.lang.String serverId,
                         java.lang.String action,
                         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

action - LDAP server test requested (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String domainId,
                        java.lang.String serverId)

Deprecated.

Delete a LDAP server for directory domain

Use the following Policy API -
DELETE /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

@Deprecated
void delete(java.lang.String domainId,
                        java.lang.String serverId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Delete a LDAP server for directory domain

Use the following Policy API -
DELETE /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

@Deprecated
void delete(java.lang.String domainId,
                        java.lang.String serverId,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Delete a LDAP server for directory domain

Use the following Policy API -
DELETE /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

@Deprecated
void delete(java.lang.String domainId,
                        java.lang.String serverId,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Delete a LDAP server for directory domain

Use the following Policy API -
DELETE /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

@Deprecated
DirectoryLdapServer get(java.lang.String domainId,
                                    java.lang.String serverId)

Deprecated.

Get a specific LDAP server for a given directory domain

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

Returns:

com.vmware.nsx.model.DirectoryLdapServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

@Deprecated
DirectoryLdapServer get(java.lang.String domainId,
                                    java.lang.String serverId,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get a specific LDAP server for a given directory domain

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DirectoryLdapServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

@Deprecated
void get(java.lang.String domainId,
                     java.lang.String serverId,
                     com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback)

Deprecated.

Get a specific LDAP server for a given directory domain

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

@Deprecated
void get(java.lang.String domainId,
                     java.lang.String serverId,
                     com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get a specific LDAP server for a given directory domain

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

@Deprecated
DirectoryLdapServerListResults list(java.lang.String domainId,
                                                java.lang.String cursor,
                                                java.lang.String includedFields,
                                                java.lang.Long pageSize,
                                                java.lang.Boolean sortAscending,
                                                java.lang.String sortBy)

Deprecated.

List all configured domain LDAP servers

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

domainId - Directory domain identifier (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.DirectoryLdapServerListResults

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

@Deprecated
DirectoryLdapServerListResults list(java.lang.String domainId,
                                                java.lang.String cursor,
                                                java.lang.String includedFields,
                                                java.lang.Long pageSize,
                                                java.lang.Boolean sortAscending,
                                                java.lang.String sortBy,
                                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

List all configured domain LDAP servers

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

domainId - Directory domain identifier (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DirectoryLdapServerListResults

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

@Deprecated
void list(java.lang.String domainId,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerListResults> asyncCallback)

Deprecated.

List all configured domain LDAP servers

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServerListResults

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

@Deprecated
void list(java.lang.String domainId,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerListResults> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

List all configured domain LDAP servers

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//ldap-servers

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServerListResults

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

@Deprecated
DirectoryLdapServer update(java.lang.String domainId,
                                       java.lang.String serverId,
                                       DirectoryLdapServer directoryLdapServer)

Deprecated.

Update a LDAP server for directory domain

Use the following Policy API -
PUT /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

directoryLdapServer - (required)

Returns:

com.vmware.nsx.model.DirectoryLdapServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

@Deprecated
DirectoryLdapServer update(java.lang.String domainId,
                                       java.lang.String serverId,
                                       DirectoryLdapServer directoryLdapServer,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update a LDAP server for directory domain

Use the following Policy API -
PUT /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

directoryLdapServer - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DirectoryLdapServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

@Deprecated
void update(java.lang.String domainId,
                        java.lang.String serverId,
                        DirectoryLdapServer directoryLdapServer,
                        com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback)

Deprecated.

Update a LDAP server for directory domain

Use the following Policy API -
PUT /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

directoryLdapServer - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

@Deprecated
void update(java.lang.String domainId,
                        java.lang.String serverId,
                        DirectoryLdapServer directoryLdapServer,
                        com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update a LDAP server for directory domain

Use the following Policy API -
PUT /policy/api/v1/infra/firewall-identity-stores//ldap-servers/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.DirectoryLdapServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

domainId - Directory domain identifier (required)

serverId - LDAP server identifier (required)

directoryLdapServer - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.