• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

kreatv-option-ntp_bcm15

This IIP has been deprecated. Please use kreatv-option-timeman instead.

This package enables NTP (Network Time Protocol) support.

For more information about the NTP daemon/client (ntpd) used in the ARRIS STB please read www.ntp.org.

There are 5 different "modes" for this iip. 4 are represented by a main parameter each, and they should not be mixed together. The 5th mode, Server mode, is enabled if neither of these parameter are set. The 4 main mode parameters are:

  • dhcp
  • dynamic_server
  • dynamic_client
  • configurable
In each of the 5 main modes, only a certain subset of the IIP parameters will have any effect as noted below.

Server mode (none of the main mode parameters are set):

All parameter available for the NTP daemon/client can be passed though via iip parameters, i.e kreatv-option-ntp:<option>=<string>,...

For detailed information about configuration options please read Server Options.

The first server option will be used for setting the system time at boot time before the NTP daemon is started. This is needed since the NTP daemon will exit if the difference is too large between the system clock and the time received. A simple example of this option is: kreatv-option-ntp:server=0.pool.ntp.org,server=1.pool.ntp.org,server=2.pool.ntp.org

"dhcp" mode:

ntpdhcp.sh will be copied into rc.sysinit file and run at startup. This file can get ntp server from DHCP server.

There is one optional parameter that can be used to configure NTP.

1. ntpsh: when set to true (default): ntp.sh will be copied into the rc.sysinit file and run at startup.

when set to false: ntp.sh will not be copied into the rc.sysinit file and will not run at startup.

"configurable" mode:

There are 5 main parameters used to configure NTP, its default value is specified by some information object.

  1. server_object: specify the ntp server information service object name
  2. minpoll_object: specify the minpoll information service object name
  3. maxpoll_object: specify the maxpoll information service object name
  4. default_server: to specify the default ntp server, which can be used when server_object value is empty.
  5. ntpsh: When set to true ntpinfo.sh will be added to rc.sysinit and run at startup.

The ntpinfo.sh file can check these specific objects to configure ntp.conf.

The object value can be configured using kreatv-option-is-default, for example:


    kreatv-option-ntp:configurable,server_object=tr-069.Time.NTPServer1
    kreatv-option-is-default::tr-069.Time.NTPServer1=some.ntpserver.domain
    

If the server_object value is empty, default_server will be used, e.g default_server=timehost.cig.mot.com.

Options for getting time by ntpdate

The STB will try to connect to the first NTP server 'ntp_retry_attempts' times. There will be an 'ntp_retry_interval' seconds delay between requests.

If the first server can not be reached the STB will try the next NTP server for 'ntp_retry_attempts' times. And so on with other servers from the list.

If none of the servers can be reached then the STB boots without time information and connection attempts will be repeated every 'kreatv-option-timeman::time_sync_interval' seconds.

"dynamic_client" mode:

The NTP server list (dynamically created by the NTP Client device) is determined by a specific algorithm executed on some KreaTV-based STBs. The NTP Server IP Addresses are gathered and put into a table (in a user defined priority order). That table is traversed by the NTP Client using the current valid NTP Server IP Address taken from the table. Then specific processing will occur based on the response coming back from the NTP server upon a time request. If an error occurs, a defined number of retries will occur. If all retries are exhausted, the next IP Address in the table will be used, and so on. This algorithm will repeat itself forever going back to the beginning of the table when the end of the table is reached. If the NTP Server Address information changes, the NTP Client device will receive a notification and will rebuild the table based on the new NTP Server information.

"dynamic_server" mode:

The STB acts as an NTP server to serve the NTP clients (see Dynamic Client Option). It gets time from atsc headend, which means it should work with kreatv-option-atsctime.

Parameters

Name Repeat Description Type Default Example
broadcast Many Add an NTP server (of address type b and m). See "Server mode" section above... String broadcast=address
configurable Once To add support for retrieval of NTP server configuration through information object. See "configurable" section above... String configurable=true,server_object=tr-069.Time.NTPServer1
default_server Once Specify the default ntp server, which will be used when the server_object value is empty. Only used in "configurable" mode. String default_server=10.177.128.120
dhcp Once To add support for retrieval of NTP server configuration through dhcp. See "dhcp" section above... String dhcp
dynamic_client Once To add support for an NTP Client device that sets up an NTP Server list dynamically (during run time). See "dynamic_client" section above... String dynamic_client
dynamic_server Once To add support for an NTP Server device that will service a Dynamic NTP Client. See "dynamic_server" section above... String dynamic_server
manycastclient Many Add an NTP server (of address type m). See "Server mode" section above... String manycastclient=address
maxpoll_object Once Specify the maxpoll information service object name. Only used in "configurable" mode. String cfg.ntp.maxpoll maxpoll_object=tr-069.Time.maxpoll
minpoll_object Once Specify the minpoll information service object name. Only used in "configurable" mode. String cfg.ntp.minpoll minpoll_object=tr-069.Time.minpoll
ntp_retry_attempts Once Number of requests to each NTP server.

Valid range is {0, ...}.

Integer 1 ntp_retry_attempts=3
ntp_retry_interval Once Interval between requests to an NTP server, unit in seconds.

Valid range is {0, ...}.

Integer 0 ntp_retry_interval=5
ntpsh Once When set to true ntp.sh will be added to rc.sysinit and run at startup. Note: This parameter is only considered if the parameter "dhcp" or "configurable" is set also. Boolean true ntpsh=false
peer Many Add an NTP server (of address type s). See "Server mode" section above... String peer=address
server Many Add an NTP server (of address type s and r). See "Server mode" section above... String server=address [key key | autokey] [burst] [iburst] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll]
server_object Once Specify the ntp server information service object name. Only used in "configurable" mode. String cfg.ntp.servers server_object=tr-069.Time.NTPServer1

Details

Version5.1.1.p8
Content version-
Branchkreatv.5.1.1.p8
Date20180221
Time150412
Architecturebcm15
Rootdisk dependencieskreatv-option-timeman, kreatv-platform
Finalize dependencieskreatv-finalize-is-default
Installation scriptsbuildtime, kit
Dependency onlyno
Explicitno
Allow any parametersyes

5.1.1.p8

Copyright (c) 2018 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.