How to restrict serial port access to a single session and set time-out on a Terminal Server

This guide explains how to configure a Terminal Server to restrict serial port access to a single session and set the default time-out.

Prerequisites

The Terminal Server must run OS version 24.11.2 or a later version.

For upgrade instructions, refer to How to Upgrade Terminal Server OS.

Note

This guide has been validated with Opengear firmware version 24.11.2, which was upgraded from version 22.06.0, and is supported with Nexus Network Fabric runtime version 5.0.0.

Step 1: Set time-out for sessions

Configure the session time-outs for CLI, WebUI, and Serial Port access using the following commands:

sudo ogcli update system/cli_session_timeout timeout=15
sudo ogcli update system/webui_session_timeout timeout=15
sudo ogcli update system/session_timeout serial_port_timeout=15

[Note] In the above example the timeout value is set to 15 minutes.

Step 2: Verify time-out settings

Confirm the new time-out settings by running:

sudo ogcli get system/session_timeout

cli_timeout=15
serial_port_timeout=15
webui_timeout=15

Step 3: Configure single serial port session

To restrict each serial port to a single session, execute the following command.

for i in {01..48} ; do
  echo "### Configuring single_session on port$i ###"
  ogcli update port port$i single_session=true
done

Note

This process may take approximately 15 minutes.

Step 4: Verify single session configuration

Validate the configuration by listing the ports and checking the single_session status:

sudo ogcli get ports | grep -E 'ogcli get port|single_session'

Alternatively, check individual ports:

sudo ogcli get port "port01"

single_session=true

Repeat the command for other ports as needed (port02, port03, etc.).