forked from dyninc/OpenBFDD
-
Notifications
You must be signed in to change notification settings - Fork 1
/
bfdd-beacon.8
83 lines (82 loc) · 4.35 KB
/
bfdd-beacon.8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.\" Manpage for bfdd-beacon.
.TH "bfdd-beacon" "8" "February 5, 2013" "OpenBFDD v0.5.0" "OpenBFDD v0.5.0"
.SH NAME
\fBbfdd-beacon\fR - a Bidirectional Forwarding Detection (BFD) beacon daemon.
.SH SYNOPSIS
\fBbfdd-beacon\fR [\fI options \fR]
.SH DESCRIPTION
\fBbfdd-beacon\fP is software implementation of the Bidirectional Forwarding Detection (BFD) protocol.
When \fBbfdd-beacon\fP is running commands can be issued to the beacon using the \fBbfdd-control\fR(8) utility.
It is part of the OpenBFDD package.
.SH OPTIONS
The \fIoptions\fR parameter can be one or more of the following:
.TP
.B --version
This will print the current version and exit.
.TP
.B --tee
All logging will be sent to stdout in addition to the normal syslog or log file.
This is the default in debug builds run with the \fB--nofork\fR option.
This option is only applied if used with the \fB--nofork\fR option.
.TP
.B --notee
Logging will not be sent to stdout. This is the default for release builds.
.TP
.B --nofork
Prevents the beacon from running as a daemon. This is useful for debugging.
.TP
.B --control \fIip\fB:\fIport\fR
Adds a communication channel to use for communicating with \fBbfdd-beacon\fR(8).
\fIip\fR may be an IPv4 or Ipv6 address. A \fIport\fR must be supplied.
This option may appear multiple times, to create multiple control channels.
If no \fB--control\fR option is supplied, then two default control channels
are created on \fB127.0.0.1\fR.
When specifying an IPv6 \fIip\fR address, the address must be contained in brackets,
to allow for a \fIport\fR specification. For example \fB[::1]:10001\fR.
See the \fBPARAMETERS\fR section for more details on specifying an \fIip\fR address.
.TP
.B --listen \fIip\fB
Adds an address on which to listen for new incoming BFD connections.
\fIip\fR may be an IPv4 or Ipv6 address.
The IPv4 address of \fB0.0.0.0.0\fR, or the IPv6 address \fB::\fR may be used to
listen on all available IPv4 or IPv6 interfaces, respectively.
This option may appear multiple times, to listen on multiple addresses.
If no \fB--listen\fR option is supplied, then \fBbfdd-beacon\fR will listen on all available IPv4 and IPv6 addresses.
See the \fBPARAMETERS\fR section for more details on specifying an \fIip\fR address.
.SH PARAMETERS
Some of the parameters used in the \fBCOMMANDS\fR section require some additional explanation.
.TP
\fIip\fR
This parameter describes an ip address. An IPv4 or IPv6 address may be supplied.
An IPv4 address muse use dotted quad notation, in the form:
"\fBddd.ddd.ddd.ddd\fR"
An IPv6 address can use full notation, in the form:
"\fBhhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh\fR"
or shorthand notation, such as: "\fBhhhh:hhhh::hhhh\fR".
Dotted-quad notation may be used for Ipv6 addresses, to specify the final 32 bits.
For example \fB::ffff:192.0.2.128\fR is equivalent to \fB::ffff:c000:0280\fR.
Link-local addresses must also be followed by an interface name, using the form:
"\fBhhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh%\fR\fIifname\fR", where \fIifname\fR is the name of the interface to which the link local address applies. An interface may \fBonly\fR be specified for link-local addresses. Of course, shorthand notation may also be used with link local addresses.
.SH CONTROL
When \fBbfdd-beacon\fP is running commands can be issued to the beacon using the \fBbfdd-control\fR(8) utility.
See \fBbfdd-control\fR(8) documentation for more details.
.SH LOGGING
Currently log messages go to syslog. The \fB--tee\fR command can be used to also send log messages to stdout.
The identity "bfdd-beacon" is used for all syslog logging.
Logging is fully configurable.
See \fBbfdd-control\fR(8) documentation for more details.
.SH NOTES
when \fBbfdd-beacon\fP is first started it will not accept any connections.
This allows \fBbfdd-beacon\fP to be configured using the \fBbfdd-control\fR(8) utility before any sessions begin.
The \fBbfdd-control\fR(8) utility can then be used to start an active session, or to enable passive sessions.
The current implementation of the BFD protocol was tested specifically with the Juniper router's BFD (JUNOS 8.5). Demand mode is not currently supported.
Echo mode is not currently supported.
Authentication is not supported.
.SH BUGS
No known bugs at this time.
.SH "SEE ALSO"
\fBbfdd-control\fP(8)
.SH AUTHOR
Jake Montgomery for Dynamic Network Services, Inc.
.SH COPYRIGHT
Copyright (c) 2010-2013, Dynamic Network Services, Inc.