com.vmware.appliance.networking

Interface Interfaces

All Superinterfaces:

InterfacesTypes, Service

All Known Implementing Classes:

InterfacesStub

public interface Interfaces
extends Service, InterfacesTypes

Interfaces interface provides methods Provides information about network interface.

Nested Class Summary

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

InterfacesTypes.InterfaceInfo, InterfacesTypes.InterfaceStatus

Field Summary

Fields inherited from interface com.vmware.appliance.networking.InterfacesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
InterfacesTypes.InterfaceInfo	get(java.lang.String interfaceName) Get information about a particular network interface.
void	get(java.lang.String interfaceName, AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback) Get information about a particular network interface.
void	get(java.lang.String interfaceName, AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback, InvocationConfig invocationConfig) Get information about a particular network interface.
InterfacesTypes.InterfaceInfo	get(java.lang.String interfaceName, InvocationConfig invocationConfig) Get information about a particular network interface.
java.util.List<InterfacesTypes.InterfaceInfo>	list() Get list of available network interfaces, including those that are not yet configured.
void	list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback) Get list of available network interfaces, including those that are not yet configured.
void	list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback, InvocationConfig invocationConfig) Get list of available network interfaces, including those that are not yet configured.
java.util.List<InterfacesTypes.InterfaceInfo>	list(InvocationConfig invocationConfig) Get list of available network interfaces, including those that are not yet configured.

Method Detail

list

java.util.List<InterfacesTypes.InterfaceInfo> list()

Get list of available network interfaces, including those that are not yet configured.

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

Returns:

List of InterfaceInfo structures.

Throws:

Error - Generic error

list

java.util.List<InterfacesTypes.InterfaceInfo> list(InvocationConfig invocationConfig)

Get list of available network interfaces, including those that are not yet 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:

List of InterfaceInfo structures.

Throws:

Error - Generic error

list

void list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback)

Get list of available network interfaces, including those that are not yet configured.

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

Invocation Result:
List of InterfaceInfo structures.

Operation Errors:
Error - Generic error

Parameters:

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

list

void list(AsyncCallback<java.util.List<InterfacesTypes.InterfaceInfo>> asyncCallback,
          InvocationConfig invocationConfig)

Get list of available network interfaces, including those that are not yet 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:
List of InterfaceInfo structures.

Operation Errors:
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

InterfacesTypes.InterfaceInfo get(java.lang.String interfaceName)

Get information about a particular network interface.

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

Parameters:

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

Returns:

Network interface information.

Throws:

NotFound - if the specified interface is not found.

Error - Generic error

get

InterfacesTypes.InterfaceInfo get(java.lang.String interfaceName,
                                  InvocationConfig invocationConfig)

Get information about a particular network interface.

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:

interfaceName - Network interface, 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:

Network interface information.

Throws:

NotFound - if the specified interface is not found.

Error - Generic error

get

void get(java.lang.String interfaceName,
         AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback)

Get information about a particular network interface.

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

Invocation Result:
Network interface information.

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

Parameters:

interfaceName - Network interface, 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

void get(java.lang.String interfaceName,
         AsyncCallback<InterfacesTypes.InterfaceInfo> asyncCallback,
         InvocationConfig invocationConfig)

Get information about a particular network interface.

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:
Network interface information.

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

Parameters:

interfaceName - Network interface, 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.