~ubuntu-branches/debian/squeeze/smokeping/squeeze

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/Smokeping::probes::TelnetJunOSPing.3

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2008-08-29 18:29:34 UTC
  • mfrom: (2.1.14 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080829182934-ad5b9csusoqn1155
Tags: 2.3.6-3
* Unset LC_ALL in the init script because the daemon needs to 
  reset LC_NUMERIC. (Closes: #489766)
* Fix a bashism in the postinst script. Thanks, lintian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
 
2
.\"
 
3
.\" Standard preamble:
 
4
.\" ========================================================================
 
5
.de Sh \" Subsection heading
 
6
.br
 
7
.if t .Sp
 
8
.ne 5
 
9
.PP
 
10
\fB\\$1\fR
 
11
.PP
 
12
..
 
13
.de Sp \" Vertical space (when we can't use .PP)
 
14
.if t .sp .5v
 
15
.if n .sp
 
16
..
 
17
.de Vb \" Begin verbatim text
 
18
.ft CW
 
19
.nf
 
20
.ne \\$1
 
21
..
 
22
.de Ve \" End verbatim text
 
23
.ft R
 
24
.fi
 
25
..
 
26
.\" Set up some character translations and predefined strings.  \*(-- will
 
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 
28
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
 
29
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
 
30
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
 
31
.\" nothing in troff, for use with C<>.
 
32
.tr \(*W-
 
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 
34
.ie n \{\
 
35
.    ds -- \(*W-
 
36
.    ds PI pi
 
37
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
38
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 
39
.    ds L" ""
 
40
.    ds R" ""
 
41
.    ds C` ""
 
42
.    ds C' ""
 
43
'br\}
 
44
.el\{\
 
45
.    ds -- \|\(em\|
 
46
.    ds PI \(*p
 
47
.    ds L" ``
 
48
.    ds R" ''
 
49
'br\}
 
50
.\"
 
51
.\" If the F register is turned on, we'll generate index entries on stderr for
 
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 
53
.\" entries marked with X<> in POD.  Of course, you'll have to process the
 
54
.\" output yourself in some meaningful fashion.
 
55
.if \nF \{\
 
56
.    de IX
 
57
.    tm Index:\\$1\t\\n%\t"\\$2"
 
58
..
 
59
.    nr % 0
 
60
.    rr F
 
61
.\}
 
62
.\"
 
63
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 
64
.\" way too many mistakes in technical documents.
 
65
.hy 0
 
66
.if n .na
 
67
.\"
 
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
69
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
70
.    \" fudge factors for nroff and troff
 
71
.if n \{\
 
72
.    ds #H 0
 
73
.    ds #V .8m
 
74
.    ds #F .3m
 
75
.    ds #[ \f1
 
76
.    ds #] \fP
 
77
.\}
 
78
.if t \{\
 
79
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
80
.    ds #V .6m
 
81
.    ds #F 0
 
82
.    ds #[ \&
 
83
.    ds #] \&
 
84
.\}
 
85
.    \" simple accents for nroff and troff
 
86
.if n \{\
 
87
.    ds ' \&
 
88
.    ds ` \&
 
89
.    ds ^ \&
 
90
.    ds , \&
 
91
.    ds ~ ~
 
92
.    ds /
 
93
.\}
 
94
.if t \{\
 
95
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
96
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
97
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
98
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
99
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
100
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
101
.\}
 
102
.    \" troff and (daisy-wheel) nroff accents
 
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
110
.ds ae a\h'-(\w'a'u*4/10)'e
 
111
.ds Ae A\h'-(\w'A'u*4/10)'E
 
112
.    \" corrections for vroff
 
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
115
.    \" for low resolution devices (crt and lpr)
 
116
.if \n(.H>23 .if \n(.V>19 \
 
117
\{\
 
118
.    ds : e
 
119
.    ds 8 ss
 
120
.    ds o a
 
121
.    ds d- d\h'-1'\(ga
 
122
.    ds D- D\h'-1'\(hy
 
123
.    ds th \o'bp'
 
124
.    ds Th \o'LP'
 
125
.    ds ae ae
 
126
.    ds Ae AE
 
127
.\}
 
128
.rm #[ #] #H #V #F C
 
129
.\" ========================================================================
 
130
.\"
 
131
.IX Title "doc::Smokeping::probes::TelnetJunOSPing 3"
 
132
.TH doc::Smokeping::probes::TelnetJunOSPing 3 "2008-04-26" "2.3.6" "SmokePing"
 
133
.SH "NAME"
 
134
Smokeping::probes::TelnetJunOSPing \- Juniper JunOS Probe for SmokePing
 
135
.SH "SYNOPSIS"
 
136
.IX Header "SYNOPSIS"
 
137
.Vb 1
 
138
\& *** Probes ***
 
139
.Ve
 
140
.PP
 
141
.Vb 1
 
142
\& +TelnetJunOSPing
 
143
.Ve
 
144
.PP
 
145
.Vb 5
 
146
\& forks = 5
 
147
\& offset = 50%
 
148
\& packetsize = 100
 
149
\& step = 300
 
150
\& timeout = 15
 
151
.Ve
 
152
.PP
 
153
.Vb 6
 
154
\& # The following variables can be overridden in each target section
 
155
\& junospass = password # mandatory
 
156
\& junosuser = user # mandatory
 
157
\& pings = 5
 
158
\& psource = 192.168.2.129
 
159
\& source = 192.168.2.1 # mandatory
 
160
.Ve
 
161
.PP
 
162
.Vb 1
 
163
\& # [...]
 
164
.Ve
 
165
.PP
 
166
.Vb 1
 
167
\& *** Targets ***
 
168
.Ve
 
169
.PP
 
170
.Vb 1
 
171
\& probe = TelnetJunOSPing # if this should be the default probe
 
172
.Ve
 
173
.PP
 
174
.Vb 1
 
175
\& # [...]
 
176
.Ve
 
177
.PP
 
178
.Vb 8
 
179
\& + mytarget
 
180
\& # probe = TelnetJunOSPing # if the default probe is something else
 
181
\& host = my.host
 
182
\& junospass = password # mandatory
 
183
\& junosuser = user # mandatory
 
184
\& pings = 5
 
185
\& psource = 192.168.2.129
 
186
\& source = 192.168.2.1 # mandatory
 
187
.Ve
 
188
.SH "DESCRIPTION"
 
189
.IX Header "DESCRIPTION"
 
190
Integrates Juniper JunOS as a probe into smokeping.  Uses the telnet protocol 
 
191
to run a ping from an JunOS device (source) to another device (host).
 
192
This probe basically uses the \*(L"extended ping\*(R" of the Juniper JunOS.  You have
 
193
the option to specify which interface the ping is sourced from as well.
 
194
.SH "VARIABLES"
 
195
.IX Header "VARIABLES"
 
196
Supported probe-specific variables:
 
197
.IP "forks" 4
 
198
.IX Item "forks"
 
199
Run this many concurrent processes at maximum
 
200
.Sp
 
201
Example value: 5
 
202
.Sp
 
203
Default value: 5
 
204
.IP "offset" 4
 
205
.IX Item "offset"
 
206
If you run many probes concurrently you may want to prevent them from
 
207
hitting your network all at the same time. Using the probe-specific
 
208
offset parameter you can change the point in time when each probe will
 
209
be run. Offset is specified in % of total interval, or alternatively as
 
210
\&'random', and the offset from the 'General' section is used if nothing
 
211
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
 
212
it is just a matter of when data acqusition is initiated.
 
213
(This variable is only applicable if the variable 'concurrentprobes' is set
 
214
in the 'General' section.)
 
215
.Sp
 
216
Example value: 50%
 
217
.IP "packetsize" 4
 
218
.IX Item "packetsize"
 
219
The (optional) packetsize option lets you configure the packetsize for
 
220
the pings sent.
 
221
.Sp
 
222
Default value: 100
 
223
.IP "step" 4
 
224
.IX Item "step"
 
225
Duration of the base interval that this probe should use, if different
 
226
from the one specified in the 'Database' section. Note that the step in
 
227
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
 
228
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
 
229
files or somehow convert them. (This variable is only applicable if
 
230
the variable 'concurrentprobes' is set in the 'General' section.)
 
231
.Sp
 
232
Example value: 300
 
233
.IP "timeout" 4
 
234
.IX Item "timeout"
 
235
How long a single 'ping' takes at maximum
 
236
.Sp
 
237
Example value: 15
 
238
.Sp
 
239
Default value: 5
 
240
.PP
 
241
Supported target-specific variables:
 
242
.IP "junospass" 4
 
243
.IX Item "junospass"
 
244
The junospass option allows you to specify the password for the username
 
245
specified with the option junosuser.
 
246
.Sp
 
247
Example value: password
 
248
.Sp
 
249
This setting is mandatory.
 
250
.IP "junosuser" 4
 
251
.IX Item "junosuser"
 
252
The junosuser option allows you to specify a username that has ping
 
253
capability on the JunOS Device.
 
254
.Sp
 
255
Example value: user
 
256
.Sp
 
257
This setting is mandatory.
 
258
.IP "pings" 4
 
259
.IX Item "pings"
 
260
How many pings should be sent to each target, if different from the global
 
261
value specified in the Database section. Note that the number of pings in
 
262
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
 
263
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
 
264
files or somehow convert them.
 
265
.Sp
 
266
Example value: 5
 
267
.IP "psource" 4
 
268
.IX Item "psource"
 
269
The (optional) psource option specifies an alternate \s-1IP\s0 address or
 
270
Interface from which you wish to source your pings from.  Routers
 
271
can have many many \s-1IP\s0 addresses, and interfaces.  When you ping from a
 
272
router you have the ability to choose which interface and/or which \s-1IP\s0
 
273
address the ping is sourced from.  Specifying an IP/interface does not 
 
274
necessarily specify the interface from which the ping will leave, but
 
275
will specify which address the packet(s) appear to come from.  If this
 
276
option is left out the JunOS Device will source the packet automatically
 
277
based on routing and/or metrics.  If this doesn't make sense to you
 
278
then just leave it out.
 
279
.Sp
 
280
Example value: 192.168.2.129
 
281
.IP "source" 4
 
282
.IX Item "source"
 
283
The source option specifies the JunOS device to which we telnet.  This
 
284
is an \s-1IP\s0 address of an JunOS Device that you/your server:
 
285
        1)  Have the ability to telnet to
 
286
        2)  Have a valid username and password for
 
287
.Sp
 
288
Example value: 192.168.2.1
 
289
.Sp
 
290
This setting is mandatory.
 
291
.SH "AUTHORS"
 
292
.IX Header "AUTHORS"
 
293
S H A N <shanali@yahoo.com>
 
294
.PP
 
295
based \s-1HEAVILY\s0 on Smokeping::probes::TelnetIOSPing by
 
296
.PP
 
297
John A Jackson <geonjay@infoave.net>
 
298
.PP
 
299
based on Smokeping::probes::JunOSPing by
 
300
.PP
 
301
Paul J Murphy <paul@murph.org>
 
302
.PP
 
303
based on Smokeping::probes::FPing by
 
304
.PP
 
305
Tobias Oetiker <tobi@oetiker.ch>
 
306
.SH "NOTES"
 
307
.IX Header "NOTES"
 
308
.Sh "JunOS configuration"
 
309
.IX Subsection "JunOS configuration"
 
310
The JunOS device should have a username/password configured, as well as
 
311
the ability to connect to the \s-1VTY\s0(s).
 
312
.PP
 
313
Some JunOS devices have a maximum of 5 VTYs available, so be careful not
 
314
to hit a limit with the 'forks' variable.
 
315
.Sh "Requirements"
 
316
.IX Subsection "Requirements"
 
317
This module requires the Net::Telnet module for perl.  This is usually
 
318
included on most newer OSs which include perl.
 
319
.Sh "Debugging"
 
320
.IX Subsection "Debugging"
 
321
There is some \s-1VERY\s0 rudimentary debugging code built into this module (it's
 
322
based on the debugging code written into Net::Telnet).  It will log
 
323
information into three files \*(L"TIPreturn\*(R", \*(L"TIPoutlog\*(R", and \*(L"TIPdump\*(R".
 
324
These files will be written out into your current working directory (\s-1CWD\s0).
 
325
You can change the names of these files to something with more meaning to
 
326
you.
 
327
.Sh "Password authentication"
 
328
.IX Subsection "Password authentication"
 
329
You should be advised that the authentication method of telnet uses
 
330
clear text transmissions...meaning that without proper network security
 
331
measures someone could sniff your username and password off the network.
 
332
I may attempt to incorporate \s-1SSH\s0 in a future version of this module, but
 
333
it is very doubtful.  Right now \s-1SSH\s0 adds a \s-1LOT\s0 of processing overhead to
 
334
a router, and isn't incredibly easy to implement in perl.
 
335
.PP
 
336
Having said this, don't be too scared of telnet.  Remember, the
 
337
original JunOSPing module used \s-1RSH\s0, which is even more scary to use from
 
338
a security perspective.
 
339
.Sh "Ping packet size"
 
340
.IX Subsection "Ping packet size"
 
341
The FPing manpage has the following to say on the topic of ping packet
 
342
size:
 
343
.PP
 
344
Number of bytes of ping data to send.  The minimum size (normally 12)
 
345
allows room for the data that fping needs to do its work (sequence
 
346
number, timestamp).  The reported received data size includes the \s-1IP\s0
 
347
header (normally 20 bytes) and \s-1ICMP\s0 header (8 bytes), so the minimum
 
348
total size is 40 bytes.  Default is 56, as in ping. Maximum is the
 
349
theoretical maximum \s-1IP\s0 datagram size (64K), though most systems limit
 
350
this to a smaller, system-dependent number.