com.vmware.nsx.pools

Interface IpPools

All Superinterfaces:

IpPoolsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

IpPoolsStub

public interface IpPools
extends com.vmware.vapi.bindings.Service, IpPoolsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.pools.IpPoolsTypes

_VAPI_SERVICE_ID, ALLOCATEORRELEASE_ACTION_ALLOCATE, ALLOCATEORRELEASE_ACTION_RELEASE

Method Summary

Modifier and Type	Method and Description
AllocationIpAddress	allocateorrelease(java.lang.String poolId, AllocationIpAddress allocationIpAddress, java.lang.String action) Allocates or releases an IP address from the specified IP pool.
void	allocateorrelease(java.lang.String poolId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback) Allocates or releases an IP address from the specified IP pool.
void	allocateorrelease(java.lang.String poolId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Allocates or releases an IP address from the specified IP pool.
AllocationIpAddress	allocateorrelease(java.lang.String poolId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Allocates or releases an IP address from the specified IP pool.
IpPool	create(IpPool ipPool) Creates a new IPv4 or IPv6 address pool.
void	create(IpPool ipPool, com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback) Creates a new IPv4 or IPv6 address pool.
void	create(IpPool ipPool, com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new IPv4 or IPv6 address pool.
IpPool	create(IpPool ipPool, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new IPv4 or IPv6 address pool.
void	delete(java.lang.String poolId, java.lang.Boolean force) Deletes the specified IP address pool.
void	delete(java.lang.String poolId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deletes the specified IP address pool.
void	delete(java.lang.String poolId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the specified IP address pool.
void	delete(java.lang.String poolId, java.lang.Boolean force, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the specified IP address pool.
IpPool	get(java.lang.String poolId) Returns information about the specified IP address pool.
void	get(java.lang.String poolId, com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback) Returns information about the specified IP address pool.
void	get(java.lang.String poolId, com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the specified IP address pool.
IpPool	get(java.lang.String poolId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the specified IP address pool.
IpPoolListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about the configured IP address pools.
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<IpPoolListResult> asyncCallback) Returns information about the configured IP address pools.
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<IpPoolListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the configured IP address pools.
IpPoolListResult	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) Returns information about the configured IP address pools.
IpPool	update(java.lang.String poolId, IpPool ipPool) Modifies the specified IP address pool.
void	update(java.lang.String poolId, IpPool ipPool, com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback) Modifies the specified IP address pool.
void	update(java.lang.String poolId, IpPool ipPool, com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies the specified IP address pool.
IpPool	update(java.lang.String poolId, IpPool ipPool, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies the specified IP address pool.

Method Detail

allocateorrelease

AllocationIpAddress allocateorrelease(java.lang.String poolId,
                                      AllocationIpAddress allocationIpAddress,
                                      java.lang.String action)

Allocates or releases an IP address from the specified IP pool. To allocate an address, include ?action=ALLOCATE in the request and \"allocation_id\":null in the request body. When the request is successful, the response is \"allocation_id\": \"\", where is an IP address from the specified pool. To release an IP address (return it back to the pool), include ?action=RELEASE in the request and \"allocation_id\": in the request body, where is the address to be released. When the request is successful, the response is NULL. Tags, display_name and description attributes are not supported for AllocationIpAddress in this release.

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

Parameters:

poolId - IP pool ID (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

Returns:

com.vmware.nsx.model.AllocationIpAddress

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

allocateorrelease

AllocationIpAddress allocateorrelease(java.lang.String poolId,
                                      AllocationIpAddress allocationIpAddress,
                                      java.lang.String action,
                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Allocates or releases an IP address from the specified IP pool. To allocate an address, include ?action=ALLOCATE in the request and \"allocation_id\":null in the request body. When the request is successful, the response is \"allocation_id\": \"\", where is an IP address from the specified pool. To release an IP address (return it back to the pool), include ?action=RELEASE in the request and \"allocation_id\": in the request body, where is the address to be released. When the request is successful, the response is NULL. Tags, display_name and description attributes are not supported for AllocationIpAddress in this release.

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:

poolId - IP pool ID (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.AllocationIpAddress

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

allocateorrelease

void allocateorrelease(java.lang.String poolId,
                       AllocationIpAddress allocationIpAddress,
                       java.lang.String action,
                       com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback)

Allocates or releases an IP address from the specified IP pool. To allocate an address, include ?action=ALLOCATE in the request and \"allocation_id\":null in the request body. When the request is successful, the response is \"allocation_id\": \"\", where is an IP address from the specified pool. To release an IP address (return it back to the pool), include ?action=RELEASE in the request and \"allocation_id\": in the request body, where is the address to be released. When the request is successful, the response is NULL. Tags, display_name and description attributes are not supported for AllocationIpAddress in this release.

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

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

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

Parameters:

poolId - IP pool ID (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

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

allocateorrelease

void allocateorrelease(java.lang.String poolId,
                       AllocationIpAddress allocationIpAddress,
                       java.lang.String action,
                       com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Allocates or releases an IP address from the specified IP pool. To allocate an address, include ?action=ALLOCATE in the request and \"allocation_id\":null in the request body. When the request is successful, the response is \"allocation_id\": \"\", where is an IP address from the specified pool. To release an IP address (return it back to the pool), include ?action=RELEASE in the request and \"allocation_id\": in the request body, where is the address to be released. When the request is successful, the response is NULL. Tags, display_name and description attributes are not supported for AllocationIpAddress in this release.

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

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

Parameters:

poolId - IP pool ID (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

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

invocationConfig - Configuration for the method invocation.

create

IpPool create(IpPool ipPool)

Creates a new IPv4 or IPv6 address pool. Required parameters are allocation_ranges and cidr. Optional parameters are display_name, description, dns_nameservers, dns_suffix, and gateway_ip.

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

Parameters:

ipPool - (required)

Returns:

com.vmware.nsx.model.IpPool

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

IpPool create(IpPool ipPool,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new IPv4 or IPv6 address pool. Required parameters are allocation_ranges and cidr. Optional parameters are display_name, description, dns_nameservers, dns_suffix, and gateway_ip.

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:

ipPool - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IpPool

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(IpPool ipPool,
            com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback)

Creates a new IPv4 or IPv6 address pool. Required parameters are allocation_ranges and cidr. Optional parameters are display_name, description, dns_nameservers, dns_suffix, and gateway_ip.

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

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

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

Parameters:

ipPool - (required)

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

create

void create(IpPool ipPool,
            com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new IPv4 or IPv6 address pool. Required parameters are allocation_ranges and cidr. Optional parameters are display_name, description, dns_nameservers, dns_suffix, and gateway_ip.

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

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

Parameters:

ipPool - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String poolId,
            java.lang.Boolean force)

Deletes the specified IP address pool. By default, if the IpPool is used in other configurations (such as transport node template), it won't be deleted. In such situations, pass \"force=true\" as query param to force delete the IpPool

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

Parameters:

poolId - IP pool ID (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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 poolId,
            java.lang.Boolean force,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deletes the specified IP address pool. By default, if the IpPool is used in other configurations (such as transport node template), it won't be deleted. In such situations, pass \"force=true\" as query param to force delete the IpPool

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:

poolId - IP pool ID (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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 poolId,
            java.lang.Boolean force,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deletes the specified IP address pool. By default, if the IpPool is used in other configurations (such as transport node template), it won't be deleted. In such situations, pass \"force=true\" as query param to force delete the IpPool

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:

poolId - IP pool ID (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

delete

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

Deletes the specified IP address pool. By default, if the IpPool is used in other configurations (such as transport node template), it won't be deleted. In such situations, pass \"force=true\" as query param to force delete the IpPool

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:

poolId - IP pool ID (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

IpPool get(java.lang.String poolId)

Returns information about the specified IP address pool.

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

Parameters:

poolId - IP pool ID (required)

Returns:

com.vmware.nsx.model.IpPool

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

IpPool get(java.lang.String poolId,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about the specified IP address pool.

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:

poolId - IP pool ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IpPool

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

Returns information about the specified IP address pool.

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

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

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

Parameters:

poolId - IP pool ID (required)

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

get

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

Returns information about the specified IP address pool.

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

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

Parameters:

poolId - IP pool ID (required)

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

invocationConfig - Configuration for the method invocation.

list

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

Returns information about the configured IP address pools. Information includes the display name and description of the pool and the details of each of the subnets in the pool, including the DNS servers, allocation ranges, gateway, and CIDR subnet address.

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

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

IpPoolListResult 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)

Returns information about the configured IP address pools. Information includes the display name and description of the pool and the details of each of the subnets in the pool, including the DNS servers, allocation ranges, gateway, and CIDR subnet 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:

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

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<IpPoolListResult> asyncCallback)

Returns information about the configured IP address pools. Information includes the display name and description of the pool and the details of each of the subnets in the pool, including the DNS servers, allocation ranges, gateway, and CIDR subnet address.

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

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

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<IpPoolListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about the configured IP address pools. Information includes the display name and description of the pool and the details of each of the subnets in the pool, including the DNS servers, allocation ranges, gateway, and CIDR subnet 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.IpPoolListResult

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.

update

IpPool update(java.lang.String poolId,
              IpPool ipPool)

Modifies the specified IP address pool. Modifiable parameters include the description, display_name, and all subnet information.

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

Parameters:

poolId - IP pool ID (required)

ipPool - (required)

Returns:

com.vmware.nsx.model.IpPool

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

IpPool update(java.lang.String poolId,
              IpPool ipPool,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Modifies the specified IP address pool. Modifiable parameters include the description, display_name, and all subnet information.

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:

poolId - IP pool ID (required)

ipPool - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IpPool

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 poolId,
            IpPool ipPool,
            com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback)

Modifies the specified IP address pool. Modifiable parameters include the description, display_name, and all subnet information.

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

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

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

Parameters:

poolId - IP pool ID (required)

ipPool - (required)

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

update

void update(java.lang.String poolId,
            IpPool ipPool,
            com.vmware.vapi.bindings.client.AsyncCallback<IpPool> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Modifies the specified IP address pool. Modifiable parameters include the description, display_name, and all subnet information.

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

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

Parameters:

poolId - IP pool ID (required)

ipPool - (required)

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

invocationConfig - Configuration for the method invocation.