How do I install and configure the ICMP poller in Watch4net
search cancel

How do I install and configure the ICMP poller in Watch4net


Article ID: 304688


Updated On:




VMware Smart Assurance - Watch4Net/M&R


About the ICMP-Collector:

This APG collector is used to ping a list of hosts and determine if they are up (responding to ICMP
echos) or down. This collector will attempt to poll all hosts within the specified period, while preserving
system resources as much as possible by smoothing out the polling on the available time.

Note: In order to run properly root permissions will be needed

Metrics include:

Icmp echo round trip time (default name: icmpRtt): The average time for an icmp echo resquest
response. This value is impacted by the drop-max-value setting.

  Icmp reachability ratio (default name: icmpReachability): The ratio of responses versus the
number of pings sent to the target. Values are between 0 and 1. If one ping is specified, 0 or 1
is returned, which corresponds to basic Icmp availability.

  Optional: Icmp availability (default name: icmpOk): Indicates that the target answered any of the
pings sent (value = 100) or none (value = 0). This can be set up by using a filter.

How to install the ICMP-Collector:
1. Navigate to bin directory
Default path for Linux: /opt/APG/bin

Default path for Windows: C:\Program Files\APG\bin

2. Make sure the ICMP-collector is available
Command for Linux: ./ list available | grep ICMP

Command for Windows:manage-modules.cmd list available | findstr ICMP

You should receive an output similar to below:

# ./ list available | grep ICMP
 * icmp-collector-5.6u1-linux-x64                      : Collecting       ICMP-Collector                        v5.6u1    linux-x64
 * icmp-collector-5.6u2-linux-x64                      : Collecting       ICMP-Collector                        v5.6u2    linux-x64

3. Install ICMP-Collector ( you can use the output from the above command for the full name of the collector) 
Command for Linux: ./ install icmp-collector-5.6u1-linux-x64

Hit enter or type yes to continue with the operation. 
How to configure the ICMP-Collector:

After installing the ICMP-Collector you must enable the ICMP collector by enabling it on a Collector-Manger instance.
Modify the collecting,xml
1. Edit your chosen Collector-Manager instance collecting.xml by declaring the ICMP-Collector  (APG/Collecting/Collector-Manager/ <INSTANCE NAME> /conf/collecting.xml)

Add the declaration in the collector section.
... other collectors
<collector enabled="true" name="ICMP-Collector" next="SomeFilter" type="icmpCollector" config="ICMP-Collector/<INSTANCE_NAME>/conf/icmp-collector.xml"/>
... other collectors

* The 'next' field will need to point to the next place to send data filter in your collecting.xml usually some filter.
** The 'config' field will need to point to the absolute or relative path of your icmp-collector.xml
It is strongly recommended to use a distinct instance of the Collector-Manager to run the ICMP-Collector. Some collectors, such as the APG-Selft-Monitoring collector, are not designed to run as root.
Verify icmp-collecting.xml

1. Navigate to icmp-collecting.xml ( APG/Collecting/ICMP-Collector/Default/conf/icmp-collector.xml)

2. Verify the fields in the configuration.
<maxIcmpThreads>1</maxIcmpThreads> : 1 thread. This is enough for a small POC (10-15 devices)
<periodicity>240</periodicity>: 4 minute polling period. May be set to 5 minutes to match other SNMP or SMARTS metrics
<source-property>icmpCollector</source-property>: Source name is icmpCollector : this value appears in the raw values source property. And should match your declaration in the collecting.xml
<snmp-polling-distribution>conf/snmp-polling-distribution.xml</snmp-polling-distribution>: No editing is needed if this suits your requirements. If you are not using the SNMP Collector, please use a < targetsFile > instead of the < snmp  polling  distribution > file. 
Enable root privledges for the collector

1. Navigate to for the Collecting-Manager instance running the ICMP-Collector. (APG/Collecting/Collector-Manager/conf/

2. Uncomment the following lines by removing the # at the start of the line.
# jvm.param.#=-Djava.rmi.server.hostname=$HOSTNAME$
Update modules

1. Update the Collector Manager instance that you are running ICMP-Collector on. This is the collector that you gave root access to.
Run the following command to update  APG/bin/ service install collector-manager (instance name) .
2. Update the ICMP-Collector
Run the following command "./ update icmp-collector"