com.vmware.nsx_policy.infra.firewall_identity_stores

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_policy.infra.firewall_identity_stores.LdapServersTypes

_VAPI_SERVICE_ID, CREATE_ACTION_CONNECTIVITY

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String action, java.lang.String enforcementPointPath) The API tests a LDAP server connection for an already configured domain.
void	create(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String action, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) The API tests a LDAP server connection for an already configured domain.
void	create(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String action, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) The API tests a LDAP server connection for an already configured domain.
void	create(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String action, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) The API tests a LDAP server connection for an already configured domain.
void	delete(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath) Delete a LDAP server for Firewall Identity store
void	delete(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete a LDAP server for Firewall Identity store
void	delete(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a LDAP server for Firewall Identity store
void	delete(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a LDAP server for Firewall Identity store
DirectoryLdapServer	get(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath) Get a specific LDAP server for a given Firewall Identity store
void	get(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback) Get a specific LDAP server for a given Firewall Identity store
void	get(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a specific LDAP server for a given Firewall Identity store
DirectoryLdapServer	get(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a specific LDAP server for a given Firewall Identity store
DirectoryLdapServerListResults	list(java.lang.String firewallIdentityStoreId, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) List all configured domain LDAP servers
void	list(java.lang.String firewallIdentityStoreId, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServerListResults> asyncCallback) List all configured domain LDAP servers
void	list(java.lang.String firewallIdentityStoreId, java.lang.String cursor, java.lang.String enforcementPointPath, 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) List all configured domain LDAP servers
DirectoryLdapServerListResults	list(java.lang.String firewallIdentityStoreId, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all configured domain LDAP servers
DirectoryLdapServer	patch(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath) More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects.
void	patch(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback) More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects.
void	patch(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects.
DirectoryLdapServer	patch(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects.
DirectoryLdapServer	update(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath) Update a LDAP server for Firewall Identity store
void	update(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback) Update a LDAP server for Firewall Identity store
void	update(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a LDAP server for Firewall Identity store
DirectoryLdapServer	update(java.lang.String firewallIdentityStoreId, java.lang.String ldapServerId, DirectoryLdapServer directoryLdapServer, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a LDAP server for Firewall Identity store

Method Detail

create

void create(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String action,
            java.lang.String enforcementPointPath)

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.

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

action - LDAP server test requested (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

void create(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String action,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

action - LDAP server test requested (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

create

void create(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String action,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

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.

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

action - LDAP server test requested (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

create

void create(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String action,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

action - LDAP server test requested (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String enforcementPointPath)

Delete a LDAP server for Firewall Identity store

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

void delete(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a LDAP server for Firewall Identity store

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

void delete(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete a LDAP server for Firewall Identity store

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

delete

void delete(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a LDAP server for Firewall Identity store

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

invocationConfig - Configuration for the method invocation.

get

DirectoryLdapServer get(java.lang.String firewallIdentityStoreId,
                        java.lang.String ldapServerId,
                        java.lang.String enforcementPointPath)

Get a specific LDAP server for a given Firewall Identity store

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

Returns:

com.vmware.nsx_policy.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

DirectoryLdapServer get(java.lang.String firewallIdentityStoreId,
                        java.lang.String ldapServerId,
                        java.lang.String enforcementPointPath,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a specific LDAP server for a given Firewall Identity store

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.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

void get(java.lang.String firewallIdentityStoreId,
         java.lang.String ldapServerId,
         java.lang.String enforcementPointPath,
         com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback)

Get a specific LDAP server for a given Firewall Identity store

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

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

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

get

void get(java.lang.String firewallIdentityStoreId,
         java.lang.String ldapServerId,
         java.lang.String enforcementPointPath,
         com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a specific LDAP server for a given Firewall Identity store

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_policy.model.DirectoryLdapServer

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

invocationConfig - Configuration for the method invocation.

list

DirectoryLdapServerListResults list(java.lang.String firewallIdentityStoreId,
                                    java.lang.String cursor,
                                    java.lang.String enforcementPointPath,
                                    java.lang.String includedFields,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy)

List all configured domain LDAP servers

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

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

enforcementPointPath - String Path of the enforcement point (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_policy.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

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

List all configured domain 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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

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

enforcementPointPath - String Path of the enforcement point (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_policy.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

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

List all configured domain LDAP servers

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

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

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

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

enforcementPointPath - String Path of the enforcement point (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

void list(java.lang.String firewallIdentityStoreId,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          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)

List all configured domain 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_policy.model.DirectoryLdapServerListResults

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

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

enforcementPointPath - String Path of the enforcement point (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.

patch

DirectoryLdapServer patch(java.lang.String firewallIdentityStoreId,
                          java.lang.String ldapServerId,
                          DirectoryLdapServer directoryLdapServer,
                          java.lang.String enforcementPointPath)

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.

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

Returns:

com.vmware.nsx_policy.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

patch

DirectoryLdapServer patch(java.lang.String firewallIdentityStoreId,
                          java.lang.String ldapServerId,
                          DirectoryLdapServer directoryLdapServer,
                          java.lang.String enforcementPointPath,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.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

patch

void patch(java.lang.String firewallIdentityStoreId,
           java.lang.String ldapServerId,
           DirectoryLdapServer directoryLdapServer,
           java.lang.String enforcementPointPath,
           com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback)

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.

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

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

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

patch

void patch(java.lang.String firewallIdentityStoreId,
           java.lang.String ldapServerId,
           DirectoryLdapServer directoryLdapServer,
           java.lang.String enforcementPointPath,
           com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

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_policy.model.DirectoryLdapServer

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

invocationConfig - Configuration for the method invocation.

update

DirectoryLdapServer update(java.lang.String firewallIdentityStoreId,
                           java.lang.String ldapServerId,
                           DirectoryLdapServer directoryLdapServer,
                           java.lang.String enforcementPointPath)

Update a LDAP server for Firewall Identity store

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

Returns:

com.vmware.nsx_policy.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

DirectoryLdapServer update(java.lang.String firewallIdentityStoreId,
                           java.lang.String ldapServerId,
                           DirectoryLdapServer directoryLdapServer,
                           java.lang.String enforcementPointPath,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update a LDAP server for Firewall Identity store

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:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.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

void update(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            DirectoryLdapServer directoryLdapServer,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback)

Update a LDAP server for Firewall Identity store

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

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

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

update

void update(java.lang.String firewallIdentityStoreId,
            java.lang.String ldapServerId,
            DirectoryLdapServer directoryLdapServer,
            java.lang.String enforcementPointPath,
            com.vmware.vapi.bindings.client.AsyncCallback<DirectoryLdapServer> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update a LDAP server for Firewall Identity store

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_policy.model.DirectoryLdapServer

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

Parameters:

firewallIdentityStoreId - Firewall Identity store identifier (required)

ldapServerId - LDAP server identifier (required)

directoryLdapServer - (required)

enforcementPointPath - String Path of the enforcement point (optional)

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

invocationConfig - Configuration for the method invocation.