com.vmware.appliance

Interface Networking

All Superinterfaces:

NetworkingTypes, Service

All Known Implementing Classes:

NetworkingStub

public interface Networking
extends Service, NetworkingTypes

The Networking interface provides methods Get Network configurations. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.NetworkingTypes

NetworkingTypes._VAPI_OPERATIONS, NetworkingTypes.ChangeSpec, NetworkingTypes.DNSInfo, NetworkingTypes.Info, NetworkingTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.appliance.NetworkingTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	change_Task(NetworkingTypes.ChangeSpec spec) Changes the Hostname/IP of the management network of vCenter appliance.
void	change_Task(NetworkingTypes.ChangeSpec spec, AsyncCallback<java.lang.String> asyncCallback) Changes the Hostname/IP of the management network of vCenter appliance.
void	change_Task(NetworkingTypes.ChangeSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Changes the Hostname/IP of the management network of vCenter appliance.
java.lang.String	change_Task(NetworkingTypes.ChangeSpec spec, InvocationConfig invocationConfig) Changes the Hostname/IP of the management network of vCenter appliance.
NetworkingTypes.Info	get() Get Networking information for all configured interfaces.
void	get(AsyncCallback<NetworkingTypes.Info> asyncCallback) Get Networking information for all configured interfaces.
void	get(AsyncCallback<NetworkingTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get Networking information for all configured interfaces.
NetworkingTypes.Info	get(InvocationConfig invocationConfig) Get Networking information for all configured interfaces.
void	reset() Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
void	reset(AsyncCallback<java.lang.Void> asyncCallback) Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
void	reset(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
void	reset(InvocationConfig invocationConfig) Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
void	update(NetworkingTypes.UpdateSpec spec) Enable or Disable ipv6 on all interfaces.
void	update(NetworkingTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Enable or Disable ipv6 on all interfaces.
void	update(NetworkingTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Enable or Disable ipv6 on all interfaces.
void	update(NetworkingTypes.UpdateSpec spec, InvocationConfig invocationConfig) Enable or Disable ipv6 on all interfaces.

Method Detail

get

NetworkingTypes.Info get()

Get Networking information for all configured interfaces. This method was added in vSphere API 6.7.

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

Returns:

The Map of network configuration info for all interfaces.

Throws:

Error - Generic error.

get

NetworkingTypes.Info get(InvocationConfig invocationConfig)

Get Networking information for all configured interfaces. 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:

invocationConfig - Configuration for the method invocation.

Returns:

The Map of network configuration info for all interfaces.

Throws:

Error - Generic error.

get

void get(AsyncCallback<NetworkingTypes.Info> asyncCallback)

Get Networking information for all configured interfaces. This method was added in vSphere API 6.7.

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

Invocation Result:
The Map of network configuration info for all interfaces.

Operation Errors:
Error - Generic error.

Parameters:

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

get

void get(AsyncCallback<NetworkingTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get Networking information for all configured interfaces. 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.

Invocation Result:
The Map of network configuration info for all interfaces.

Operation Errors:
Error - Generic error.

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

void update(NetworkingTypes.UpdateSpec spec)

Enable or Disable ipv6 on all interfaces. 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:

spec - update spec with optional boolean value

Throws:

Error - Generic error.

update

void update(NetworkingTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Enable or Disable ipv6 on all interfaces. 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:

spec - update spec with optional boolean value

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error.

update

void update(NetworkingTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Enable or Disable ipv6 on all interfaces. 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:
Error - Generic error.

Parameters:

spec - update spec with optional boolean value

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

update

void update(NetworkingTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Enable or Disable ipv6 on all interfaces. 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:
Error - Generic error.

Parameters:

spec - update spec with optional boolean value

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

invocationConfig - Configuration for the method invocation.

reset

void 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.

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

Throws:

Error - Generic error.

reset

void reset(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.

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.

Throws:

Error - Generic error.

reset

void reset(AsyncCallback<java.lang.Void> asyncCallback)

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.

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

Operation Errors:
Error - Generic error.

Parameters:

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

reset

void reset(AsyncCallback<java.lang.Void> asyncCallback,
           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.

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:
Error - Generic error.

Parameters:

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

invocationConfig - Configuration for the method invocation.

change_Task

java.lang.String change_Task(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.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

spec - Information required to change the hostname.

Returns:

identifier for the task created by this API invocation

Throws:

Unsupported - if it's not embedded node

InvalidArgument - if passed arguments are invalid.

Unauthenticated - if the user is not authenticated.

NotAllowedInCurrentState - if another change task is in progress

change_Task

java.lang.String change_Task(NetworkingTypes.ChangeSpec spec,
                             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.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - Information required to change the hostname.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Unsupported - if it's not embedded node

InvalidArgument - if passed arguments are invalid.

Unauthenticated - if the user is not authenticated.

NotAllowedInCurrentState - if another change task is in progress

change_Task

void change_Task(NetworkingTypes.ChangeSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

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.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unsupported - if it's not embedded node
InvalidArgument - if passed arguments are invalid.
Unauthenticated - if the user is not authenticated.
NotAllowedInCurrentState - if another change task is in progress

Parameters:

spec - Information required to change the hostname.

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

change_Task

void change_Task(NetworkingTypes.ChangeSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback,
                 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.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unsupported - if it's not embedded node
InvalidArgument - if passed arguments are invalid.
Unauthenticated - if the user is not authenticated.
NotAllowedInCurrentState - if another change task is in progress

Parameters:

spec - Information required to change the hostname.

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

invocationConfig - Configuration for the method invocation.