com.vmware.appliance

Class NetworkingStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.NetworkingStub

All Implemented Interfaces:

Networking, NetworkingTypes, Service

public class NetworkingStub
extends com.vmware.vapi.internal.bindings.Stub
implements Networking

Remote stub implementation of the Networking API service.

WARNING: Internal class, subject to change in future versions.

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 class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.appliance.NetworkingTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
NetworkingStub(ApiProvider apiProvider, StubConfigurationBase config)
NetworkingStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NetworkingStub

public NetworkingStub(ApiProvider apiProvider,
                      com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                      StubConfigurationBase config)

NetworkingStub

public NetworkingStub(ApiProvider apiProvider,
                      StubConfigurationBase config)

Method Detail

get

public NetworkingTypes.Info get()

Description copied from interface: Networking

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.

Specified by:

get in interface Networking

Returns:

The Map of network configuration info for all interfaces.

get

public NetworkingTypes.Info get(InvocationConfig invocationConfig)

Description copied from interface: Networking

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.

Specified by:

get in interface Networking

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The Map of network configuration info for all interfaces.

get

public void get(AsyncCallback<NetworkingTypes.Info> asyncCallback)

Description copied from interface: Networking

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.

Specified by:

get in interface Networking

Parameters:

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

get

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

Description copied from interface: Networking

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.

Specified by:

get in interface Networking

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

public void update(NetworkingTypes.UpdateSpec spec)

Description copied from interface: Networking

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.

Specified by:

update in interface Networking

Parameters:

spec - update spec with optional boolean value

update

public void update(NetworkingTypes.UpdateSpec spec,
                   InvocationConfig invocationConfig)

Description copied from interface: Networking

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.

Specified by:

update in interface Networking

Parameters:

spec - update spec with optional boolean value

invocationConfig - Configuration for the method invocation.

update

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

Description copied from interface: Networking

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.

Specified by:

update in interface Networking

Parameters:

spec - update spec with optional boolean value

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

update

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

Description copied from interface: Networking

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.

Specified by:

update in interface Networking

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

public void reset()

Description copied from interface: Networking

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.

Specified by:

reset in interface Networking

reset

public void reset(InvocationConfig invocationConfig)

Description copied from interface: Networking

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.

Specified by:

reset in interface Networking

Parameters:

invocationConfig - Configuration for the method invocation.

reset

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

Description copied from interface: Networking

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.

Specified by:

reset in interface Networking

Parameters:

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

reset

public void reset(AsyncCallback<java.lang.Void> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Networking

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.

Specified by:

reset in interface Networking

Parameters:

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

invocationConfig - Configuration for the method invocation.

change_Task

public java.lang.String change_Task(NetworkingTypes.ChangeSpec spec)

Description copied from interface: Networking

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.

Specified by:

change_Task in interface Networking

Parameters:

spec - Information required to change the hostname.

Returns:

identifier for the task created by this API invocation

change_Task

public java.lang.String change_Task(NetworkingTypes.ChangeSpec spec,
                                    InvocationConfig invocationConfig)

Description copied from interface: Networking

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.

Specified by:

change_Task in interface Networking

Parameters:

spec - Information required to change the hostname.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

change_Task

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

Description copied from interface: Networking

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

Specified by:

change_Task in interface Networking

Parameters:

spec - Information required to change the hostname.

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

change_Task

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

Description copied from interface: Networking

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

Specified by:

change_Task in interface Networking

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.