com.vmware.nsx.dhcp.servers

Class LeasesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.dhcp.servers.LeasesStub

All Implemented Interfaces:

Leases, LeasesTypes, com.vmware.vapi.bindings.Service

public class LeasesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Leases

Remote stub implementation of the Leases API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.dhcp.servers.LeasesTypes

_VAPI_SERVICE_ID, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Constructor Summary

Constructors

Constructor and Description
LeasesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
LeasesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String serverId, java.lang.String ip, java.lang.String mac) Delete a single DHCP lease entry specified by ip and mac.
void	delete(java.lang.String serverId, java.lang.String ip, java.lang.String mac, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete a single DHCP lease entry specified by ip and mac.
void	delete(java.lang.String serverId, java.lang.String ip, java.lang.String mac, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a single DHCP lease entry specified by ip and mac.
void	delete(java.lang.String serverId, java.lang.String ip, java.lang.String mac, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a single DHCP lease entry specified by ip and mac.
DhcpLeases	list(java.lang.String serverId, java.lang.String address, java.lang.String poolId, java.lang.String source) Get specific leases of a given dhcp server.
void	list(java.lang.String serverId, java.lang.String address, java.lang.String poolId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeases> asyncCallback) Get specific leases of a given dhcp server.
void	list(java.lang.String serverId, java.lang.String address, java.lang.String poolId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeases> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get specific leases of a given dhcp server.
DhcpLeases	list(java.lang.String serverId, java.lang.String address, java.lang.String poolId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get specific leases of a given dhcp server.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LeasesStub

public LeasesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                  com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                  com.vmware.vapi.bindings.StubConfigurationBase config)

LeasesStub

public LeasesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                  com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

delete

public void delete(java.lang.String serverId,
                   java.lang.String ip,
                   java.lang.String mac)

Description copied from interface: Leases

Delete a single DHCP lease entry specified by ip and mac. The DHCP server matches the DHCP lease with the given ip address and the mac address. The matched lease entry will be deleted. If no lease matches, the request is ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

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

Specified by:

delete in interface Leases

Parameters:

serverId - (required)

ip - IPv4 or IPv6 address (required)

mac - MAC Address (required)

delete

public void delete(java.lang.String serverId,
                   java.lang.String ip,
                   java.lang.String mac,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Leases

Delete a single DHCP lease entry specified by ip and mac. The DHCP server matches the DHCP lease with the given ip address and the mac address. The matched lease entry will be deleted. If no lease matches, the request is ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

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

Specified by:

delete in interface Leases

Parameters:

serverId - (required)

ip - IPv4 or IPv6 address (required)

mac - MAC Address (required)

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String serverId,
                   java.lang.String ip,
                   java.lang.String mac,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Leases

Delete a single DHCP lease entry specified by ip and mac. The DHCP server matches the DHCP lease with the given ip address and the mac address. The matched lease entry will be deleted. If no lease matches, the request is ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

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

Specified by:

delete in interface Leases

Parameters:

serverId - (required)

ip - IPv4 or IPv6 address (required)

mac - MAC Address (required)

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

delete

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

Description copied from interface: Leases

Delete a single DHCP lease entry specified by ip and mac. The DHCP server matches the DHCP lease with the given ip address and the mac address. The matched lease entry will be deleted. If no lease matches, the request is ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

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

Specified by:

delete in interface Leases

Parameters:

serverId - (required)

ip - IPv4 or IPv6 address (required)

mac - MAC Address (required)

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

invocationConfig - Configuration for the method invocation.

list

public DhcpLeases list(java.lang.String serverId,
                       java.lang.String address,
                       java.lang.String poolId,
                       java.lang.String source)

Description copied from interface: Leases

Get specific leases of a given dhcp server. As a dhcp server could manage millions of leases, the API has to limit the number of the returned leases via two mutually-excluded request parameters, i.e. \"pool_id\" and \"address\". Either a \"pool_id\" or an \"address\" can be provided, but not both in a same call. If a \"pool_id\" is specified, the leases of the specific pool are returned. If an \"address\" is specified, only the lease(s) represented y this address is(are) returned. The \"address\" can be a single IP, an ip-range, or a mac address.

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

Specified by:

list in interface Leases

Parameters:

serverId - (required)

address - can be an ip address, or an ip range, or a mac address (optional)

poolId - The uuid of dhcp ip pool (optional)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.DhcpLeases

list

public DhcpLeases list(java.lang.String serverId,
                       java.lang.String address,
                       java.lang.String poolId,
                       java.lang.String source,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Leases

Get specific leases of a given dhcp server. As a dhcp server could manage millions of leases, the API has to limit the number of the returned leases via two mutually-excluded request parameters, i.e. \"pool_id\" and \"address\". Either a \"pool_id\" or an \"address\" can be provided, but not both in a same call. If a \"pool_id\" is specified, the leases of the specific pool are returned. If an \"address\" is specified, only the lease(s) represented y this address is(are) returned. The \"address\" can be a single IP, an ip-range, or a mac address.

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

Specified by:

list in interface Leases

Parameters:

serverId - (required)

address - can be an ip address, or an ip range, or a mac address (optional)

poolId - The uuid of dhcp ip pool (optional)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpLeases

list

public void list(java.lang.String serverId,
                 java.lang.String address,
                 java.lang.String poolId,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeases> asyncCallback)

Description copied from interface: Leases

Get specific leases of a given dhcp server. As a dhcp server could manage millions of leases, the API has to limit the number of the returned leases via two mutually-excluded request parameters, i.e. \"pool_id\" and \"address\". Either a \"pool_id\" or an \"address\" can be provided, but not both in a same call. If a \"pool_id\" is specified, the leases of the specific pool are returned. If an \"address\" is specified, only the lease(s) represented y this address is(are) returned. The \"address\" can be a single IP, an ip-range, or a mac address.

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

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

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

Specified by:

list in interface Leases

Parameters:

serverId - (required)

address - can be an ip address, or an ip range, or a mac address (optional)

poolId - The uuid of dhcp ip pool (optional)

source - Data source type. (optional)

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

list

public void list(java.lang.String serverId,
                 java.lang.String address,
                 java.lang.String poolId,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeases> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Leases

Get specific leases of a given dhcp server. As a dhcp server could manage millions of leases, the API has to limit the number of the returned leases via two mutually-excluded request parameters, i.e. \"pool_id\" and \"address\". Either a \"pool_id\" or an \"address\" can be provided, but not both in a same call. If a \"pool_id\" is specified, the leases of the specific pool are returned. If an \"address\" is specified, only the lease(s) represented y this address is(are) returned. The \"address\" can be a single IP, an ip-range, or a mac address.

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

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

Specified by:

list in interface Leases

Parameters:

serverId - (required)

address - can be an ip address, or an ip range, or a mac address (optional)

poolId - The uuid of dhcp ip pool (optional)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.