Configuring using PATROL Configuration Manager


Agent configuration variables are the means by which the characteristics of a PATROL Agent are defined. To configure a IT Data Analytics host for monitoring by using PATROL Configuration Manager, add the following set of agent configuration variables, and apply it on the PATROL Agent that runs PATROL for ITDA KM.

The following table lists the rule set files, which are available at $PATROL_HOME \bww\udc\pconfig_rules

Directory path and variable

Description

/ITDAConfig/ITDA/UDC/<AgentName>/agent.name

Sets the name of the Collection Agent that you want to configure.

/ITDAConfig/ITDA/UDC/<AgentName>/stationprotocol

Specifies whether you want to use secure connection between PATROL for IT Data Analytics and the Collection Station component in IT Data Analytics.

The following values apply:

  • 0: If you want to use an unsecured HTTP connection
  • 1: If you want to use a secured HTTPS connection

Before you specify 1 for using a secured connection, ensure that you have performed the steps described in the topic, Enabling security for the Collection Station available in the IT Data Analytics online documentation portal.

/ITDAConfig/ITDA/UDC/<AgentName>/serverhost


Provides the host name of the computer where the Collection Station is installed.

/ITDAConfig/ITDA/UDC/<AgentName>/serverport

Provides the port number of the computer where the Collection Station is installed.

While installing the TrueSight IT Data Analytics product, by default, the Collection Station port is set to 8080.

/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/collectionprofile


(Optional) Specifies the name of the collection profile that you want to associate with the Collection Agent for creating the data collector in TrueSight IT Data Analytics.

Note that if you want to associate a collection profile that is imported via a content pack, then you need to specify the name in the format, "<collectionProfileName> [<contentPackName>]." For example, to associate a collection profile "OracleCP" imported via the content pack "Database Pack", you need to specify, OracleCP [Database Pack].

/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/CollectionProfilePropMacro/<Collection Profile Name>_1/macroname

(Optional) Specifies the name of the macro associated with the collection profile for which you want to override values.

After specifying this variable, ensure that you specify the corresponding macro value by adding the macrovalue variable.

/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/CollectionProfilePropMacro/<Collection Profile Name>_1/macrovalue

(Optional) Specifies the new value for the macro specified in the macroname variable.

/ITDAConfig/ITDA/UDC/<AgentName>/ItdaCollectionAgentProperties/<AgentName>_1/PropertyName

(Optional) Specify the property name in the agent.properties file located at %PATROL_HOME%\bww\udc\conf\agent.properties for which you want to modify the value.You can modify the value for any of the following properties:

  • collection.thread.pool.size
    Indicates the total number of reader threads used for collecting data.
  • collection.reader.batch.size
    Indicates the number of records that the Collection Agent reads at one time and forwards the results to the Collection Station.
  • collection.reader.throttle.bytes.threshold
    Indicates the maximum number of bytes read (per reader thread) before triggering a delay
  • collection.reader.throttle.delay
    Indicates the delay in milliseconds per reader thread. This property is used with the collection.reader.throttle.bytes.threshold property.

You can change the default value of the property by specifying its name and specifying a corresponding value in the PropertyValue variable. This feature provides a means to change the properties in the agent.properties file. These changes might be required for making advanced configurations to improve the performance of the Collection Agent.

Note: The property values specified in the variable takes precedence over the values available in the agent.properties file.

/ITDAConfig/ITDA/UDC/<AgentName>/ItdaCollectionAgentProperties/<AgentName>_1/PropertyValue

(Optional) Specify the corresponding value for the property name specified in the PropertyName variable.Example:

If you want to change the collection thread pool size from 2 to 3, then you need to specify the following inputs:

Specify 3 in this field and ensure that you have specified collection.thread.pool.size in the PropertyName variable.

/AgentSetup/ThirdParty/java_home

Specifies the location of the JRE used by PATROL.

Specifying this variable is necessary only if you installed the JRE in a new location, other than the following PATROL default location:

  • Windows: %PATROL_HOME%
  • UNIX: $PATROL_HOME/..

The value of this field is the absolute path to the JRE.

Example: C:\Program Files (x86)\JAVA\jre64

Configuration variables in PATROL for IT Data Analytics

Click here to see the list
PATROL_CONFIG
"/AgentSetup/ThirdParty/java_home" = { REPLACE = "<local path jre>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/agent.name" = { REPLACE = "<AgentName>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/serverhost" = { REPLACE = "<ITDA Collection Station Host>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/serverport" = { REPLACE = "<Station Port :default 8080>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/stationprotocol" = { REPLACE = "<station protocol : 0(http)or 1(https)>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/collectionprofile" = { REPLACE = "<Collection Profile Name>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/CollectionProfilePropMacro/<Collection Profile Name>_1/macroname" = { REPLACE = "<macro name>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/CollectionProfilePropMacro/<Collection Profile Name>_1/macrovalue" = { REPLACE = "<macroValue>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/CollectionProfilePropMacro/<Collection Profile Name>_2/macroname" = { REPLACE = "<macro name>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/CollectionProfileProp/<Collection Profile Name>/CollectionProfilePropMacro/<Collection Profile Name>_2/macrovalue" = { REPLACE = "<macroValue>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/ItdaCollectionAgentProperties/<AgentName>_1/PropertyName" = { REPLACE = "<Property Name>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/ItdaCollectionAgentProperties/<AgentName>_1/PropertyValue" = { REPLACE = "<Property Value>" },
"/ITDAConfig/ITDA/UDC/<AgentName>/ItdaCollectionAgentProperties/<AgentName>_2/PropertyName" = { REPLACE = "<Property Name>" }
"/ITDAConfig/ITDA/UDC/<AgentName>/ItdaCollectionAgentProperties/<AgentName>_2/PropertyValue" = { REPLACE = "<Property Value>" },

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*