Anchor

	TOC
	TOC

Include Page

	KBCOMMON:KB-CSSstyle
	KBCOMMON:KB-CSSstyle

...

Div

class	pagebreak

General Description

Before build 204-13

Configuration of CHARON-VAX serial lines is performed in 3 steps:

Loading virtual serial lines controller, for example:
load DHV11/DHV11 TXA
In this example, an instance of a "DHV11" serial line controller is loaded and named "TXA"
Note that VAX console adapters ("UART", "QUART") do not need to be loaded; they are preloaded.
Mapping an object type to host resources, for example:
load physical_serial_line TTA1 set OPA0 line="/dev/ttyS1"
In this example the object "physical_serial_line" is loaded, named "TTA1", and mapped to the "/dev/ttyS1" host physical serial port.
Connect the loaded virtual line controller and the mapped object:
set TXA line[5]=TTA1
In this example, the 6th line of the DHV11 controller "TXA" loaded at step 1 is connected to the mapping object "TTA1" loaded at the step 2.

...

Console

CHARON-VAX offers a one- or four-port serial console depending on the specified VAX model. The one line serial line controller is identified in CHARON-VAX with the name UART. The four serial lines controller is identified in CHARON-VAX with the name QUART.

UART is used in Qbus systems only (e.g. the MicroVAX/VAXserver 3600/3900).

QUART is used in SCSI (e.g. MicroVAX 3100 model 96/98, VAXstation 4000 model 90) and SCSI/Qbus systems (e.g. VAX4000 model 106/108). The last QUART line (line[3]) is the console port (known in VAX/VMS as OPA0).

CHARON-VAX console ports can be configured to connect to an external terminal via the host system COM/TTY port or can be connected via TCP/IP.

rts

...

"On" - assert RTS (Request To Send) signal
"Off" - clear RTS signal (default)
"DTR" - assert RTS signal as soon as DTR signal is asserted ( Applicable only for QUART )

...

class	pagebreak

dsr

...

This syntax is still supported after build 204-13 but using it will not provide the new features provided by this build.

Starting with build 204-13

Configuration of the CHARON-VAX / CHARON-PDP serial lines is performed as detailed below:

Example for MicroVAX II, 3600, 3900, VAX 4000-700/705:

set UART alias=OPA0set OPA0 port=10003

The first line above is optional as Charon-VAX presets UART's alias to OPA0

Example for MicroVAX 3100-96/98, VAX 4000-106/108, and VAXstation 4000-90:

set QUART alias[3] = OPA0
set OPA0 port=10003

The first line above is optional as Charon-VAX presets UART's alias to OPA0

Please note using the old method with "load virtual_serial_line OPA0" will invalidate some features detailed further.

Include Page

	KBCOMMON:DOC-GoToToc
	KBCOMMON:DOC-GoToToc

Console

CHARON-VAX offers a one- or four-port serial console depending on the specified VAX model. The one line serial line controller is identified in CHARON-VAX with the name UART. The four serial lines controller is identified in CHARON-VAX with the name QUART.

UART is used in Qbus systems only (e.g. the MicroVAX/VAXserver 3600/3900).

QUART is used in SCSI (e.g. MicroVAX 3100 model 96/98, VAXstation 4000 model 90) and SCSI/Qbus systems (e.g. VAX4000 model 106/108). The last QUART line (line[3]) is the console port (known in VAX/VMS as OPA0).

CHARON-VAX console ports can be configured to connect to an external terminal via the host system COM/TTY port or can be connected via TCP/IP.

alias

Parameter alias

Type Identifier

Value

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
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 UART alias=OPA0

This parameter is optional as Charon-VAX presets UART's alias to OPA0

rts

Parameter	rts[<line>]
Type	Text string
Value	"On" - assert RTS (Request To Send) signal "Off" - clear RTS signal (default) "DTR" - assert RTS signal as soon as DTR signal is asserted ( Applicable only for QUART )

Div

class	pagebreak

dsr

Parameter

dsr[<line>]

Type

Text string

Value

"On" - always reports DSR signal asserted
"Off" - always reports DSR signal deasserted
"DSR" - use DSR signal of physical serial line (if configured)
"CD", "DCD", "RLSD" - use CD (carrier detect) signal of physical serial line (if configured)

Info
This parameter is applicable only for line "2" of QUART. UART has no such parameter.

...

Parameter line

Type Text string

Value

A defined TTY port on host system:

"/dev/tty<N>" - virtual serial lines
"/dev/ttyS<N>" - onboard serial lines
"/dev/ttyUSB<N>" - modem or usb serial lines adapters
"/dev/tty<XXX>" - proprietary (depending on a driver) devices such as DIGI or MOXA cards

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

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

...

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

Example of mapping a console line to an onboard serial line:

...

class	pagebreak

virtual_serial_line

host

...

A remote host’s IP address or a host name (and optional remote TCP/IP port number) for the virtual serial line connection.

If omitted, the virtual serial line does not initiate a connection to the remote host and will listen for incoming connection requests.

Specify the value in the following form:

set OPA0 host="<host-name>[:<port-no>]"

If "<port-no>" is not specified, the virtual serial line uses the TCP/IP port number specified by the "port" parameter (see below).

port

...

application

...

A command line for calling some host application for communication to Charon on a given serial line.

Example:

...

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

# cp /opt/charon/putty/sessions/CHTERM-VT100 $HOME/.config/putty/sessions

Example:

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

break_on

Parameter

break

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

Example of mapping a console line to an onboard serial line:

load physical_serial_line OPA0
set OPA0 line="/dev/ttyS1"

Include Page

	KBCOMMON:DOC-GoToToc
	KBCOMMON:DOC-GoToToc

Div

class	pagebreak

virtual_serial_line

host

Parameter host

Type Text string

Value

A remote host’s IP address or a host name (and optional remote TCP/IP port number) for the virtual serial line connection.

If omitted, the virtual serial line does not initiate a connection to the remote host and will listen for incoming connection requests.

Specify the value in the following form:

set OPA0 host="<host-name>[:<port-no>]"

If "<port-no>" is not specified, the virtual serial line uses the TCP/IP port number specified by the "port" parameter (see below).

port

Parameter	port
Type	Numeric
Value	TCP/IP port number for the virtual serial line. A virtual serial line always listens on this port for incoming connection requests.

application

Parameter application

Type Text string

Value

A command line for calling some host application for communication to Charon on a given serial line.

Example:

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

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

# cp /opt/charon/putty/sessions/CHTERM-VT100 $HOME/.config/putty/sessions

Example:

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

break_on

Parameter break_on

Type Text string

Value

Specifies what byte sequences received over virtual serial line must trigger HALT command.

This parameter works only for console line (for CHARON-VAX it is the only line of UART and the "line[3]" of QUART).

Specify the following values: "Ctrl-P", "Break" or "none" to disable triggering HALT condition.

Example:

set OPA0 break_on="Ctrl-P"

The default value is "Break" for line 3 of QUART and "none" for other lines.

stop_on

Parameter stop_on

Type Text string

Value

Specifies what byte sequences received over the virtual serial line must trigger HALT commandwill trigger a STOP condition. The STOP condition causes CHARON-VAX to exit.

This parameter works only for console line (for CHARON-VAX it is the only line of UART and the "line[3]" of QUART).

Specify the value as the following values: "Ctrl-P", "Break" or : “F6” or “none” ("none" to disable disables triggering HALT STOP condition).

Example:

set OPA0 breakstop_on="Ctrl-PF6"

The default value is "Break" for line 3 of QUART and "none" for other lines.

stop_on

Parameter	stop_on none".Setting "F6" triggers the STOP condition upon receipt of the "`<ESC>[17~`" sequence.

log

Parameter log

Type Text string

Value

Specifies what byte sequences received over the virtual serial line will trigger a STOP condition. The STOP condition causes CHARON-VAX to exit.

This parameter works only for console line (for CHARON-VAX it is the only line of UART and the "line[3]" of QUART).

Specify the value as the following: “F6” or “none” ("none" disables triggering 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.

log

...

A string specifying a file name to store content of console sessions or a directory where log files for each individual session will be stored.If an existing directory is specified, CHARON-VAX automatically enables creation of individual log file for each session.

If the "log" parameter is omitted CHARON-VAX does not create any console log.

Example 1:

set OPA0 log="log.txt"

Example 2:

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

log_file_size

...

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.

...

class	pagebreak

log_flush_period

...

<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

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=30A string specifying a file name to store content of console sessions or a directory where log files for each individual session will be stored.If an existing directory is specified, CHARON-VAX automatically enables creation of individual log file for each session.

If the "log" parameter is omitted CHARON-VAX does not create any console log.

Example 1:

set OPA0 log="log.txt"

Example 2:

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

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.

Div

class	pagebreak

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

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

Div

class	pagebreak

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 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-14, 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 port = 10003set 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

Example of mapping a console line to an onboard serial line

...

Versions Compared

Old Version 25

New Version 26

Key

General Description

Before build 204-13

Console

rts

dsr

Starting with build 204-13

Console

alias

rts

dsr

virtual_serial_line

host

port

application

break_on

virtual_serial_line

host

port

application

break_on

stop_on

stop_on

log

log

log_file_size

log_flush_period

log_flush_period

log_file_size

log_flush_period

log_flush_period

connection_override

access_control

Example of mapping a console line to an onboard serial line

Page Comparison

Versions Compared

Old Version 25

New Version 26

Key

General Description

Before build 204-13

Console

rts

dsr

Starting with build 204-13

Console

alias

rts

dsr

virtual_serial_line

host

port

application

break_on

virtual_serial_line

host

port

application

break_on

stop_on

stop_on

log

log

log_file_size

log_flush_period

log_flush_period

log_file_size

log_flush_period

log_flush_period

connection_override

access_control

Example of mapping a console line to an onboard serial line