com.vmware.nsx_policy.aaa

Interface LdapIdentitySources

All Superinterfaces:

LdapIdentitySourcesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

LdapIdentitySourcesStub

public interface LdapIdentitySources
extends com.vmware.vapi.bindings.Service, LdapIdentitySourcesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.aaa.LdapIdentitySourcesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String ldapIdentitySourceId) Delete an LDAP identity source.
void	delete(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete an LDAP identity source.
void	delete(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete an LDAP identity source.
void	delete(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete an LDAP identity source.
PeerCertificateChain	fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint) Attempt to connect to an LDAP server and retrieve the server certificate it presents.
void	fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint, com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback) Attempt to connect to an LDAP server and retrieve the server certificate it presents.
void	fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint, com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an LDAP server and retrieve the server certificate it presents.
PeerCertificateChain	fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an LDAP server and retrieve the server certificate it presents.
com.vmware.vapi.bindings.Structure	get(java.lang.String ldapIdentitySourceId) Return details about one LDAP identity source
void	get(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Return details about one LDAP identity source
void	get(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return details about one LDAP identity source
com.vmware.vapi.bindings.Structure	get(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return details about one LDAP identity source
LdapIdentitySourceListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Return a list of all configured LDAP identity sources.
void	list(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<LdapIdentitySourceListResult> asyncCallback) Return a list of all configured LDAP identity sources.
void	list(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<LdapIdentitySourceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return a list of all configured LDAP identity sources.
LdapIdentitySourceListResult	list(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) Return a list of all configured LDAP identity sources.
LdapIdentitySourceProbeResults	probe(java.lang.String ldapIdentitySourceId) Attempt to connect to an existing LDAP identity source and report any errors encountered.
void	probe(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback) Attempt to connect to an existing LDAP identity source and report any errors encountered.
void	probe(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an existing LDAP identity source and report any errors encountered.
LdapIdentitySourceProbeResults	probe(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an existing LDAP identity source and report any errors encountered.
LdapIdentitySourceProbeResults	probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource) Verify that the configuration of an LDAP identity source is correct before actually creating the source.
void	probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource, com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback) Verify that the configuration of an LDAP identity source is correct before actually creating the source.
void	probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource, com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Verify that the configuration of an LDAP identity source is correct before actually creating the source.
LdapIdentitySourceProbeResults	probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Verify that the configuration of an LDAP identity source is correct before actually creating the source.
IdentitySourceLdapServerProbeResult	probeldapserver(IdentitySourceLdapServer identitySourceLdapServer) Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.
void	probeldapserver(IdentitySourceLdapServer identitySourceLdapServer, com.vmware.vapi.bindings.client.AsyncCallback<IdentitySourceLdapServerProbeResult> asyncCallback) Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.
void	probeldapserver(IdentitySourceLdapServer identitySourceLdapServer, com.vmware.vapi.bindings.client.AsyncCallback<IdentitySourceLdapServerProbeResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.
IdentitySourceLdapServerProbeResult	probeldapserver(IdentitySourceLdapServer identitySourceLdapServer, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.
com.vmware.vapi.bindings.Structure	update(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.Structure ldapIdentitySource) Create a new LDAP identity source or update the configuration of an existing LDAP identity source.
void	update(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.Structure ldapIdentitySource, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Create a new LDAP identity source or update the configuration of an existing LDAP identity source.
void	update(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.Structure ldapIdentitySource, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a new LDAP identity source or update the configuration of an existing LDAP identity source.
com.vmware.vapi.bindings.Structure	update(java.lang.String ldapIdentitySourceId, com.vmware.vapi.bindings.Structure ldapIdentitySource, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a new LDAP identity source or update the configuration of an existing LDAP identity source.

Method Detail

delete

void delete(java.lang.String ldapIdentitySourceId)

Delete an LDAP identity source. Users defined in that source will no longer be able to access NSX.

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

Parameters:

ldapIdentitySourceId - (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

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

Delete an LDAP identity source. Users defined in that source will no longer be able to access NSX.

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:

ldapIdentitySourceId - (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

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

Delete an LDAP identity source. Users defined in that source will no longer be able to access NSX.

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:

ldapIdentitySourceId - (required)

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

delete

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

Delete an LDAP identity source. Users defined in that source will no longer be able to access NSX.

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:

ldapIdentitySourceId - (required)

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

invocationConfig - Configuration for the method invocation.

fetchcertificate

PeerCertificateChain fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint)

Attempt to connect to an LDAP server and retrieve the server certificate it presents.

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

Parameters:

identitySourceLdapServerEndpoint - (required)

Returns:

com.vmware.nsx_policy.model.PeerCertificateChain

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

fetchcertificate

PeerCertificateChain fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint,
                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an LDAP server and retrieve the server certificate it presents.

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:

identitySourceLdapServerEndpoint - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PeerCertificateChain

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

fetchcertificate

void fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint,
                      com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback)

Attempt to connect to an LDAP server and retrieve the server certificate it presents.

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

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

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

Parameters:

identitySourceLdapServerEndpoint - (required)

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

fetchcertificate

void fetchcertificate(IdentitySourceLdapServerEndpoint identitySourceLdapServerEndpoint,
                      com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an LDAP server and retrieve the server certificate it presents.

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

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

Parameters:

identitySourceLdapServerEndpoint - (required)

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

invocationConfig - Configuration for the method invocation.

get

com.vmware.vapi.bindings.Structure get(java.lang.String ldapIdentitySourceId)

Return details about one LDAP identity source

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

Parameters:

ldapIdentitySourceId - (required)

Returns:

com.vmware.nsx_policy.model.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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

com.vmware.vapi.bindings.Structure get(java.lang.String ldapIdentitySourceId,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return details about one LDAP identity source

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:

ldapIdentitySourceId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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 ldapIdentitySourceId,
         com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Return details about one LDAP identity source

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

Invocation Result:
com.vmware.nsx_policy.model.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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

Parameters:

ldapIdentitySourceId - (required)

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

get

void get(java.lang.String ldapIdentitySourceId,
         com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return details about one LDAP identity source

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.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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

Parameters:

ldapIdentitySourceId - (required)

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

invocationConfig - Configuration for the method invocation.

list

LdapIdentitySourceListResult list(java.lang.String cursor,
                                  java.lang.String includedFields,
                                  java.lang.Long pageSize,
                                  java.lang.Boolean sortAscending,
                                  java.lang.String sortBy)

Return a list of all configured LDAP identity sources.

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

Parameters:

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

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

LdapIdentitySourceListResult list(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)

Return a list of all configured LDAP identity sources.

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:

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

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 cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceListResult> asyncCallback)

Return a list of all configured LDAP identity sources.

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

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

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

Parameters:

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

void list(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<LdapIdentitySourceListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return a list of all configured LDAP identity sources.

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

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

Parameters:

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.

probe

LdapIdentitySourceProbeResults probe(java.lang.String ldapIdentitySourceId)

Attempt to connect to an existing LDAP identity source and report any errors encountered.

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

Parameters:

ldapIdentitySourceId - (required)

Returns:

com.vmware.nsx_policy.model.LdapIdentitySourceProbeResults

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

probe

LdapIdentitySourceProbeResults probe(java.lang.String ldapIdentitySourceId,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an existing LDAP identity source and report any errors encountered.

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:

ldapIdentitySourceId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.LdapIdentitySourceProbeResults

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

probe

void probe(java.lang.String ldapIdentitySourceId,
           com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback)

Attempt to connect to an existing LDAP identity source and report any errors encountered.

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

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

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

Parameters:

ldapIdentitySourceId - (required)

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

probe

void probe(java.lang.String ldapIdentitySourceId,
           com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an existing LDAP identity source and report any errors encountered.

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

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

Parameters:

ldapIdentitySourceId - (required)

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

invocationConfig - Configuration for the method invocation.

probeidentitysource

LdapIdentitySourceProbeResults probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource)

Verify that the configuration of an LDAP identity source is correct before actually creating the source.

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

Parameters:

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

Returns:

com.vmware.nsx_policy.model.LdapIdentitySourceProbeResults

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

probeidentitysource

LdapIdentitySourceProbeResults probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource,
                                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Verify that the configuration of an LDAP identity source is correct before actually creating the source.

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:

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.LdapIdentitySourceProbeResults

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

probeidentitysource

void probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource,
                         com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback)

Verify that the configuration of an LDAP identity source is correct before actually creating the source.

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

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

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

Parameters:

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

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

probeidentitysource

void probeidentitysource(com.vmware.vapi.bindings.Structure ldapIdentitySource,
                         com.vmware.vapi.bindings.client.AsyncCallback<LdapIdentitySourceProbeResults> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Verify that the configuration of an LDAP identity source is correct before actually creating the source.

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

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

Parameters:

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

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

invocationConfig - Configuration for the method invocation.

probeldapserver

IdentitySourceLdapServerProbeResult probeldapserver(IdentitySourceLdapServer identitySourceLdapServer)

Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.

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

Parameters:

identitySourceLdapServer - (required)

Returns:

com.vmware.nsx_policy.model.IdentitySourceLdapServerProbeResult

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

probeldapserver

IdentitySourceLdapServerProbeResult probeldapserver(IdentitySourceLdapServer identitySourceLdapServer,
                                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.

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:

identitySourceLdapServer - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.IdentitySourceLdapServerProbeResult

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

probeldapserver

void probeldapserver(IdentitySourceLdapServer identitySourceLdapServer,
                     com.vmware.vapi.bindings.client.AsyncCallback<IdentitySourceLdapServerProbeResult> asyncCallback)

Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.

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

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

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

Parameters:

identitySourceLdapServer - (required)

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

probeldapserver

void probeldapserver(IdentitySourceLdapServer identitySourceLdapServer,
                     com.vmware.vapi.bindings.client.AsyncCallback<IdentitySourceLdapServerProbeResult> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.

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

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

Parameters:

identitySourceLdapServer - (required)

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

invocationConfig - Configuration for the method invocation.

update

com.vmware.vapi.bindings.Structure update(java.lang.String ldapIdentitySourceId,
                                          com.vmware.vapi.bindings.Structure ldapIdentitySource)

Create a new LDAP identity source or update the configuration of an existing LDAP identity source. You may wish to verify the new configuration using the POST /aaa/ldap-identity-sources?action=probe API before creating or changing the configuration. Note that if you are using LDAP on an active and standby NSX-T Global Manager in a federated environment, you must use the same name for your LDAP identity sources on the active and standby Global Managers.

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

Parameters:

ldapIdentitySourceId - (required)

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

Returns:

com.vmware.nsx_policy.model.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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

com.vmware.vapi.bindings.Structure update(java.lang.String ldapIdentitySourceId,
                                          com.vmware.vapi.bindings.Structure ldapIdentitySource,
                                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a new LDAP identity source or update the configuration of an existing LDAP identity source. You may wish to verify the new configuration using the POST /aaa/ldap-identity-sources?action=probe API before creating or changing the configuration. Note that if you are using LDAP on an active and standby NSX-T Global Manager in a federated environment, you must use the same name for your LDAP identity sources on the active and standby Global Managers.

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:

ldapIdentitySourceId - (required)

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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 ldapIdentitySourceId,
            com.vmware.vapi.bindings.Structure ldapIdentitySource,
            com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Create a new LDAP identity source or update the configuration of an existing LDAP identity source. You may wish to verify the new configuration using the POST /aaa/ldap-identity-sources?action=probe API before creating or changing the configuration. Note that if you are using LDAP on an active and standby NSX-T Global Manager in a federated environment, you must use the same name for your LDAP identity sources on the active and standby Global Managers.

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

Invocation Result:
com.vmware.nsx_policy.model.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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

Parameters:

ldapIdentitySourceId - (required)

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

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

update

void update(java.lang.String ldapIdentitySourceId,
            com.vmware.vapi.bindings.Structure ldapIdentitySource,
            com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a new LDAP identity source or update the configuration of an existing LDAP identity source. You may wish to verify the new configuration using the POST /aaa/ldap-identity-sources?action=probe API before creating or changing the configuration. Note that if you are using LDAP on an active and standby NSX-T Global Manager in a federated environment, you must use the same name for your LDAP identity sources on the active and standby Global Managers.

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.LdapIdentitySource The return value will contain all the properties defined in LdapIdentitySource.

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

Parameters:

ldapIdentitySourceId - (required)

ldapIdentitySource - (required) The parameter must contain all the properties defined in LdapIdentitySource.

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

invocationConfig - Configuration for the method invocation.