Console
Table of Contents
General Description
CHARON-AXP offers two-port serial console on all supported AXP models.
Example for OPA0 console ("COM1" port):
set COM1 alias=OPA0 |
Starting with Charon-AXP V4.12 build 204-13, the line above is optional. OPA0 is mapped by default to COM1.
Example when using the TTA0 console ("COM2" port):
|
Refer to Mapping Serial line controllers to system resources for details of mapping.
General parameters
CHARON-AXP console lines COM1 and COM2 have the following parameters:
All the values in the following tables are case insensitive.
alias
| Parameter | alias |
|---|---|
| Type | Identifier |
| Value | This parameter is used to set an useful name for COM1 or COM2 ports. It can be any name, for example "Console1", but usually it is "OPA0" for COM1 and "TTA0" for COM2. This name is logged in CHARON log file, it can also be used for parametrization in CHARON configuration file along with "COM1" and "COM2" identifiers. The main purpose of this parameter is migration from old CHARON systems (which do not have the described implementation of consoles) to the current design, since it allows retaining the original name used for parametrization, since the rest of the parameters stay the same in both implementations. This note applies to builds before 204-13 If the "alias" parameter is not specified CHARON log file will miss the name for the given console, for example " : Connected. Remote 127.0.0.1:63516" will be displayed instead of "OPA0 : Connected. Remote 127.0.0.1:63516". So it is always recommended to specify the "alias" parameter. Example:
|
communication
| Parameter | communication |
|---|---|
| Type | Text string |
| Value |
|
baud
| Parameter | baud |
|---|---|
| Type | Numeric |
| Value | Forces the baud rate of the corresponding TTY port to a specified value.The variety of supported values depends on the underlying physical communication resource (TTY port). The most widely used values are: 300, 1200, 9600, 19200, 38400. Example:
|
break_on
| Parameter | break_on |
|---|---|
| Type | Text string |
| Value | Specifies what byte sequences received over the physical serial line will trigger a HALT command. This parameter works only for the console line. Specify the following values: "Ctrl-P" , "Break" or "none" ("none" disables triggering a HALT condition). If your guest operating system is OpenVMS in addition to "none" setting you have to set a specific console parameter "controlp" to "off" in the following way:
The second line is to preserve the ROM settings. Example:
The default value is "Break".
|
stop_on
| Parameter | stop_on |
|---|---|
| Type | Text string |
| Value | Specifies what byte sequences received over the physical serial line will trigger a STOP condition. The STOP condition causes CHARON-AXP to exit. Specify either “F6” or “none” ("none" disables triggering a STOP condition). Example:
The default value is "none". Setting "F6" triggers the STOP condition upon receipt of the "
|
log
| Parameter | log |
|---|---|
| Type | Text string |
| Value | A string specifying a file name to store the content of the console sessions or a directory where the log files for each individual session will be stored. If an existing directory is specified, CHARON-AXP automatically enables creation of individual log files, one for each session using the same scheme as used for the generation of the rotating log files. If the "log" parameter is omitted, CHARON-AXP does not create a console log. Example 1:
Example 2:
Only existing directory can be used as a value of the "log" parameter. |
log_file_size
| Parameter | log_file_size |
|---|---|
| Type | Text string |
| Value | If log rotation is enabled, the log_file_size parameter determines the log file size threshold at which the log is automatically rotated.
Example 1:
Example 2:
|
log_flush_period
| Parameter | log_flush_period |
|---|---|
| Type | Numeric |
| Value |
Defines a period of flushing log to disk. Default period is 60 seconds (it means that every minute log file is flushed to disk) Example:
|
port
| Parameter | port |
|---|---|
| Type | Numeric |
| Value | The TCP/IP port number for the virtual serial line. A virtual serial line always listens on this port for incoming connection requests. If multiple virtualized machines are running on a server, ensure the port number is unique across the platform. |
application
| Parameter | application |
|---|---|
| Type | Text string |
| Value | A command line for calling some host application for communication to Charon on a given COM line. Typically this parameter is used for mapping COM1 or COM2 or some "xterm" terminal emulator Example:
If "putty" terminal emulator is going to be used as an option copy the following file to your home directory:
Example:
|
connection_override
| Parameter | connection_override |
|---|---|
| Type | text string |
| Value | "enable" Allows new connection to override existing connection, if any. Enabled connection override on OPA0 allows to intercept virtual serial console. When emulator detects new connection request on the port (10003 for the below example), it closes old connection, if any, and switches to the new one. Example: set COM1 alias = OPA0set OPA0 port = 10003 connection_override = enable This is implemented only for serial lines using the new syntax, not for lines using the legacy syntax (load virtual_serial_line ...). |
access_control
Available only since build 204-13
| Parameter | access_control |
|---|---|
| Type | text string |
| Value | "disable" Since build 204-13, Incoming connection requests are by default filtered for virtual serial lines and then allowed only for the localhost. This is to avoid security scanners that can block the port. Example:
|
Notes on "port" and "application" parameters
Use the combination of "port" and "application" parameters as follows to connect a 3rd party terminal emulator or similar program.
set COM1 alias=OPA0 port=10003 application="xterm -title OPA0 -e chterm -h 127.0.0.1:10003" |
In this example CHARON-AXP OPA0 console connects to port 10003 of localhost ("127.0.0.1") and at the same time it starts "xterm" with parameters "-title OPA0 -e chterm -h 127.0.0.1:10003", instructs it to connect to the port 10003 of the host with TCP/IP address "127.0.0.1" (localhost)
Mapping Serial line controllers to system resources
line
| Parameter | line |
|---|---|
| Type | Text string |
| Value | A defined TTY port on host system (or "(console)" value):
If a virtual console "/dev/tty<N>" is going to be used, it must be freed from all the processes running on it at first. Refer to your OS documentation for details, also some description on how to do it is available here. A specific account for running CHARON ("charon") does not allow usage of physical consoles " |
"ttyY" notation specifics
Note that the "ttyY" notation can have different forms depending on the nature of the device used:
| Mapping | Type | Commentary |
|---|---|---|
"/dev/tty<N>" where N is from 0 to 11 | Linux virtual tty | Those tty devices must be free from the Linux "getty/mgetty" and similar programs (specified in "/etc/inittab") Example:
|
"/dev/ttyS<N>" where N is a number | Onboard serial lines | Example:
|
"/dev/tty<XXX>" where XXX is a complex letter/number notation | Proprietary (depending on a driver) devices | Example for a first port of a MOXA card:
Example for a first port of a DIGI card:
|
"/dev/ttyUSB<N>" where N is a number | Modem or USB serial lines adapters | Example:
|
OPA0 console configuration examples
Using legacy syntax (not recommended)
This example maps OPA0 to port 10003, enable F6 key (emulator stop) and logs the console input/output to a rotating log file in /charon/myaxp/logs folder:
|
Using new syntax (recommended)
This example maps OPA0 to port 10003, enable F6 key (emulator stop), logs the console input/output to a rotating log file in /charon/myaxp/logs folder and enables the connection_override feature:
|
© Stromasys, 1999-2024 - All the information is provided on the best effort basis, and might be changed anytime without notice. Information provided does not mean Stromasys commitment to any features described.