com.vmware.vcenter.vm.guest.networking

Interface Interfaces

All Superinterfaces:

InterfacesTypes, Service

All Known Implementing Classes:

InterfacesStub

public interface Interfaces
extends Service, InterfacesTypes

The Interfaces interface provides methods for retrieving guest operating system network interface information. This interface was added in vSphere API 7.0.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.guest.networking.InterfacesTypes

InterfacesTypes.Info, InterfacesTypes.IpAddressInfo, InterfacesTypes.IpAddressOrigin, InterfacesTypes.IpAddressStatus, InterfacesTypes.IpConfigInfo

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.guest.networking.InterfacesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.List<InterfacesTypes.Info>	list(java.lang.String vm) Returns information about the networking interfaces in the guest operating system.
void	list(java.lang.String vm, AsyncCallback<java.util.List<InterfacesTypes.Info>> asyncCallback) Returns information about the networking interfaces in the guest operating system.
void	list(java.lang.String vm, AsyncCallback<java.util.List<InterfacesTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns information about the networking interfaces in the guest operating system.
java.util.List<InterfacesTypes.Info>	list(java.lang.String vm, InvocationConfig invocationConfig) Returns information about the networking interfaces in the guest operating system.

Method Detail

list

java.util.List<InterfacesTypes.Info> list(java.lang.String vm)

Returns information about the networking interfaces in the guest operating system. This method was added in vSphere API 7.0.0.0.

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

Parameters:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

Information about the interfaces configured in the guest operating system. Interfaces are ordered in a guest operating system specific determined order.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if VMware Tools is not running.

list

java.util.List<InterfacesTypes.Info> list(java.lang.String vm,
                                          InvocationConfig invocationConfig)

Returns information about the networking interfaces in the guest operating system. This method was added in vSphere API 7.0.0.0.

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:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the interfaces configured in the guest operating system. Interfaces are ordered in a guest operating system specific determined order.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if VMware Tools is not running.

list

void list(java.lang.String vm,
          AsyncCallback<java.util.List<InterfacesTypes.Info>> asyncCallback)

Returns information about the networking interfaces in the guest operating system. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
Information about the interfaces configured in the guest operating system. Interfaces are ordered in a guest operating system specific determined order.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if VMware Tools is not running.

Parameters:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

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

list

void list(java.lang.String vm,
          AsyncCallback<java.util.List<InterfacesTypes.Info>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about the networking interfaces in the guest operating system. This method was added in vSphere API 7.0.0.0.

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:
Information about the interfaces configured in the guest operating system. Interfaces are ordered in a guest operating system specific determined order.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if VMware Tools is not running.

Parameters:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.