CP-54217: Change wording.

Signed-off-by: Stephen Cheng <[email protected]>

Author: stephenchengCloud

ocaml/idl/datamodel_lifecycle.ml

@@ -138,7 +138,7 @@ let prototyped_of_field = function
   | "VM", "actions__after_softreboot" ->
       Some "23.1.0"
   | "pool", "limit_console_sessions" ->
-      Some "25.29.0"
+      Some "25.30.0-next"
   | "pool", "ha_reboot_vm_on_internal_shutdown" ->
       Some "25.16.0"
   | "pool", "license_server" ->

ocaml/idl/datamodel_pool.ml

@@ -2252,8 +2252,10 @@ let t =
              when HA is enabled"
         ; field ~writer_roles:_R_POOL_OP ~qualifier:RW ~lifecycle:[] ~ty:Bool
             ~default_value:(Some (VBool false)) "limit_console_sessions"
-            "Indicate whether the console concurrent limit is set for the pool \
-             (false means no limit)"
+            "When true, only one console connection per VM/host in the pool is \
+             accepted. Otherwise every connection for a VM/host's console is \
+             accepted. Note: when true, connection attempts via websocket will \
+             be rejected."
         ]
       )
     ()

ocaml/idl/schematest.ml

@@ -3,7 +3,7 @@ let hash x = Digest.string x |> Digest.to_hex
 (* BEWARE: if this changes, check that schema has been bumped accordingly in
    ocaml/idl/datamodel_common.ml, usually schema_minor_vsn *)
 
-let last_known_schema_hash = "f546a0d01815608cbcf04cdb90c1be9f"
+let last_known_schema_hash = "cf1c1e26b4288dd53cf6da5a4d6ad13c"
 
 let current_schema_hash : string =
   let open Datamodel_types in

ocaml/xapi-cli-server/records.ml

@@ -1599,7 +1599,7 @@ let pool_record rpc session_id pool =
           ~get:(fun () -> string_of_bool (x ()).API.pool_limit_console_sessions)
           ~set:(fun x ->
             Client.Pool.set_limit_console_sessions ~rpc ~session_id ~self:pool
-              ~value:(bool_of_string x)
+              ~value:(safe_bool_of_string "limit-console-sessions" x)
           )
           ()
       ]

ocaml/xapi/console.ml

@@ -34,9 +34,9 @@ type address =
 
 (* console is listening on a Unix domain socket *)
 
-(* This module enforces connection limits for VM consoles.
-   Depending on configuration, only one active connection per VM (including Dom0) is allowed,
-   or that connections are unlimited. *)
+(* This module limits VNC console sessions to at most one per VM/host.
+   Depending on configuration, either unlimited connections are allowed,
+   or only a single active connection per VM/host is allowed. *)
 module Connection_limit = struct
   module VMSet = Set.Make (String)
 
@@ -162,56 +162,55 @@ let ws_proxy __context _ req protocol address s =
     Db.Pool.get_limit_console_sessions ~__context ~self:pool
   in
   (* Disable connection via websocket if the limit is set *)
-  if limit_console_sessions = true then (
-    Http_svr.headers s (Http.http_503_service_unavailable ()) ;
-    ()
-  ) ;
-  let addr = match address with Port p -> string_of_int p | Path p -> p in
-  let protocol =
-    match protocol with `rfb -> "rfb" | `vt100 -> "vt100" | `rdp -> "rdp"
-  in
-  let real_path = Filename.concat "/var/lib/xcp" "websockproxy" in
-  let sock =
-    try Some (Fecomms.open_unix_domain_sock_client real_path)
-    with e ->
-      debug "Error connecting to wsproxy (%s)" (Printexc.to_string e) ;
-      Http_svr.headers s (Http.http_501_method_not_implemented ()) ;
-      None
-  in
-  (* Ensure we always close the socket *)
-  finally
-    (fun () ->
-      let upgrade_successful =
-        Option.map
-          (fun sock ->
-            try
-              let result = (sock, Some (Ws_helpers.upgrade req s)) in
-              result
-            with _ -> (sock, None)
-          )
-          sock
-      in
-      Option.iter
-        (function
-          | sock, Some ty ->
-              let wsprotocol =
-                match ty with
-                | Ws_helpers.Hixie76 ->
-                    "hixie76"
-                | Ws_helpers.Hybi10 ->
-                    "hybi10"
-              in
-              let message =
-                Printf.sprintf "%s:%s:%s" wsprotocol protocol addr
-              in
-              let len = String.length message in
-              ignore (Unixext.send_fd_substring sock message 0 len [] s)
-          | _, None ->
-              Http_svr.headers s (Http.http_501_method_not_implemented ())
-          )
-        upgrade_successful
-    )
-    (fun () -> Option.iter (fun sock -> Unix.close sock) sock)
+  if limit_console_sessions = true then
+    Http_svr.headers s (Http.http_503_service_unavailable ())
+  else
+    let addr = match address with Port p -> string_of_int p | Path p -> p in
+    let protocol =
+      match protocol with `rfb -> "rfb" | `vt100 -> "vt100" | `rdp -> "rdp"
+    in
+    let real_path = Filename.concat "/var/lib/xcp" "websockproxy" in
+    let sock =
+      try Some (Fecomms.open_unix_domain_sock_client real_path)
+      with e ->
+        debug "Error connecting to wsproxy (%s)" (Printexc.to_string e) ;
+        Http_svr.headers s (Http.http_501_method_not_implemented ()) ;
+        None
+    in
+    (* Ensure we always close the socket *)
+    finally
+      (fun () ->
+        let upgrade_successful =
+          Option.map
+            (fun sock ->
+              try
+                let result = (sock, Some (Ws_helpers.upgrade req s)) in
+                result
+              with _ -> (sock, None)
+            )
+            sock
+        in
+        Option.iter
+          (function
+            | sock, Some ty ->
+                let wsprotocol =
+                  match ty with
+                  | Ws_helpers.Hixie76 ->
+                      "hixie76"
+                  | Ws_helpers.Hybi10 ->
+                      "hybi10"
+                in
+                let message =
+                  Printf.sprintf "%s:%s:%s" wsprotocol protocol addr
+                in
+                let len = String.length message in
+                ignore (Unixext.send_fd_substring sock message 0 len [] s)
+            | _, None ->
+                Http_svr.headers s (Http.http_501_method_not_implemented ())
+            )
+          upgrade_successful
+      )
+      (fun () -> Option.iter (fun sock -> Unix.close sock) sock)
 
 let default_console_of_vm ~__context ~self =
   try