Creating and configuring custom monitors using PCM

This section describes how to create and configure custom monitors using PATROL Configuration Manager (PCM).

If you do not want to use native monitors to monitor the network devices, you can create and configure custom monitors using PCM.

The rule set file, CustomMonitor.cfg for creating and configuring custom monitor is located at $PATROL_HOME\..\pconfmgr\rulesets\Shipped\PSM\km_version_number\CustomMonitorCreation.

You can configure the custom monitor using the following template: 

PATROL_CONFIG
"/PSM/txn_id" = { REPLACE = "1"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/MonitorName" = { REPLACE = "<<MonitorName>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/MonitorCategory" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/CounterName" = { REPLACE = "<<CounterName>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/OidFormula" = { REPLACE = "<<.1.3.6.1.2.1.6.14.0>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/Unit" = { REPLACE = "<<Use Units.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/CustomUnit" = { REPLACE = "<<delete=12,error=other>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/MeasureAS" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/Scale" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/Availability" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/Delta" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/GraphByDefault" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/KPI" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/ResponseTime" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/Counters/<<CounterName>>/Statistical" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/Name" = { REPLACE = "<<ObjectTypeName>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/DiscoveryKey" = { REPLACE = "<<.1.3.6.1.2.1.6.13.1.2,.1.3.6.1.2.1.6.13.1.3>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/CounterName" = { REPLACE = "<<CounterName>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/OidFormula" = { REPLACE = "<<.1.3.6.1.2.1.6.13.1.1>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/Unit" = { REPLACE = "<<Use Units.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/CustomUnit" = { REPLACE = "<<delete=12,error=other>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/MeasureAS" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/Scale" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/Availability" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/Delta" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/GraphByDefault" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/KPI" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/ResponseTime" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"},
"/PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/ObjectTypes/<<ObjectTypeName>>/ObjectCounters/<<CounterName>>/Statistical" = { REPLACE = "<<Use Readme.txt file for Entry settings>>"}

Creating and configuring custom monitors using PCM menu commands

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

  1. In PATROL Configuration Manager, locate Shipped > PSM > km_version_number > CustomMonitorCreation.
  2. Right click the rule and select Edit Rule.

    The RuleSet dialog box is displayed.
  3. In the Operation column, select the REPLACE option, which is the default value.

  4. 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.

     

    Note

     The value of the variable does not support blank spaces and special characters such as /, \, &, and @.

  5. Click OK.
  6. Repeat the above steps for all the rules.
  7. After adding values to the variables for creating a custom monitor, drag the new RuleSet onto the agentHostName in the left pane.
  8. Click the Apply Configuration icon in the PATROL Configuration Manager menu bar.

For more information about adding a variable or RuleSet by using PATROL Configuration Manager, see the PATROL Configuration Manager User Guide.

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 for configuring custom monitor (CustomMonitor.cfg), 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 CustomMonitor

The CustomMonitor variable represents the name of the RuleSets file.

Note

In the preceding 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 for custom monitor configuration

The following table provides information about the configuration variables for creating and configuring custom monitors. You can use PATROL Configuration Manager to add values to the configuration variable for configuring custom monitors. For more information about how to add values to the custom monitor, 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 variable.
  • Each variable within <<>> should be replaced by the user's variable.

    Example: 

    /PSM/PSM_Custom/CustomMonitors/<<MonitorName>>/MonitorName can be replaced with /PSM/PSM_Custom/CustomMonitors/MY_MONITOR/MonitorName

Variable

Description

Operation

Value

Custom monitor creation

/PSM/txn_id

Activates the custom monitor configuration.

Note

Every time you create and configure the custom monitor, the value of txn_id must be different from the previous configuration of a custom monitor.


Replace

1

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/MonitorName

Name of the custom monitor.

Replace

Manual

Note

The value must be same as the variable that replaces <<MonitorName>>.

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/MonitorCategory

Monitor category based on the MIB file definition.

Replace

  • 1: Network
  • 2: System
  • 3: Application
  • 4: Hardware

Monitor counter details

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/CounterName

Monitor counter name.

Replace

Manual

 

Note

The value must be same as the variable that replaces <<CounterName>>.

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/OidFormula

Monitor counter OID or formula to poll.

Replace

Manual

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/Unit

Monitor counter unit.

If this pre-defined rule set does not serves the counter unit, then you can remove this rule set to provide the required unit in the /PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/CustomUnit rule set.

Replace

  • 0: No unit
  • 1: Milliseconds (ms)
  • 2: seconds (sec)
  • 3: Minutes (min)
  • 4: Hours (hr)
  • 5: Days (day)
  • 6: Weeks (wk)
  • 7: Bits (b)
  • 8: Kilobits (kb)
  • 9: Megabits (Mb)
  • 10: Gigabits (Gb)
  • 11: Bytes (B)
  • 12: KiloBytes (kB)
  • 13: MegaBytes (MB)
  • 14: GigaBytes (GB)
  • 15: Bits per second 
    (b/sec)
  • 16: Kilobits per second 
    (kb/sec)
  • 17: Megabits per second 
    (Mb/sec)
  • 18: Gigabits per second 
    (Gb/sec)
  • 19: Bytes per second 
    (B/sec)
  • 20: KiloBytes per second
    (KB/sec)
  • 21: MegaBytes per second 
    (MB/sec)
  • 22: GigaBytes per second 
    (GB/sec)
  • 23: Bits per minute 
    (b/min)
  • 24: Kilobits per minute 
    (kb/min)
  • 25: Megabits per minute 
    (Mb/min)
  • 26: Gigabits per minute 
    (Gb/min)
  • 27: Bytes per minute 
    (B/min)
  • 28: KiloBytes per minute 
    (KB/min)
  • 29: MegaBytes per minute 
    (MB/min)
  • 30: GigaBytes per minute 
    (GB/min)
  • 31: Bits per hour 
    (b/hr)
  • 32: Kilobits per hour 
    (kb/hr)
  • 33: Megabits per hour 
    (Mb/hr)
  • 34: Gigabits per hour 
    (Gb/hr)
  • 35: Bytes per hour 
    (B/hr)
  • 36: KiloBytes per hour 
    (kB/hr)
  • 37: MegaBytes per hour 
    (MB/hr)
  • 38: GigaBytes per hour 
    (GB/hr)
  • 39: packets per second 
    (pkts/sec)
  • 40: Errors per second 
    (err/sec)
  • 41: Percentage (%)
  • 42: Number of (#)
  • 43: Per minute (per min)
  • 44: Per sec (per sec)
  • 45: RPM (RPM)

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/CustomUnit

This rule set can be used if the predefined rule set,

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>> /Counters/

<<CounterName>>/Unit cannot serve as the counter unit. 

Replace

Manual

Monitor counter calculation

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/MeasureAS

Select how to measure the counter.

Replace

  • 1:Raw
  • 2: Delta
  • 3: Rate

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/Scale

Number to scale on the counter.

Replace

Manual

Monitor counter metadata

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/Availability

Availability counter type.

Replace

  • 0: No
  • 1: Yes

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/Delta

Delta counter type.

Replace

  • 0: No
  • 1: Yes

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/GraphByDefault

Attribute for default display.

Replace

  • 0: No
  • 1: Yes

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/KPI

Key Performance Indicator attribute of the monitor.

Replace

  • 0: No
  • 1: Yes

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/ResponseTime

Response time counter type.

Replace

  • 0: No
  • 1: Yes

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/Statistical

Statistical counter type.

Replace

  • 0: No
  • 1: Yes

Monitor object type

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/Name

Monitor object type name.

Replace

Manual

Note

The value must be same as the variable that replaces <<ObjectTypeName>>.

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/DiscoveryKey

Monitor object type discovery key.

Multi OIDs must be comma-separated.

Replace

Manual

Monitor object type counter details

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/CounterName

Monitor object type counter name.

Replace

Note

The value must be same as the variable that replaces <<CounterName>>.

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/OidFormula

Monitor object type counter OID or formula to poll.

Replace

Manual

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/Unit

Monitor counter unit.

If this pre-defined rule set does not serves the counter unit, then you can remove this rule set to provide the required unit in the

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/Counters/

<<CounterName>>/CustomUnit rule set.

Replace

  • 0: No unit
  • 1: Milliseconds (ms)
  • 2: seconds (sec)
  • 3: Minutes (min)
  • 4: Hours (hr)
  • 5: Days (day)
  • 6: Weeks (wk)
  • 7: Bits (b)
  • 8: Kilobits (kb)
  • 9: Megabits (Mb)
  • 10: Gigabits (Gb)
  • 11: Bytes (B)
  • 12: KiloBytes (kB)
  • 13: MegaBytes (MB)
  • 14: GigaBytes (GB)
  • 15: Bits per second 
    (b/sec)
  • 16: Kilobits per second 
    (kb/sec)
  • 17: Megabits per second 
    (Mb/sec)
  • 18: Gigabits per second 
    (Gb/sec)
  • 19: Bytes per second 
    (B/sec)
  • 20: KiloBytes per second 
    (KB/sec)
  • 21: MegaBytes per second 
    (MB/sec)
  • 22: GigaBytes per second 
    (GB/sec)
  • 23: Bits per minute 
    (b/min)
  • 24: Kilobits per minute 
    (kb/min)
  • 25: Megabits per minute 
    (Mb/min)
  • 26: Gigabits per minute 
    (Gb/min)
  • 27: Bytes per minute 
    (B/min)
  • 28: KiloBytes per minute 
    (kB/min)
  • 29: MegaBytes per minute 
    (MB/min)
  • 30: GigaBytes per minute 
    (GB/min)
  • 31: Bits per hour 
    (b/hr)
  • 32: Kilobits per hour 
    (kb/hr)
  • 33: Megabits per hour 
    (Mb/hr)
  • 34: Gigabits per hour 
    (Gb/hr)
  • 35: Bytes per hour 
    (B/hr)
  • 36: KiloBytes per hour 
    (kB/hr)
  • 37: MegaBytes per hour 
    (MB/hr)
  • 38: GigaBytes per hour 
    (GB/hr)
  • 39: Packets per second 
    (pkts/sec)
  • 40: Errors per second 
    (err/sec)
  • 41: Percentage (%)
  • 42: Number of (#)
  • 43: Per minute (per min)
  • 44: Per sec (per sec)
  • 45: RPM (RPM)

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/CustomUnit

This rule set can be used if the predefined rule set,

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/Unit cannot serve as the counter unit. 

Replace

Manual

Monitor object type counter calculation

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/MeasureAS

Select how to measure the counter.

Replace

  • 1:Raw
  • 2: Delta
  • 3: Rate

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/Scale

A number to scale on the counter value.

Replace

Manual

Monitor object type counter metadata

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/Availability

Availability counter type.

Replace

  • 0: No
  • 1: Yes

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/Delta

Delta counter type.

Replace

  • 0: No
  • 1: Yes

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/GraphByDefault

Attribute for default display.

Replace

  • 0: No
  • 1: Yes

 

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/KPI

Key Performance Indicator attribute of the monitor.

Replace

  • 0: No
  • 1: Yes

 

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/ResponseTime

Response time counter type.

Replace

  • 0: No
  • 1: Yes

 

/PSM/PSM_Custom/CustomMonitors/

<<MonitorName>>/ObjectTypes/

<<ObjectTypeName>>/ObjectCounters/

<<CounterName>>/Statistical

Statistical counter type.

Replace

  • 0: No
  • 1: Yes

 


 

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