com.vmware.appliance

Interface Ntp

All Superinterfaces:

NtpTypes, Service

All Known Implementing Classes:

NtpStub

public interface Ntp
extends Service, NtpTypes

Ntp interface provides methods Gets NTP configuration status and tests connection to ntp servers. This interface was added in vSphere API 6.7.

Nested Class Summary

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

NtpTypes.LocalizableMessage, NtpTypes.ServerStatus, NtpTypes.TestRunStatus

Field Summary

Fields inherited from interface com.vmware.appliance.NtpTypes

_VAPI_SERVICE_ID

Method Summary

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.

Method Detail

test

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

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.

Parameters:

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

Returns:

List of test run statuses.

Throws:

Error - Generic error

test

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

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

List of test run statuses.

Throws:

Error - Generic error

test

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. 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:
List of test run statuses.

Operation Errors:
Error - Generic error

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

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. 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:
List of test run statuses.

Operation Errors:
Error - Generic error

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

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

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.

Parameters:

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

Throws:

Error - Generic error

set

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

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

set

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

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

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

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

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

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

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

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.

Returns:

List of NTP servers.

Throws:

Error - Generic error

get

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

List of NTP servers.

Throws:

Error - Generic error

get

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

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.

Invocation Result:
List of NTP servers.

Operation Errors:
Error - Generic error

Parameters:

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

get

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

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.

Invocation Result:
List of NTP servers.

Operation Errors:
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.