com.vmware.appliance.networking.interfaces

Class Ipv4Stub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.networking.interfaces.Ipv4Stub

All Implemented Interfaces:

Ipv4, Ipv4Types, Service

public class Ipv4Stub
extends com.vmware.vapi.internal.bindings.Stub
implements Ipv4

Remote stub implementation of the Ipv4 API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.networking.interfaces.Ipv4Types

Ipv4Types.Config, Ipv4Types.Info, Ipv4Types.Mode

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.appliance.networking.interfaces.Ipv4Types

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
Ipv4Stub(ApiProvider apiProvider, StubConfigurationBase config)
Ipv4Stub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
Ipv4Types.Info	get(java.lang.String interfaceName) Get IPv4 network configuration for specific NIC.
void	get(java.lang.String interfaceName, AsyncCallback<Ipv4Types.Info> asyncCallback) Get IPv4 network configuration for specific NIC.
void	get(java.lang.String interfaceName, AsyncCallback<Ipv4Types.Info> asyncCallback, InvocationConfig invocationConfig) Get IPv4 network configuration for specific NIC.
Ipv4Types.Info	get(java.lang.String interfaceName, InvocationConfig invocationConfig) Get IPv4 network configuration for specific NIC.
void	set(java.lang.String interfaceName, Ipv4Types.Config config) Set IPv4 network configuration for specific network interface.
void	set(java.lang.String interfaceName, Ipv4Types.Config config, AsyncCallback<java.lang.Void> asyncCallback) Set IPv4 network configuration for specific network interface.
void	set(java.lang.String interfaceName, Ipv4Types.Config config, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set IPv4 network configuration for specific network interface.
void	set(java.lang.String interfaceName, Ipv4Types.Config config, InvocationConfig invocationConfig) Set IPv4 network configuration for specific network interface.

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

Ipv4Stub

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

Ipv4Stub

public Ipv4Stub(ApiProvider apiProvider,
                StubConfigurationBase config)

Method Detail

set

public void set(java.lang.String interfaceName,
                Ipv4Types.Config config)

Description copied from interface: Ipv4

Set IPv4 network configuration for specific network interface. This method was added in vSphere API 6.7.

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

Specified by:

set in interface Ipv4

Parameters:

interfaceName - Network interface to update, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

config - The IPv4 Network configuration to set.

set

public void set(java.lang.String interfaceName,
                Ipv4Types.Config config,
                InvocationConfig invocationConfig)

Description copied from interface: Ipv4

Set IPv4 network configuration for specific network interface. This method was added in vSphere API 6.7.

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:

set in interface Ipv4

Parameters:

interfaceName - Network interface to update, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

config - The IPv4 Network configuration to set.

invocationConfig - Configuration for the method invocation.

set

public void set(java.lang.String interfaceName,
                Ipv4Types.Config config,
                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Ipv4

Set IPv4 network configuration for specific network interface. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - if the specified NIC is not found.
NotAllowedInCurrentState - if the IP is used as PNID
ResourceBusy - if the specified NIC is busy.
Error - Generic error.

Specified by:

set in interface Ipv4

Parameters:

interfaceName - Network interface to update, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

config - The IPv4 Network configuration to set.

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

set

public void set(java.lang.String interfaceName,
                Ipv4Types.Config config,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Ipv4

Set IPv4 network configuration for specific network interface. This method was added in vSphere API 6.7.

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:
NotFound - if the specified NIC is not found.
NotAllowedInCurrentState - if the IP is used as PNID
ResourceBusy - if the specified NIC is busy.
Error - Generic error.

Specified by:

set in interface Ipv4

Parameters:

interfaceName - Network interface to update, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

config - The IPv4 Network configuration to set.

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

invocationConfig - Configuration for the method invocation.

get

public Ipv4Types.Info get(java.lang.String interfaceName)

Description copied from interface: Ipv4

Get IPv4 network configuration for specific NIC. This method was added in vSphere API 6.7.

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

Specified by:

get in interface Ipv4

Parameters:

interfaceName - The Network interface to query, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

Returns:

The IPv4 configuration for the queried NIC.

get

public Ipv4Types.Info get(java.lang.String interfaceName,
                          InvocationConfig invocationConfig)

Description copied from interface: Ipv4

Get IPv4 network configuration for specific NIC. This method was added in vSphere API 6.7.

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 Ipv4

Parameters:

interfaceName - The Network interface to query, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

invocationConfig - Configuration for the method invocation.

Returns:

The IPv4 configuration for the queried NIC.

get

public void get(java.lang.String interfaceName,
                AsyncCallback<Ipv4Types.Info> asyncCallback)

Description copied from interface: Ipv4

Get IPv4 network configuration for specific NIC. This method was added in vSphere API 6.7.

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

Invocation Result:
The IPv4 configuration for the queried NIC.

Operation Errors:
NotFound - if the specified NIC is not found.
Error - Generic error.

Specified by:

get in interface Ipv4

Parameters:

interfaceName - The Network interface to query, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

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

get

public void get(java.lang.String interfaceName,
                AsyncCallback<Ipv4Types.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Ipv4

Get IPv4 network configuration for specific NIC. This method was added in vSphere API 6.7.

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:
The IPv4 configuration for the queried NIC.

Operation Errors:
NotFound - if the specified NIC is not found.
Error - Generic error.

Specified by:

get in interface Ipv4

Parameters:

interfaceName - The Network interface to query, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

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

invocationConfig - Configuration for the method invocation.