CHARON-AXP for Linux utilities

General description

CHARON-AXP provides the following set of utilities:

Utility	Description
mkdskcmd	Used to create CHARON virtual disk containers of custom or standard types. This utility also may be used to transfer virtual disks of one type to virtual disks of another type.
mtd	Used to create CHARON tape images from physical tapes and to write tape images back to physical tapes.
hasp_srm_view	Used to display the CHARON license contents, to collect the host system fingerprint and to transfer software licenses from one host to another.
hasp_update	Sentinel standard utility used to retrieve Sentinel protection key information, detach a license from a Sentinel SL key and rehost a license from a Sentinel SL key
ncu	Used to dedicate a host interface to CHARON-AXP, to release it back to the host and to manage CHARON virtual interfaces (TAPs).
CHARON Guest Utilities for OpenVMS	Used to manage virtual tapes and CHARON performance.

All these utilities (exept for CHARON Guest Utilities for OpenVMS) are invoked from Linux console command line.

Back to Table of Contents

Details of CHARON-AXP Utilities

'hasp_update' utility

The "hasp_update" is a Sentinel standard utility for license management included in CHARON-AXP kit.

To invoke the "hasp_update" utility login as "root" and use the following syntax:

# hasp_update <option> [filename]

where:

Parameter	Value	Description
<option>	u	Updates a Sentinel protection key / attaches a detached license
	i	Retrieves Sentinel protection key information
	d	Detaches a license from a Sentinel Software License (SL) key
	r	Rehost a license from a Sentinel Software License (SL) key
	h	Display help
[filename]		Path to the V2C/H2R file when used with the 'u' option
[filename]		Optional path to the C2V file when used with the 'i' option Uses "stdout" if file name is not specified

Example:

# hasp_update u license_update.v2c

We recommend to use this tool only for "Update a Sentinel protection key / attach a detached license" function ("u" option). For the rest use "hasp_srm_view" utility.

Back to Table of Contents

'ncu' utility

The "ncu" ("Network Control Utility") is used to dedicate a host interface to CHARON-AXP, to release it back to the host and to manage CHARON virtual interfaces (TAPs).

The utility allocates chosen network interfaces (both physical and virtual) and configures the offload parameters.

Dedication of a host physical interface to CHARON

Login as root and enter "ncu". The following menu will appear:

Interfaces Dedicated to State
---------- ------------ ------------
eth0 host         connected to host
eth1       host         connected from host
lo         host         unmanaged from host

================================================================= 
bridge name        bridge id         STP enabled       interfaces 
========================== VLAN ================================= 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 8

The utility lists available network interfaces (both physical and virtual) and indicates whether they are dedicated to the host or to CHARON and whether they are currently in use by host operating system.

"ncu" offers several options:

Dedicate interface to CHARON
Release interface to host
Create a bridge between a chosen physical network interface and the Linux virtual network and create a number of virtual network interfaces
Remove the Linux virtual network and all the created virtual network interfaces
Add VLAN interface
Remove VLAN interface
Print status - use it to display status of network interfaces and the menu shown above
Exit

In the example above we see 2 network interfaces - "eth0" and "eth1", both of them are dedicated to host, but host uses only the interface "eth0".

Let's dedicate the interface "eth1" to CHARON-AXP.

Enter "1", then type "eth1" and press Enter:

Specify the interface to dedicate to CHARON:eth1
Turning off offloading for eth1.. Please wait

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 7

Now the interface "eth1" is dedicated to CHARON-AXP:

Interfaces Dedicated to State
---------- ------------ ------------
eth0       host         connected to host
eth1       CHARON       disconnected from host
lo         host         unmanaged from host

================================================================= 
bridge name            bridge id         STP enabled     interfaces 
========================== VLAN ================================= 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

Enter "8" to return to console prompt.

Now "eth1" can be used by CHARON-AXP.

Back to Table of Contents

Release of a host physical interface back to host

Login as root and enter "ncu". The following menu will appear:

Interfaces Dedicated to State
---------- ------------ ------------
eth0       host         connected to host
eth1       CHARON       disconnected from host
lo         host         unmanaged from host

================================================================= 
bridge name           bridge id          STP enabled      interfaces 
========================== VLAN ================================= 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 2

Let's say that we want to return the interface "eth1" (currently dedicated to CHARON) back to host. To do that enter "2" then "eth1":

Specify the interface to release to HOST:eth1
Connection successfully activated (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/3)

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 8

Enter "8" to quit the "ncu" utility.

The interface "eth1" is released back to host system now.

Back to Table of Contents

Creation of a virtual network

Login as root and enter "ncu":

# ncu
CHARON Network Configuration Utility, STROMASYS (c) 2016 Version 1.6

Interfaces Dedicated to State
---------- ------------ ------------
eth0       host         connected to host
eth1       host         connected to host
lo         host         unmanaged from host

================================================================= 
bridge name         bridge id          STP enabled      interfaces 
========================== VLAN ================================= 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 3

Enter "3" to create a bridge between the host physical network adapter and the LINUX virtual network interfaces (TAP) and specify the physical network interface ("eth1" in our example) and the number of virtual network interfaces to be created (2 in our example):

Specify the interface to be used for BRIDGE:eth1
How many tap should be created:2
Forming the bridge: ..1..2..3..4..5.. addif tap0 .. addif tap1 ..7..8 done!
Formed bridge br0_eth1 attached over eth1...

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 7

Now enter "7" to see the created virtual interfaces:

Interfaces Dedicated to State
---------- ------------ ------------

eth0           host            connected to host 
eth1           bridge          connected to bridge 
lo             host            unmanaged from host 
tap0           CHARON          connected to host 
tap1           bridge          connected to bridge 
================================================================= 
bridge name         bridge id           STP enabled         interfaces 
br0_eth1            8000.768e1ea091d9   no                  eth1 
                                                            tap0 
                                                            tap1 
========================== VLAN ================================= 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 8

In the example above we see 2 virtual network Interfaces "tap0" and "tap1" connected to the created bridge. The physical network interface "eth1" is used for the bridge to the virtual network interfaces.

The interfaces "tap0" and "tap1" are ready to be used in CHARON configurations - they do not need to be additionally dedicated to CHARON.

Enter "8" to quit "ncu" utility.

Back to Table of Contents

Removal of a virtual network

Login a root. Start "ncu" utility:

# ncu

Interfaces Dedicated to State ---------- ------------ ------------

eth0           host            connected to host 
eth1           bridge          connected to bridge 
lo             host            unmanaged from host 
tap0           CHARON          connected to host 
tap1           bridge          connected to bridge 
================================================================= 
bridge name         bridge id           STP enabled         interfaces 
br0_eth1            8000.768e1ea091d9   no                  eth1 
                                                            tap0 
                                                            tap1 
========================== VLAN ================================= 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 4

Enter "4" then enter the interface name that is a bridge to the Linux virtual network on this host ("eth1" in our example):

Specify the phys interface used for BRIDGE:eth1
Cleanup bridge br0_eth1 with ip over eth1...
Removing the bridge: ..1..2 delif eth1
delif tap0
delif tap1
..5..6..7..8 done!

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 8

Enter "8" to quit "ncu" utility.

Back to Table of Contents

Adding VLAN interface

Login a root. Start "ncu" utility:

# ncu

Interfaces Dedicated to State ---------- ------------ ------------

eth0       host         connected to host
eth1       host         connected to host
lo         host         unmanaged from host

================================================================= 
bridge name         bridge id          STP enabled      interfaces 
========================== VLAN ================================= 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 5

Enter "5" then enter:

The phisical interface name to be used for creating VLAN
The ID of the VLAN device
IP address of the VLAN device. Skip this step if no IP is required
Network mask of the VLAN device. Enter for no network mask.

Specify the phys interface used for VLAN:eth1 
Specify the id of VLAN device (<4095):111 
Specify the ip address of VLAN device or empty string for no ip address: 192.168.1.100
Specify the netmask address of VLAN device or empty string for no netmask: 225.225.225.0

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 8

Enter "8" to quit "ncu" utility.

Back to Table of Contents

Removing VLAN interface

Login a root. Start "ncu" utility:

# ncu

Interfaces Dedicated to State ---------- ------------ ------------

eth0       host         connected to host
eth1       host         connected to host
lo         host         unmanaged from host

================================================================= 
bridge name         bridge id          STP enabled      interfaces

========================== VLAN ================================= 
eth1.111 
=================================================================

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 6

Enter "6" then enter the VLAN interface for remove:

Specify the VLAN interface, which be removed: eth1.111
Removed VLAN -:eth1.111:-

select action:

1 - Dedicate to CHARON 
2 - Release to host 
3 - Create Bridge with TAPs 
4 - Remove Bridge 
5 - Add VLAN 
6 - Remove VLAN 
7 - Print status 
8 - Exit

:> 8

Enter "8" to quit "ncu" utility.

Back to Table of Contents

CHARON Guest Utilities for OpenVMS

The "CHARON Guest Utilities for OpenVMS" (CHARONCP) package contains several utilities for managing virtual tapes, changing the emulator speed and creating useful definitions for that operations.

This set of utilities is located in the "charoncp011.vdisk" disk file in the "/opt/charon/disks".

Back to Table of Contents

Installation

Specify this image in the CHARON configuration file, boot from the system disk and mount the disk with the following OpenVMS command:

$ MOUNT <device name> /OVERRIDE=IDENTIFICATION

Issue the following commands to install the package:

$ @SYS$UPDATE:VMSINSTAL

* Are you satisfied with the backup of your system disk [YES]? YES
* Where will the distribution volumes be mounted: <device name>:[000000.CHARONCP011.KIT]

Enter the products to be processed from the first distribution volume set.
* Products: CHARONCP011

Select all the components included to the package:

Component Selection

Select the CHARONCP components you wish to install from the menu below.
An asterisk appears next to the packages that have already been
selected. You can remove a package from the list by selecting it
again. You may enter more than one selection by separating your
choices with commas.

1. [*] CHARONCP Guest Utility (REQUIRED)
2. [*] Compatability Utilities
3. [*] Install DCL Commands & Help

4. Exit

* Your choice [4]: 4

Proceed with installation using all the default options.

Once the installation is completed, add the following line to the "SYS$STARTUP:SYSTARTUP_VMS.COM" ("SYS$STARTUP:SYSTARTUP_V5.COM" for VMS 5.5) file for the package to be loaded automatically at system startup:

$ @SYS$STARTUP:CHARONCP_STARTUP

After that the package will be loaded automatically on startup.

Back to Table of Contents

Performance optimization

CHARON takes 100% of host CPU even in case of idle state of guest OpenVMS operating system. To get rid of such resources consumption there is a specific option provided by CHARON Guest Utilities - "idle" mode.

Command	Description
$ CHARONCP SET IDLE /ENABLE	Loads the OpenVMS idle loop detection software. This allows CHARON to detect when the emulated CPU(s) are idle and use the host power saving instructions to reduce power usage.
$ CHARONCP SET IDLE /DISABLE	Unloads the OpenVMS idle loop detection software.

Back to Table of Contents

Virtual tapes management

Specify mapping to tape container in the following way in the CHARON configuration file:

set <adapter name> container[<unit name>] = ".vtape" removable[<unit name>] = true

Example:

set PKA container[600] = ".vtape" removable[600] = true

Once it is done using the following commands it is possible to manage virtual tapes attached to CHARON:

Command Description

$ CHARONCP SET MAGTAPE <device> /LOAD="<filename>.vtape"

Create the specified host-file (if it does not already exist) and attach it to the specified virtual tape device.

Example:

$ CHARONCP SET MAGTAPE MKA600: /LOAD="backup_01.vtape"

$ CHARONCP SET MAGTAPE <device> /UNLOAD

Detach any file currently attached to te specified virtual tape device.

Example:

$ CHARONCP SET MAGTAPE MKA600: /UNLOAD

Possible errors:

Error

Description

BADFILENAME

The filename specified as a value to the qualifier /LOAD was either too long or does not have a file extension of ".vtape".

DEVNOTDISM

Attempting to execute a SET MAGTAPE/LOAD when a file is already attached.

Perform a SET MAGTAPE/UNLOAD first. If a SET MAGTAPE/LOAD command has not previously been executed, then the CHARON configuration container specification for the tape device may contain a full path. Doing this will create and attach and initial tape container file. To avoid this, remove the file name from the specification (leaving only a fileextension of ".vtape" and optional directory).

If some tape container has been already specified in the CHARON configuratioon file use the command "CHARONCP SET MAGTAPE <device> /UNLOAD" to unload it first.

Back to Table of Contents

Defining keys

It is possible to define certain keys on the terminal keyboard for fast access to the CHARONCP functionalilty while you are in CHARONCP:

Command Description

$ CHARONCP
CHARONCP> DEFINE /KEY <key-name> <equivalence-string>

Defines an equivalence string and a set of attributes with a key on the terminal keyboard.

You can have a set of keys defined automatically for use with the CHARONCP utility by placing DEFINE/KEY commands in the file SYS$LOGIN:CHARONCP_KEYDEFS.INI

Example:

$CHARONCP
CHARONCP> DEFINE /KEY F1 "SET MAGTAPE MKA600: /UNLOAD"

$ CHARONCP
CHARONCP> SHOW KEY <key-name>

Displays key definitions created with the DEFINE/KEY command. Refer to the DCL help entry for SHOW KEY for further information.

Example:

$CHARONCP
CHARONCP> SHOW KEY F1
DEFAULT key state definitions:
F1 = "set magtape mka600: /unload"
CHARONCP>

For more information refer to the OpenVMS DCL Dictionary (DEFINE/KEY section).

Back to Table of Contents

Displaying version

Command Description

$ CHARONCP SHOW VERSION

Displays the CHARONCP package version number and architecture. This can be useful for customers reporting issues with the CHARONCP software.

Example:

$ CHARONCP SHOW VERSION

CHARONCP version id is: V1.1

Back to Table of Contents