Edit “local-configuration.yaml” (Linux)
Use the following procedure to update the local-configuration.yaml file generated in the /opt/flexnetls/producer directory during installation. This file contains optional settings for the license server service that are, by default, disabled.
Edit Settings in the “local-configuration.yaml” file
Use the following procedure to enable, edit, or disable settings in local-configuration.yaml file.
To edit settings in the “local-configuration.yaml’ file
| 1. | As a root or sudo user, edit the local-configuration.yaml file in an editor such gedit. Uncomment (or comment out) lines and edit setting values as needed. For a description of the settings, see the next section. |
| 2. | Run the following command to stop and restart the service to apply the configuration changes: |
sudo systemctl restart flexnetls-producer_name
Settings in the “local-configuration.yaml” File
The following settings can be edited directly in the configuration-local.yaml file. Note that a space after the colon is required for all entries.
|
Setting |
Description |
|
port: port |
The override for the listening port used by the license server, as described in Configuration Values Editable from the Command Line. You can edit this override value as needed. If no override is specified (that is, the setting is commented out), the service uses the default port 7070 (or the value defined in producer-settings.xml). |
|
active-hostid: value/type |
The hostid to use for the license server. The hostid can only be set using a configuration file if no hostid has yet been specified for the license server. Once a hostid has been set, it can only be changed using the FlexNet License Server Administrator or the FlexNet License Server Manager. The syntax is value/type (for example, 7200014f5df0/Ethernet). If no value is specified for this setting and no active hostid has yet been set for the license server, the license server uses, by default, the first available Ethernet address on the machine. If using a dongle ID or a hostid other than the first available Ethernet address, specify it here. For more information about hostids, see Understanding Hostids. Important:It is not recommended to change the hostid of a license server that has licenses mapped in the back office (FlexNet Operations). If the hostid is changed to a value that is different to that specified for the license server in the back office, any existing licenses mapped to the license server that is locked to the old hostid in the back office will be orphaned. To prevent this from happening, it is best practice to return the license server in the back office. During the return operation, the producer can transfer the licenses to a different device; this can be the same machine with the desired hostid. After the transfer, wait for the license server to synchronize with the back office (server synchronization occurs based on synchronization policies or on-demand). |
|
backup-hostid: value/type |
The hostid of the back-up license server in a failover configuration with the current license server (as the main server), if the back-up server is “unknown”—that is, not registered—in FlexNet Operations. The syntax is value/type (for example, 7200014f5df0/Ethernet). For more information about hostids, see Understanding Hostids. This setting adds the back-up server’s hostid to the capability request sent by the current license server to the back office. The back office then automatically registers the back-up server in a failover configuration with the main server. This process saves the extra step of having to manually register the failover pair in FlexNet Operations. For more information, see License Server Failover in the More About License Server Functionality. Make sure the back-up server’s hostid is the same type (for example, “ethernet”) as the hostid type of the current (main) license server. |
|
extended-suffix: suffix |
The suffix used for the Extended Host ID feature. Contact the software producer for details. |
|
server-alias: alias |
A user-defined name (sometimes called host name) for the license server. This name is added to server’s capability requests to the back office, where it is then saved and used to identify the license server in the FlexNet Operations Producer and End User portals. One important use for this setting is that the alias can be included in the initial capability request sent at server registration, providing a helpful name by which users can identify the new server in the portals. If no alias is sent at registration, the server is identified by its hostid. |
|
jni-helper-directory: path |
If the default location for the JNI shared library (/tmp) is not suitable (for example, because execute permission is required), use this setting to supply an alternative directory path. The directory has to exist and be writable by the server. |
|
logging-threshold: level |
The override for the lowest level of log-message granularity to record—FATAL, ERROR, WARN, INFO, LICENSING, POLICY, or DEBUG, as described in Configuration Values Editable from the Command Line. You can edit this override value as needed. If no override is specified (that is, the setting is commented out), the service uses the default level INFO (or the value defined in producer-settings.xml). For more information about logging levels, see section Logging Policies in Reference: License Server Policy Settings. |
|
loggingStyle: style |
The logging style determines rollover, JSON formatting and timestamp behaviour. If no logging style is specified, the default DAILY_ROLLOVER is used. Logging style values: DAILY_ROLLOVER—The log file is closed at midnight local time, compressed with gzip, and a new log file is started. Timestamp values use the local time zone. This is the default if no logging style is specified. DAILY_ROLLOVER_UTC—Same as DAILY_ROLLOVER, but with UTC timestamp. CONTINUOUS—Legacy value. Rollover is handled as DAILY_ROLLOVER. CONTINUOUS_UTC—Legacy value. Rollover is handled as DAILY_ROLLOVER_UTC. JSON_ROLLOVER—Logs are formatted using JSON. The log file is closed at midnight local time, compressed with gzip (suitable for filebeat), and a new log file is started. Always uses ISO 8601 UTC timestamps. JSON—Logs are emitted as JSON to stdout only (suitable for Docker). Always uses ISO 8601 UTC timestamps. Note:The Docker-friendly JSON logging style is not supported when the local license server is run as a Windows or Linux service (because it only writes to stdout). If set, the style will be changed to DAILY_ROLLOVER. |
|
https-in: parameters |
Parameters used to access the “server” certificate from a certificate authority (CA) to support incoming HTTPS from client devices. For details, see Incoming HTTPS in the More About License Server Functionality These parameters replace the “server” configuration file used for HTTPS in previous FlexNet Embedded license server versions. To use a “server” configuration file from a previous license server version (instead of these parameters), you need to set up a command-line option to specify the file path and name. For more information, see Define Command-Line Options for HTTPS Configuration Files. Note:The “server” configuration file is being deprecated and will be removed in a future release. |
|
https-out: parameters |
Parameters to access the truststore containing root and intermediate certificates to validate the license server’s outgoing HTTPS communication to FlexNet Operations. This setting is not required for Revenera-hosted FlexNet Operations instances. If you have the “on-premises” version of FlexNet Operations and the HTTPS server certificate has been signed by an unknown (private) certificate authority, you must define this setting. For details, see Outgoing HTTPS in the More About License Server Functionality These parameters replace the “client” configuration file used for HTTPS in previous FlexNet Embedded license server versions. To use a “client” configuration file from a previous license server version (instead of these parameters), you need to set up a command-line option to specify the file path and name. For more information, see Define Command-Line Options for HTTPS Configuration Files. Note:The “client” configuration file is being deprecated and will be removed in a future release. |
|
rate-limit: value |
The maximum number of capability requests per second that the license server will accept. By default, the local license server has no limit for the number of capability requests it will accept at a given time. However, if a license server experiences a high load of capability requests, a degradation in response time can result. This option is intended for use only in situations where this type of exceptional load is expected, as such a limit helps to enable consistent response times for accepted requests. A number of factors affect the rate at which the server is capable of handling requests, including the specification of the server hardware and the complexity of the requests. Therefore, the rate-limit value should be determined only through load-testing on a mirror of the production environment using a representative client load. If this setting is currently not included in the .yaml file, you can manually add it to the file to define the necessary rate limit. |