Package com.vmware.nsx_policy.global_infra.dhcp_server_configs

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_policy.global_infra.dhcp_server_configs.LeasesTypes

_VAPI_SERVICE_ID, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Method Summary

Modifier and Type	Method	Description
DhcpLeasesResult	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source)	Read DHCP server leases
void	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback)	Read DHCP server leases
void	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read DHCP server leases
DhcpLeasesResult	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read DHCP server leases

Method Detail

list

DhcpLeasesResult list(java.lang.String configId,
                      java.lang.String connectivityPath,
                      java.lang.String address,
                      java.lang.String cursor,
                      java.lang.String enforcementPointPath,
                      java.lang.Boolean includeMarkForDeleteObjects,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.String segmentPath,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String source)

Read DHCP server leases

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

Parameters:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

Returns:

com.vmware.nsx_policy.model.DhcpLeasesResult

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

DhcpLeasesResult list(java.lang.String configId,
                      java.lang.String connectivityPath,
                      java.lang.String address,
                      java.lang.String cursor,
                      java.lang.String enforcementPointPath,
                      java.lang.Boolean includeMarkForDeleteObjects,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.String segmentPath,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String source,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read DHCP server leases

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:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.DhcpLeasesResult

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 configId,
          java.lang.String connectivityPath,
          java.lang.String address,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String segmentPath,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback)

Read DHCP server leases

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

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

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

Parameters:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

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

list

void list(java.lang.String configId,
          java.lang.String connectivityPath,
          java.lang.String address,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String segmentPath,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read DHCP server leases

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

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

Parameters:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.