openbmc/phosphor-time-manager/README.md

3 `phosphor-time-manager` is the time manager service that implements D-Bus
4 interface `xyz/openbmc_project/Time/EpochTime.interface.yaml`. The user can get
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:
20 - Compile phosphor-time-manager with some configurable options:
36 The service `xyz.openbmc_project.Time.Manager` provides an object on D-Bus:
38 - /xyz/openbmc_project/time/bmc
40 where each object implements interface `xyz.openbmc_project.Time.EpochTime`.
43 set the time. For example on an authenticated session:
45 - To get BMC's time:
49   busctl get-property xyz.openbmc_project.Time.Manager \
50       /xyz/openbmc_project/time/bmc xyz.openbmc_project.Time.EpochTime Elapsed
53   curl -b cjar -k https://${BMC_IP}/xyz/openbmc_project/time/bmc
56 - To set BMC's time:
60   busctl set-property xyz.openbmc_project.Time.Manager \
61       /xyz/openbmc_project/time/bmc xyz.openbmc_project.Time.EpochTime \
67       https://${BMC_IP}/xyz/openbmc_project/time/bmc/attr/Elapsed
70 ### Time settings
72 Getting BMC time is always allowed, but setting the time may not be allowed
76   - NTP: The time is set via NTP server.
77   - MANUAL: The time is set manually.
79 A summary of which cases the time can be set on BMC or HOST:
81 | Mode   | Set BMC Time |
106       /xyz/openbmc_project/time/sync_method xyz.openbmc_project.Time.Synchronization \
107       TimeSyncMethod s "xyz.openbmc_project.Time.Synchronization.Method.NTP"
111       '{"data": "xyz.openbmc_project.Time.Synchronization.Method.NTP" }' \
112       https://${BMC_IP}/xyz/openbmc_project/time/sync_method/attr/TimeSyncMethod
118 new beahvior that it checks the NTP services' status during setting time,
122   stopped, setting time will get an error.