Skip to main content

Configuration: CODESYS Virtual Control for Linux SL

Table 3. Setting options for instances

Configuration

Value

Description

Autostart

TRUE or FALSE

Automatic start of the instance on startup/boot of the target device. The dependencies are resolved and the instances are started in the correct order.

Capabilities

Comma-separated list, for example:

cap_sys_admin, cap_sched, cap_chown, cap_ipc_lock

Permissions for the instance on the target device.

The pre-selection is needed for real-time compliance.

For Docker settings, see: Docker docs: Runtime Privilege and Linux capabilities

Dependencies

String

Comma-separated list of instances on which the current instance depends. As a result, the instances listed here are started beforehand in order to make the shared memory available. If the specified instance does not exist, then an error message is issued.

Inst_B,Inst_C

If the current instance (for example, Inst_A) is started with the Start selected command, then a warning is displayed which states that Inst_B and Inst_C also have to be started. When this is confirmed, these two instances are started first and then the Instance_A instance.

Hostname

String

Network name of the instance

The default value is the instance name.

Image

String

Image used for the instance

IPC

String

Basically, all values which are also specified in the Docker Docs for the field are allowed.

The field is validated only when the field contains the container: prefix. According to Docker Docs, this is used in order to use an existing shared memory ("join"). This shared memory has to be created on the instance named after container: using the shareable keyword. In order to make sure that the shared memory is available when the instance starts, a corresponding dependency has to be defined on the instance entered after the container: prefix.

  • shareable

  • none

  • container:Inst_first

Licenseserver

String

IP addresses of the license servers

Specified in a comma-separated list

Example: 192.168.0.1,10.0.0.1,172.17.0.2

Mounts

Comma separated list

Mounts the instance to the host.

To be specified in the syntax Host path:Instance path

Notes:

  • Paths are absolute.

  • The host path contains instance names. For default mounts (data / conf), this path must not be changed.

Network

String

Network where the instance will be mounted on the host.

See: Docker docs: network settings

Note: Only one network can be specified.

Docker networks allow containers to communicate with each other. If the configured Docker network does not exist yet, then a new one will be created. The IP address of the respective instance within this network can be configured via the Nic field.

For more information about Docker networks, see the Docker documentation.

Nic

String

Configuration of the network adapters of the target system which are exclusively assigned to an instance. This configuration is required when Ethernet-based fieldbuses should be used.

The following format is used for configuration:

<Nic>/<IP>/<network mask>,<Nic2>/<IP2>/<network mask2>,...

Multiple network adapters can be specified with a comma-separated list.

Examples:

Desired configuration

"Nic" configuration

NIC: eno1

IP: 192.168.0.100

Mask: 255.255.255.0 → /24

eno1/192.168.0.100/24

NIC: eno1

IP: -

Mask: -

NIC2: eno2

IP2: 192.168.0.100

Mask2: 255.255.248.0 → /21

eno1,eno2/102.168.0.100/21

NIC: eno1

IP: -

Mask: -

NIC2: eno2

IP2: -

Mask2: -

eno1,2eno2

Notes:

  • An adapter can be assigned to only one instance.

  • As a result, this adapter is also no longer available on the target system.

  • The IP address needs to be specified together with the corresponding network mask.

  • The network mask is specified with a suffix (example: "/24", or "/21").

  • It is not possible to assign multiple IP addresses to an adapter.

Ports

Comma-separated list, for example:

1217:1217, 8081:8080

Ports used by the runtime instance

To be specified in the syntax HostPort:InstancePort (comma-separated list)

Note: A host port cannot be assigned more than one time.

For common use cases or ports, see: CODESYS Control

Examples: Gateway 1217. Webvisu (https) 443, OPC UA 4840

Producttype

Runtime / Gateway

Type of product: Runtime or Gateway

This value cannot be changed.

Technology

Docker / Podman

Container technology used on the target system

This value cannot be changed.

Next Start in Maintenance Mode

TRUE or FALSE

Important

Only for CODESYS Virtual Edge Gateway for Linux and CODESYS Edge Gateway for Linux

This setting determines whether or not the Edge Gateway is started in maintenance mode. In this mode, a connection between the Edge Gateway and the Automation Server can be configured using the CODESYS Automation Server Connector.

Important

Use this mode only within a secure environment.

Tip

This mode is deactivated after 30 minutes, when the gateway is restarted, or after the configuration has been completed.