com.vmware.nsx.cluster

Interface ApiVirtualIp

All Superinterfaces:

ApiVirtualIpTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ApiVirtualIpStub

public interface ApiVirtualIp
extends com.vmware.vapi.bindings.Service, ApiVirtualIpTypes

Field Summary

Fields inherited from interface com.vmware.nsx.cluster.ApiVirtualIpTypes

_VAPI_SERVICE_ID, SETVIRTUALIP_FORCE_FALSE, SETVIRTUALIP_FORCE_TRUE

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.

Method Detail

clearvirtualip

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.

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

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

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

clearvirtualip

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.

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:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

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

clearvirtualip

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.

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

Parameters:

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

clearvirtualip

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.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

clearvirtualip6

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.

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

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

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

clearvirtualip6

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.

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:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

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

clearvirtualip6

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.

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

Parameters:

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

clearvirtualip6

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.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

ClusterVirtualIpProperties get()

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.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

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

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterVirtualIpProperties

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

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

Parameters:

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

get

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.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

setvirtualip

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

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.

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

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

setvirtualip

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

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

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

setvirtualip

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

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

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

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.