Important

   

This documentation space contains information about PATROL Agents when deployed in a BMC Helix Operations Management environment. If you are a TrueSight Operations Management user, see PATROL Agent 20.08.

Integration variables

In the PATROL AgentConfiguration Utility, these variables are located in /AgentSetup/integration.



Note

To change the values for these variables, you must create configuration variables and assign new values.

Variable

Description

Format

integrationMaxNumRetries

The maximum number of times a PATROL Agent tries to connect to the load balancer.

After the maximum retries, the PATROL Agent attempts to connect to the next configured load balancer when:

    • PATROL Agent is restarted.
    • The value of the integrationMaxNumRetries variable is reset or modified.
    • The load balancer name is changed or modified. 

Default value = -1

With the value of -1, the PATROL Agent tries connecting to the load balancer continuously without a maximum number of retries.

Numeric

perIntegrationMaxNumRetries

The maximum number of times a PATROL Agent tries to connect to the same load balancer

After the maximum retries, the PATROL Agent attempts to connect to the next configured load balancer.

Default value = 2

Numeric

integrationRetryPeriod

Time between connection attempts to the load balancer.

Default value = 30 seconds

Numeric

integrationConnectTimeout

Number of seconds to wait before terminating the connection request with the load balancer.

Default value = 20 seconds

Numeric

publishHostName

User-defined string for the PATROL Agent that is published (displayed) to theload balancer.

  • If you change the value of this variable before the connection is established with the load balancer, it gets reflected in the load balancer. In this case, you do not need to restart the PATROL Agent.
  • If you change the value of this variable after the connection is established with the load balancer, restart the PATROL Agent.

Default value = none

Text string

integrationServices

Contains the load balancer string (tcp:host:port) to which PATROL Agent will bind.

Default value = none

Text String 

denyCfg

Controls the configuration of PATROL Agent through Monitoring policies in the BMC Helix Operations Management environment. For more information, see Controlling the configuration of PATROL Agent.

Boolean
PVMessageLimit

The number of messages that can be sent at a time.

Default value = 500

Min=1, Max=10000

Numeric
ENTITYMessageLimit  

The number of instances that can be grouped together to send to the load balancer.

Default value = 500

Min=1, Max=1000

Numeric
SocketNoDelay

For HTTPS communication, PATROL Agent uses a third-party library libevent. This parameter defines if the socket used in HTTPS communication needs to be flushed immediately or not. You can set one of the following values:

  • 1: The socket is flushed immediately, and the data is sent to the load balancer.
  • 0: The socket is not flushed immediately.

Default value = 0

Boolean
HelixMonitorEvents

Specifies if the monitoring events are sent to BMC Helix Operations Management. You can set one of the following values:

  • 0: PATROL Agents do not send monitoring events to BMC Helix Operations Management.
  • 1: PATROL Agents send monitoring events to BMC Helix Operations Management.

Default value = 0

Boolean
forwardProxyServer

The FQDN and port number of the proxy server. For example, proxyServer.bmc.com:3128

A proxy server creates an additional layer of security between PATROL Agents and BMC Helix Operations Management.

Text String

forwardProxyUser

User name of the proxy server.Text String

Was this page helpful? Yes No Submitting... Thank you

Comments