From 3930be3b878643034fcfa99d9f428a0d38daec35 Mon Sep 17 00:00:00 2001
From: William Hughes <will@willhughes.name>
Date: Mon, 26 Sep 2022 16:07:55 +1300
Subject: conserver: T4717: Support for setting a name for console-server
 devices

This adds a new 'alias' property to the console-server device definition
to allow users to connect to a console using a human-readable name
rather than just the device name.

For a configuration like:
service {
  console-server {
    device ttyUSB0 {
      speed 115200
      alias my-server
    }
  }
}

Users can connect either by doing `connect console ttyUSB0`, or
`connect console my-server`.

Names:
* Must be unique
* Are limited to 128 characters
* Are optional - if not specified, only the `connect console ttyX`
  form can be used
---
 data/templates/conserver/conserver.conf.j2          | 3 +++
 interface-definitions/service-console-server.xml.in | 8 ++++++++
 op-mode-definitions/connect.xml.in                  | 1 +
 src/completion/list_consoles.sh                     | 4 ++++
 src/conf_mode/service_console-server.py             | 7 +++++++
 5 files changed, 23 insertions(+)
 create mode 100755 src/completion/list_consoles.sh

diff --git a/data/templates/conserver/conserver.conf.j2 b/data/templates/conserver/conserver.conf.j2
index 1823657d7..ffd29389d 100644
--- a/data/templates/conserver/conserver.conf.j2
+++ b/data/templates/conserver/conserver.conf.j2
@@ -25,6 +25,9 @@ console {{ key }} {
     baud {{ value.speed }};
     parity {{ value.parity }};
     options {{ "!" if value.stop_bits == "1" }}cstopb;
+{%     if value.alias is vyos_defined %}
+    aliases "{{ value.alias }}";
+{%     endif %}
 }
 {% endfor %}
 
diff --git a/interface-definitions/service-console-server.xml.in b/interface-definitions/service-console-server.xml.in
index e9591ad87..fb71538dd 100644
--- a/interface-definitions/service-console-server.xml.in
+++ b/interface-definitions/service-console-server.xml.in
@@ -28,6 +28,14 @@
             </properties>
             <children>
               #include <include/interface/description.xml.i>
+              <leafNode name="alias">
+                <properties>
+                  <help>Human-readable name for this console</help>
+                  <constraint>
+                    <regex>[-_a-zA-Z0-9.]{1,128}</regex>
+                  </constraint>
+                </properties>
+              </leafNode>
               <leafNode name="speed">
                 <properties>
                   <help>Serial port baud rate</help>
diff --git a/op-mode-definitions/connect.xml.in b/op-mode-definitions/connect.xml.in
index 8f19eac70..d0c93195c 100644
--- a/op-mode-definitions/connect.xml.in
+++ b/op-mode-definitions/connect.xml.in
@@ -10,6 +10,7 @@
           <help>Connect to device attached to serial console server</help>
           <completionHelp>
             <path>service console-server device</path>
+            <script>${vyos_completion_dir}/list_consoles.sh</script>
           </completionHelp>
         </properties>
         <command>/usr/bin/console "$3"</command>
diff --git a/src/completion/list_consoles.sh b/src/completion/list_consoles.sh
new file mode 100755
index 000000000..52278c4cb
--- /dev/null
+++ b/src/completion/list_consoles.sh
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+# For lines like `aliases "foo";`, regex matches everything between the quotes
+grep -oP '(?<=aliases ").+(?=";)' /run/conserver/conserver.cf
\ No newline at end of file
diff --git a/src/conf_mode/service_console-server.py b/src/conf_mode/service_console-server.py
index a2e411e49..ee4fe42ab 100755
--- a/src/conf_mode/service_console-server.py
+++ b/src/conf_mode/service_console-server.py
@@ -61,6 +61,7 @@ def verify(proxy):
     if not proxy:
         return None
 
+    aliases = []
     processes = process_iter(['name', 'cmdline'])
     if 'device' in proxy:
         for device, device_config in proxy['device'].items():
@@ -75,6 +76,12 @@ def verify(proxy):
             if 'ssh' in device_config and 'port' not in device_config['ssh']:
                 raise ConfigError(f'Port "{device}" requires SSH port to be set!')
 
+            if 'alias' in device_config:
+                if device_config['alias'] in aliases:
+                    raise ConfigError("Console aliases must be unique")
+                else:
+                    aliases.append(device_config['alias'])
+
     return None
 
 def generate(proxy):
-- 
cgit v1.2.3