1Smokeping_probes_DismanPing(3)     SmokePing    Smokeping_probes_DismanPing(3)
2
3
4

NAME

6       Smokeping::probes::DismanPing - DISMAN-PING-MIB Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +DismanPing
12
13        offset = 50%
14        pings = 15
15        step = 300
16
17        # The following variables can be overridden in each target section
18        /^influx_.+/ = influx_location = In the basement
19        ownerindex = smokeping
20        packetsize = 56
21        pinghost = pinger@router.example.com # mandatory
22        pingsrc = 192.0.2.9
23
24        # [...]
25
26        *** Targets ***
27
28        probe = DismanPing # if this should be the default probe
29
30        # [...]
31
32        + mytarget
33        # probe = DismanPing # if the default probe is something else
34        host = my.host
35        /^influx_.+/ = influx_location = In the basement
36        ownerindex = smokeping
37        packetsize = 56
38        pinghost = pinger@router.example.com # mandatory
39        pingsrc = 192.0.2.9
40

DESCRIPTION

42       Uses the DISMAN-PING-MIB to cause a remote system to send probes.
43

VARIABLES

45       Supported probe-specific variables:
46
47       offset
48           If you run many probes concurrently you may want to prevent them
49           from hitting your network all at the same time. Using the probe-
50           specific offset parameter you can change the point in time when
51           each probe will be run. Offset is specified in % of total interval,
52           or alternatively as 'random', and the offset from the 'General'
53           section is used if nothing is specified here. Note that this does
54           NOT influence the rrds itself, it is just a matter of when data
55           acquisition is initiated.  (This variable is only applicable if the
56           variable 'concurrentprobes' is set in the 'General' section.)
57
58           Example value: 50%
59
60       pings
61           How many pings should be sent to each target. Note that the maximum
62           value for DismanPing MIP is 15, which is less than the SmokePing
63           default, so this class has its own default value.  If your Database
64           section specifies a value less than 15, you must also set it for
65           this probe.  Note that the number of pings in the RRD files is
66           fixed when they are originally generated, and if you change this
67           parameter afterwards, you'll have to delete the old RRD files or
68           somehow convert them.
69
70           Example value: 15
71
72           Default value: 15
73
74       step
75           Duration of the base interval that this probe should use, if
76           different from the one specified in the 'Database' section. Note
77           that the step in the RRD files is fixed when they are originally
78           generated, and if you change the step parameter afterwards, you'll
79           have to delete the old RRD files or somehow convert them. (This
80           variable is only applicable if the variable 'concurrentprobes' is
81           set in the 'General' section.)
82
83           Example value: 300
84
85       Supported target-specific variables:
86
87       /^influx_.+/
88           This is a tag that will be sent to influxdb and has no impact on
89           the probe measurement. The tag name will be sent without the
90           "influx_" prefix, which will be replaced with "tag_" instead. Tags
91           can be used for filtering.
92
93           Example value: influx_location = In the basement
94
95       ownerindex
96           The SNMP OwnerIndex to use when setting up the test.  When using
97           VACM, can map to a Security Name or Group Name of the entity
98           running the test.
99
100           By default this will be set to
101
102           Example value: smokeping
103
104       packetsize
105           The packetsize parameter lets you configure the packet size for the
106           pings sent. The minimum is 8, the maximum 65507. Use the same
107           number as with fping if you want the same packet sizes being used
108           on the network.
109
110           Default value: 56
111
112       pinghost
113           The (mandatory) pinghost parameter specifies the remote system
114           which will execute the pings, as well as the SNMP community string
115           on the device.
116
117           Example value: pinger@router.example.com
118
119           This setting is mandatory.
120
121       pingsrc
122           The (optional) pingsrc parameter specifies the source address to be
123           used for pings.  If specified, this parameter must identify an IP
124           address assigned to pinghost.
125
126           Example value: 192.0.2.9
127

AUTHORS

129       Bill Fenner <fenner@research.att.com>, Tobi Oetiker <tobi@oetiker.ch>
130

NOTES

132   MENU NAMES
133       This probe uses the menu name of a test as part of the unique index.
134       If the menu name is longer than 32 characters, the last 32 characters
135       are used for the index.  Collisions are *not* detected and simply cause
136       one test's results to be used for all colliding names.
137
138   CONFIGURATION
139       This probe requires read/write access to the pingCtlTable.  It also
140       requires read-only access to the pingResultsTable and the
141       pingHistoryTable.  The DISMAN-PING-MIB is structured such that it is
142       possible to restrict by pingCtlOwnerIndex.  This probe uses a
143       pingCtlOwnerIndex of "SP on hostname" as ownerindex by default; use
144       ownerindex to configure this if needed.
145
146   SAMPLE JUNOS CONFIGURATION
147       This configuration permits the community "pinger" read-write access to
148       the full DISMAN-PING-MIB, but only when sourced from the manager at
149       192.0.2.134.
150
151           snmp {
152               view pingMIB {
153                   oid .1.3.6.1.2.1.80 include;
154               }
155               community pinger {
156                   view pingMIB;
157                   authorization read-write;
158                   clients {
159                       192.0.2.134/32;
160                   }
161               }
162           }
163
164   SAMPLE CONFIGURATIONS NOTE
165       This configuration allows the "pinger" community full access to the
166       DISMAN-PING-MIB.  There is information in the description of
167       pingCtlOwnerIndex in RFC 4560 (<http://tools.ietf.org/html/rfc4560>)
168       about using the vacmViewTreeFamilyTable to further restrict access.
169       The author has not tried this method.
170
171
172
1732.8.2                             2022-01-22    Smokeping_probes_DismanPing(3)
Impressum