openbmc/phosphor-time-manager/README.md

3 `phosphor-time-manager` is the time manager service that implements D-Bus
5 or set the BMC's time via this interface.
9 phosphor-time-manager is configured by setting `-D` flags that correspond to
10 options in `phosphor-time-manager/meson.options`. The option names become C++
13 - Compile phosphor-time-manager with default options:
17      meson compile -C builddir
20 - Compile phosphor-time-manager with some configurable options:
23      meson setup builddir -Dbuildtype=minsize  -Dtests=false
24      meson compile -C builddir
27 - Generate test coverage report:
30      meson setup builddir -Db_coverage=true -Dtests=true
31      meson compile -C builddir
32      meson test -C builddir
33      ninja -C builddir coverage
38 The service `xyz.openbmc_project.Time.Manager` provides an object on D-Bus:
40 - /xyz/openbmc_project/time/bmc
44 The user can directly get or set the property `Elapsed` of the objects to get or
45 set the time. For example on an authenticated session:
47 - To get BMC's time:
51   busctl get-property xyz.openbmc_project.Time.Manager \
55   curl -b cjar -k https://${BMC_IP}/xyz/openbmc_project/time/bmc
58 - To set BMC's time:
62   busctl set-property xyz.openbmc_project.Time.Manager \
64       Elapsed t <value-in-microseconds>
67   curl -b cjar -k -H "Content-Type: application/json" -X PUT \
68       -d '{"data": 1487304700000000}' \
77 - TimeSyncMethod
78   - NTP: The time is set via NTP server.
79   - MANUAL: The time is set manually.
81 A summary of which cases the time can be set on BMC or HOST:
83 | Mode   | Set BMC Time |
84 | ------ | ------------ |
85 | NTP    | Fail to set  |
88 - To set an NTP [server](https://tf.nist.gov/tf-cgi/servers.cgi):
92   busctl set-property  xyz.openbmc_project.Network \
98   curl -c cjar -b cjar -k -H "Content-Type: application/json" -X  PUT  -d \
103 - To go into NTP mode
107   busctl set-property xyz.openbmc_project.Settings \
112   curl -c cjar -b cjar -k -H "Content-Type: application/json" -X  PUT  -d \
123 - When NTP server is set to disabled, and the NTP service is stopping but not