Important

   

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

Integration variables

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



/AgentSetup/integration variables

Note

If you need to change the values for these variables, you must create configuration variables and assign new values.


Variable

Description

Format

integrationMaxNumRetries

Specifies the maximum number of times a PATROL Agent tries to connect to an Integration Service.

Default value = -1

  • Default value -1 means that the PATROL Agent tries connecting to the Integration Service innumerable number of times. 
  • Once the maximum number of retries is exhausted, the PATROL Agent attempts to connect to the next configured Integration Service in one of the following conditions:
    • PATROL Agent is restarted.
    • The value of the integrationMaxNumRetries variable value is reset or modified.
    • Integration Service name is changed or modified. 

Numeric

perIntegrationMaxNumRetries

Specifies the maximum number of times a PATROL Agent tries to connect to the same Integration Service. Once the maximum number of retries is exhausted, the PATROL Agent attempts to connect to the next configured Integration Service.

Default value 2

Numeric

integrationRetryPeriod

Represents the time period between connection attempts to the Integration Service.

Default value = 30 seconds

Numeric

integrationConnectTimeout

Number of seconds to wait before giving up on a connection request with the Integration Service

Default value 20 seconds

Numeric

publishHostName

Contains the user-defined string for the PATROL Agent that is published (displayed) to Integration service.

Default value none

  • If you change the value of this variable before the connection is established with the Integration Service, it gets reflected in the Integration Service. 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 Integration Service, restart the PATROL Agent.

Text string

integrationServices

Contains integration service string (tcp:host:port) to which PATROL Agent will bind.

Default value none


denyCfgControls the configuration of PATROL Agent through the Infrastructure Monitoring Administration in the TrueSight environment. For more information, see Controlling the configuration of PATROL Agent.Boolean
sendAllConnectDisconnectEvent
No

When the PATROLAgent  disconnects from the ISN, a self-monitoring event PA is disconnected from the ISN triggers from the TrueSight.

The same event closes when the PATROLAgent connects back to the ISN by generating a new event PA is connected to the ISN component.

Yes

When the PATROLAgent  disconnects from the ISN, the ISN generates a self-monitoring event  PA is disconnected from the TrueSight Infrastructure Management.  PATROL Agent publishes the same to the PATROL console.

The same event closes when the PATROLAgent connects back to the ISN by generating a new event PA is connected to the ISN component.

The event is redundant to the event raised by the TrueSight Infrastructure Management. 

The event arrives after the PATROLAgent is reconnected to the Truesight.  It generates a generic event_trigger psl call.

The default value is No.

Text string


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

Comments