com.vmware.nsx.cluster

Class ApiVirtualIpStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.cluster.ApiVirtualIpStub

All Implemented Interfaces:

ApiVirtualIp, ApiVirtualIpTypes, com.vmware.vapi.bindings.Service

public class ApiVirtualIpStub
extends com.vmware.vapi.internal.bindings.Stub
implements ApiVirtualIp

Remote stub implementation of the ApiVirtualIp 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.cluster.ApiVirtualIpTypes

_VAPI_SERVICE_ID, SETVIRTUALIP_FORCE_FALSE, SETVIRTUALIP_FORCE_TRUE

Constructor Summary

Constructors

Constructor and Description
ApiVirtualIpStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
ApiVirtualIpStub(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
ClusterVirtualIpProperties	clearvirtualip() Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
void	clearvirtualip(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback) Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
void	clearvirtualip(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
ClusterVirtualIpProperties	clearvirtualip(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
ClusterVirtualIpProperties	clearvirtualip6() Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
void	clearvirtualip6(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback) Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
void	clearvirtualip6(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
ClusterVirtualIpProperties	clearvirtualip6(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.
ClusterVirtualIpProperties	get() Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback) Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.
ClusterVirtualIpProperties	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.
ClusterVirtualIpProperties	setvirtualip(java.lang.String force, java.lang.String ip6Address, java.lang.String ipAddress) Sets the cluster virtual IPv4 and IPv6 address.
void	setvirtualip(java.lang.String force, java.lang.String ip6Address, java.lang.String ipAddress, com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback) Sets the cluster virtual IPv4 and IPv6 address.
void	setvirtualip(java.lang.String force, java.lang.String ip6Address, java.lang.String ipAddress, com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Sets the cluster virtual IPv4 and IPv6 address.
ClusterVirtualIpProperties	setvirtualip(java.lang.String force, java.lang.String ip6Address, java.lang.String ipAddress, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Sets the cluster virtual IPv4 and IPv6 address.

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

ApiVirtualIpStub

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

ApiVirtualIpStub

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

Method Detail

clearvirtualip

public ClusterVirtualIpProperties clearvirtualip()

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.

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

Specified by:

clearvirtualip in interface ApiVirtualIp

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

clearvirtualip

public ClusterVirtualIpProperties clearvirtualip(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 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:

clearvirtualip in interface ApiVirtualIp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

clearvirtualip

public void clearvirtualip(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback)

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.

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

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

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

Specified by:

clearvirtualip in interface ApiVirtualIp

Parameters:

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

clearvirtualip

public void clearvirtualip(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 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.ClusterVirtualIpProperties

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

Specified by:

clearvirtualip in interface ApiVirtualIp

Parameters:

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

invocationConfig - Configuration for the method invocation.

clearvirtualip6

public ClusterVirtualIpProperties clearvirtualip6()

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.

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

Specified by:

clearvirtualip6 in interface ApiVirtualIp

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

clearvirtualip6

public ClusterVirtualIpProperties clearvirtualip6(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 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:

clearvirtualip6 in interface ApiVirtualIp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

clearvirtualip6

public void clearvirtualip6(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback)

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.

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

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

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

Specified by:

clearvirtualip6 in interface ApiVirtualIp

Parameters:

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

clearvirtualip6

public void clearvirtualip6(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 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.ClusterVirtualIpProperties

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

Specified by:

clearvirtualip6 in interface ApiVirtualIp

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

public ClusterVirtualIpProperties get()

Description copied from interface: ApiVirtualIp

Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.

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

Specified by:

get in interface ApiVirtualIp

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

get

public ClusterVirtualIpProperties get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.

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:

get in interface ApiVirtualIp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

get

public void get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback)

Description copied from interface: ApiVirtualIp

Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.

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

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

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

Specified by:

get in interface ApiVirtualIp

Parameters:

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

get

public void get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.

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

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

Specified by:

get in interface ApiVirtualIp

Parameters:

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

invocationConfig - Configuration for the method invocation.

setvirtualip

public ClusterVirtualIpProperties setvirtualip(java.lang.String force,
                                               java.lang.String ip6Address,
                                               java.lang.String ipAddress)

Description copied from interface: ApiVirtualIp

Sets the cluster virtual IPv4 and IPv6 address. Note, all nodes in the management cluster must be in the same subnet. If not, a 409 CONFLICT status is returned.
Query parameter ip_address sets virtual IPv4 address and ip6_address sets virtual IPv6 address; either or both of the parameters can be specified to set virtual IP address(es).
When updating either of any one parameter value this does not changes the value of other unspecified parameter.

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

Specified by:

setvirtualip in interface ApiVirtualIp

Parameters:

force - On enable it ignores duplicate address detection and DNS lookup validation check (optional, default to false)

ip6Address - Virtual IPv6 address, :: if not configured (optional)

ipAddress - Virtual IP address, 0.0.0.0 if not configured (optional)

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

setvirtualip

public ClusterVirtualIpProperties setvirtualip(java.lang.String force,
                                               java.lang.String ip6Address,
                                               java.lang.String ipAddress,
                                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Sets the cluster virtual IPv4 and IPv6 address. Note, all nodes in the management cluster must be in the same subnet. If not, a 409 CONFLICT status is returned.
Query parameter ip_address sets virtual IPv4 address and ip6_address sets virtual IPv6 address; either or both of the parameters can be specified to set virtual IP address(es).
When updating either of any one parameter value this does not changes the value of other unspecified parameter.

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:

setvirtualip in interface ApiVirtualIp

Parameters:

force - On enable it ignores duplicate address detection and DNS lookup validation check (optional, default to false)

ip6Address - Virtual IPv6 address, :: if not configured (optional)

ipAddress - Virtual IP address, 0.0.0.0 if not configured (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

setvirtualip

public void setvirtualip(java.lang.String force,
                         java.lang.String ip6Address,
                         java.lang.String ipAddress,
                         com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback)

Description copied from interface: ApiVirtualIp

Sets the cluster virtual IPv4 and IPv6 address. Note, all nodes in the management cluster must be in the same subnet. If not, a 409 CONFLICT status is returned.
Query parameter ip_address sets virtual IPv4 address and ip6_address sets virtual IPv6 address; either or both of the parameters can be specified to set virtual IP address(es).
When updating either of any one parameter value this does not changes the value of other unspecified parameter.

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

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

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

Specified by:

setvirtualip in interface ApiVirtualIp

Parameters:

force - On enable it ignores duplicate address detection and DNS lookup validation check (optional, default to false)

ip6Address - Virtual IPv6 address, :: if not configured (optional)

ipAddress - Virtual IP address, 0.0.0.0 if not configured (optional)

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

setvirtualip

public void setvirtualip(java.lang.String force,
                         java.lang.String ip6Address,
                         java.lang.String ipAddress,
                         com.vmware.vapi.bindings.client.AsyncCallback<ClusterVirtualIpProperties> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ApiVirtualIp

Sets the cluster virtual IPv4 and IPv6 address. Note, all nodes in the management cluster must be in the same subnet. If not, a 409 CONFLICT status is returned.
Query parameter ip_address sets virtual IPv4 address and ip6_address sets virtual IPv6 address; either or both of the parameters can be specified to set virtual IP address(es).
When updating either of any one parameter value this does not changes the value of other unspecified parameter.

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

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

Specified by:

setvirtualip in interface ApiVirtualIp

Parameters:

force - On enable it ignores duplicate address detection and DNS lookup validation check (optional, default to false)

ip6Address - Virtual IPv6 address, :: if not configured (optional)

ipAddress - Virtual IP address, 0.0.0.0 if not configured (optional)

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

invocationConfig - Configuration for the method invocation.