Skip to main content

# 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 automation.

## AgentConnectRoute​

note

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​

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

### Reference Data​

Configures | AgentConnect
Default Value | 60
Unit | Minutes

## AgentConnectTimeWarn​

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

### Reference Data​

Configures | AgentConnect
Default Value | 60
Unit | Minutes

## AgentEnvironment​

General-purpose parameter.

warning

Do not use it unless instructed by the Avantra support team.

### Reference Data​

Configures | Agent
Unit | String

## AgentListenerPort​

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

warning

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​

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​

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

warning

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​

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​

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

### Reference Data​

Configures | All checks with a Basic Check Cycle
Default Value | 5
Unit | Minutes

## Cloud Detection​

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​

Defines how long (in minutes) AGENTALIVE 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​

The value of CPULoadAverageTime defines the time period used to compute the average CPU load over. CPULOAD will only result in Warning or Critical statuses 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​

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 | Percent %

## CPULoadWarn​

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 | Percent %

## DailyCheckSendTimeRange​

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​

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​

Only use if instructed to by Avantra.

### Reference Data​

Configures | Agent
Unit | List

## EnableOSCodeExec​

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​

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 Parameter Exception available? | Yes

## FSExWarn​

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 Parameter Exception available? | Yes

## FSForecast​

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 Parameter Exception available? | Yes

## FSMonitorNetwork​

If the parameter is selected FILESYSTEMS 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, DB2_FSLOGARCH, ORA_FSLOGARCH
Default Value | Not set
Unit | Checkbox

## FSNodeCrit​

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 | Percent %

## FSNodeWarn​

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 | Percent %

## FSQueueCrit​

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​

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

### Reference Data​

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

## FSTypeRemote​

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 enabled.

### Reference Data​

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

## FSUsageCrit​

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 | Percent %
Monitoring Parameter Exception available? | Yes

## FSUsageWarn​

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 | Percent %
Monitoring Parameter Exception available? | Yes

## GatewayTunnels​

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

warning

Do not change this monitoring parameter, unless you have knowledge with the impact it has. It is recommended to use the Route Configurator to set this parameter instead.

### Reference Data​

Configures | All checks assigned to the system
Default Value | `empty`
Unit | String

## LocalIPAddress​

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

### Reference Data​

Unit | String

## LocalMonitoringOff​

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).

warning

Do not change this monitoring parameter, unless you have knowledge with the impact it has.

### Reference Data​

Configures | All checks assigned to the system
Default Value | `empty`
Unit | Boolean

## LogKeepFiles​

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​

note

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​

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 | The value of Network.masterhost
Unit | Formatted string. Full Qualified Domain Name or IP Address

## MasterPort​

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 | The value of Network.masterport
Unit | Number

## MediumCheckCycleTime​

Defines the time interval between two consecutive runs of the Medium Check Cycle(../../Glossary/#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(../../Glossary/#check-cycle)
Default Value | 3
Unit | Number

## Memory Usage Thresholds​

## MemoryUsageCrit​

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 | Percent %

## MemoryUsageWarn​

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 | Percent %

## MessageSuppressTime​

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

Configures | All checks
Default Value | 60
Unit | Minutes

## PagingSpaceCrit​

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 | Percent %

## PagingSpaceWarn​

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 | Percent %

## PagingSpacePhysMemRatioWarn​

If the Server's total amount of paging space is less PagingSpacePhysMemRatioWarn percent of the physical memory, the check status 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 | Percent %

## PerfDataCollection​

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 | On
Unit | Checkbox

## PerfDataDiskIOFileSystems​

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.

tip

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.

warning

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

### Reference Data​

Configures | FILESYSTEMS
Default Value | N/A
Unit | String

## PerfDataNetworkIOInterfaces​

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.

tip

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​

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

Option | Description
--- | ---
`Off` | Turns off the Predictive Analytics engine.
`Best Performance` | Configures the engine to run with best performance.
`Balanced` | Configures the engine to run in a balanced way.
`Highest Precision` | Configures the engine to run with the highest precision.

### Reference Data​

Configures | CPULOAD

## RelevantDailyCheckDetails​

Configures Daily check contributing check details for Servers.

### Reference Data​

Unit | DCDList

## RTMMaxMessageSize​

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​

Defines if the daily checks are executes during the weekend.

### Reference Data​

Default Value | 0
Unit | Boolean

## SAPHostAgentCheckSaposcol​

Activates/deactivates the SAPOSCOL sub-check for SAPHostAgentStatus. 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

## SAPHostAgentIP​

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

## SAPHostAgentProtocol​

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

## SAPInstanceDetection​

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.

warning

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.

caution

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 P1`1 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​

This parameter determines how SAP Instances are discovered on the server.

SAPInstanceDetectionMode has three values: `PROFILES`, `SAPServices`, and `AUTO`.

For `PROFILES`, the filesystem is scanned for SAP instance profiles, which is the default behavior.

For `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's 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​

warning

This is a deprecated monitoring parameter, and is supported only for backwards compatibility. Use SAPInstanceDetection instead.

### Reference Data​

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

## SAPInstanceProfilePaths​

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​

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.

warning

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.

### Reference Data​

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

## SAPLogicalHostResolution​

In addition to SAPLogicalHostDetection, 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​

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.

### Reference Data​

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

## SAPSystemAutoCreation​

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`.

Value | Description
--- | ---
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.

### Reference Data​

Configures | Avantra Server
Default Value | Off
Unit | Enum

## SocketReadTimeOut​

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​

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​

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​

ConfiguresTimeOffset |
Default Value | 60
Unit | Seconds

## TimeOutOsCalls​

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​

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​

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​

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.

Setting | Description
--- | ---
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.

### Reference Data​

Default Value | 0
Unit | Seconds

## WaitingTimeStartMoniOn​

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

### Reference Data​

Default Value | 60
Unit | Seconds

## WorkflowStartServer​

Define workflow to execute start server action.

### Reference Data​

Unit | Workflow

## WorkflowStopServer​

Define workflow to execute stop server action

### Reference Data​

Unit | Workflow