CP-308856 host.get_ntp_synchronized

Signed-off-by: Ming Lu <ming.lu@cloud.com>

Author: minglumlu

ocaml/idl/datamodel_host.ml

@@ -2646,6 +2646,19 @@ let list_timezones =
     ~result:(Set String, "The set of available timezones on the host")
     ~allowed_roles:_R_READ_ONLY ()
 
+let get_ntp_synchronized =
+  call ~name:"get_ntp_synchronized" ~lifecycle:[]
+    ~doc:
+      "Returns true if the system clock on the host is synchronized with the \
+       NTP servers."
+    ~params:[(Ref _host, "self", "The host")]
+    ~result:
+      ( Bool
+      , "true if the system clock on the host is synchronized with the NTP \
+         servers."
+      )
+    ~allowed_roles:_R_READ_ONLY ()
+
 (** Hosts *)
 let t =
   create_obj ~in_db:true
@@ -2800,6 +2813,7 @@ let t =
       ; get_ntp_servers_status
       ; set_timezone
       ; list_timezones
+      ; get_ntp_synchronized
       ]
     ~contents:
       ([

ocaml/xapi/message_forwarding.ml

@@ -4184,6 +4184,12 @@ functor
         let local_fn = Local.Host.list_timezones ~self in
         let remote_fn = Client.Host.list_timezones ~self in
         do_op_on ~local_fn ~__context ~host:self ~remote_fn
+
+      let get_ntp_synchronized ~__context ~self =
+        info "Host.get_ntp_synchronized: host = '%s'" (host_uuid ~__context self) ;
+        let local_fn = Local.Host.get_ntp_synchronized ~self in
+        let remote_fn = Client.Host.get_ntp_synchronized ~self in
+        do_op_on ~local_fn ~__context ~host:self ~remote_fn
     end
 
     module Host_crashdump = struct

ocaml/xapi/xapi_host.ml

@@ -3581,3 +3581,10 @@ let list_timezones ~__context ~self:_ =
     Helpers.call_script !Xapi_globs.timedatectl ["list-timezones"]
     |> Astring.String.cuts ~empty:false ~sep:"\n"
   with e -> Helpers.internal_error "%s" (ExnHelper.string_of_exn e)
+
+let get_ntp_synchronized ~__context ~self:_ =
+  match Xapi_host_ntp.is_synchronized () with
+  | Ok r ->
+      r
+  | Error msg ->
+      Helpers.internal_error "%s" msg

ocaml/xapi/xapi_host.mli

@@ -632,3 +632,5 @@ val set_timezone :
   __context:Context.t -> self:API.ref_host -> value:string -> unit
 
 val list_timezones : __context:Context.t -> self:API.ref_host -> string list
+
+val get_ntp_synchronized : __context:Context.t -> self:API.ref_host -> bool

ocaml/xapi/xapi_host_ntp.ml

@@ -175,3 +175,12 @@ let promote_legacy_default_servers () =
     set_servers_in_conf defaults ;
     restart_ntp_service ()
   )
+
+let is_synchronized () =
+  let patterns = ["System clock synchronized: yes"; "NTP synchronized: yes"] in
+  try
+    Helpers.call_script !Xapi_globs.timedatectl ["status"]
+    |> String.split_on_char '\n'
+    |> List.exists ((Fun.flip List.mem) patterns)
+    |> Result.ok
+  with e -> Error (ExnHelper.string_of_exn e)

ocaml/xapi/xapi_host_ntp.mli

@@ -35,3 +35,5 @@ val get_servers_from_conf : unit -> string list
 val is_ntp_dhcp_enabled : unit -> bool
 
 val get_servers_status : unit -> (string * string) list
+
+val is_synchronized : unit -> (bool, string) Result.t