# Avantra Server Configuration

You can configure the Avantra server runtime environment by setting the values for a number of parameters. Some of the parameters can be adjusted while the server is running and others require a restart. If there is a icon beside the parameter you need to restart the Avantra server service before changes will take effect.

To adjust Server parameters:

1. Select Administration Settings from the top-level menu.

   Choose Avantra Master.

2. Click on and change the value or on to restore the default.

3. Push the Save button.

## Server Parameters

### Automation.AutomationThreads

Sets the maximum number of worker threads that can be used from the Avantra automation engine.

Default Value

  `10`

Unit

  Integer

### DB Clean Up Service.CcmsAlertKeepdays

Defines how long to keep CCMS Alerts in the Avantra Database.

Default Value

  `60`

Unit

  Days

### DB Clean Up Service.DAILY_CHECK_KEEPTIME

Defines how long to keep Daily Checks in the Avantra Database. `0` means forever. Please be aware that the unit is months.

Default Value

  `0`

Unit

  Months

### DB Clean Up Service.KeepAbortedMessagesForNDays

Defines how long aborted Notification messages are kept in the Avantra Database.

Default Value

  `3`

Unit

  Days

### DB Clean Up Service.KeepOkBlockedMessagesForNDays

Defines how long blocked OK Notification messages are kept in the database.

Default Value

  `3`

Unit

  Days

### DB Clean Up Service.KeepOkSentMessagesForNDays

Defines how long sent OK Notification messages are kept in the database.

Default Value

  `3`

Unit

  Days

### DB Clean Up Service.KeepUnprocessedMessagesForNHours

Defines how long unprocessed Notification messages are kept in the Avantra Database.

Default Value

  `6`

Unit

  Hours

### DB Clean Up Service.LOGBOOK_KEEPTIME

Defines how long logbook entries are kept in the Avantra Database.

Default Value

  `24`

Unit

  Months

### DB Clean Up Service.RTM_HISTORY_KEEPTIME

Defines how long RealTime Monitoring history records are kept in the Avantra Database.

Default Value

  `60`

Unit

  Days

### DB Clean Up Service.UPDATE_LOG_KEEP_DAYS

Defines the maximum age of Agent Self Updates log records to keep.

Default Value

  `60`

Unit

  Days

### ForceAuditComment

Makes a comment for Start/Stop/Restart actions a mandatory action. The comment field is always visible on Start/Stop actions and is blank by default. Entering text (not less than 5 characters) is mandatory to start the action.

Possible values are: `OFF`: comment field is available, but entering a comment is optional `ON`: entering a comment is mandatory to perform the action

Default Value

  OFF

### global.AGENTLISTENERPORT

Defines the default TCP port of the Avantra Agent to which the Avantra Server tries to connect unless an AgentListenerPort is defined.

Default Value

  `9051`

Unit

  Number

### global.log-level

Defines the level of messages to be logged in Avantra Server `master.log*` files in `C:\Program Files\syslink\master\log` (on Microsoft Windows operating systems) or `/syslink/master/log` (on Unix-like operating systems

Default Value

  `INFO`

Unit

  Enum

### Gateway.tunnels

Defines tunnels to avantra-gateways in order to establish reverse connections.

Default Value

  empty

Unit

  String of format: `'{' id 1 ';' url 1 '}' '{' id 2 ';' url 2 '}'…​ ` . The `URL` has the format like the one described in AgentConnectRoute.

  See also the description of Gateway.tunnels

### Mail.charset

Configures the default character set for the encoding used in the Mail Service.

Default Value

  empty

Unit

  String

### Mail.connect-timeout

Configures the connection timeout used in the Mail Service.

Default Value

  20000

Unit

  Milliseconds

### Mail.from

Configures the default sender address used in the Mail Service.

Default Value

  empty

Unit

  String

### Mail.host

Configures the default SMTP server hostname or IP address used in the Mail Service.

Default Value

  empty

Unit

  String

### Mail.port

Configures the default SMTP server port used in the Mail Service.

Default Value

  25

Unit

  Number

### Mail.send-separately

Configures the Mail Service: If set to `true`, emails to multiple recipients are sent as separate emails instead of one email being sent to multiple recipients.

Default Value

  `false`

Unit

  Booelan

### Mail.ssl

Configures the Mail Service to use SMTP over SSL.

Default Value

  `false`

Unit

  Booelan

### Mail.ssl-port

Configures the port to which the Mail service connects if Mail.ssl is set.

Default Value

  465

Unit

  Number

### Mail.suppress-names

Configures the Mail Service to suppress names in the `FROM` and `To` field. In other words, if set to `true`, only the email address is included.

Default Value

  `false`

Unit

  Boolean

### Mail.timeout

Configures the socket timeout used in the Mail Service.

Default Value

  20000

Unit

  Milliseconds

### Mail.tls

Configures Avantra Server’s Mail Service to use STARTTSL with SMTP.

Default Value

  false

Unit

  Booelan

### Mail.use-cc

Configures the Mail Service to add only the first recipient to the `TO` field and all others to the `CC` field.

Default Value

  false

Unit

  Booelan

### Mail.user

Configures the user name used by the Mail Service for authentication.

Default Value

  empty

Unit

  String

### Mail.password

Configures the password for Mail.user.

Default Value

  empty

Unit

  String

### MaintenanceWindowManager.NumberOfDaysToKeepMtnwHistory

Defines the number of days that old Maintenance Window history records are kept. History records are used internally only. This setting does not affect the Maintenance Windows themselves!

Default Value

  60

Unit

  Days

### MasterWorker.enable-masterworker-2

Enable a third worker for the Avantra Server

| Do not change this setting unless instructed by the Avantra support!

Default Value

  false

Unit

  Boolean

### MasterWorker.enable-masterworker-3

Enable a fourth worker for the Avantra Server

| Do not change this setting unless instructed by the Avantra support!

Default Value

  false

Unit

  Boolean

### MasterWorker.max-queue-size

Defines the length of the communication queue between the Avantra Server and its workers.

| Do not change this setting unless instructed by the Avantra support!

Default Value

  200

Unit

  Number

### Max.steps-triggered-per-minute

Defines how many steps can be started simultaneously per minute.

| Depending on the resources available to the Avantra servers, the default number of maximum steps executed per minute may be too high or too low. If you experience issues starting many workflows, lower the parameter value.

Default Value

  60

Unit

  Number

### Network.bind-address

Defines the IP Address for the Avantra Server to listen to. The default is `0.0.0.0` in case of which the Avantra Server will listen on all available IP addresses of the host.

Default Value

  `0.0.0.0`

Unit

  String

### Network.client-alias

Determines the aliases of the keystore used for outgoing connections.

Default Value

  `client,client52`

Unit

  List

### Network.masterhost

Defines FQDN of the Avantra Server. This value is determined automatically based on the physical hostname and the value of Network.bind-address, and there is usually no need to change it.

This value is taken as the default for the MasterHost Monitoring Parameter.

| === If the value determined is not suitable for the Avantra Agents to communicate with the Avantra Server, you probably want to define a Parameter Set for Servers containing a properly defined MasterHost. ===

Unit

  Integer

### Network.masterport

Defines the Listening TCP port of the Avantra Server.

This value is taken as the default for the MasterPort Monitoring Parameter.

Default Value

  9050

Unit

  Integer

### Network.server-alias

Determines the aliases of the keystore used for incoming connections.

Default Value

  `server,server52`

Unit

  List

### Network.tls-cipher-suites

Defines patterns for allowed SSL/TLS cipher suites. Note that this only applies to outbound communication between the Avantra Server and the Avantra Agent.

Default Value

  `SSL,TLS`

Unit

  String

### Network.tls-enabled-client-protocols

Defines enabled SSL/TLS protocols for connections to an SSL/TLS server.

Default Value

  `TLSv1.2,TLSv1.3`

Unit

  String

### Network.tls-minimal-server-protocol

Defines the minimal/preferred SSL/TLS protocol version to be used in server mode.

Default Value

  `TLSv1.2`

Unit

  Enum

### Notifier.enable

Defines if the Notifier service of the Avantra Server is started.

Default Value

  true

Unit

  Boolean

### Notifier.LogLevel

Defines the level of messages to be logged in Avantra Server `notifier.log*` files in `C:\Program Files\syslink\master\log ` (on Microsoft Windows operating systems) or `/syslink/master/log` (on Unix-like operating systems

Default Value

  `INFO`

Unit

  Enum

### Notifier.Mail.fromSenderName

Defines the default sender address used by the Notifier service of the Avantra Server. It is used as the default sender for Email output channels. It can either be just an email address `example@domain.com` or the combination of name and email address `Firstname Lastname <example@domain.com>`.

Default Value

  empty

Unit

  String

### Notifier.EnableRawEmailAddresses

By default, notification output channels can only send emails to known users in Avantra. Set this option if you want to send emails to users who are not Avantra users.

Default Value

  Not set

Unit

  Boolean

### Notifier.PollEveryNSeconds

Defines how frequently (in seconds) the Notifier service of the Avantra Server processes Notification Actions.

Default Value

  `120`

Unit

  Enum

### Performance.PERFDATA_AGGREGATION_HOUR

This property defines the hours when Performance data is aggregated.

Default Value

  `02:00`

Unit

  Integer

### Performance.PERFDATA_KEEPTIME

Defines how long (in months) to keep hourly and daily Performance data in the Avantra Database.

Default Value

  `6`

Unit

  Enum

### Performance.PERFDATA_KEEPTIME_MONTHLY

Defines how long (in months) to keep monthly Performance data in the Avantra Database.

Default Value

  `36`

Unit

  Enum

### Security.EnableOSCodeExec

Enables all Avantra features that may allow remote code execution, including RUN_PROG and RUN_JS Custom Checks, SSH automation action, Run an external command output channel, JavaScript Resolver notification.

Default Value

  `true`

Unit

  Boolean

| If you want to disable remote code execution, e.g. for security reasons, you can do so by going to Administration Settings in the top-level menu and then navigating to Avantra Master.

### Security.RUNJSAllowDBWrite

Allows you to execute database WRITE statements (INSERT, DELETE, UPDATE) in addition to READ statements. This parameter is available starting from Avantra Version 20.11.5.

Default Value

  `false`

Unit

  Boolean

### System Configuration.CONFIG_REFRESH_TIME

Defines the maximum time span the Avantra Server will resend any config data to the Avantra Agents no matter if it has changed or not.

Default Value

  `86400`

Unit

  Seconds

### System Configuration.enable

Enable or disable the service that synchronizes configuration settings to the Avantra Agents.

Default Value

  `true`

Unit

  Boolean

### System Configuration.SEND_ATTEMPTS

Defines how often the Configuration Service tries to send a config update or command to the Avantra Agent before the data to be sent is discarded.

Default Value

  `5`

Unit

  Enum

### Web.authentication

If set to `on`, the User having the `Administrator Role` assigned.

Default Value

  `on`

Unit

  String

### Web.enable-https

If set to `on`, the Web.http-server is only accessible using `https`.

Default Value

  `off`

Unit

  String

### Web.http-port

Defines the web port number of the Web.http-server.

Default Value

  `9058`

Unit

  String

### Web.http-server

Defines if the statistics web server of the Avantra Server is turned on or off.

Default Value

  `on`

Unit

  Boolean

### Web.jvm

Enables or disables JVM diagnostics servlet.

Default Value

  `off`

Unit

  Boolean

### Web.servlets-display

Enables or disables the display of servlets on the Web Server.

Default Value

  `on`

Unit

  Boolean

### Worker.AGENTALIVE_REFRESH_MIN_WAIT

Defines the minimum time the Avantra Server waits to update the `Last message from Avantra Agent is at least hh:mm:ss` message of the AGENTALIVE Check in case the check status remains Critical.

Default Value

  `300`

Unit

  Enum

### Worker.DCD_MAX_MESSAGE_SIZE

Defines the maximum size (in bytes) of Daily Check Detail messages.

Default Value

  `65536`

Unit

  Enum

### Worker.InstanceDetectionForceMatchCustomer

If set to `1`, SAP Instances are automatically assigned only if the Customer of the hosting Server matches the Customer of the target SAP System.

Default Value

  `1`

Unit

  Boolean

### Worker.LOGKEEPFILES

Defines the number of Avantra Server Worker log files in `C:\Program Files\avantra\master\services\mw\log ` (on Microsoft Windows operating systems) or `/avantra/master/services/mw/log` (on Unix-like operating systems).

Default Value

  `10`

Unit

  Enum

### Worker.LOGTIMEHIRES

Defines the time stamp precision of Avantra Server Worker log files in `%ProgramFiles%\master\services\mw\log` (on Microsoft Windows operating systems) or `/avantra/master/services/mw/log` (on Unix-like operating systems). (0=seconds, 1=milliseconds, 2=microseconds)

Default Value

  `1`

Unit

  Enum

### Worker.TRACELEVEL

Defines the log level of Avantra Server Worker log files in `%ProgramFiles%\master\services\mw\log` (on Microsoft Windows operating systems) or `/avantra/master/services/mw/log` (on Unix-like operating systems).

Default Value

  `2`

Unit

  Enum