vmware::appliance::networking::interfaces::Ipv4 Interface Reference

The Ipv4 interface provides methods to perform IPv4 network configuration for interfaces. More...

Inherited by vmware::appliance::networking::interfaces::Ipv4Stub.

List of all members.

Public Member Functions
void	Set (string interfaceName, vmware.appliance.networking.interfaces.Ipv4Types.Config config)
	Set IPv4 network configuration for specific network interface.
void	Set (string interfaceName, vmware.appliance.networking.interfaces.Ipv4Types.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Set IPv4 network configuration for specific network interface.
global::System.Threading.Tasks.Task	SetAsync (string interfaceName, vmware.appliance.networking.interfaces.Ipv4Types.Config config)
	Set IPv4 network configuration for specific network interface.
global::System.Threading.Tasks.Task	SetAsync (string interfaceName, vmware.appliance.networking.interfaces.Ipv4Types.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Set IPv4 network configuration for specific network interface.
vmware.appliance.networking.interfaces.Ipv4Types.Info	Get (string interfaceName)
	Get IPv4 network configuration for specific NIC.
vmware.appliance.networking.interfaces.Ipv4Types.Info	Get (string interfaceName, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get IPv4 network configuration for specific NIC.
global::System.Threading.Tasks.Task < vmware.appliance.networking.interfaces.Ipv4Types.Info >	GetAsync (string interfaceName)
	Get IPv4 network configuration for specific NIC.
global::System.Threading.Tasks.Task < vmware.appliance.networking.interfaces.Ipv4Types.Info >	GetAsync (string interfaceName, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get IPv4 network configuration for specific NIC.

---

Detailed Description

The Ipv4 interface provides methods to perform IPv4 network configuration for interfaces.

This interface was added in vSphere API 6.7.

---

Member Function Documentation

vmware.appliance.networking.interfaces.Ipv4Types.Info vmware::appliance::networking::interfaces::Ipv4::Get

(

string

interfaceName

)

Get IPv4 network configuration for specific NIC.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.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 .

Returns:

The IPv4 configuration for the queried NIC.

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

vmware.appliance.networking.interfaces.Ipv4Types.Info vmware::appliance::networking::interfaces::Ipv4::Get	(	string	interfaceName,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Get IPv4 network configuration for specific NIC.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The IPv4 configuration for the queried NIC.

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

global::System.Threading.Tasks.Task<vmware.appliance.networking.interfaces.Ipv4Types.Info> vmware::appliance::networking::interfaces::Ipv4::GetAsync	(	string	interfaceName,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Get IPv4 network configuration for specific NIC.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The IPv4 configuration for the queried NIC.

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

global::System.Threading.Tasks.Task<vmware.appliance.networking.interfaces.Ipv4Types.Info> vmware::appliance::networking::interfaces::Ipv4::GetAsync

(

string

interfaceName

)

Get IPv4 network configuration for specific NIC.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.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 .

Returns:

The IPv4 configuration for the queried NIC.

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

void vmware::appliance::networking::interfaces::Ipv4::Set	(	string	interfaceName,
		vmware.appliance.networking.interfaces.Ipv4Types.Config	config,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Set IPv4 network configuration for specific network interface.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the IP is used as PNID
vmware.vapi.std.errors.ResourceBusy	if the specified NIC is busy.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

void vmware::appliance::networking::interfaces::Ipv4::Set	(	string	interfaceName,
		vmware.appliance.networking.interfaces.Ipv4Types.Config	config
	)

Set IPv4 network configuration for specific network interface.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the IP is used as PNID
vmware.vapi.std.errors.ResourceBusy	if the specified NIC is busy.
vmware.vapi.std.errors.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.

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

global::System.Threading.Tasks.Task vmware::appliance::networking::interfaces::Ipv4::SetAsync	(	string	interfaceName,
		vmware.appliance.networking.interfaces.Ipv4Types.Config	config
	)

Set IPv4 network configuration for specific network interface.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the IP is used as PNID
vmware.vapi.std.errors.ResourceBusy	if the specified NIC is busy.
vmware.vapi.std.errors.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.

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

global::System.Threading.Tasks.Task vmware::appliance::networking::interfaces::Ipv4::SetAsync	(	string	interfaceName,
		vmware.appliance.networking.interfaces.Ipv4Types.Config	config,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Set IPv4 network configuration for specific network interface.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified NIC is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the IP is used as PNID
vmware.vapi.std.errors.ResourceBusy	if the specified NIC is busy.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::networking::interfaces::Ipv4Stub.

---

The documentation for this interface was generated from the following file:

• appliance/networking/interfaces/Ipv4.cs