Configuring the devices to ping using PCM
This section describes how to configure network devices to be pinged using PATROL Configuration Manager (PCM).
List of ruleset files
The following table lists the rule set files, which are available at$PATROL_HOME\..\pconfmgr\rulesets\Shipped\PPM\km_version_number\NetworkDeviceConfiguration for configuring network devices:
Files | Descrption |
|---|---|
NetworkDevice.cfg | Contains configuration variables to configure a single network device. |
NetworkSegment.cfg | Contains configuration variables to configure a network segment, that is, network devices within an IP address range. It also provides configuration variables to specify the IP addresses of those devices, which have to be excluded from the range. |
ConfigurationFilesBasedMonitoring.cfg | Contains configuration variables to configure network devices from a text file. the text file is located at%PATROL_HOME%\PPM\Conf\ImportDevices. |
SharedConfiguration.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. |
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 Administration.cfg,ConfigurationFilesBasedMonitoring.cfg, NetworkDevice.cfg,NetworkSegment.cfg, and DefaultConfiguration.cfg. |
All.cfg file template
The following is the template of All.cfg file, which contains configuration variables to configure the network device.
"/PPM/txn_id" = { REPLACE = "1"},
"/PPM/Default/Properties/RootDisplayName" = { REPLACE = "Network devices(Ping)"},
"/PPM/Default/Properties/DeviceMapping" = { REPLACE = "1"},
"/PPM/Default/Properties/Debug" = { REPLACE = "0"},
"/PPM/Default/Properties/ReadFromFile" = { REPLACE = "1"},
"/PPM/Devices/<<MyNetworkDevice>>/ConfiguredManually" = { REPLACE = "1"},
"/PPM/Devices/<<MyNetworkDevice>>/GroupName" = {REPLACE = "Network"},
"/PPM/Devices/<<MyNetworkDevice>>/IPAddress" = {REPLACE = "<<My IP Address (Optional)>>"},
"/PPM/Devices/<<MyNetworkDevice>>/IsDynamic" = { REPLACE = "2"},
"/PPM/Devices/<<MyNetworkDevice>>/Name" = { REPLACE = "<<MyNetworkDevice>>" },
"/PPM/Devices/<<MyNetworkDevice>>/PollInterval" = { REPLACE = "300" },
"/PPM/Devices/<<MyNetworkDevice>>/Protocol" = { REPLACE = "1"},
"/PPM/Devices/<<MyNetworkDevice>>/RequestCount" = {REPLACE = "4"},
"/PPM/Devices/<<MyNetworkDevice>>/Timeout" = { REPLACE = "1000"},
"/PPM/Devices/<<MyNetworkDevice>>/TransmitPackageSize" = { REPLACE = "32"},
"/PPM/NetworkSegment/<<192.168.1.1-8>>/AddressRange" = { REPLACE = "<<192.168.1.1-8>>"},
"/PPM/NetworkSegment/<<192.168.1.1-8>>/ExcludeIPAddresses" = { REPLACE = "<<Comma Separated IP Addresses" },
"/PPM/NetworkSegment/<<192.168.1.1-8>>/GroupName" = { REPLACE = "<<Group Name>>"},
"/PPM/NetworkSegment/<<192.168.1.1-8>>/PollInterval" = {REPLACE = "300"},
"/PPM/NetworkSegment/<<192.168.1.1-8>>/RequestCount" = {REPLACE = "4"},
"/PPM/NetworkSegment/<<192.168.1.1-8>>/Timeout" = {REPLACE = "1000"},
"/PPM/NetworkSegment/<<192.168.1.1-8>>/TransmitPackageSize" = {REPLACE = "32"},
"/PPM/Default/Properties/DefaultIsDynamic" = {REPLACE = "0"},
"/PPM/Default/Properties/DefaultPollInterval" = {REPLACE = "300"},
"/PPM/Default/Properties/DefaultProtocol" = {REPLACE = "1"},
"/PPM/Default/Properties/DefaultRequestCount" = {REPLACE = "4"},
"/PPM/Default/Properties/DefaultTimeout" = {REPLACE = "1000"},
"/PPM/Default/Properties/DefaultTransmitPackageSize" = {REPLACE = "32"}
Configuring network devices using 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 > PPM > KM_version_number > NetworkDeviceConfiguration 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.- 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 following command in the script file:
apply -a agentName NetworkDevice
The NetworkDevice variable represents the name of the RuleSets file.
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 for Network device configuration
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.
Variable | Description | Operation | Value |
|---|---|---|---|
/PSM/txn_id | Activates the network device configuration. | Replace | 1 |
Network device configuration details | |||
/PPM/Devices/<<MyNetworkDevice>> /ConfiguredManually
| Option for configuring the network device manually. | Replace | 1: ConfigureS network deivce manually |
/PPM/Devices/<<MyNetworkDevice>> /GroupName | Group name for all IP addresses in the range. If you don not provide any value in this field blank, the IP address range itself will be taken as the group name | Manual |
|
/PPM/Devices/<<MyNetworkDevice>> /IPAddress | (Optional) The IP address of the network device you want to ping. | Manual |
|
/PPM/Devices/<<MyNetworkDevice>> /IsDynamic | Option to configure the device with the dynamic IP address. If the IP address is dynamic, the device communicates with the DNS server during each poll interval to resolve the IP address. | Replace |
|
/PPM/Devices/<<MyNetworkDevice>>/Name | Alias name of the network device you want to ping. | Manual |
|
/PPM/Devices/<<MyNetworkDevice>> /PollInterval
| The poll interval time in seconds to ping the device. The default value is 300 seconds. The minimum value you can enter is 1 and the maximum value you can enter is 10. | Manual |
|
/PPM/Devices/<<MyNetworkDevice>> /Protocol
|
|
|
|
/PPM/Devices/<<MyNetworkDevice>> /RequestCount | The number of echo request messages to send. The default value is 4. The minimum value you can enter is 1 and the maximum value you can enter is 10. | Manual |
|
/PPM/Devices/<<MyNetworkDevice>> /Timeout | The timeout in milliseconds to wait for each reply. The default value is 1000 milliseconds. The minimum value you can enter is 1 millisecond and the maximum value you can enter is 30000 milliseconds. | Manual |
|
/PPM/Devices/<<MyNetworkDevice>> /TransmitPackageSize | The transmit packet size in bytes.The default value is 32 bytes. The minimum bytes you can transmit is 32 bytes. The maximum bytes you can transmit is 65500 bytes. | Manual |
|
Network segment | |||
/PPM/NetworkSegment/<<192.168.1.1-8>>/AddressRange | The IP address range in the following format: IPAddress-Range. For example, if you enter the IP address range as 10.64.109.1-10, all IP addresses in the range between 10.64.109.1 to 10.64.109.10 are configured. | Manual |
|
/PPM/NetworkSegment/<<192.168.1.18>> /ExcludeIPAddresses | (Optional.) Comma separated IP addresses to be excluded from the range. For example, if you enter the IP address range is 10.64.109.1-10 and you want to exclude IP addresses:10.64.109.6, 10.64.109.7, and 10.64.109.8, use one of the following options:
| Manual |
|
/PPM/NetworkSegment/<<192.168.1.1-8>>/GroupName | (Optional.) The group name for all IP addresses in the range. If you will leave this field blank, the group name is the IP address range. | Manual |
|
/PPM/NetworkSegment/<<192.168.1.1-8>>/PollInterval | The poll interval time in seconds to ping the device. The default value is 300 seconds. The minimum value you can enter is 10 seconds. The maximum value you can enter is 3600 seconds. | Manual |
|
/PPM/NetworkSegment/<<192.168.1.1-8>>/RequestCount | The number of echo request messages to send. The default value is 4. The minimum value you can enter is 1 and the maximum value you can enter is 10. | Manual |
|
/PPM/NetworkSegment/<<192.168.1.1-8>> /Timeout | The timeout in milliseconds to wait for each reply. The default value is 1000 milliseconds. The minimum value you can enter is 1 millisecond and the maximum value you can enter is 30000 milliseconds. | Manual |
|
/PPM/NetworkSegment/<<192.168.1.1-8>>/TransmitPackageSize | The transmit packet size in bytes.The default value is 32 bytes. The minimum bytes you can transmit is 32 bytes. The maximum bytes you can transmit is 65500 bytes. | Manual |
|
Configuration files based monitoring | |||
/PPM/Default/Properties/ReadFromFile | Option to configure devices to be pinged automatically from files. | Replace | 1: Enables to configure devices to be pinged automatically from files. |
Administration | |||
/PPM/Default/Properties/RootDisplayName | Display name for the monitor type in order to display a meaningful location name for the target agent. | Manual |
|
/PPM/Default/Properties/DeviceMapping | Option to display monitor instance as a device in the Operations Console. | Replace |
|
/PPM/Default/Properties/Debug | Option to enable logging. The log files are created at %PATROL_HOME%\PPM\logs. By default, this option is disabled. |
| 0: Disables logging 1: Enables logging |
DefaultConfiguration | |||
The default configuration settings enables you to set pre-defined values in the configuration rule sets to ping a device or network segment. You can set up default configuration for the following configuration rule sets. | |||
/PPM/Default/Properties/DefaultIsDynamic | Option to configure the device with the dynamic IP address. If the IP address is dynamic, the device communicates with the DNS server during each poll interval to resolve the IP address. | Replace |
|
PPM/Default/Properties/DefaultPollInterval | The poll interval time in seconds to ping the device. The default value is 300 seconds. The minimum value you can enter is 1 and the maximum value you can enter is 10. | Manual |
|
/PPM/Default/Properties/DefaultProtocol" = {REPLACE = "1"}, |
|
|
|
/PPM/Default/Properties/DefaultRequestCount | The number of echo request messages to send. The default value is 4. The minimum value you can enter is 1 and the maximum value you can enter is 10. | Manual |
|
/PPM/Default/Properties/DefaultTimeout | The timeout in milliseconds to wait for each reply. The default value is 1000 milliseconds. The minimum value you can enter is 1 millisecond and the maximum value you can enter is 30000 milliseconds. | Manual |
|
/PPM/Default/Properties /DefaultTransmitPackageSize | The transmit packet size in bytes.The default value is 32 bytes. The minimum bytes you can transmit is 32 bytes. The maximum bytes you can transmit is 65500 bytes. | Manual |
|