Serial ports
The device's serial ports, and additional USB serial ports.
Default Serial port items cannot be deleted. New Serial port items can be added.
Serial port
- USB - Settings for USB serial port adapters.
- TCP - Settings for serial over TCP.
- Communications settings - The communications settings used for serial data and signaling.
- Signals
- Statistics
- Direct access
- Logging
- Connected users
Properties
Enable
Enable the serial port for use.
- Data type: boolean
- Default:
true - Configuration
CLI: (cli)> config serial <key> enable
Label
The label used to describe and locate this serial port.
Whenever this serial port is displayed the label will be used in preference, or addition to, the serial port number. The Label is also added as a tag allowing it to be located easily is searching and configuration.
- Data type: string
- Configuration
- Optional
CLI: (cli)> config serial <key> label
Device type
| Option | Label |
|---|---|
tty | Serial port |
tcp | TCP port |
- Data type: string select
- Default:
tty - Configuration
- Required
CLI: (cli)> config serial <key> type
Resource tags
Apply these tags to resources associated with this serial port.
Tagging provides a convenient method for finding single and group resources. The serial port label is automatically added to the ports tags.
- Data type: string list
- Configuration
CLI: (cli)> config serial <key> tags
Mode
The mode of operation for this serial port.
The serial port mode determines how serial port is accessed and what options are allowed when connected.
| Option | Label | Description |
|---|---|---|
remote | Remote access | Access an external serial appliance remotely. Suitable for remotely accessing a serial console on servers or other appliances, and if required, interacting with those appliances via their serial interface. |
login | System login | Provide a traditional login service. A login service will allow remote CLI access to this device. A console server, modem or other appliance can be used to access the CLI on this device via the serial port. |
container | Container use | Reserve the serial port for use by a container. The serial port pinout configuration can still be set on serial ports with pinout switching available. |
rpc | RPC connection | Connected to a Remote Power Controller (RPC). Used as a control channel for a Remote Power Controller. This serial port can be selected as the interface for a serially connected RPC, allowing the RPC to be controlled via this device. |
- Data type: string select
- Default:
remote - Configuration
- Required
CLI: (cli)> config serial <key> mode
Escape character (ASCII character code)
The escape character to enter for menu and command access.
Enter the escape character followed by a command character while connected to a serial port in order to access the menu or serial port commands. The following sequences are possible:
Escape-Char 'q' : quit
Escape-Char 'b' : send serial break
Escape-Char 'd' : list or disconnect other sessions
Escape-Char 's' : port history (graphical terminal only)
Escape-Char '?' : help
The table below lists the decimal values for the escape character, control characters are prefixed with '^'.
| 00 | 10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100 | 110 | 120 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | ^J | ^T | ^^ | ( | 2 | < | F | P | Z | d | n | x | |
| 1 | ^A | ^K | ^U | ^ | ) | 3 | = | G | Q | [ | e | o | y |
| 2 | ^B | ^L | ^V | ^? | * | 4 | > | H | R | \ | f | p | z |
| 3 | ^C | ^M | ^W | ! | + | 5 | ? | I | S | ] | g | q | { |
| 4 | ^D | ^N | ^X | " | , | 6 | @ | J | T | ^ | h | r | |
| 5 | ^E | ^O | ^Y | # | - | 7 | A | K | U | _ | i | s | } |
| 6 | ^F | ^P | ^Z | $ | . | 8 | B | L | V | ` | j | t | ~ |
| 7 | ^G | ^Q | ^[ | % | / | 9 | C | M | W | a | k | u | DEL |
| 8 | ^H | ^R | ^\ | & | 0 | : | D | N | X | b | l | v | |
| 9 | ^I | ^S | ^] | ' | 1 | ; | E | O | Y | c | m | w |
- Data type: integer
- Default:
30 - Minimum: 1
- Maximum: 255
- Configuration
- Required
CLI: (cli)> config serial <key> escape-character
Single user mode
Allow only one user at a time.
The port will allow a single user to connect. While a user is connected, all other connection requests will be rejected and logged.
- Data type: boolean
- Default:
false - Configuration
CLI: (cli)> config serial <key> single-user
Outlet power control
A list of RPC outlets that are used to power the equipment connected to this serial port.
Adding RPC outlets to this list allows those outlets to be controlled during a serial session, allowing the equipment connected to this port to be power cycled if required.
- Data type: reference list
- Configuration
CLI: (cli)> config serial <key> power-control