Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Small clarifications and updates

Anchor
TOC
TOC
Include Page
KBCOMMON:KB-CSSstyle
KBCOMMON:KB-CSSstyle

...

Parameter license_key_id 

Optional parameter for HASP licenses, mandatory for VE licenses.

Insert excerpt
Initial Emulator License Configuration
Initial Emulator License Configuration
nameMutuallyExclusive
nopaneltrue

Parameter Use for HASP Licenses

There can be several license_key_id parameters in this section. They define a prioritized list of license keys. The first entry has the highest priority. If no key with this ID is available, the next key in the list will be tried. If a higher priority key becomes available, the emulator will switch to this license at the next periodic license check.

Syntax:

license_key_id "key-id-prio1"

...

Optional parameter for HASP licensing. There can be several license_id parameters in this section. They define a prioritized list of product license IDs. The first entry has the highest priority. If no key with this product license ID is available, the next product license ID in the list will be attempted. If a higher priority license becomes available, the emulator will switch to this license at the next periodic license check.

Syntax:

license_id "lic-id-prio1"

...

  • physical host interface,
  • a TAP interface connected to a virtual bridge on the host, or
  • (planned for since Charon-PAR 3.0.9) a MACVTAP interface linked to a physical NIC on the host.

Notes for TAP physical interfaces:

  • A TAP interface can either be created by the user or will be created automatically by the emulator if it does not already exist.
  • For automatically created TAP interfaces, the user can specify a name or let the emulator select a name.
  • A automatically created TAP interface is not automatically If used directly as a guest interface, offloading parameters must be turned off using the initialization command parameter in the configuration file.
  • In cloud environments, the necessary interface settings are not always reflected correctly on the cloud-provided NICs. For such installation settings a MACVTAP interface can be used to provide a dedicated connection without connecting the emulator directly to the physical interface.

Notes for TAP interfaces:

  • A TAP interface can either be created by the user or will be created automatically by the emulator if it does not already exist.
  • For automatically created TAP interfaces, the user can specify a name or let the emulator select a name.
  • A automatically created TAP interface is not automatically added to a bridge, this must be configured via the initialize_command (see the Ethernet Configuration Parameter table below).
  • An automatically created TAP interface is deleted automatically upon emulator stop.If used in a cloud environment, only internal virtual bridges (no connection to the cloud LAN) are supportedautomatically created TAP interface is deleted automatically upon emulator stop.
  • If used in a cloud environment, only internal virtual bridges (no connection to the cloud LAN) are supported.

Notes for MACVTAP interfaces:

  • Introduces a transparent bridge interface associated with on physical NIC on the host, and provides a dedicated interface to the emulator.
  • Provides an abstraction layer between physical NIC and emulator.
  • Physical interface requires no changes in the offloading configuration.
  • Fragmentation is performed by Linux on the MACVTAP interface. Jumbo frames on the physical interface will not cause problems.
  • Uses same MAC address as the physical interface.
  • Suited for associating a dedicated host Ethernet interface to the emulator in cloud environments.

Notes for network configurations on VMware:

...

ParameterValues
mapping_mode

Possible values:

  • RAW: the emulated Ethernet card is mapped to a physical interface on the Charon host that is dedicated to the Charon guest system. This setting is the default value.
  • TAP: the emulated Ethernet card is mapped to a TAP device on the Charon host. If the parameter iface is not set or the specified interface does not exist, it is created by the emulator.
  • MACVTAP: links the emulated NIC to a physical NIC on the host via an automatically configured TAP interface. Different from a  bridge, it allows using the same MAC as the host NIC when used in passthrough mode. This makes it suitable for cloud environments. MACVTAP mode is planned for requires at least Charon-PAR version 3.0.9.
  • DUMMY: presents a network interface without any actual network connectivity to the guest system. All other Ethernet parameters are ignored if this parameter is set.
    It will be set automatically, if
    • iface="dummy",
    • or iface="" and mapping_mode="RAW".
iface

Specifies the name of the host interface mapped to the emulated interface.

For mapping_mode="RAW" or "MACVTAP": this parameter must be set to an interface dedicated to the emulator.

For mapping_mode="TAP": the parameter can be

  • empty: the emulator will choose a name for the TAP interface and create it automatically at startup (and delete it when stopped).
  • name of non-existing TAP interface: the emulator will create the interface automatically at startup (and delete it when stopped).
  • name of an existing TAP interface: the emulator will use this interface.

For any mapping_mode: the value dummy will cause the emulator to present a dummy NIC to the guest system.

Upon emulator start, Charon-PAR will set a variable IFACE to contain the interface name. This variable can then be used in the initialization command to refer to the interface name.

macaddr

Can be set to override the default (same as host interface) MAC address of the interface. By default, when using if this parameter is used together with mapping_mode RAW, the interface is put into promiscuous mode, and the original MAC address of the interface is not overwritten.
If the legacy_mode is configured for the interface, it the interface is not set into promiscuous mode, and the MAC address of the corresponding host NIC is changed to the configured address. The original MAC address is restored upon emulator exit.
The format of the MAC address is: XX-XX-XX-XX-XX-XX where X is a hexadecimal number.

Please note: the above behavior is new starting with version 3.0.1 build 21.500. In older versions, when the MAC address was changed, it was not reset automatically when the emulator was stopped.

initialize_command

Command(s) to initialize the host interface for use with the Charon emulator.

  • For physical interfaces (RAW): all offload parameters active on the interface should be turned off, as shown by the example in the configuration file template.
  • For TAP interfaces: the TAP interface should be activated, if needed, and added to the appropriate bridge interface (example: "ip link set $IFACE up; ip link set $IFACE master br0"); the exact configuration depends on the customer requirements.
  • Not needed if a MACVTAP interface is used.

The variable IFACE is set by the emulator and defined automatically for the execution of the initialization command.

adapter_mode

Defines the speed and duplex settings of the interface that are reported to the guest system.

Possible values: auto, 10BaseT-HD, 10BaseT-FD, 100BaseT-HD, 100BaseT-FD
Default: 100BaseT-FD

...

Parameter (cont'd)Values
legacy_mode

New starting with version 3.0.1 build 21.500. Only applicable to mapping_mode RAW . PA64 uses a physical network adapter in promiscuous mode by default. This parameter allows to change the mode to non-promiscuouswith a manually configured MAC address.

Possible values:

  • true - non-promiscuous mode; if a custom MAC address was set, it will be set on the physical NIC during emulator operation and reset to the burned-in MAC address when the emulator stops.
  • false - promiscuous mode; if a custom MAC address was set, it will not be be set on the physical NIC (not required for the guest communication due to promiscuous mode)

Default: false

pkg_dump

Can be used to enable a packet dump to the log file.
Possible values: true or false
Default: false

rx_fifo_size

Can be used to set the size of the RX FIFO buffer (in KB). Do not change unless advised to do so by Stromasys support.
Possible values: 0, or 16 to 1024
Default: 0 = disabled

ignore_tx_start_error

Possible values: true or false
Default: true
By default, this parameter enables a workaround for DMA failures at the adapter startup. If needed, the workaround can be disabled by setting the parameter to false. Introduced by build 3.0.6-22001.

...