com.vmware.nsx.pools

Interface IpSubnets

All Superinterfaces:

IpSubnetsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

IpSubnetsStub

public interface IpSubnets
extends com.vmware.vapi.bindings.Service, IpSubnetsTypes

Field Summary

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

_VAPI_SERVICE_ID, ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_ALLOCATE, ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_RELEASE

Method Summary

Modifier and Type	Method and Description
AllocationIpAddress	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action) Deprecated.
void	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback) Deprecated.
void	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
AllocationIpAddress	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
IpBlockSubnet	create(IpBlockSubnet ipBlockSubnet) Deprecated.
void	create(IpBlockSubnet ipBlockSubnet, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback) Deprecated.
void	create(IpBlockSubnet ipBlockSubnet, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
IpBlockSubnet	create(IpBlockSubnet ipBlockSubnet, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String subnetId) Deprecated.
void	delete(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String subnetId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
IpBlockSubnet	get(java.lang.String subnetId) Deprecated.
void	get(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback) Deprecated.
void	get(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
IpBlockSubnet	get(java.lang.String subnetId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
IpBlockSubnetListResult	list(java.lang.String blockId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all subnets present within an IP address block.
void	list(java.lang.String blockId, 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<IpBlockSubnetListResult> asyncCallback) Returns information about all subnets present within an IP address block.
void	list(java.lang.String blockId, 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<IpBlockSubnetListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all subnets present within an IP address block.
IpBlockSubnetListResult	list(java.lang.String blockId, 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 all subnets present within an IP address block.

Method Detail

allocateorreleasefromipblocksubnet

@Deprecated
AllocationIpAddress allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                                                   AllocationIpAddress allocationIpAddress,
                                                                   java.lang.String action)

Deprecated.

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

Parameters:

subnetId - IP subnet 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

allocateorreleasefromipblocksubnet

@Deprecated
AllocationIpAddress allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                                                   AllocationIpAddress allocationIpAddress,
                                                                   java.lang.String action,
                                                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

subnetId - IP subnet 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

allocateorreleasefromipblocksubnet

@Deprecated
void allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                                    AllocationIpAddress allocationIpAddress,
                                                    java.lang.String action,
                                                    com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback)

Deprecated.

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:

subnetId - IP subnet id (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

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

allocateorreleasefromipblocksubnet

@Deprecated
void allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                                    AllocationIpAddress allocationIpAddress,
                                                    java.lang.String action,
                                                    com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback,
                                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

subnetId - IP subnet 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

@Deprecated
IpBlockSubnet create(IpBlockSubnet ipBlockSubnet)

Deprecated.

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

Parameters:

ipBlockSubnet - (required)

Returns:

com.vmware.nsx.model.IpBlockSubnet

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

create

@Deprecated
IpBlockSubnet create(IpBlockSubnet ipBlockSubnet,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

ipBlockSubnet - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IpBlockSubnet

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

create

@Deprecated
void create(IpBlockSubnet ipBlockSubnet,
                        com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback)

Deprecated.

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

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

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

Parameters:

ipBlockSubnet - (required)

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

create

@Deprecated
void create(IpBlockSubnet ipBlockSubnet,
                        com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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

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

Parameters:

ipBlockSubnet - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String subnetId)

Deprecated.

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

Parameters:

subnetId - Subnet id (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

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

Deprecated.

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:

subnetId - Subnet id (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

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

Deprecated.

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:

subnetId - Subnet id (required)

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

delete

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

Deprecated.

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:

subnetId - Subnet id (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
IpBlockSubnet get(java.lang.String subnetId)

Deprecated.

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

Parameters:

subnetId - Subnet id (required)

Returns:

com.vmware.nsx.model.IpBlockSubnet

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

@Deprecated
IpBlockSubnet get(java.lang.String subnetId,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

subnetId - Subnet id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IpBlockSubnet

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

@Deprecated
void get(java.lang.String subnetId,
                     com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback)

Deprecated.

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

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

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

Parameters:

subnetId - Subnet id (required)

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

get

@Deprecated
void get(java.lang.String subnetId,
                     com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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

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

Parameters:

subnetId - Subnet id (required)

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

invocationConfig - Configuration for the method invocation.

list

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

Returns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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

Parameters:

blockId - (optional)

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

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

IpBlockSubnetListResult list(java.lang.String blockId,
                             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 all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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:

blockId - (optional)

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

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 blockId,
          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<IpBlockSubnetListResult> asyncCallback)

Returns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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

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

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

Parameters:

blockId - (optional)

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

Returns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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

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

Parameters:

blockId - (optional)

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.