VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::appliance::Networking Interface Reference

The Networking interface provides methods Get Network configurations. More...

Inherited by vmware::appliance::NetworkingStub.

List of all members.

Public Member Functions

vmware.appliance.NetworkingTypes.Info Get ()
 Get Networking information for all configured interfaces.
vmware.appliance.NetworkingTypes.Info Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get Networking information for all configured interfaces.
global::System.Threading.Tasks.Task
< vmware.appliance.NetworkingTypes.Info
GetAsync ()
 Get Networking information for all configured interfaces.
global::System.Threading.Tasks.Task
< vmware.appliance.NetworkingTypes.Info
GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get Networking information for all configured interfaces.
void Update (vmware.appliance.NetworkingTypes.UpdateSpec spec)
 Enable or Disable ipv6 on all interfaces.
void Update (vmware.appliance.NetworkingTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Enable or Disable ipv6 on all interfaces.
global::System.Threading.Tasks.Task UpdateAsync (vmware.appliance.NetworkingTypes.UpdateSpec spec)
 Enable or Disable ipv6 on all interfaces.
global::System.Threading.Tasks.Task UpdateAsync (vmware.appliance.NetworkingTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Enable or Disable ipv6 on all interfaces.
void Reset ()
 Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
void Reset (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
global::System.Threading.Tasks.Task ResetAsync ()
 Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
global::System.Threading.Tasks.Task ResetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
string Change_Task (vmware.appliance.NetworkingTypes.ChangeSpec spec)
 Changes the Hostname/IP of the management network of vCenter appliance.
string Change_Task (vmware.appliance.NetworkingTypes.ChangeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Changes the Hostname/IP of the management network of vCenter appliance.

Detailed Description

The Networking interface provides methods Get Network configurations.

This interface was added in vSphere API 6.7.


Member Function Documentation

string vmware::appliance::Networking::Change_Task ( vmware.appliance.NetworkingTypes.ChangeSpec  spec)

Changes the Hostname/IP of the management network of vCenter appliance.

The Hostname/IP change invokes the PNID change process which involves LDAP entry modification, updating registry entries, configuration files modification and network configuration changes. vCenter server is expected to be down for few minutes during these changes. This method was added in vSphere API 6.7.3.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:
vmware.vapi.std.errors.Unsupportedif it's not embedded node
vmware.vapi.std.errors.InvalidArgumentif passed arguments are invalid.
vmware.vapi.std.errors.Unauthenticatedif the user is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentStateif another change task is in progress
Parameters:
specInformation required to change the hostname.

Implemented in vmware::appliance::NetworkingStub.

string vmware::appliance::Networking::Change_Task ( vmware.appliance.NetworkingTypes.ChangeSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Changes the Hostname/IP of the management network of vCenter appliance.

The Hostname/IP change invokes the PNID change process which involves LDAP entry modification, updating registry entries, configuration files modification and network configuration changes. vCenter server is expected to be down for few minutes during these changes. This method was added in vSphere API 6.7.3.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:
vmware.vapi.std.errors.Unsupportedif it's not embedded node
vmware.vapi.std.errors.InvalidArgumentif passed arguments are invalid.
vmware.vapi.std.errors.Unauthenticatedif the user is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentStateif another change task is in progress
Parameters:
specInformation required to change the hostname.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::NetworkingStub.

vmware.appliance.NetworkingTypes.Info vmware::appliance::Networking::Get ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get Networking information for all configured interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
The Map of network configuration info for all interfaces.

Implemented in vmware::appliance::NetworkingStub.

vmware.appliance.NetworkingTypes.Info vmware::appliance::Networking::Get ( )

Get Networking information for all configured interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
The Map of network configuration info for all interfaces.

Implemented in vmware::appliance::NetworkingStub.

global::System.Threading.Tasks.Task<vmware.appliance.NetworkingTypes.Info> vmware::appliance::Networking::GetAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get Networking information for all configured interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
The Map of network configuration info for all interfaces.

Implemented in vmware::appliance::NetworkingStub.

global::System.Threading.Tasks.Task<vmware.appliance.NetworkingTypes.Info> vmware::appliance::Networking::GetAsync ( )

Get Networking information for all configured interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
The Map of network configuration info for all interfaces.

Implemented in vmware::appliance::NetworkingStub.

void vmware::appliance::Networking::Reset ( )

Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.

Implemented in vmware::appliance::NetworkingStub.

void vmware::appliance::Networking::Reset ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.

Implemented in vmware::appliance::NetworkingStub.

global::System.Threading.Tasks.Task vmware::appliance::Networking::ResetAsync ( )

Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.

Implemented in vmware::appliance::NetworkingStub.

global::System.Threading.Tasks.Task vmware::appliance::Networking::ResetAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.

Implemented in vmware::appliance::NetworkingStub.

void vmware::appliance::Networking::Update ( vmware.appliance.NetworkingTypes.UpdateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Enable or Disable ipv6 on all interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
specupdate spec with optional boolean value
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::NetworkingStub.

void vmware::appliance::Networking::Update ( vmware.appliance.NetworkingTypes.UpdateSpec  spec)

Enable or Disable ipv6 on all interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
specupdate spec with optional boolean value

Implemented in vmware::appliance::NetworkingStub.

global::System.Threading.Tasks.Task vmware::appliance::Networking::UpdateAsync ( vmware.appliance.NetworkingTypes.UpdateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Enable or Disable ipv6 on all interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
specupdate spec with optional boolean value
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::NetworkingStub.

global::System.Threading.Tasks.Task vmware::appliance::Networking::UpdateAsync ( vmware.appliance.NetworkingTypes.UpdateSpec  spec)

Enable or Disable ipv6 on all interfaces.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
specupdate spec with optional boolean value

Implemented in vmware::appliance::NetworkingStub.


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