Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for B18302

Anchor
TopUtilPage
TopUtilPage

...

CHARON-VAX provides the following set of utilities:

 


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

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, detache 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-VAX, to release it back to the host and to manage CHARON virtual interfaces (TAPs).

mtd

Used to create CHARON tape images from physical tapes and to write tape images back to physical tapes.

CHARON Guest Utilities for OpenVMSUsed to manage virtual tapes and CHARON performance.

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

...

The first step is to obtain the name of the disk that needs to be created:

$ mkdskcmd --list

This command results in a list of all supported disk types.

Choose the desired disk (for example "RZ22"), then use the "mkdskcmd" command  to create the virtual disk image as shown below:

$ mkdskcmd --disk rz22 --output rz22.vdisk

A disk container "rz22.vdisk" will be created in the current directory.

...

To get all the available parameters please use the "–help"switch:

mkdisk for CHARON utility v. 1.14
Copyright: STROMASYS, 2015

Usage:
mkdskcmd [Options]

Options:
--help - to see help screen
-h - to see help screen

--output <full name> - to specify output file name
-o <full name> - to specify output file name

--disk <disk name> - to specify the disk name from Disk table
-d <disk name> - to specify the disk name from Disk table

--blsize <number> - to specify the block size in bytes (custom disk image)
-z <number> - to specify the block size in bytes (custom disk image)

--blcount <number> - to specify number of the blocks (custom disk image)
-c <number> - to specify number of the blocks (custom disk image)

--avtable <full_name> - to specify AVDISK table file
-a <full_name> - to specify AVDISK table file

-t - please see the '--transform' options description
--transform <source_disk_name> <source_disk_params> - to transform the the disk image (change actual size)
<source_disk_name> - the file name of the disk image to be transformed
<source_disk_params> - the name of the disk from the list of available at the Disk table
The source disk size will changed accordingly the reach the specified parameters.
To specify the transform parameters manually, follow the option below:
--transform <source_disk_name> --blsize <number> --blcount <number>

--shrink - parameter which needs to be EXPLICITLY provided, if the disk size is to be decreased
-k - parameter which needs to be EXPLICITLY provided, if the disk size is to be decreased

--list <full_name> - to display AVDISK table
-l <full_name> - to display AVDISK table

--silent - silent mode running
-s - silent mode running

Return value:
0 - for Success
Non zero - in case of failure

Examples:
mkdskcmd -h
mkdskcmd -l
mkdskcmd -a /opt/charon/utils/mkdsk.vtable -o /etc/rk07.vdisk -d rk07
mkdskcmd -o /etc/custom.vdisk -z 512 -c 16384
mkdskcmd -t /etc/rz22.vdisk rz25 -a /opt/charon/utils/mkdsk.vtable
mkdskcmd -t /etc/rz22.vdisk rz25 -a /opt/charon/utils/mkdsk.vtable -z 512 -c 262134

The "--avtable" parameter is used to work with an alternative disk specification database (or to point to the standard database ("mkdsk.vtable") if it is in a location other than the current directory).

...

An example of the syntax follows:

$ mkdskcmd --transfer <source disk file name> <source disk parameters> [--shrink] [-k]

where:

  • <source disk file name> - a file name of the disk image to be transferred

  • <source disk parameters> - the name of the disk from the list of available on "mkdskcmd --list" request or the disk geometry specification (see below).

  • --shrink or -k - used in the case when the target disk is transferred to a smaller disk.

Example:

$ mkdskcmd --transfer /etc/rz22.vdisk rz25

It is also possible to specify the disk parameters manually with "--blcount / -c" (blocks count) and "--blsize / -z" (blocks size) switches:

$ mkdskcmd --transfer <source disk file name> -blsize <number> -blcount <number>

Example:

$ mkdskcmd -t /etc/custom.vdisk -z 512 -c 262134
Warning

There is a certain delay between the moment when the utility reports that a disk image has been transferred and its actual availability to CHARON. This delay can reach to several minutes in case of very big disks transfers. It happens because the host operating systems needs some time for actual allocation of the enlarged file on HDD.

...

  • Create a CHARON tape image from a physical tape
  • Write a tape image to a physical tape.

Usage is the following:

$ mtd [options] <tape device name> <tape container name>
Div
classpagebreak

 

where the options areParameters:

...

Creates an execution log “file name”.

...

Directs to ignore bad blocks and continue processing w/o interruption. It implies "-r 0"

...

Enable verbose trace of data transfer (implies "-p")

Example:

$ mtd -l tape1.txt -r 10 /dev/st5 /charon/tapes/tape1.vtape

Use the following syntax to write the content of a tape container to a physical tape:

$ mtd <tape container name> <tape device name>

Example:

$ mtd /charon/tapes/tape1.vtape /dev/st5

Back to Table of Contents

...

MTD - CHARON Magnetic Tape Dump & Restore utility, Version 2.3 (Build 18302)
Copyright (C) 2009-2016 STROMASYS SA. All rights reserved.

Usage: mtd [options] <tape-drive-name> <file-name> - dump tape content to file
mtd <file-name> <tape-drive-name> - restore dump to tape
mtd <file-name> <file-name> - convert formats
mtd <file-name> - examine tape dump and check integrity

<tape-drive-name> - tape drive
<file-name> - name of tape container file (.mtd or .vtape)

Options:
-l <file-name> - log file name (.log)

-n - do not rewind tape
-r <number> - number of attempts to retry failing tape reads
-i - ignore failing tape reads (implies -r 0)
-p - disable progress reporting
-v - enable verbose trace of data transfer (implies -p)
-s - output tape image in SMA format
-g - gather statistics and print upon completion

Div
classpagebreak


Example:

$ mtd -l tape1.txt -r 10 /dev/st5 /charon/tapes/tape1.vtape

Use the following syntax to write the content of a tape container to a physical tape:

$ mtd <tape container name> <tape device name>

Example:

$ mtd /charon/tapes/tape1.vtape /dev/st5

Back to Table of Contents

Anchor
hasp_srm_view
hasp_srm_view
'hasp_srm_view' utility

...

  • Display the CHARON-AXP licenses details. It is possible to view all available license or some specific one.
  • Collecting license status information
  • Collecting host fingerprint information
  • Managing software license transfer procedure.

Run the utility without any options to display the license details.

# hasp_srm_view -help

CHARON Sentinel HASP utility
Copyright: STROMASYS,

2015

2016

Options:
-? or -h or -help - to see help screen

-l - to see CHARON license details (for default key)
-all - to see CHARON license details (for all available keys)
-key <key number> - to see CHARON license details (for specific key)

-c2v <C2V file> - to collect the key status information (C2V file)
-

fgp

c2v <C2V file> -key <key number> - to collect

the host fingerprint information (

C2V file

)

for specific local key
-

tfr <LicenseID> <recipient

fgp <C2V file> - to

transfer SL license (V2C

collect the host fingerprint information (C2V file)

-tfr <LicenseID> - to remove SL license (V2C file) from the local host
-idf - to get transfer recipient (ID) file "recipient.id"

The specific type of CHARON license defines what switches may be used in each The specific type of CHARON license defines what switches may be used in each case.

Collecting the "c2v" file can be done only from the CHARON host console.

...

For remote collection of status information it is recommended to use "ssh" as shown in the following examples:

# ssh root@CHARON_HOST /opt/charon/bin/hasp_srm_view -c2v /opt/charon/bin/my_hasp_key.c2v
# ssh root@CHARON_HOST /opt/charon/bin/hasp_srm_view -fgp /opt/charon/bin/my_host_fingerprint.c2v

 

To see the license text on the console:

# ssh root@localhost /opt/charon/bin/hasp_srm_view

...

To collect license text to an output file on host server:

# ssh root@localhost /opt/charon/bin/hasp_srm_view > /opt/charon/bin/hasp_srm_view.txt

The "hasp_srm_view" utility always reports the ID and IP address of the host(s) where active licenses are found.

Back to Table of Contents

Software Licenses Transfer

Software Licenses (SL) can be transferred from one host to another one with the help of "hasp_srm_view" utility and "Sentinel Admin Control Center" (ACC).

The following example demonstrates the transfer procedure.

Let's suppose a Software License must be transferred from a host "SourceHost" to a host "RecipientHost":
 

  1. Run "hasp_srm_view" utility on the "RecipientHost" with the following parameters to collect the host ID info:

    $ hasp_srm_view -idf

    The "recipient.id" file will be created in the current directory.
     

  2. Copy the "recipient.id" file to the "SourceHost".

    Info

    "recipient.id" is an ASCII file, so use the "ascii" option for FTP transfer.

           

  3. On the "SourceHost", open the "Sentinel Admin Control Center" (ACC) ( http://localhost:1947). Note the number of the software license you are going to transfer.
     

  4. Run the "hasp_srm_view" utility in the following way to create a transfer license for the host "RecipientHost":

    $ hasp_srm_view -tfr <license number> recipient.id

    The "license number" is the value collected at the step 3.

    Example of collecting a transfer license:

    $ hasp_srm_view -tfr 12345678 recipient.id

    A "<license number>.v2c" file will be created in the current directory. In the example above, the name of the transfer license will be "12345678.v2c"

    Div
    classpagebreak

     

  5. Copy the resulting "<license number>.v2c" file to the "RecipientHost".

    Info

    "<license number>.v2c" is an ASCII file, so use the "ascii" option for FTP transfer.

          

  6. On the "RecipientHost", open "Sentinel Admin Control Center" (ACC) (http://localhost:1947) and apply the "<license number>.v2c" file as  described above.

Back to Table of Contents

Software Licenses Removal

When a Software License is removed completely from a host, the license is dumped to a specific license file ".v2c". The license is not destroyed and can be re-applied if needed.

To remove a software license from a host do the following:
 

  1. Open "Sentinel Admin Control Center" (ACC) (http://localhost:1947). Note the number of the software license you are going to remove.
     

  2. Run the "hasp_srm_view" utility in the following way to remove the license:

    $ hasp_srm_view -tfr <license number>

    The "license number" is the value collected at the step 1.

    Example:

    $ hasp_srm_view -tfr 12345678

    The "<license number>.v2c" file will then be created in the current directory. In the example above the name of the transfer license will be "12345678.v2c"
     

  3. It is always possible to re-apply the created ".v2c" file to restore the deleted software license.

Back to Table of Contents

...

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

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

# hasp_update <option> [filename]

where:

ParameterValueDescription
<option>uUpdates a Sentinel protection key / attaches a detached license
iRetrieves Sentinel protection key information
dDetaches a license from a Sentinel Software License (SL) key
rRehost a license from a Sentinel Software License (SL) key
hDisplay help
[filename]Path to the V2C/H2R file (in case of 'u'pdate/attach)

Path to the C2V file
Optional: uses "stdout" if file name is not specified (in case of 'i'nfo)

Example:

# hasp_update u license_update.v2c

Info

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

...

The "ncu" ("Network Control Utility") is used to dedicate a host interface to CHARON-VAX, 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. Type "ncu" and press Enter. The following menu will appear:

# ncu
CHARON Network Configuration Utility, STROMASYS (c) 2015 Version 1.5 

...

Anchor
hasp_update
hasp_update
'hasp_update' utility

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

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

# hasp_update <option> [filename]

where:

ParameterValueDescription
<option>uUpdates a Sentinel protection key / attaches a detached license
iRetrieves Sentinel protection key information
dDetaches a license from a Sentinel Software License (SL) key
rRehost a license from a Sentinel Software License (SL) key
hDisplay help
[filename]Path to the V2C/H2R file (in case of 'u'pdate/attach)

Path to the C2V file
Optional: uses "stdout" if file name is not specified (in case of 'i'nfo)

Example:

# hasp_update u license_update.v2c

Info

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

Anchor
ncu
ncu
'ncu' utility

The "ncu" ("Network Control Utility") is used to dedicate a host interface to CHARON-VAX, 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:

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

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:

  1. Dedicate interface to CHARON
  2. Release interface to host
  3. Create a bridge between a chosen physical network interface and the Linux virtual network and create a number of virtual network interfaces 
  4. Remove the Linux virtual network and all the created virtual network interfaces 
  5. Add VLAN interface
  6. Remove VLAN interface
  7. Print status  - use it to display status of network interfaces and the menu shown above
  8. 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

Div
classpagebreak



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

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

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

select action:
1 - Dedicate to CHARON
2 - Release to host
3 - Create Bridge with TAPs
4 - Remove Bridge
5 - Print status
6 - Exit
:> 6

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 (press "1")
  • Release interface to host (press "2")
  • Create a bridge between a chosen physical network interface and the Linux virtual network and create a number of virtual network interfaces (press "3")
  • Remove the Linux virtual network and all the created virtual network interfaces (press "4")
  • Print status (press "5") - use it to display status of network interfaces and the menu shown above
  • Exit (press "6")

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

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 - Print status
6 - Exit
:> 5

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

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

 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:

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

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

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

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
6
8 - Exit

Enter "6" to return to console prompt.

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

Back to Table of Contents

Release of a host physical interface back to host

Login as root. Type "ncu" and press Enter. The following menu will appear:

# ncu
CHARON Network Configuration Utility, STROMASYS (c) 2015 Version 1.5  

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

select action:
1 - Dedicate to CHARON
2 - Release to host
3 - Create Bridge with TAPs
4 - Remove Bridge
5 - Print status
6 - 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 - Print status
6 - Exit
:> 6

Enter "6" 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 a root. Start "ncu" utility:

# ncu
CHARON Network Configuration Utility, STROMASYS (c) 2015 Version 1.5 

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

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

bridge name     bridge id        STP enabled            interfaces select action:

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

:> 3

Enter "3" to create a bridge between the host physical network adapter and the LINUX virtual network Interfaces interfaces (TAP) and specify the physical network interface ("eth1" in our example) and a the number of the virtual of virtual network Interfaces 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
6
8 - Exit


:> 5 7

 

Div
classpagebreak


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

...

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

eth0
        host            connected to host
eth1         bridge          connected to bridge
lo           host            unmanaged from host
tap0         bridge          connected to bridge
tap1         bridge          connected to bridge
           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.525400698995a  no                 tap0
                                                       tap1

select action:
1 - Dedicate to CHARON
2 - Release to host
3 - Create Bridge with TAPs
4 - Remove Bridge
5 - Print status
6 - Exit
:> E

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 "6" to quit "ncu" utility.

Back to Table of Contents

Removal of a virtual network

Login a root. Start "ncu" utility:

# ncu

CHARON Network Configuration Utility, STROMASYS (c) 2015 Version 1.5 
Interfaces   Dedicated to    State
---------- ------------ ------------
eth0       host         connected to host
eth1       bridge       connected to bridge
lo         host         unmanaged from host
tap0       bridge      connected to bridge
tap1       bridge       connected to bridge
==================================================================
bridge name bridge id STP enabled interfaces
br0_eth1       8000.525400698995a  no     tap0
tap1 

select action:
1 - Dedicate to CHARON
2 - Release to host
3 - Create Bridge with TAPs
4 - Remove Bridge
5 - Print status
6 - Exit
:> 4

Enter "4", after that specify the interface that is a bridge to the Linux virtual network on this host ("eth1" in our example) and press Enter:

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 - Print status
6 - Exit
:> 6

Enter "6" to quit "ncu" utility.

Back to Table of Contents

 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

Div
classpagebreak


Removal of a virtual network

Login a root. Start "ncu" utility:

# ncu

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

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

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

:> 5

Enter "5" then enter:

  1. The phisical interface name to be used for creating VLAN
  2. The ID of the VLAN device
  3. IP address of the VLAN device. Skip this step if no IP is required
  4. 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

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 ================================= 
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, update "SYSTARTUP_VMS.COM" file with the following line:

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

CommandDescription
$ 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 /DISABLEUnloads the OpenVMS idle loop detection software.


Back to Table of Contents


Adjusting emulator's speed

CHARON speed can be adjusted using these commands:

CommandDescription
$ CHARONCP SET SPEED /UP=<number of steps>Increase the emulator speed by the specified number of steps.
$ CHARONCP SET SPEED /DOWN=<number of steps>Decrease the emulator speed by the specified number of steps.
$ CHARONCP SET SPEED /RESETRemove all speed stepping restraints.


Back to Table of Contents

Emulator's shutdown control

It is possible to schedule CHARON to shutdown directly from OpenVMS:

CommandDescription
$ CHARONCP SET SHUTDOWN /IN=<seconds, 60 is default>

The number of seconds before the CHARON emulator is to shut down.

The value can be between 0 and 65535 (approx. 18 hours).

$ CHARONCP SET SHUTDOWN /RESETClear a scheduled shutdown.


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:


CommandDescription
$ 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:


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


(info) 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:


CommandDescription

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


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


Back to Table of Contents


Displaying version


CommandDescription
$ 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