com.vmware.appliance

Class NtpStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.NtpStub

All Implemented Interfaces:

Ntp, NtpTypes, Service

public class NtpStub
extends com.vmware.vapi.internal.bindings.Stub
implements Ntp

Remote stub implementation of the Ntp API service.

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

Nested Class Summary

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

NtpTypes.LocalizableMessage, NtpTypes.ServerStatus, NtpTypes.TestRunStatus

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	get() Get the NTP configuration status.
void	get(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Get the NTP configuration status.
void	get(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Get the NTP configuration status.
java.util.List<java.lang.String>	get(InvocationConfig invocationConfig) Get the NTP configuration status.
void	set(java.util.List<java.lang.String> servers) Set NTP servers.
void	set(java.util.List<java.lang.String> servers, AsyncCallback<java.lang.Void> asyncCallback) Set NTP servers.
void	set(java.util.List<java.lang.String> servers, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set NTP servers.
void	set(java.util.List<java.lang.String> servers, InvocationConfig invocationConfig) Set NTP servers.
java.util.List<NtpTypes.TestRunStatus>	test(java.util.List<java.lang.String> servers) Test the connection to a list of ntp servers.
void	test(java.util.List<java.lang.String> servers, AsyncCallback<java.util.List<NtpTypes.TestRunStatus>> asyncCallback) Test the connection to a list of ntp servers.
void	test(java.util.List<java.lang.String> servers, AsyncCallback<java.util.List<NtpTypes.TestRunStatus>> asyncCallback, InvocationConfig invocationConfig) Test the connection to a list of ntp servers.
java.util.List<NtpTypes.TestRunStatus>	test(java.util.List<java.lang.String> servers, InvocationConfig invocationConfig) Test the connection to a list of ntp servers.

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

NtpStub

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

NtpStub

public NtpStub(ApiProvider apiProvider,
       StubConfigurationBase config)

Method Detail

test

public java.util.List<NtpTypes.TestRunStatus> test(java.util.List<java.lang.String> servers)

Description copied from interface: Ntp

Test the connection to a list of ntp servers. 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:

test in interface Ntp

Parameters:

servers - List of host names or IP addresses of NTP servers.

Returns:

List of test run statuses.

test

public java.util.List<NtpTypes.TestRunStatus> test(java.util.List<java.lang.String> servers,
                                          InvocationConfig invocationConfig)

Description copied from interface: Ntp

Test the connection to a list of ntp servers. 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:

test in interface Ntp

Parameters:

servers - List of host names or IP addresses of NTP servers.

invocationConfig - Configuration for the method invocation.

Returns:

List of test run statuses.

test

public void test(java.util.List<java.lang.String> servers,
        AsyncCallback<java.util.List<NtpTypes.TestRunStatus>> asyncCallback)

Description copied from interface: Ntp

Test the connection to a list of ntp servers. 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:
List of test run statuses.

Operation Errors:
Error - Generic error

Specified by:

test in interface Ntp

Parameters:

servers - List of host names or IP addresses of NTP servers.

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

test

public void test(java.util.List<java.lang.String> servers,
        AsyncCallback<java.util.List<NtpTypes.TestRunStatus>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Ntp

Test the connection to a list of ntp servers. 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:
List of test run statuses.

Operation Errors:
Error - Generic error

Specified by:

test in interface Ntp

Parameters:

servers - List of host names or IP addresses of NTP servers.

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

invocationConfig - Configuration for the method invocation.

set

public void set(java.util.List<java.lang.String> servers)

Description copied from interface: Ntp

Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration. 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:

set in interface Ntp

Parameters:

servers - List of host names or ip addresses of ntp servers.

set

public void set(java.util.List<java.lang.String> servers,
       InvocationConfig invocationConfig)

Description copied from interface: Ntp

Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration. 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:

set in interface Ntp

Parameters:

servers - List of host names or ip addresses of ntp servers.

invocationConfig - Configuration for the method invocation.

set

public void set(java.util.List<java.lang.String> servers,
       AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Ntp

Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration. 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:

set in interface Ntp

Parameters:

servers - List of host names or ip addresses of ntp servers.

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

set

public void set(java.util.List<java.lang.String> servers,
       AsyncCallback<java.lang.Void> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Ntp

Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration. 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:

set in interface Ntp

Parameters:

servers - List of host names or ip addresses of ntp servers.

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

invocationConfig - Configuration for the method invocation.

get

public java.util.List<java.lang.String> get()

Description copied from interface: Ntp

Get the NTP configuration status. If you run the 'timesync.get' command, you can retrieve the current time synchronization method (NTP- or VMware Tools-based). The 'ntp' command always returns the NTP server information, even when the time synchronization mode is not set to NTP. If the time synchronization mode is not NTP-based, the NTP server status is displayed as down. 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 Ntp

Returns:

List of NTP servers.

get

public java.util.List<java.lang.String> get(InvocationConfig invocationConfig)

Description copied from interface: Ntp

Get the NTP configuration status. If you run the 'timesync.get' command, you can retrieve the current time synchronization method (NTP- or VMware Tools-based). The 'ntp' command always returns the NTP server information, even when the time synchronization mode is not set to NTP. If the time synchronization mode is not NTP-based, the NTP server status is displayed as down. 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 Ntp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

List of NTP servers.

get

public void get(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Description copied from interface: Ntp

Get the NTP configuration status. If you run the 'timesync.get' command, you can retrieve the current time synchronization method (NTP- or VMware Tools-based). The 'ntp' command always returns the NTP server information, even when the time synchronization mode is not set to NTP. If the time synchronization mode is not NTP-based, the NTP server status is displayed as down. 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:
List of NTP servers.

Operation Errors:
Error - Generic error

Specified by:

get in interface Ntp

Parameters:

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

get

public void get(AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Ntp

Get the NTP configuration status. If you run the 'timesync.get' command, you can retrieve the current time synchronization method (NTP- or VMware Tools-based). The 'ntp' command always returns the NTP server information, even when the time synchronization mode is not set to NTP. If the time synchronization mode is not NTP-based, the NTP server status is displayed as down. 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:
List of NTP servers.

Operation Errors:
Error - Generic error

Specified by:

get in interface Ntp

Parameters:

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

invocationConfig - Configuration for the method invocation.