com.vmware.nsx.dhcp.servers

Interface Leases

All Superinterfaces:

LeasesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

LeasesStub

public interface Leases
extends com.vmware.vapi.bindings.Service, LeasesTypes

Field Summary

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

_VAPI_SERVICE_ID, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

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) Deprecated.
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) Deprecated.
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) Deprecated.
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) Deprecated.

Method Detail

delete

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

Parameters:

serverId - (required)

ip - IPv4 or IPv6 address (required)

mac - MAC Address (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 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. 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.

Parameters:

serverId - (required)

ip - IPv4 or IPv6 address (required)

mac - MAC Address (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 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. 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

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

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

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

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

Deprecated.

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.

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

Throws:

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

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

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

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

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

list

@Deprecated
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)

Deprecated.

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.

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

Throws:

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

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

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

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

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

list

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

Deprecated.

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

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

@Deprecated
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)

Deprecated.

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

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.