...

Example for OPA0 console ("COM1" port):

set COM1 alias=OPA0

Starting with Charon-AXP V4.11 build 204-13, the line above is optional. OPA0 is mapped by default to COM1.

Example when using the TTA0 console ("COM2" port):

...

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.

Note

title	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:

set COM2 alias=TTA0

Div

class	pagebreak

communication

Parameter	communication
Type	Text string
Value	"ascii" - for connection to terminals (default) "binary" - for binary (packet) protocols, which are used mainly for communicating with PLCs

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:

set OPA0 baud=38400

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).

Note

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:

>>> set controlp off
>>> power off

The second line is to preserve the ROM settings.

Example:

set OPA0 break_on="Ctrl-P"

The default value is "Break".

This parameter can be specified only for COM1 (OPA0) console

Div

class	pagebreak

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:

set OPA0 stop_on="F6"

The default value is "none".

Setting "F6" triggers the STOP condition upon receipt of the "<ESC>[17~" sequence. Terminals usually send these sequences by pressing the F6 button

This parameter can be specified only for COM1 (OPA0) console

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:

set OPA0 log="log.txt"

Example 2:

set OPA0 log="/Charon/Logs"

Note
Only existing directory can be used as a value of the "log" parameter.

...

Div

class	pagebreak

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.

"unlimited" or "0" (default) - the feature is disabled
"default" - default size is used (4Mb)
<size>[KMG] - size of the current log file in bytes with additional multipliers:
- K - Kilobyte - multiply by 1024
- M - Megabyte - multiply by 1024*1024
- G - Gigabyte - multiply by 1024*1024*1024

Example 1:

set OPA0 log_file_size="default"

Example 2:

set OPA0 log_file_size=10M

Minimum log file size is 64K, maximum is 1G. Setting size less then 64K effectively makes the log file unlimited.

log_flush_period

Parameter log_flush_period

Type Numeric

Value

<period-in-seconds>

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:

set OPA0 log_flush_period=30

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.

...

Div

class	pagebreak

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:

set OPA0 application = "xterm -title OPA0 -e telnet 127.0.0.1 10003"

If "putty" terrminl emulator is going to be used as an option copy the following file to your home directory:

# mkdir -p $HOME/.config/putty/sessions (if it does not already exist)
# cp /opt/charon/putty/sessions/CHTERM-VT100 $HOME/.config/putty/sessions

Example:

set OPA0 application = "putty -load CHTERM-VT100 -title OPA0@XYZ -P 10003"

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 = OPA0` `set 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:

set OPA0 access_control = disable

This is implemented only for serial lines using the new syntax, not for lines using the legacy syntax (load virtual_serial_line ...).

Div

class	pagebreak

Notes on "port" and "application" parameters

...

class	pagebreak

Mapping Serial line controllers to system resources

line

Parameter line

Type Text string

Value

A defined TTY port on host system (or "(console)" value):

(console) for CHARON console (the console from which it starts). It is the default setting for COM1 ("OPA0")
"/dev/tty<N>" for virtual console
"/dev/ttyS<N>" for onboard serial lines
"/dev/ttyUSB<N>" for modem or USB serial lines adapters
"/dev/tty<XXX>" for proprietary (depending on a driver) devices such as DIGI or MOXA cards

Note
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.

Note
A specific account for running CHARON ("charon") does not allow usage of physical consoles "`/dev/tty<N>`" as CHARON consoles. If you plan to map CHARON console to "`/dev/tty<N>`" use only "root" account for CHARON running.

...

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/tty1"

"/dev/ttyS<N>"

where N is a number

Onboard serial lines

Example:

"/dev/ttyS1"

"/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:

"/dev/ttyR01"

Example for a first port of a DIGI card:

"/dev/ttyaa"

"/dev/ttyUSB<N>"

where N is a number

Modem or USB serial lines adapters

Example:

"/dev/ttyUSB1"

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:

load virtual_serial_line OPA0

set OPA0 port=10003

set OPA0 stop_on="F6"

set OPA0 log="/charon/myaxp/logs"

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:

set COM1 alias=OPA0 (optional starting with build 204-13)

set OPA0 port=10003

set OPA0 stop_on="F6"

set OPA0 log="/charon/myaxp/logs"

set OPA0 connection_override=enable

Include Page

	KBCOMMON:DOC-GoToToc
	KBCOMMON:DOC-GoToToc

Versions Compared

Old Version 37

New Version Current

Key

General parameters

alias

communication

baud

break_on

stop_on

log

log_file_size

log_flush_period

port

application

connection_override

access_control

Notes on "port" and "application" parameters

Mapping Serial line controllers to system resources

line

OPA0 console configuration examples

Using legacy syntax (not recommended)

Using new syntax (recommended)

Page Comparison

Versions Compared

Old Version 37

New Version Current

Key

General parameters

alias

communication

baud

break_on

stop_on

log

log_file_size

log_flush_period

port

application

connection_override

access_control

Notes on "port" and "application" parameters

Mapping Serial line controllers to system resources

line

OPA0 console configuration examples

Using legacy syntax (not recommended)

Using new syntax (recommended)