Configuring DNS using PCM

This section describes how to configure DNS and check the DNS availability and response time using the PATROL Configuration Manager (PCM).

List of ruleset files

The following table lists the ruleset files, which are available at $PATROL_HOME\..\pconfmgr\rulesets\Shipped\KDN\km_version_number\DNS for configuring the network devices:

Files	Descrption
ConfigurationFilesBasedMonitoring.cfg	Contains configuration variables to configure network devices from a text file. the text file is located at *%PATROL_HOME%\KDN\Conf\ImportDevices*.
DefaultConfiguration.cfg	Default configuration settings enables you to set pre-defined values for the configuration fields to ping a network device or network segment. You can set up default configuration.
DNS.cfg	Contains configuration variables to provide additional information related to DNS servers.
Administration.cfg	Contains configuration variables to provide additional information related to network devices, such as, display name, debug enabling and so on.
All.cfg	Consolidated file containing all the configuration variables available in ConfigurationFilesBasedMonitoring.cfg, Administration.cfg, DNS.cfg, and DefaultConfiguration.cfg.

All.cfg file template

The following is the template of All.cfg file, which contains configuration variables to monitor DNS servers.

PATROL_CONFIG
"/KDN/txn_id" = { REPLACE = "1"},
#DNS Device
"/KDN/KDN_Root/Devices/<<MyDevice>>/Category" = {REPLACE = "REPLACE = "<<Network>>""},
"/KDN/KDN_Root/Devices/<<MyDevice>>/ConnectionProtocol" = {REPLACE = "<<0 for TCP 1 for UDP>>"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery//<<MyQuery>>/Query" = {REPLACE = "www.bmc.com"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryName" = {REPLACE = "<<DNS Query>>"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryPollInterval" = {REPLACE = "300"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryTimeout" = {REPLACE = "30"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryType" = {REPLACE = "1"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/RegEx" = {REPLACE = "<<Java regular expression>>"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DeviceName" = {REPLACE = "<<MyDevice>>"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DevicePollInterval" = {REPLACE = "300"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/DeviceTimeout" = {REPLACE = "10"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/Port" = {REPLACE = "53"},
"/KDN/KDN_Root/Devices/<<MyDevice>>/ipAddress" = {REPLACE = "<<ip>>"},
#Administration
"/KDN/KDN_Root/RootDisplayName" = { REPLACE = "<<DNS>>"},
"/KDN/KDN_Root/DeviceMapping" = { REPLACE = "<<0(No) or 1(Yes: FQDN) or 2(Yes: User defined)>>"},
"/KDN/KDN_Root/ReadFromFile" = { REPLACE = "<<0>>"},
"/KDN/KDN_Root/JAVA_HOME" = { REPLACE = "<<%JAVA_HOME%>>"},
"/KDN/KDN_Root/Debug" = { REPLACE = "<<1(Yes) or 0(No)>>"},
#Shared Configuration
"/KDN/KDN_Root/Shared_DevicePollInterval" = {REPLACE = "300"},
"/KDN/KDN_Root/Shared_DeviceTimeout" = {REPLACE = "10"},
"/KDN/KDN_Root/Shared_Port" = {REPLACE = "53"},
"/KDN/KDN_Root/Shared_QueryPollInterval" = {REPLACE = "300"},
"/KDN/KDN_Root/Shared_QueryTimeout" = {REPLACE = "30"},
"/KDN/KDN_Root/Shared_QueryType" = {REPLACE = "1"},
"/KDN/KDN_Root/Shared_ConnectionProtocol" = {REPLACE = "<<0 for TCP 1 for UDP>>"}

Configuring DNS using the PCM menu commands

The following procedure explains how to use the PATROL Configuration Manager menu commands to create and configure custom monitor.

In PATROL Configuration Manager, locate Shipped > KDN > KM_version_number > DNSConfiguration folder.
Select the ruleset folder using which you want to configure the network devices.
Right-click the rule and select Edit Rule. The RuleSet dialog box is displayed.
In the Operation column, select the REPLACE option, which is the default value.
Double-click the highlighted space in the Value column and enter the value of the variable.
For information about the description and values of the variables, see Configuration variables.
Warning
Note
The value of the variable does not support blank spaces and special characters such as /, \, &, and @.
Click OK.
Repeat the above steps for all the rules.
After adding values to the variables for creating custom monitor, drag the new RuleSet onto the agentHostName in the left pane.
Click the Apply Configuration icon in the PATROL Configuration Manager menu bar.

Configuring using the PATROL Configuration Manager CLI

The PATROL Configuration Manager CLI processes a script file that contains commands regarding RuleSets.
To perform BMC PATROL for Light Weight Protocols configuration using the PATROL Configuration Manager RuleSets, you must set values for the configuration variables in the .cfg files. After you provide values in the files, you can apply the configuration to the PATROL Agent using the PATROL Configuration Manager CLI. For a list of configuration variables that you can include in the .cfg file, see Configuration variables.
Store your .cfg files in any directory under the %BMC_ROOT%/pconfmgr/rulesets directory, and use the following command to apply the RuleSets:

- (Windows) pcm.cmd -f scriptFileName
- (UNIX) pcm.sh -f scriptFileName
  The scriptFileName variable represents the script file that contains commands to be executed for applying RuleSets. For example, to apply rulesets for the creating and configure custom monitor, enter the apply -a agentName DNS
  command in the script file. The variable represents the name of the rulesets file.
  Warning
  Note
  In the apply -a agentName DNS command:
  Specify the path as relative to the rulesets directory.
  Do not include the extension when specifying the file name.

For more information about the commands and options that can be used in a script file, see the PATROL Configuration Manager User Guide and Configuration variables.

Configuration variables

The following table provides information about the configuration variables for configuring the network devices you want monitor. You can use PATROL Configuration Manager to add values to the variable for configuring network devices. For more information about how to add values to the network device, see Configure-using-PATROL-Configuration-Manager.

Note

The value, Manual in the value column of the table indicates that there is no predefined value for the configuration variable and you must manually enter a value for those variables.

Variable	Description	Operation	Value
/KDN/txn_id	Activates the network device configuration. Note: Every time you configure a network device or network segment, the value of txn_id must be different from the previous configuration of network device or network segment.	Replace	1
DNS Device details
/KDN/KDN_Root/Devices/<<MyDevice>>/Category	Category name	Replace	Network
/KDN/KDN_Root/Devices/<<MyDevice>>/ConnectionProtocol	Connection Protocol.	Replace	0 -TCP 1 - UDP
/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/Query	Query argument, hostname or an IP.	Replace	<<MyQuery>>
/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryName	Query display name, can be any meaningful name associated with the DNS.	Replace	DNS Query name
/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryPollInterval	Connection validation frequency in seconds	Replace	300
/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryTimeout	Connection timeout in seconds	Replace	30
/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/QueryType	Query Type that will passed to the DNS server. The query type can be: 1=A - Address Mapping record 28=AAAA - IPv6 Address Mapping record 2=NS - Name Server records 5=CNAME - Canonical Name record 6=SOA - Start of Authority 12=PTR - Reverse-lookup Pointer records 15=MX - Mail exchanger record 16=TXT - Text record 37=CERT - Certificate record 33=SRV - Service Location 255=ANY - All records	Replace	1
/KDN/KDN_Root/Devices/<<MyDevice>>/DNSQuery/<<MyQuery>>/RegEx			Java regular expression
/KDN/KDN_Root/Devices/<<MyDevice>>/DeviceName			MyDevice
/KDN/KDN_Root/Devices/<<MyDevice>>/DevicePollInterval			300
/KDN/KDN_Root/Devices/<<MyDevice>>/DeviceTimeout			10
/KDN/KDN_Root/Devices/<<MyDevice>>/Port			53
/KDN/KDN_Root/Devices/<<MyDevice>>/ipAddress			IP
Files based configuration
/KDN_Root/ReadFromFile		Replace	1 - Yes 0 - No
Default configuration
/KDN/KDN_Root/Shared_DevicePollInterval	Connection validation frequency in seconds	Replace	300
/KDN/KDN_Root/Shared_DeviceTimeout	Connection timeout in seconds	Replace	10
/KDN/KDN_Root/Shared_Port	Connection port number	Replace	53
/KDN/KDN_Root/Shared_QueryPollInterval	Connection validation frequency in seconds	Replace	300
/KDN/KDN_Root/Shared_QueryTimeout	Connection timeout in seconds	Replace	30
/KDN/KDN_Root/Shared_QueryType	Query Type that will passed to the DNS server. The query type can be: 1=A - Address Mapping record 28=AAAA - IPv6 Address Mapping record 2=NS - Name Server records 5=CNAME - Canonical Name record 6=SOA - Start of Authority 12=PTR - Reverse-lookup Pointer records 15=MX - Mail exchanger record 16=TXT - Text record 37=CERT - Certificate record 33=SRV - Service Location 255=ANY - All records	Replace	1
/KDN_Root/Shared_ConnectionProtocol	Connection Protocol	Replace	0 -TCP 1 -UDP
Administration configuration
/KDN/KDN_Root/RootDisplayName	Display name for the monitor type in order to display a meaningful location name for the target agent.	Manual	DNS
/KDN/KDN_Root/DeviceMapping	Option to display monitor instance as a device in the Operations console.	Replace	0 - Disable 1 - Displays FQDN as the device name of the network device in the Operations console 2 - Displays user defined name (alias name) as the device name of the network device in the Operations console.
/KDN/KDN_Root/Debug	Option to enable logging. The log files are created at *%PATROL_HOME%\KDN\logs*. By default, this option is disabled.	Replace	0 - Disable logging 1 - Enable logging
/KDN/KDN_Root/Java path	Specify the path of the JRE directory ($JAVA_HOME environment variable) on the PATROL Agent host which is used by the KM. If the JAVA_HOME environment variable of the PATROL Agent is set, you can use the default value $JAVA_HOME as the Java path. If the feild is left blank, the KM uses the Java path installed on the PATROL Agent home directory in the following format: $PATROL_HOME/openjdk or $PATROL_HOME/jre64. For example: Windows - C:\Program Files\Java\jdk-11.	Replace	%JAVA_HOME%