Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The information on this page refers to LM-X version v66.0 and newer, which implemented YAML configuration. As of LM-X v6.0, legacy configuration files from LM-X versions prior to v6.0 will no longer work (see the note below on migrating your old configuration file to the new YAML format). If you are using a version of LM-X older than LM-X v6.0, please see documentation for older versions 


Note

By default, a new YAML configuration file will be created automatically after installing and running v6.0 or newer.

As of v6.0, legacy configuration files from LM-X versions prior to v6.0 will no longer work. If you use If you have an existing configuration file , it from an older version when you start up the license server in v6.0 or newer, the configuration file will be migrated to the new YAML format.

when you install LM-X version 6.0 or newer. The old configuration file does not include settings for the web server used to run the new new LM-X License Server UI. To enable the web server and access the LM-X License Server UI, you must manually add the following lines to the newly migrated configuration file:

web_server:

  tcp_listen_port: 6199

After adding these lines to the configuration file and restarting the LM-X server, you can access the LM-X License Server UI at  at https://URL:6199.

This page details all LM-X license server configuration settings, their valid values, and required YAML syntax.  

...

Info

Note the following:

  • Configuration Changes: All settings can be modified either directly in the configuration file or by using the LM-X License Server UI. However, any changes will only be applied after a restart of the license server.

  • Admin User Management: The web server configuration must include an admin user. If the admin user is missing in the configuration, it will be automatically recreated using the default password admin.  This This default password can be changed later using the LM-X License Server UI.

  • YAML Syntax: As of LM-X License Manager v6.0, the LM-X license server configuration is defined using YAML. Ensure you use proper YAML formatting, including indentation and case sensitivity for keys. Incorrect syntax may lead to configuration errors or server misbehavior. To avoid errors, using the LM-X License Server UI is recommended.

Anchor
lic serverlicserverlic server
licserver
License server settings

The license_server settings configure the TCP port and bind addresses for the license server. The license_server settings are detailed below. 

...

  • Description: Restricts client connections to specific networks. When defined, the server accepts connections only from clients whose IP addresses match the provided values.
  • Example syntax:
    tcp_bind_address:
      ipv4: '192.168.21.123'
      ipv6: '8000:8000:8000:8000:abcd:1234:12df:fd54'
    
  • Note: If not specified, connections from all networks are accepted.

...

Example syntax:

hal:
  master:
    host: "'server1"'
    port: 6200
  slave1:
    host: "'server2"'
    port: 6200
  slave2:
    host: "'server3"'
    port: 6200

Important: The HAL server list must be identical across all servers for proper operation. For more details, refer to the LM-X End Users Guide on High Availability Licensing.

...

  • Description: Path to the pay-per-use usage database.
  • Syntax: String indicating the database file location.
  • Example: "'/var/ppu.db"'

format:

  • Description: Determines the level of detail recorded.
  • Valid values:
    • normal (basic usage information)
    • extended (includes additional user information)

...

Example syntax:

pay_per_use:
  path: "'/var/ppu.db"'
  format: normal
  write_interval: 1000
  anonymization: true

...

  • Valid values:
    • A list of feature identifiers.
  • Example syntax:
    fast_queue:
      - "f1"
      - "f2"
      - "f3"

Anchor
web server
web server
Web Server Configuration settings

...

  • Description: A mapping of user credentials required for accessing the UI.
  • Mandatory Admin User:
    • An admin user must exist for the UI to function.
    • Behavior: If the admin user is missing from the configuration, it will be automatically recreated with the default password "admin". This password can be changed via the the LM-X License Server UI.
  • Example syntax:
    web_server:
      tcp_listen_port: 6199
      users:
        admin:
          password: '$argon2id$v=19$m=65536,t=3,p=4$PVbKB+ekhE0ZBJ/2z1ggwQ==$+PjvNqhTnRlCxtApKJqq6kFYfPlR5QFVaXN5jEaT5t4='
          role: admin

Anchor
groups
groups
Group settings

...

  • Usage:
    Define groups that can later be referenced in access rules.
  • Example syntax:
    groups:
      admins:
        - "'admin1"'
        - "'admin2"'
      users:
        - "'user1"'
      limited_users:
        - "'userA"'
      ip_address_blacklist:
        - "'1.2.3.4"'
        - "'1.2.*.*"'
      banned_users:
        - "'baduser1"'
        - "'baduser2"'

Anchor
checkout
checkout
License Checkout Access Rule settings

...

  • Description:
    A list of rules evaluated in order. If no rule matches, the client is allowed by default.
  • Rule Properties:
    • feature: Specify the license feature (use "'*"' for all features).
    • allow or deny: Define lists of users, hosts, or ip_addresses.

...

checkout:
  access:
    - feature: "'f1"'
      allow:
        users:
          - "'bob"'
          - "'alice"'
    - feature: "'f2"'
      allow:
        hosts:
          - "'localhost"'
        users:
          - "'bob"'
          - "'alice"'
        ip_addresses:
          - "'1.1.*.*"'
    - feature: "'*"'
      deny:
        users:
          - "'bob"'
          - "'alice"'
  limit:
    - feature: "'f1"'
      count: 6
      users:
        - "'limited_users"'
    - feature: "'f3"'
      count: 3
      hosts:
        - "'host666"'
    - feature: "'*"'
      count: 1
      ip_addresses:
        - "'123.123.123.123"'
  reserve:
    - feature: "'f1"'
      count: 5
      users:
        - "'bob"'
        - "'alice"'
    - feature: "'f16"'
      count: 10
      hosts:
        - "'localhost"'

Anchor
borrow
borrow
License Borrow Access Rule settings

...

borrow:
  access:
    - feature: "'f1"'
      allow:
        users:
          - "'bob"'
          - "'alice"'
    - feature: "'f2"'
      allow:
        hosts:
          - "'localhost"'
        ip_addresses:
          - "'1.1.*.*"'
    - feature: "'*"'
      allow:
        users:
          - "'test"'
    - feature: "'f3"'
      deny:
        users:
          - "'bob"'
          - "'alice"'
  limit:
    - feature: "'f5"'
      hours: 3
    - feature: "'f1"'
      count: 6
      ignore:
        users:
          - "'bob"'
    - feature: "'f3"'
      hours: 3
      ignore:
        hosts:
          - "'host666"'
    - feature: "'*"'
      count: 1
      ignore:
        ip_addresses:
          - "'123.123.123.123"'

Anchor
licenses
licenses
License file settings

The licenses settings define where the license server searches for license files and optionally let you embed license data within the configuration.

...