com.vmware.appliance.networking.interfaces

Interface Ipv4

All Superinterfaces:

Ipv4Types, Service

All Known Implementing Classes:

Ipv4Stub

public interface Ipv4
extends Service, Ipv4Types

The Ipv4 interface provides methods to perform IPv4 network configuration for interfaces. This interface was added in vSphere API 6.7.

Nested Class Summary

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

Ipv4Types.Config, Ipv4Types.Info, Ipv4Types.Mode

Method Summary

Methods

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.

Method Detail

set

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

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.

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.

Throws:

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.

set

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

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.

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.

Throws:

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.

set

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

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.

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

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

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.

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

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

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.

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.

Throws:

NotFound - if the specified NIC is not found.

Error - Generic error.

get

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

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.

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.

Throws:

NotFound - if the specified NIC is not found.

Error - Generic error.

get

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

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.

Operation Result:
The IPv4 configuration for the queried NIC.

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

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

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

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.

Operation Result:
The IPv4 configuration for the queried NIC.

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

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.