# Server - Monitoring Parameters

Here you will find detailed information about monitoring parameters for Server monitored objects.

Monitoring parameters are the mechanism for you to configure how your systems are monitored. They are how you set configuration of how the agent runs, how checks are executed, thresholds for checks (when does a check go critical or warning) and much more. All Monitoring Parameters have a carefully chosen default value. As soon as you add a new system, Avantra uses these defaults. You may change these defaults by defining a parameter and by modifying its values. Monitoring Parameters can be defined for a single system, or for collections of systems using Monitoring Parameter Sets. You can also define your own Custom Monitoring Parameters for use within Custom Checks and automations.

## AgentConnectRoute

Define routing string for use with the avantra-gateway

| Description It is recommended to use The Route Configurator instead of configuring this parameter directly.

If the Avantra Server connects to the Avantra Agent through one or more avantra-gateways, you can define this value.

Reference Data

Configures | AgentConnect
Unit | String. The format of a routing string is defined by the following EBNF:
    Routing   ::==  Sequence | Backup
    Backup    ::==  '(' Sequence ')' { '|(' Sequence ')' }
    Sequence  ::==  [ URL { ' ' URL }]
    URL       ::==  ( target | reverse) ['?' query ]
    target    ::==  protocol '//' host ':' port
    reverse   ::==  '//' reverse-id
    query     ::==  param {'&' param}
    protocol  ::==  'a5' | 'a5s'
    param     ::==  key '=' value
    host      ::==  hostname | ip-address
    port      ::==  integer
    key       ::==  url-encoded string
    value     ::==  url-encoded string
The meaning of protocol is as follows:
`a5` | The (unsecured) protocol provided by Avantra 5 and higher, i.e. HTTP
`a5s` | The secure protocol used by Avantra 5 and higher, i.e. HTTPS

## AgentConnectTimeCrit

Configure critical threshold for AgentConnect

Description

If no connection could be established to an Avantra Agent for more than AgentConnectTimeCrit minutes, the Avantra Server will set the status of the AgentConnect Check to Critical.

Reference Data

Configures | Agent
Default Value | 60
Unit | Minutes

## AgentConnectTimeWarn

Configure warning threshold for AgentConnect

Description

If no connection could be established to an Avantra Agent for more than AgentConnectTimeWarn minutes, the Avantra Server will set the status of the AgentConnect Check to Warning.

Reference Data

Configures | Agent
Default Value | 10
Unit | Minutes

## AgentEnvironment

Set Environment variables effective for the Avantra Agent.

Description

General-purpose parameter. Do not use it unless instructed by the Avantra support team.

Reference Data

Configures | Agent
Unit | String

## AgentListenerPort

Configure the Avantra Agent TCP/IP listener port.

Description

Defines the Avantra Agent TCP/IP listener port. Do not change this value unless the default port is already in use.

If you need to change it, please contact our support for assistance.

If you are not familiar with TCP/IP, or you do not know what a port is, you may want to start further reading at RFC 1180.

Reference Data

Configures | Agent
Default Value | 9051
Unit | Number

## AgentProtocolUseSSL

Configures, whether the communication between Avantra Agent and Avantra Server uses SSL encryption or not.

Description

By default, the communication between Avantra Agent and Avantra Server is secured by SSL using client-side certificates. Turning SSL off should only be required under rare circumstances, i.e. to work around SSL problems with the Avantra Agent Java Runtime Environment. Please be aware that without SSL communication between Avantra Agent and Avantra Server will be plain text HTTP.

Reference Data

Configures | Agent
Default Value | true
Unit | Boolean

## AliveTimeout

Defines the timeout value for the Avantra Agent

Description

If the Avantra Server did not receive data for more than AliveTimeout minutes, it will set the status of Check AGENTALIVE to Critical. You may decrease this parameter for productive systems, and increase it for systems connected via low speed/low bandwidth links.

| We do not recommend setting this parameter to a value less than the check cycle length, as this would cause unnecessary CRITICAL statuses

Reference Data

Configures | AGENTALIVE
Default Value | 10
Unit | Minutes

## AutoChangeDetectionIgnore

Description

This parameter has currently no effect for Servers.

Reference Data

Configures | System Change Auto Detection
Unit | Keyword followed by comma-separated value list, optionally followed by a semicolon followed by a keyword followed by comma-separated value list, …​ Colon, semicolon, and comma must be escaped by `\` (backslash) if used as a value.

## CheckCycleTime

Modifies scheduling of the Basic Check Cycle

Description

Defines the time interval between two consecutive runs of the Basic Check Cycle.

Reference Data

Configures | All Checks in the Basic Check Cycle
Default Value | 5
Unit | Minutes

## CloudDetection

Enable/disable cloud detection on Agent.

Description

Determine if the Agent shall perform cloud detection. For the purpose of cloud detection, several predefined URLs need to be accessed, which may lead to firewall messages depending on your environment. In this case, you can turn off cloud detection by this parameter.

Reference Data

Configures | Cloud detection
Default Value | On
Unit | Boolean

## ClusterSwitchMsgDisplayDuration

Configures Cluster Switch Visibility in RealTime Monitoring

Description

Defines how long (in minutes) the AGENTALIVE Check remains in status Warning after a Virtual Cluster Server has switched from one Physical Server to the other.

Reference Data

Configures | AGENTALIVE (for Virtual Cluster Servers only)
Default Value | 30
Unit | Minutes

## CPULoadAverageTime

Configures CPU usage computation interval

Description

The value of CPULoadAverageTime defines the time period used to compute the average CPU load over. CPULOAD will only result in Warning or Critical status if the CPU load of the system was over the corresponding threshold for CPULoadAverageTime minutes or more. The higher this value is, the less likely you will get alerts due to CPU peaks over a small period of time only.

Reference Data

Configures | CPULOAD
Default Value | 10
Unit | Minutes

## CPULoadCrit

Configures a critical threshold for the CPU usage

Description

If the server’s average CPU load exceeds CPULoadCrit percent the check status of CPULOAD turns to Critical.

Reference Data

Configures | CPULOAD
Default Value | 95
Unit | %

## CPULoadWarn

Configures a warning threshold for the CPU usage

Description

If the server’s average CPU load exceeds CPULoadWarn percent but does not exceed CPULoadCrit percent, the check status of CPULOAD turns to Warning.

Reference Data

Configures | CPULOAD
Default Value | 80
Unit | %

## DailyCheckSendTimeRange

Configures a random delay for Daily Check delivery

Description

Usually, Daily Checks are executed at DailyCheckStart and delivered immediately. In a large-scale environment with hundreds of Avantra Agents, and if DailyCheckStart has the same value for all Avantra Agents, it may cause a high load of the Avantra Server.

If you set this parameter, the Avantra Agent randomly chooses a time between 0 and DailyCheckSendTimeRange minutes before the Daily Check is actually delivered.

Reference Data

Configures | FULLCHECK
Default Value | 0
Unit | Minutes

## DailyCheckStart

Configures Daily Check execution time

Description

Defines the start time of the FULLCHECK in the Avantra Agent's local time zone. It affects all SAP Instances eventually installed on the same Physical Server or Virtual Cluster Server.

Reference Data

Configures | FULLCHECK
Default Value | 07:00
Unit | Formatted String: `HH:MM`

## DumpData

Dump data for debugging purposes

Description

Use only if instructed by Avantra.

Reference Data

Configures | Agent
Unit | List

## EnableOSCodeExec

Use this monitoring parameter to enable/disable operating system code execution

Description

Please note that the global setting Security.EnableOSCodeExec may override this setting

Reference Data

Configures | RUN_JS, SQL_QUERY
Default Value | Global setting Security.EnableOSCodeExec

## FSExCrit

Configure filesystem forecasting critical threshold

Description

If the predicted point in time when the filesystem usage limit is exceeded is within the upcoming FSExCrit hours, the check status of FILESYSTEMS is set to Critical.

Reference Data

Configures | FILESYSTEMS
Default Value | 2
Unit | Hours
Monitoring Exception Parameter available | Yes

## FSExWarn

Configure filesystem forecasting warning threshold

Description

If the predicted point in time when the filesystem usage limit is exceeded is within the upcoming FSExWarn hours, but not within the upcoming FSExCrit hours, the check status of FILESYSTEMS is set to Warning (unless the FSUsageCrit threshold is exceeded for some file system).

Reference Data

Configures | FILESYSTEMS
Default Value | 12
Unit | Hours
Monitoring Exception Parameter available | Yes

## FSForecast

Enables forecasting for FILESYSTEMS check

Description

Defines whether the forecasting algorithm is active or inactive. See Forecasting for more information.

Reference Data

Configures | FILESYSTEMS
Default Value | Active
Unit | Enum (Active/Inactive)
Monitoring Exception Parameter available | Yes

## FSMonitorNetwork

Configure monitoring of network filesystems

Description

If the parameter is selected the FILESYSTEMS Check also monitors non-local file systems, i.e. mapped network drives (in the Windows world) and NFS-mounted file systems (in the Unix world).

Reference Data

Configures | FILESYSTEMS, ORA_FSLOGARCH, DB2_FSLOGARCH
Default Value | Not set
Unit | Check box

## FSNodeCrit

Configure critical filesystem inode usage threshold

Description

If one or more of the Physical Server’s filesystem inode usage exceeds FSNodeCrit percent, the Check status is set to Critical (on Unix-like operating systems only).

Reference Data

Configures | FILESYSTEMS
Default Value | 95
Unit | %

## FSNodeWarn

Configure warning filesystem inode usage threshold

Description

If one or more of the Physical Server’s filesystem inode usage exceeds FSNodeWarn percent, but none of them exceeds FSNodeCrit percent, the check status is set to Warning (unless any other Critical threshold is exceeded for some filesystem; on Unix-like operating systems only).

Reference Data

Configures | FILESYSTEMS
Default Value | 90
Unit | %

## FSQueueCrit

Description

This monitoring parameter configures a Critical threshold for FILESYSTEMS whenever the disk queue length reaches a certain number.

The number given for this parameter should be higher than the one set for FSQueueWarn.

By default, this parameter is empty and do not influence the check status of FILESYSTEMS.

Reference Data

Configures | FILESYSTEMS
Default Value | empty
Unit | Number

## FSQueueWarn

This monitoring parameter configures a Warning threshold for FILESYSTEMS whenever the disk queue length reaches a certain number.

The number given for this parameter should be lower than the one set for FSQueueCrit.

By default, this parameter is empty and do not influence the check status of FILESYSTEMS.

Reference Data

Configures | FILESYSTEMS
Default Value | empty
Unit | Number

## FSTypeLocal

Configure filesystem types considered local

Description

A list of (local) filesystem types. Avantra Agent does not monitor filesystems having a type not defined in this parameter.

Reference Data

Configures | FILESYSTEMS, ORA_FSLOGARCH, DB2_FSLOGARCH
Default Value | advfs aix ext2 ext3 ext4 gpfs hfs jfs jfs2 minix ntfs ocfs2 reiser4 reiserfs ufs vxfs xfs xiafs zfs
Unit | String

## FSTypeRemote

Configure filesystem types considered as network filesystems

Description

A list of (network) filesystem types. Avantra Agent does not monitor filesystems having a type not defined in this parameter. The parameter is only effective if FSMonitorNetwork is selected.

Reference Data

Configures | FILESYSTEMS, ORA_FSLOGARCH, DB2_FSLOGARCH
Default Value | afs dfs nfs nfs2 nfs3 nfsv2 nfsv3 smbfs
Unit | String

## FSUsageCrit

Configure critical filesystem usage threshold

Description

If one or more of the Physical Server’s filesystem usage exceeds the FSUsageCrit threshold, the Check status is set to Critical.

You can define the threshold either in percentage of the total size of the resource, or in `KB`, `MB`, or `GB` values of the remaining free space. In the first case, the parameter gets effective if the usage measured in `%` of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.

Reference Data

Configures | FILESYSTEMS
Default Value | 95
Unit | %
Monitoring Exception Parameter available | Yes

## FSUsageWarn

Configure warning filesystem usage threshold

Description

If one or more of the Physical Server’s filesystem usage exceeds the FSUsageWarn threshold, but none of them exceeds the FSUsageCrit threshold, the check status is set to Warning (unless any other Critical threshold is exceeded for some filesystem).

You can define the threshold either in percentage of the total size of the resource, or in `KB`, `MB`, or `GB` values of the remaining free space. In the first case, the parameter gets effective if the usage measured in `%` of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.

Reference Data

Configures | FILESYSTEMS
Default Value | 80
Unit | %
Monitoring Exception Parameter available | Yes

## GatewayTunnels

Configure Tunnels maintained by the Avantra Agent.

Description

This parameter is used to configure Tunnels to other Avantra Agents used as Gateways or the Avantra Server.

| Do not change this Monitoring Parameter unless you really know what you are doing. This parameter can be set using The Route Configurator.

Reference Data

Configures | All checks assigned to the System.
Default Value | (not defined)
Unit | Boolean

## LocalIPAddress

Define the local IP address of this server

Description

This IP address must only be set if 127.0.0.1 is not valid.

Reference Data

Unit | String

## LocalMonitoringOff

Turn local monitoring off

Description

If you set this parameter Avantra will stop monitoring the System.

This setting can be used if you want to monitor this System only using End-to-End Application Monitoring (from a different System).

| Do not change this Monitoring Parameter unless you really know what you are doing.

Reference Data

Configures | All checks assigned to the System.
Default Value | (not defined)
Unit | Boolean

## LogKeepFiles

Control how many log files to preserve

Description

Defines how many old log files to keep. If set to `0`, there is one log file kept called `lyceus.log.old`.

If set to a value `n` greater 0, `n` log files are kept named with time stamp suffix.

Reference Data

Configures | Avantra Agent
Default Value | 0
Unit | Number

## MasterConnectRoute

Define a routing string for more sophisticated routing from the Avantra Agent to the Avantra Server, as well as a replacement for parameters MasterHost and MasterPort.

| Description It is recommended to use The Route Configurator instead of configuring this parameter directly.

Use this parameter if MasterHost and MasterPort parameters are not sufficient to specify the routing from Avantra Agent to Avantra Server.

Reference Data

Configures | AGENTALIVE
Unit | String. The format of a routing string is defined by the following EBNF:
    Routing   ::==  Sequence | Backup
    Backup    ::==  '(' Sequence ')' { '|(' Sequence ')' }
    Sequence  ::==  [ URL { ' ' URL }]
    URL       ::==  ( target | reverse) ['?' query ]
    target    ::==  protocol '//' host ':' port
    reverse   ::==  '//' reverse-id
    query     ::==  param {'&' param}
    protocol  ::==  'a5' | 'a5s'
    param     ::==  key '=' value
    host      ::==  hostname | ip-address
    port      ::==  integer
    key       ::==  url-encoded string
    value     ::==  url-encoded string
The meaning of protocol is as follows:
`a5` | The (unsecured) protocol provided by Avantra 5 and higher, i.e. HTTP
`a5s` | The secure protocol used by Avantra 5 and higher, i.e. HTTPS

## MasterHost

Configure how to connect to the Avantra Server

Description

Hostname or IP address of the Avantra server, more precisely, of the server running Avantra Server.

The default value is taken from the Avantra Server property Network.masterhost which itself is determined automatically.

If you use MasterConnectRoute, you probably need to set MasterHost to the hostname of the last gateway defined in MasterConnectRoute.

Reference Data

Configures | Avantra Agent
Default Value | The value of Network.masterhost
Unit | Formatted String: Full Qualified Domain Name or IP Address

## MasterPort

Configure how to connect to the Avantra Server

Description

TCP/IP port number the Avantra Server is listening to.

The default value is taken from the Avantra Server property Network.masterport.

If you use AgentConnectRoute you probably need to set MasterPort to the TCP/IP port number of the last gateway defined in AgentConnectRoute.

Reference Data

Configures | Avantra Agent
Default Value | The value of Network.masterport.
Unit | Number

## MediumCheckCycleTime

Modifies scheduling of the Medium Check Cycle

Description

Defines the time interval between two consecutive runs of the Medium Check Cycle. Please be aware that the cycle time is always 'rounded' up to the next CheckCycleTime time. For example, if you enter 8 minutes as the MediumCheckCycleTime and the CheckCycleTime is set to 5 minutes, the check will be executed every 10 minutes in every 2nd check interval.

Reference Data

Configures | Medium Check Cycle
Default Value | 3
Unit | Number

## MemoryUsageCrit

Configure critical threshold for physical memory check MEMORY

Description

If the physical memory usage exceeds the MemoryUsageCrit threshold, the check status is set to Critical.

You can define the threshold either in percentage of the total size of the resource, or in `KB`, `MB`, or `GB` values of the remaining free space. In the first case, the parameter gets effective if the usage measured in `%` of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.

Reference Data

Configures | MEMORY
Default Value | 95
Unit | %

## MemoryUsageWarn

Configure warning threshold for physical memory check MEMORY

Description

If the physical memory usage exceeds the MemoryUsageWarn threshold but does not exceed the MemoryUsageCrit threshold, the check status is set to Warning.

You can define the threshold either in percentage of the total size of the resource, or in `KB`, `MB`, or `GB` values of the remaining free space. In the first case, the parameter gets effective if the usage measured in `%` of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.

Reference Data

Configures | MEMORY
Default Value | 90
Unit | %

## MessageSuppressTime

Suppress Avantra Agent communication

Description

The Avantra Agent re-sends a Check Result after MessageSuppressTime minutes if check status and check message have not changed during this time.

Reference Data

Configures | All Checks
Default Value | 60
Unit | Minutes

## PagingSpaceCrit

Configure critical threshold for virtual memory check

Description

If the total amount of paging space usage exceeds the PagingSpaceCrit threshold, the check status is set to Critical.

You can define the threshold either in percentage of the total size of the resource, or in `KB`, `MB`, or `GB` values of the remaining free space. In the first case, the parameter gets effective if the usage measured in `%` of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.

Reference Data

Configures | PAGINGSPACE
Default Value | 95
Unit | %

## PagingSpaceWarn

Configure warning threshold for virtual memory check

Description

If the total amount of paging space usage exceeds the PagingSpaceWarn threshold but does not exceed the PagingSpaceCrit threshold, the check status is set to Warning.

You can define the threshold either in percentage of the total size of the resource, or in `KB`, `MB`, or `GB` values of the remaining free space. In the first case, the parameter gets effective if the usage measured in `%` of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.

Reference Data

Configures | PAGINGSPACE
Default Value | 80
Unit | %

## PagingSpacePhysMemRatioWarn

Configure warning threshold for the amount of virtual memory

Description

If the Server's total amount of paging space is less PagingSpacePhysMemRatioWarn percent of the physical memory, the check status of Check PAGINGSPACE is set to Warning.

The default is `0`, in which case this sub-Check is disabled.

Reference Data

Configures | PAGINGSPACE
Default Value | 0
Unit | %

## PerfDataCollection

Turn Performance Data Collection on or off (for Servers)

Description

Controls whether or not Performance Data Collection is turned on for Systems. If you do not want the Avantra Agent to collect performance data you may remove the flag.

Reference Data

Configures | System
Default Value | On
Unit | Check box

## PerfDataDiskIOFileSystems

Configures FILESYSTEMS Check to collect disk IO performance data

Description

Use this monitoring parameter to collect disk IO performance data for file systems. Disk IO performance data for file systems is not collected by default. It must be turned on using this monitoring parameter. Define the names of the file systems you want to collect data for. Multiple entries can be separated by one or more spaces, comma, or semicolon. If one of these characters appears in a file system path, you must escape it with `\`. You can use wildcard `*` to define multiple file systems.

Use `*` to collect performance data of all file systems.

Use `/usr/sap*` to collect performance data of all filesystems starting with `/usr/sap`.

Use `C:* D:* E:*` to collect performance data of logical drives On Microsoft Windows operating systems.

Do not use `C:\` since `\` must be quoted itself.

Reference Data

Configures | FILESYSTEMS
Default Value | n/a
Unit | String

## PerfDataNetworkIOInterfaces

Configures network interfaces to collect performance data

Description

Use this monitoring parameter to collect performance data of network I/O interfaces. Performance data is not collected by default for network interfaces. It must be turned on with this monitoring parameter. Define the names of the network interfaces, multiple network interfaces can be separated with spaces, comma, or semicolon. You can use wildcard `\*` to define network interfaces.

Use `*` to collect performance data of all network I/O interfaces.

Use `eth*` to collect performance data of all network I/O interfaces with a name starting with eth.

## PredictiveAnalyticsEngine

Reference Data

Configures the Predictive Analytics engine for the Server

Description

Use this monitoring parameter to configure the Predictive Analytics engine for the Server. By default the engine is configured as `Balanced`.

- Use `Off` to turn off the Predictive Analytics engine.

- Use `Best Performance` to configure the Predictive Analytics engine to run with best performance.

- Use `Balanced` to configure the Predictive Analytics engine to run in a balanced way.

- Use `Highest Precision` to configure the Predictive Analytics engine to run with highest precision.

Reference Data

Configures | CPULOAD

## RelevantDailyCheckDetails

Configure Daily Check contributing check details (for Servers)

Description

Configure Daily Check contributing check details (for Servers)

Reference Data

Unit | DCDList

## RTMMaxMessageSize

Restrict the amount of transmitted RealTime Monitoring Check data.

Description

Defines the maximum number of bytes of the check message that are transferred to the Avantra Server. This is to prevent network transmission problems in case of very large message sizes.

Reference Data

Configures | Avantra Agent
Default Value | 16384
Unit | Number

## RunDailyCheckOnWE

Description

Define if Daily Checks are executed during weekends.

Reference Data

Unit | Boolean
Default Value | 0

## SAPHostAgentProtocol

Description

One of Auto:HTTP:HTTPS:HTTP+HTTPS, defines which protocol/port is used to connect to the SAP host control service. AUTO uses HTTPS if available else HTTP; the others force the respective protocol/port; HTTP+HTTPS probes both, like AUTO, but reports if the other is working too.

Reference Data

Configures | SAPHostAgentStatus
Default Value | Auto
Unit | Boolean

## SAPHostAgentIP

Description

Defines the hostname/IP address to which the host agent is configured to listen to. It can override the default (localhost/127.0.0.1) setting.

If this parameter is set to a value, the SAPHostAgentStatus check is always enabled and ignores local detection. Setting a value that is not the server’s hostname, machine name or any alias will force the check to remote mode and skip monitoring of the local daemon.

Reference Data

Configures | SAPHostAgentStatus
Default Value | True
Unit | Boolean

## SAPHostAgentCheckSaposcol

Description

Activates/deactivates the SAPOSCOL sub-check for the SAPHostAgentStatus check. This sub-check needs `sapadm` user credentials to be maintained as avantra.sapHostControl credential type on the server level.

Reference Data

Configures | SAPHostAgentStatus
Default Value | False
Unit | Boolean

## SAPInstanceDetection

Control SAP Instance Auto Discovery

Description

This parameter controls the SAP Instance Auto Discovery algorithm of the Avantra Agent.

By default, only SAP Instances with an instance profile file ending on the `hostname` (on Physical Servers) or the Virtual Cluster Server Name (on Virtual Cluster Servers) are monitored. If your profiles are named differently and you are using logical hostnames, first, have a look at SAPLogicalHostDetection and SAPLogicalHostResolution.

Allow Mode

  You can define a list of SAP Instance names for the SAP Instances to be discovered on the corresponding Server. In this mode, define all SAP Instances in question as a formatted string.

| Only if the Avantra Agent cannot find instance profiles after setting SAPLogicalHostDetection and SAPLogicalHostResolution, you should consider using SAPInstanceDetection in allowlist mode.

Deny Mode

  Let the Avantra Agent automatically discover all the SAP Instances and define a list of SAP Instance names that should be excluded. In this mode, define all excluded SAP Instances as a formatted string and add the keyword `EXCEPT` as a prefix to this list. You can even use `EXCEPT *` to turn off SAP Instance Auto Discovery completely.

You can change this behavior by using the keyword `ALL`. The keywords `ALL` and `EXCEPT` can be combined.

| Do NOT use the value `ALL` only unless instructed by the support. In particular, do NOT use the value `ALL` in conjunction with Virtual Cluster Servers.

Example 1. Example for an Allow List

`BEN: pinot_BEN_00, merlot_BEN_01; P11: riesling_P11_00`

with `BEN` and `P11` the Real SAP SID of the SAP Instances followed by the corresponding instance names, in case of `BEN` separated by a comma.

Example 2. Example for a Deny List

`EXCEPT BEN: merlot_BEN_01`

with `BEN` the Real SAP SID of the SAP Instances followed by the corresponding instance name.

Example 3. Discover no SAP Instances at all

`EXCEPT *`

Reference Data

Configures | SAP Instance Auto Discovery
Unit | Formatted String: `[ALL] [EXCEPT [*]] <SID1>:<InstPrf11>, <InstPrf12>, …​ ; <SID2>:<InstPrf21>, <InstPrf22>, …​; …​`

## SAPInstanceDetectionMode

Control SAP Instance Auto Discovery

Description

This parameter determines how SAP Instances are discovered on the server. SAPInstanceDetectionMode has three values: `PROFILES`, `SAPServices`, and `AUTO`. In the first case, the filesystem is scanned for SAP instance profiles, which is the default behavior. In the case of SAPServices, the `sapservices` file is parsed and SAP instance profiles are detected based on the findings. For the AUTO search method, profiles are determined from the `sapservices` file if it is present and can be read. Otherwise, a filesystem scan for SAP instance profiles will be performed.

Reference Data

Configures | SAP Instance Auto Discovery
Unit | Enum

## SAPInstanceProfiles

Control SAP Instance Auto Discovery

| This parameter is deprecated and supported only for backward compatibility. Please use the improved SAPInstanceDetection parameter instead.

Reference Data

Configures | SAP Instance Auto Discovery
Unit | Formatted String: `[ALL] [EXCEPT [*]] <SID1>:<InstPrf11>, <InstPrf12>, …​ ; <SID2>:<InstPrf21>, <InstPrf22>, …​; …​`

## SAPInstanceProfilePaths

Specifies additional directories containing SAP Instance profiles or/and paths to SAP Instance profile files.

Description

SAPInstanceProfilePaths tells the Avantra Agent where to look for profiles additionally. There are specified directories that contain SAP Instance profiles, or the direct paths can be specified to the certain profile files. These profiles then are examined for systems and used for system detection.

Reference Data

Configures | SAP Instance Auto Discovery
Default Value | “”
Unit | String

## SAPLogicalHostDetection

Lets the Agent detect instances using Logical Host Names automatically.

Description

If the hostname used by the instance (SAPLOCALHOST) is a Logical Host Name and doesn’t match the Server Name defined in Avantra, monitoring will not be performed. But if this parameter is activated on the corresponding SAP System, the Agent will do a `/etc/hosts` and DNS lookup for the Logical Host Name, and if the name resolves to a matching IP address, the instance will be monitored by the Agent.

Reference Data

Configures | Instance Detection
Default Value | false
Unit | Boolean
Monitoring Exception Parameter available | No

! Do not use this parameter in conjunction with Virtual Cluster Servers. Otherwise, instances might be detected twice - once for the logical host and once for a VCS with the corresponding host name, which may lead to mutual cancellation.

## SAPLogicalHostResolution

Allows you to define custom host name / ip mappings augmenting Logical Host Name resolution.

Description

In addition to the SAPLogicalHostDetection parameter, this parameter can be used to define IP addresses or host names for Logical Host name resolution. Normally the automatic resolution using the hosts file or DNS will work, but in case of DNS problems or Agentless Monitoring, this parameter can be set to customize the resolution. On a per-host basis, mappings of multiple host names to an IP address or host name can be defined. If Logical Host detection is active but this parameter doesn’t provide a mapping, the detection falls back to the hosts file / DNS mapping.

The format of the parameter looks as follows:

    logical-host-name-mappings ::=  logical-host-name-mapping { ';' logical-host-name-mapping }
    logical-host-name-mapping  ::=  real-name ':' logical-name { ',' logical-name }
    real-name                  ::=  ip-address | host-name
    logical-name               ::=  host-name

The following examples show how to set the parameter:

`192.168.10.105: baker, berthe` `192.168.10.105: baker, berthe; 192.168.10.106: baltimore`

Reference Data

Configures | Instance Detection
Unit | String

## SAPSidAdmMapping

Defines mapping from sid to custom sidadm users who don’t follow the default <sid>adm naming scheme.

Description

The <sid>adm user reads the user environment of the bootstrap instance, but this user can be arbitrary. Therefore the correct mapping can be specified from system id (sid) to the user with this parameter, for example:

WDB: wdmadm

It tells the Avantra Agent that the sidadm of system WDB is 'wdmadm' and provides the environment of wdmadm for system WDB.

Configures

  SAP Instance Auto Discovery

Default Value

  “”

Unit

  Formatted String: `[ALL] [EXCEPT [*]] <SID1>:<InstPrf11>, <InstPrf12>, …​ ; <SID2>:<InstPrf21>, <InstPrf22>, …​; …​`

## SAPSystemAutoCreation

Automatically define SAP Systems based on instance detection findings.

Description

Instructs the Avantra Server to automatically define SAP Systems, when instances are detected on a server which can’t be assigned to an existing SAP System in Avantra.

The SAP System is assigned to the customer that owns the server the instance has been detected on. The Unified SAP SID will be composed of the first three letters of the customer name and the real SAP SID, i.e customer Avantra and system PR1 will result in AVA_PR1.

Reference Data

Configures | Avantra Server
Default Value | Off
Unit | Enum
`Off` | SAP System auto creation is turned off.
`Not Operational` | SAP System is created in 'not operational' mode.
`Monitor Off` | SAP System is created with monitoring turned off.
`Active` | SAP System is created and monitoring starts immediately.

## SocketReadTimeOut

Configure Avantra Agent network timeout

Description

Defines the maximum time (in seconds) the Avantra Agent reads an incoming TCP/IP connection. There usually is no need to change this value.

Reference Data

Configures | Avantra Agent
Default Value | 20
Unit | Seconds

## TimeOffsetCrit

Critical threshold for the TimeOffset check.

Description

Defines the Critical threshold for the TimeOffset check; if the Agent server UTC time differs from the Avantra Server UTC time more than the configured value, TimeOffset becomes Critical.

Reference Data

Configures | TimeOffset
Default Value | 60
Unit | Seconds

## TimeOffsetWarn

Warning threshold for the TimeOffset check.

Description

Defines the Warning threshold for the TimeOffset check; if the Agent server UTC time differs from the Avantra Server UTC time more than the configured value, TimeOffset becomes Warning.

Reference Data

Configures | TimeOffset
Default Value | 30
Unit | Seconds

## TimeOutOsCalls

Configure operating system call timeout

Description

Defines the timeout for Avantra Agent child processes performing operating system calls. If the value exceeds, the process is terminated. There usually is no need to change this value. This parameter affects Solaris systems only.

Reference Data

Configures | FILESYSTEMS and PAGINGSPACE
Default Value | 10
Unit | Seconds

## TraceLevel

Configure Avantra Agent logging

Description

Defines how verbose the Avantra Agent performs logging. Valid values range from `0` to `5`

Reference Data

Configures | Avantra Agent
Default Value | 2
Unit | Number

## TrustedCertificates

Description

This is monitoring parameter can be used to specify CA certificates that should be trusted. Certificates must be in base64 PEM format.

To make use of it with SAP HANA connections, you must set DBConnectJdbcUrl as `jdbc:sap://<server>//?encrypt=TRUE&hostNameInCertificate=[certificate]`, where `encrypt=TRUE` switches to TLX, and at the same time triggers the usage of TrustedCertificates. the `hostnameInCertificate=[certificate]` causes verification by the HANA driver that the certificate host name matches.

Reference Data

Configures | Avantra Agent
Default Value | empty
Unit | string

## VCSDetection

Control the detection of Virtual Cluster Servers by Avantra

Description

This monitoring parameter allows you to control Virtual Cluster Server detection (only applicable to Avantra Agents >= Avantra Version 20.11.7). There are three possible settings for this parameter: Auto (default), Local, Master.

Auto

  In the current implementation, Auto always defaults to Local.

Local

  The Avantra Agent tries to bind a listener to the virtual IP address (specified on the Virtual Cluster Server) and connects to that listener. If successful, the cluster server is reported to be active on the Avantra Agent.

Master

  The Avantra Agent triggers the Avantra Server / Avantra Server to connect to the Avantra Agent, reachable via a virtual IP address. If the reached Agent matches the calling Agent, the cluster server is reported to be active on the Avantra Agent.

Reference Data

Configures | Virtual Cluster Server
Unit | Enum

## WaitingTimeMoniOffStop

Define the waiting time in seconds how long to wait after setting the monitoring to off before stopping the system

Description

Define the waiting time in seconds how long to wait after setting the monitoring to off before stopping the system

Reference Data

Unit | Seconds
Default Value | 0

## WaitingTimeStartMoniOn

Define the waiting time in seconds how long to wait after starting a system before the monitoring is turned on

Description

Define the waiting time in seconds how long to wait after starting a system before the monitoring is turned on

Reference Data

Unit | Seconds
Default Value | 60

## WorkflowStartServer

Define workflow to execute start server action

Description

Define workflow to execute start server action

Reference Data

Unit | Workflow

## WorkflowStopServer

Define workflow to execute stop server action

Description

Define workflow to execute stop server action

Reference Data

Unit | Workflow