1
0
mirror of https://github.com/CumulusNetworks/ifupdown2.git synced 2024-05-06 15:54:50 +00:00
Roopa Prabhu f82758bf2c Merge 'vlan filtering bridge + vxlan + mlag + vrr' support from internal
tree to external

This also combines python-ifupdown2 and python-ifupdown2-addons package
into a single python-ifupdown2 package
2015-03-06 21:46:10 -08:00

270 lines
6.2 KiB
Groff

.\" Man page generated from reStructeredText.
.
.TH IFUP 8 "2014-02-05" "0.1" ""
.SH NAME
ifup \- network interface management commands
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH NAME
.INDENT 0.0
.INDENT 3.5
\fBifup\fP \- bring a network interface up
.sp
\fBifdown\fP \- take a network interface down
.UNINDENT
.UNINDENT
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B ifup [\-h] [\-a] [\-v] [\-d] [\-\-allow CLASS] [\-\-with\-depends]
\fB[\-X EXCLUDEPATS] [\-f] [\-n] [\-\-print\-dependency {list,dot}]\fP
\fB[IFACE [IFACE ...]]\fP
.TP
.B ifdown [\-h] [\-a] [\-v] [\-d] [\-\-allow CLASS] [\-\-with\-depends]
\fB[\-X EXCLUDEPATS] [\-f] [\-n] [\-\-print\-dependency {list,dot}]\fP
\fB[IFACE [IFACE ...]]\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.INDENT 0.0
.INDENT 3.5
\fBifup\fP and \fBifdown\fP commands can be used to configure (or, respectively,
deconfigure) network interfaces based on interface definitions in the
file \fB/etc/network/interfaces/\fP file.
.sp
\fBifquery(8)\fP maybe used in conjunction with \fBifup\fP and \fBifdown\fP
commands to query and validate applied/running configuration.
.sp
\fBifup\fP always works on the current \fBinterfaces(5)\fP file under
\fB/etc/network/interfaces\fP. \fBifdown\fP works on the last applied interface
configuration.
.sp
\fBifup\fP on an already ifup\(aqed interface will re\-apply the configuration,
skipping already applied configuration whereever possible. In many cases
where config commands are idempotent, you will see that ifup/ifdown will
reapply the config even if the interface already has that config.
.sp
\fBifup\fP and \fBifdown\fP understands interface dependency order.
.sp
For logical interfaces like vlans, bridges, bonds, \fBifup\fP creates the
interface and \fBifdown\fP deletes the interface. Use \fB\-\-admin\-state\fP
option if you only want to administratively bring the interface up/down.
.sp
When \fBifup\fP and \fBifdown\fP are used with interfaces on command line,
they must be have a \fBiface\fP section in the \fBinterfaces(5)\fP file.
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.INDENT 3.5
positional arguments:
.sp
\fBIFACE\fP interface list separated by spaces. \fBIFACE\fP list and \fB\(aq\-a\(aq\fP
argument are mutually exclusive.
.sp
optional arguments:
.INDENT 0.0
.TP
.B \-h, \-\-help
show this help message and exit
.TP
.B \-a, \-\-all
process all interfaces marked "auto"
.TP
.B \-v, \-\-verbose
verbose
.TP
.B \-d, \-\-debug
output debug info
.TP
.BI \-\-allow \ CLASS
ignore non\-"allow\-CLASS" interfaces
.TP
.B \-w, \-\-with\-depends
run with all dependent interfaces. This option
is redundant when \-a is specified. When \(aq\-a\(aq is
specified, interfaces are always executed in
dependency order.
.TP
.BI \-X \ EXCLUDEPATS, \ \-\-exclude \ EXCLUDEPATS
Exclude interfaces from the list of interfaces to
operate on. Can be specified multiple times
.TP
.BI \-i \ INTERFACESFILE, \ \-\-interfaces \ INTERFACESFILE
Use interfaces file instead of default
/etc/network/interfaces
.UNINDENT
.INDENT 0.0
.TP
.B \-t {native,json}, \-\-interfaces\-format {native,json}
interfaces file format
.UNINDENT
.INDENT 0.0
.TP
.B \-f, \-\-force
force run all operations
.TP
.B \-n, \-\-no\-act
print out what would happen, but don\(aqt do it
.UNINDENT
.INDENT 0.0
.TP
.B \-p, \-\-print\-dependency {list,dot}
print iface dependency in list or dot format
.UNINDENT
.INDENT 0.0
.TP
.B \-m, \-\-admin\-state, \-\-no\-scripts
dont run any addon modules/scripts. Only bring
the interface administratively up/down
.TP
.B \-u, \-\-use\-current\-config
By default ifdown looks at the saved state for
interfaces to bring down. This option allows ifdown
to look at the current interfaces file. Useful when
your state file is corrupted or you want down to use
the latest from the interfaces file
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
# bringing up all interfaces
.INDENT 0.0
.INDENT 3.5
\fBifup \-a\fP
.UNINDENT
.UNINDENT
.sp
# bringing up interface list
.INDENT 0.0
.INDENT 3.5
\fBifup swp1 swp2\fP
.UNINDENT
.UNINDENT
.sp
# bringing up interface with its dependents
.INDENT 0.0
.INDENT 3.5
\fBifup br0 \-\-with\-depends\fP
.UNINDENT
.UNINDENT
.sp
# bringing down all interfaces
.INDENT 0.0
.INDENT 3.5
\fBifdown \-a\fP
.UNINDENT
.UNINDENT
.sp
# bringing down a single interface
.INDENT 0.0
.INDENT 3.5
\fBifdown swp1\fP
.UNINDENT
.UNINDENT
.sp
# excluding interfaces using \-X option
.INDENT 0.0
.INDENT 3.5
\fBifdown \-X eth0 \-a\fP
.sp
\fBifup \-X eth0 \-a\fP
.sp
\fBifdown \-X eth0 \-X lo \-a\fP
.UNINDENT
.UNINDENT
.sp
# using verbose \-v option to see what is going on
.INDENT 0.0
.INDENT 3.5
\fBifup \-v \-a\fP
.UNINDENT
.UNINDENT
.sp
# using debug \-d option to see more of what is going on
.INDENT 0.0
.INDENT 3.5
\fBifup \-d \-a\fP
.UNINDENT
.UNINDENT
.sp
# ignore errors
.INDENT 0.0
.INDENT 3.5
\fBifup \-a \-f\fP
.sp
\fBifdown \-a \-f\fP
.UNINDENT
.UNINDENT
.sp
# run ifdown and ifup on all interfaces using service command/init script
.INDENT 0.0
.INDENT 3.5
\fBservice networking restart\fP
.UNINDENT
.UNINDENT
.sp
# run ifup on all interfaces using service command/init script
.INDENT 0.0
.INDENT 3.5
\fBservice networking start\fP
.UNINDENT
.UNINDENT
.sp
# ifdown on all interfaces using service command/init script
.INDENT 0.0
.INDENT 3.5
\fBservice networking stop\fP
.UNINDENT
.UNINDENT
.sp
# To run ifup/ifdown on only interfaces that changed see \fBifreload(8)\fP
.UNINDENT
.UNINDENT
.SH SEE ALSO
.INDENT 0.0
.INDENT 3.5
ifquery(8),
ifreload(8),
interfaces(5),
ifupdown\-addons\-interfaces(5)
.UNINDENT
.UNINDENT
.SH AUTHOR
Roopa Prabhu <roopa@cumulusnetworks.com>
.SH COPYRIGHT
Copyright 2014 Cumulus Networks, Inc. All rights reserved.
.\" Generated by docutils manpage writer.
.\"
.