.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "interfaces-batman" "5" "2022-10-15"
.P
.SH NAME
.P
\fBinterfaces-batman\fR - B.\&A.\&T.\&M.\&A.\&N.\& adv.\& extensions for the interfaces(5)
file format
.P
.SH DESCRIPTION
.P
Better Approach To Mobile Ad-Hoc Networking (B.\&A.\&T.\&M.\&A.\&N.\&) advanced is
a mesh protocol which provides an Ethernet overlay network over an
Ethernet underlay.\& The overlay interface is called \fImeshif\fR whereas
underlay interfaces are called \fIhardif\fR.\&
.P
It'\&s supported in the Linux kernel and thus available in many Linux
environments.\& The ifupdown-ng exectuor relies on the \fBbatctl\fR tool
being installed.\& Support for setting interface based hop-penalties
required Linux Kernel 5.\&8 or later.\&
.P
B.\&A.\&T.\&M.\&A.\&N.\& adv.\& adds 30-60 bytes of encapsulation overhead depending
on wether netword coding is activated or not.\& This should be taken into
consideration when setting up overlay networks, particularly on underlay
networks with a conventional 1500 byte MTU.\&
.P
See https://www.\&open-mesh.\&org/projects/open-mesh/wiki for more details
and updates.\&
.P
The following options allow to set up B.\&A.\&T.\&M.\&A.\&N.\& adv.\& interfaces.\&
.P
.SH BATMAN-RELATED OPTIONS
.P
\fBbatman-ifaces\fR \fIlist of interfaces\fR
.RS 4
Specifies the underlay interfaces (hardifs) which should be
configured for the B.\&A.\&T.\&M.\&A.\&N.\& adv.\& meshif defined within
the iface stanza.\&
.P
.RE
\fBbatman-hop-penalty\fR \fIhop-penalty\fR
.RS 4
The \fIhop-penalty\fR defines the cost of traversing a node or an
interface.\& The \fIhop-penalty\fR is a numeric value between 0 and
255.\& Historically a \fIhop-penalty\fR could only be set on a meshif,
since B.\&A.\&T.\&M.\&A.\&N adv.\& v2020.\&3 (included in Kernel 5.\&8) it can
also be set on a per-interfaces (hardif) basis.\&
.P
.RE
\fBbatman-gw-mode\fR \fIgw-mode\fR
.RS 4
Denotes the gateway mode which controls the role this node will
play within this B.\&A.\&T.\&M.\&A.\&N.\& adv.\& instance.\& The mode can be
\fIoff\fR, \fIclient\fR, or \fIserver\fR.\&
.P
.RE
\fBbatman-distributed-arp-table\fR \fImode\fR
.RS 4
Activates or deactivates the Distributed ARP table (DAT) within
this B.\&A.\&T.\&M.\&A.\&N.\& adv.\& instance.\& Valid values are \fIenable\fR and
\fIdisable\fR.\&
.P
.RE
\fBbatman-multicast-mode\fR \fImode\fR
.RS 4
Activates or deactivates the multicast mode of this B.\&A.\&T.\&M.\&A.\&N.\&
adv.\& instance.\& Valid values are \fIenable\fR and \fIdisable\fR.\&
.P
.RE
.SH EXAMPLES
.P
A B.\&A.\&T.\&M.\&A.\&N.\& adv.\& \fImeshif\fR:
.P
.nf
.RS 4
auto bat-pad-cty
iface bat-pad-cty
	batman-ifaces dummy-pad-cty vlan1234
	batman-hop-penalty 5
	#
	hwaddress f2:00:c1:01:00:00
	mtu 1500
.fi
.RE
.P
A B.\&A.\&T.\&M.\&A.\&N.\& adv.\& member interfaces (\fIhardif\fR):
.P
.nf
.RS 4
auto vlan1234
iface vlan1234
	mtu 1560
	batman-hop-penalty 10
.fi
.RE
.P
.SH SEE ALSO
.P
\fBbatctl\fR(8)
.P
.SH AUTHORS
.P
Maximilian Wilhelm <max@sdn.\&clinic>