Technical part

Scripts and files description

All scripts and files are located in the /opt/charon/utils folder except for .charon* files. The "Custom" column below indicates the file will not be overwritten with new kit installation/upgrade.

Greyed cells represent obsolete files that could be present if you upgrade from a previous kit

File	Type	Description
`charon_check.alertcmd`	Shell script	Common script file used for alerts. If it does not exist, it is cloned from the example file (see below)
`charon_check.alertcmd.example`	Shell script	Example of common script file used for alerts. By default alerts are ‘wall’ and ‘mailx’ based
`charon_check.mailfooter`	Data file	Contains the mail footer used to send email alerts (see above)
`charon_check.mailto`	Data file	Contains the mail recipients list used to send email alerts (see above)
`charon_common`	Shell script	Script file including common variables and functions
`charon_common_menu`	Shell script	Script file including common variables and functions for menus
`charon_console_autoconnect`	Shell script	Script executed in the crontab file to connect to the guests console if no user is already connected, records all console output
`charon_expchk`	Shell script	License expiration check or key reading check with ‘-nomail’ parameter
`charon_gstart`	Shell script	Manages start/stop of the guests, defined as a service
`charon_gstart.boot`	Data file	Contains the guests list for start/stop: HW emulator and configuration file
`charon_gstart.chkrun`	Shell script	Optional script, user made, used to display status of the guest by the guest start menu (charon_menu_gstart)
`charon_gstart.chkrun.example`	Shell script	Example for the one one above
`charon_gstart.stop`	Shell script	Optional script that enables the customer to insert proper guests shutdown commands (based on ‘ssh’ or ‘expect’ tool for example). This script is generated on user request.
`charon_gstart.stop.example`	Shell script	Example for the script above including ‘ssh’ and ‘expect’ usage for VMS and Tru64 operating systems.
`charon_licenses.list`	Data file	Optional file that contains the list of licenses (number), their description and a display color code
`charon_linux_toolkit.Vxx.tar`	Tar file	Contains the full Linux Toolkit package where "xx" represents the kit number (starting with kit number 41)
`charon_linux_utils.kitxx.tar`	Tar file	Contains the full Linux utils kit where "xx" represents the kit number (kits number 40 and below)
`CHARON_Linux_Toolkit_UG.pdf`	Document	Toolkit users guide, PDF format (starting with kit number 41)
`charon_linux_utils.pdf`	Document	Utilities users guide, PDF format (kits number 40 and below)
`charon_logarchive`	Shell script	Manage services and guests console logs archiving
`charon_logchk`	Shell script	Manages guests log monitoring, defined as a service
`charon_logchk.list`	Data file	Contains the list of guests log files to monitor
`charon_logevent`	Shell script	Check for new events in the guests log files and sends alerts depending on the selected level
`charon_menu_alertsmgr`	Shell script	Menu: Alerts management
`charon_menu_alertcmd`	Shell script	Menu: alert script editing (kits number 40 and below)
`charon_menu_alert.dat`	Data file	Contains the options list for the alerts menu (kits number 40 and below)
`charon_menu_c2v`	Shell script	Menu: creates and send C2V file
`charon_menu_console`	Shell script	Menu: connection to guest console
`charon_menu_cron`	Shell script	Menu: edit crontab for license expiration check
`charon_menudoc.dat`	Data file	Contains the options list for the Documentation submenu
`charon_menu_editcfg`	Shell script	Menu: edit guests configuration file
`charon_menu_gstart`	Shell script	Menu: guests start/stop management, install service, edit guests list, etc…
`charon_menu_hostinfo`	Shell script	Menu: host information report management
`charon_menuhostinfo.dat`	Data file	Contains the options list for the Host information submenu
`charon_menu_logchk`	Shell script	Menu: guests log monitoring management
`charon_menu_logevent`	Shell script	Menu: selection for the of guests logs alert level (kits number 40 and below)
`charon_menu_mailfooter`	Shell script	Menu: customize alerts email footer (kits number 40 and below)
`charon_menu_mailmode`	Shell script	Menu: selection of the alert emails mode, HTML or pure TEXT (kits number 40 and below)
`charon_menu_mailto`	Shell script	Menu: mail recipients list management (kits number 40 and below)
`charon_menu_ncu`	Shell script	Menu: check if '`ncu`' is installed and execute it
`charon_menumain.dat`	Data file	Contains the options list for the main menu
`charon_menu_sendlogs`	Shell script	Menu: send configuration and log files via email
`charon_menu_showlic`	Shell script	Menu: show license content
`charon_menu_v2c`	Shell script	Menu: Install or Update (apply V2C file)
`charon_menu_walloff`	Shell script	Menu: enable/disable alert wall messages (kits number 40 and below)
`charon_mongstop`	Shell script	Monitors abnormal termination of the services (guests)
`charon_setup`	Shell script	Charon installation/upgrade/remove script
`charon_showhostinfo`	Shell script	Gather Charon server information
`events`	Folder	Contains the events found in guests log files that will be sent via mail. Contains only events detected since last charon_logevent script execution (crontab)
`fixgedit`	Shell script	Prevents from gedit command to display garbage messages. Execute this script before like this: # . /opt/charon/utils/fixgedit
`guest_shutdown.exp`	Expect script	This ‘expect’ script contains sequence for Tru64 and VMS shutdown. See explanation in the Tips and Tricks chapter
`haspruntime.errorcodes`	Data file	With the introduction of new ERROR message in the log file (code 000003E8), this file is used to translate the HASP runtime error code number to text.
`kit.version`	Data file	Contains kit version and release date (updated by the maketar script below)
`menu_mod.pl`	Perl script	Menu display based on data file
`menusetup`	Shell script	Kit installation script, setup the ‘menu’ command
`MyTput.pm`	Perl module	Contains enhanced display commands used by `menu_mod.pl`
`pluto.cfg.example`	Data file	Configuration file used for guests tests
`release-notes`	Text file	Release notes
`requests`	Folder	Contains flag files that determines the guest has been stopped properly (requested stop). If the guest is stopped and the file does not exist, it indicates an abnormal termination of the guest Flag files are empty and have the following name: configuration file name + ".stop" (example: `pluto.cfg.stop`)
`ssh-linux-openvms-setup.readme`	Text file	Tips on how to create ssh trust between Linux and Openvms
`ssh-linux-tru64-setup.readme`	Text file	Tips on how to create ssh trust between Linux and Tru64
`templates`	Folder	Contains templates used to send alerts via ‘`mailx`’ and ‘`wall`’ + templates to create '`systemd`' services
`$HOME/.charon.autoconnect`	Data file	Console autoconnect enabled (contains 1) or disabled (contains 0)
`$HOME/.charonconslogdir`	Data file	Location for the console log file can be changed by placing the desired folder name in this file. Default is /opt/charon/log folder if this file is not created
`$HOME/.charonkitfolder`	Data file	Contains the Charon kit location provided at installation
`$HOME/.charon.lastrecipient`	Data file	Contains the last email recipient used for the above options in order to prevent from typing again the email address
`$HOME/.charonlogevent`	Data file	Contains the alert level selected for guests log files events
`$HOME/.charonmailmode`	Data file	Contains mail mode used to send email alerts, either HTML (default if the file does not exist) or TEXT. Used by charon_check.alertcmd script
`$HOME/.charonsoftlicfolder`	Data file	Contains the software license kit location (where the dinst and dunst script files are located)
`$HOME/.charon.recipient`	Data file	Contains the email recipient selected when sending hasp_srm_view output, C2V file or host information html report
`$HOME/.charonwalloff`	Data file	Exists if the "wall" message are disabled
`$HOME/.charon.expchk.nodongle`	Data file	Exists if the expiration check script has detected the absence of the dongle. This is to prevent from sending expiration alert messages if no dongle is present (the alert will be sent only once)
`$HOME/.charonlicfolder`	Data file	Contains the folder name where all the license files, C2V and V2C, are located

Notes:

Menu data files format is detailed using the following command:

# /opt/charon/utils/menu_mod.pl -fd

Manual services management

Request	Command
Request	Linux distribution without `systemd` (Red Hat Enterprise Linux 6)	Linux distribution using `systemd` (Red Hat Enterprise Linux 7 and Fedora)
Services list	`# chkconfig –list \| grep ^Charon` There are 2 services that can be installed: `charon_gstart`: guests start/stop `charon_logchk`: log monitoring	`# systemctl \| grep ^charon` Typically there is: one service for dongle connection/disconnection monitoring (`charon_monusb`) 2 services per guest (virtual machine), one for the emulator itself and one for the log monitoring
Disabling service start at boot	`# chkconfig <service> off`	`# systemctl disable <service>` It is not recommended to use command line to do so, please use menu option 7
Enabling service start at boot	`# chkconfig <service> on`	`# systemctl enable <service>` It is not recommended to use command line to do so, please use menu option 7
Start or Stop service	`# service <service> start` `# service <service> stop` Without supplemental parameter, all guests or logs monitoring are stopped To stop a dedicated guest, add the configuration file name To stop a dedicated log file monitoring, add the log file name Files can be truncated to their name only, directory and extension will be automatically completed Example: `# service charon_gstart stop pluto` `# service charon_gstart stop /opt/charon/cfg/pluto.cfg`	`# systemctl start <service>` `# systemctl stop <service>` Example: `# systemctl start charon_pluto`
Service status	`# service <service> status`	`# systemctl status <service>` Use of the following options is recommended: "`-l --lines=xx`" where "xx" is the number of lines from the journal to show, counting the most recent ones.
Service removal	`# chkconfig –del <service>`	First disable the service: `# systemctl disable <service>` then remove (optional) the associated service file: `# rm /etc/systemd/system/<service>.service` Example: `# systemctl disable` `charon_pluto` `# systemctl disable` `charon_logmon_pluto` `# rm /etc/systemd/system/charon_pluto.service` `# rm /etc/systemd/system/``charon_logmon_pluto``.service` It is not recommended to use command line to do so, please use menu option 6

CHARON Linux Toolkit - Kit 42-43

Technical part

Table of contents

Scripts and files description

Manual services management