com.vmware.nsx.directory

Interface LdapServer

All Superinterfaces:

LdapServerTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

LdapServerStub

public interface LdapServer
extends com.vmware.vapi.bindings.Service, LdapServerTypes

Field Summary

Fields inherited from interface com.vmware.nsx.directory.LdapServerTypes

_VAPI_SERVICE_ID, CREATE_ACTION_CONNECTIVITY

Method Summary

Modifier and Type	Method and Description
DirectoryLdapServerStatus	create(DirectoryLdapServer directoryLdapServer, java.lang.String action) Deprecated.
void	create(DirectoryLdapServer directoryLdapServer, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerStatus> asyncCallback) Deprecated.
void	create(DirectoryLdapServer directoryLdapServer, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DirectoryLdapServerStatus	create(DirectoryLdapServer directoryLdapServer, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

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

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.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-store-ldap-server

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

Parameters:

directoryLdapServer - (required)

action - LDAP server test requested (required)

Returns:

com.vmware.nsx.model.DirectoryLdapServerStatus

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
DirectoryLdapServerStatus create(DirectoryLdapServer directoryLdapServer,
                                             java.lang.String action,
                                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-store-ldap-server

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:

directoryLdapServer - (required)

action - LDAP server test requested (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DirectoryLdapServerStatus

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(DirectoryLdapServer directoryLdapServer,
                        java.lang.String action,
                        com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerStatus> asyncCallback)

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.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-store-ldap-server

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

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

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

Parameters:

directoryLdapServer - (required)

action - LDAP server test requested (required)

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

create

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

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.

Use the following Policy API -
POST /policy/api/v1/infra/firewall-identity-store-ldap-server

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.DirectoryLdapServerStatus

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

Parameters:

directoryLdapServer - (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.