Configuration of ntp-client

YaST2 Developers Documentation: Configuration of ntp-client |

functions files intro |  |
# Configuration of ntp-client | `modules/NtpClient.ycp`
Data for configuration of ntp-client, input and output functions.
Jiri Srain <jsrain@suse.cz>
Representation of the configuration of ntp-client. Input and output routines. # Imports Directory Message Mode NetworkDevices PackageSystem Progress Report SLP Service SuSEFirewall Summary # Global Variables config_dhcp firewall_services modified ntp_records original_config_dhcp required_packages run_chroot run_service selected_index selected_record write_only # Global Functions AutoPackages () DetectNtpServers (symbol method) Export () GetCountryNames () GetNtpServers () Import (map settings) Read () Summary () TestNtpServer (string server, boolean silent) Write () deleteSyncRecord (integer index) findSyncRecord (string type, string address) getSyncRecords () selectSyncRecord (integer index) storeSyncRecord () # Local Variables country_names ntp_servers # Local Functions Abort ()
Info:
Abort function return boolean return true if abort
`global modified -> boolean`
Data was modified?
`global write_only -> boolean`
Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.
`global ntp_records -> list<map<string, any> >`
  Read all ntp-client settings Return value:
  | true on success
`global run_service -> boolean`
Should the daemon be started when system boots?
`global run_chroot -> boolean`
Should the daemon be started in chroot environment?
`global config_dhcp -> boolean`
NTP servers will be configured via DHCP
`global original_config_dhcp -> boolean`
NTP servers will be configured via DHCP - value got while reading
`global selected_index -> integer`
Index of the currently sellected item
`global selected_record -> map<string,any>`
The currently sellected item
`global required_packages -> list`
Required packages
`global firewall_services -> list<string>`
ports in firewall to open
`local ntp_servers -> map<string,map<string,string> >`
List of known NTP servers server -> information
`local country_names -> map<string,string>`
Mapping between country codes and country names ("CZ" -> "Czech Republic")
`local Abort () -> boolean`
  Abort function Return value:
  | blah blah lahjk
`global GetNtpServers () -> map<string, map<string,string> >`
  Get the list of known NTP servers Return value:
  | a list of known NTP servers
`global GetCountryNames () -> map<string, string>`
  Get the mapping between country codea and names ("CZ" -> "Czech Republic") Return value:
  | a map the country codes and names mapping
`global Read () -> boolean`
  Read all ntp-client settings Return value:
  | true on success
`global Write () -> boolean`
  Write all ntp-client settings Return value:
  | true on success
`global Import (map settings) -> boolean`
  Get all ntp-client settings from the first parameter (For use by autoinstallation.) Parameters:
  settings | The YCP structure to be imported.
  Return value:
  | True on success
`global Export () -> map`
  Dump the ntp-client settings to a single map (For use by autoinstallation.) Return value:
  | Dumped settings (later acceptable by Import ())
`global Summary () -> string`
  Create a textual summary and a list of unconfigured cards Return value:
  | summary of the current configuration
`global TestNtpServer (string server, boolean silent) -> boolean`
  Test if specified NTP server answers Parameters:
  server | string host name or IP address of the NTP server
  silent | boolean don't report the result of the detection
  Return value:
  | true if NTP server answers properly
`global DetectNtpServers (symbol method) -> list<string>`
  Detect NTP servers present in the local network Parameters:
  method | symbol method of the detection (only `slp suported ATM)
  Return value:
  | a list of found NTP servers
`global getSyncRecords () -> list<map<string,any> >`
  Get the list of synchronization-related records Return value:
  | a list of maps with keys type (eg. "server"), address and index.
`global selectSyncRecord (integer index) -> boolean`
  Select synchronization record Parameters:
  index | integer, -1 for creating a new record
  Return value:
  | true on success
`global findSyncRecord (string type, string address) -> integer`
  Find index of synchronization record Parameters:
  type | string record type
  address | string address
  Return value:
  | index of the record if found, -1 otherwise
`global storeSyncRecord () -> boolean`
  Store currently sellected synchronization record Return value:
  | true on success
`global deleteSyncRecord (integer index) -> boolean`
  Delete specified synchronization record Parameters:
  index | integer index of record to delete
  Return value:
  | true on success
`global AutoPackages () -> map`
  Return required packages for auto-installation Return value:
  | of packages to be installed and to be removed

YaST2 Developers Documentation |