mirror of
https://github.com/CumulusNetworks/ifupdown2.git
synced 2024-05-06 15:54:50 +00:00
Fix manpage formatting
Ticket: CM-1438 Reviewed By: Testing Done: Checked man page
This commit is contained in:
@@ -14,47 +14,54 @@ network interface management commands
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
====
|
====
|
||||||
ifup - bring a network interface up
|
**ifup** - bring a network interface up
|
||||||
|
|
||||||
ifdown - take a network interface down
|
**ifdown** - take a network interface down
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
========
|
========
|
||||||
|
|
||||||
ifup [-h] [-a] [-v] [-d] [--allow CLASS] [--with-depends]
|
ifup [-h] [-a] [-v] [-d] [--allow CLASS] [--with-depends]
|
||||||
[-X EXCLUDEPATS] [-f] [-n] [--print-dependency {list,dot}]
|
**[-X EXCLUDEPATS] [-f] [-n] [--print-dependency {list,dot}]**
|
||||||
[IFACE [IFACE ...]]
|
**[IFACE [IFACE ...]]**
|
||||||
|
|
||||||
ifdown [-h] [-a] [-v] [-d] [--allow CLASS] [--with-depends]
|
ifdown [-h] [-a] [-v] [-d] [--allow CLASS] [--with-depends]
|
||||||
[-X EXCLUDEPATS] [-f] [-n] [--print-dependency {list,dot}]
|
**[-X EXCLUDEPATS] [-f] [-n] [--print-dependency {list,dot}]**
|
||||||
[IFACE [IFACE ...]]
|
**[IFACE [IFACE ...]]**
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
===========
|
===========
|
||||||
The ifup and ifdown commands may be used to configure (or, respectively,
|
**ifup** and **ifdown** commands can be used to configure (or, respectively,
|
||||||
deconfigure) network interfaces based on interface definitions in the
|
deconfigure) network interfaces based on interface definitions in the
|
||||||
file /etc/network/interfaces/ file.
|
file **/etc/network/interfaces/** file.
|
||||||
|
|
||||||
ifquery(8) maybe used in conjunction with ifup and ifdown commands to query
|
**ifquery(8)** maybe used in conjunction with **ifup** and **ifdown**
|
||||||
and validate applied/running configuration.
|
commands to query and validate applied/running configuration.
|
||||||
|
|
||||||
ifup always works on the current interfaces(5) file under
|
**ifup** always works on the current **interfaces(5)** file under
|
||||||
/etc/network/interfaces. ifdown works on the last applied interface
|
**/etc/network/interfaces**. **ifdown** works on the last applied interface
|
||||||
configuration.
|
configuration.
|
||||||
|
|
||||||
ifup on an already ifup'ed interface will re-apply the configuration,
|
**ifup** on an already ifup'ed interface will re-apply the configuration,
|
||||||
skipping already applied configuration whereever possible. In many cases
|
skipping already applied configuration whereever possible. In many cases
|
||||||
where config commands are idempotent, you will see that ifup/ifdown will
|
where config commands are idempotent, you will see that ifup/ifdown will
|
||||||
reapply the config even if the interface already has that config.
|
reapply the config even if the interface already has that config.
|
||||||
|
|
||||||
ifup and ifdown understands interface dependency order.
|
**ifup** and **ifdown** understands interface dependency order.
|
||||||
|
|
||||||
|
For logical devices like vlans, bridges, bonds **ifup** creates the
|
||||||
|
interface and **ifdown** deletes the interface. Use **--no-scripts**
|
||||||
|
option if you only want to administratively bring the interface up/down.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
=======
|
=======
|
||||||
positional arguments:
|
positional arguments:
|
||||||
IFACE interface list separated by spaces. IFACE list and '-a' argument are mutually exclusive.
|
|
||||||
|
**IFACE** interface list separated by spaces. **IFACE** list and **'-a'**
|
||||||
|
argument are mutually exclusive.
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
|
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
|
|
||||||
-a, --all process all interfaces marked "auto"
|
-a, --all process all interfaces marked "auto"
|
||||||
@@ -63,14 +70,13 @@ OPTIONS
|
|||||||
|
|
||||||
-d, --debug output debug info
|
-d, --debug output debug info
|
||||||
|
|
||||||
--allow CLASS ignore non-"allow-CLASS" interfaces
|
-l, --allow CLASS ignore non-"allow-CLASS" interfaces
|
||||||
|
|
||||||
--with-depends run with all dependent interfaces. This option
|
-w, --with-depends run with all dependent interfaces. This option
|
||||||
is redundant when -a is specified. When '-a' is
|
is redundant when -a is specified. When '-a' is
|
||||||
specified, interfaces are always executed in
|
specified, interfaces are always executed in
|
||||||
dependency order.
|
dependency order.
|
||||||
|
|
||||||
|
|
||||||
-X EXCLUDEPATS, --exclude EXCLUDEPATS
|
-X EXCLUDEPATS, --exclude EXCLUDEPATS
|
||||||
Exclude interfaces from the list of interfaces to
|
Exclude interfaces from the list of interfaces to
|
||||||
operate on. Can be specified multiple times
|
operate on. Can be specified multiple times
|
||||||
@@ -79,54 +85,72 @@ OPTIONS
|
|||||||
|
|
||||||
-n, --no-act print out what would happen,but don't do it
|
-n, --no-act print out what would happen,but don't do it
|
||||||
|
|
||||||
--print-dependency {list,dot} print iface dependency in list or dot format.
|
-p, --print-dependency {list,dot} print iface dependency in list or dot format.
|
||||||
|
|
||||||
CHEATSHEET
|
--no-scripts, --no-addons dont run any addon modules/scripts. Only bring
|
||||||
==========
|
the interface administratively up/down
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
========
|
||||||
# bringing up all interfaces
|
# bringing up all interfaces
|
||||||
ifup -a
|
|
||||||
|
**ifup -a**
|
||||||
|
|
||||||
# bringing up interface list
|
# bringing up interface list
|
||||||
ifup swp1 swp2
|
|
||||||
|
|
||||||
# bringing up interface with its dependents.
|
**ifup swp1 swp2**
|
||||||
ifup br0 --with-depends
|
|
||||||
|
# bringing up interface with its dependents
|
||||||
|
|
||||||
|
**ifup br0 --with-depends**
|
||||||
|
|
||||||
# bringing down all interfaces
|
# bringing down all interfaces
|
||||||
ifdown -a
|
|
||||||
|
**ifdown -a**
|
||||||
|
|
||||||
# bringing down a single interface
|
# bringing down a single interface
|
||||||
ifdown swp1
|
|
||||||
|
**ifdown swp1**
|
||||||
|
|
||||||
# excluding interfaces using -X option
|
# excluding interfaces using -X option
|
||||||
ifdown -X eth0 -a
|
|
||||||
ifup -X eth0 -a
|
**ifdown -X eth0 -a**
|
||||||
ifdown -X eth0 -X lo -a
|
|
||||||
|
**ifup -X eth0 -a**
|
||||||
|
|
||||||
|
**ifdown -X eth0 -X lo -a**
|
||||||
|
|
||||||
# using verbose -v option to see what is going on
|
# using verbose -v option to see what is going on
|
||||||
ifup -v -a
|
|
||||||
|
**ifup -v -a**
|
||||||
|
|
||||||
# using debug -d option to see more of what is going on
|
# using debug -d option to see more of what is going on
|
||||||
ifup -d -a
|
|
||||||
|
**ifup -d -a**
|
||||||
|
|
||||||
# ignore errors
|
# ignore errors
|
||||||
ifup -a -f
|
|
||||||
ifdown -a -f
|
**ifup -a -f**
|
||||||
|
|
||||||
|
**ifdown -a -f**
|
||||||
|
|
||||||
# ifdown and ifup on all interfaces using service command/init script
|
# ifdown and ifup on all interfaces using service command/init script
|
||||||
service networking restart
|
|
||||||
|
**service networking restart**
|
||||||
|
|
||||||
# ifup on all interfaces using service command/init script
|
# ifup on all interfaces using service command/init script
|
||||||
service networking start
|
|
||||||
|
**service networking start**
|
||||||
|
|
||||||
# ifdown on all interfaces using service command/init script
|
# ifdown on all interfaces using service command/init script
|
||||||
service networking stop
|
|
||||||
|
|
||||||
# Also see ifreload(8)
|
**service networking stop**
|
||||||
|
|
||||||
|
# Also see **ifreload(8)**
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
========
|
========
|
||||||
ifquery(8)
|
ifquery(8),
|
||||||
ifreload(8)
|
ifreload(8),
|
||||||
interfaces(5)
|
interfaces(5),
|
||||||
interfaces-addons(5)
|
interfaces-addons(5)
|
||||||
|
Reference in New Issue
Block a user