1
0
mirror of https://github.com/CumulusNetworks/ifupdown2.git synced 2024-05-06 15:54:50 +00:00
Sam Tannous 6f10696cc3 Document exclude (-X) option in ifreload
Ticket: CM-5419
Reviewed By: Trivial
Testing Done: built ifupdown2 deb and tested on switch

This patch adds man page mention of undocumented (but working)
option to exclude interfaces from a reload (-X option)
(cherry picked from commit 0358905782a4c0290a967d6f730fdcb27f2af3d9)
2015-06-04 15:32:48 -04:00

81 lines
2.3 KiB
ReStructuredText

========
ifreload
========
--------------------------------------
reload network interface configuration
--------------------------------------
:Author: Roopa Prabhu <roopa@cumulusnetworks.com>
:Date: 2014-02-05
:Copyright: Copyright 2014 Cumulus Networks, Inc. All rights reserved.
:Version: 0.1
:Manual section: 8
SYNOPSIS
========
ifreload [-h] (-a|-c) [-v] [-d] [-f] [-n]
DESCRIPTION
===========
reloads network **interfaces(5)** file **/etc/network/interfaces**.
Runs **ifdown** on interfaces that were removed from the file and
subsequently runs **ifup** on all interfaces.
When removing an interface (iface section) from the interfaces file
please make sure all its references are removed as well. Similarly
when renaming an interface, please make sure all references to the
interface are changed to the new name. Renaming an interface
in the interfaces file results in ifdown of the old and ifup
of the interface with the new name.
If you do not wish to execute **down** on any interfaces, but only **up** on
interfaces that were already **up**, please see the **--currently-up**
option below.
OPTIONS
=======
-h, --help show this help message and exit
-a, --all process all interfaces marked "auto"
-v, --verbose verbose
-d, --debug output debug info
-f, --force force run all operations
-c, --currently-up only reload auto and other interfaces that are
currently up. This can be used as a non-disruptive
alternative to -a because it will not down any
interfaces
-X EXCLUDEPATS, --exclude EXCLUDEPATS
Exclude interfaces from the list of interfaces to
operate on. Can be specified multiple times
EXAMPLES
========
# reload all auto interfaces in **interfaces(5)** file
**ifreload -a**
# reload all interfaces using service command
**service networking reload**
# reload all currently up interfaces without bringing any interfaces down
**service networking reload-currently-up**
SEE ALSO
========
ifup(8),
ifdown(8),
ifquery(8),
interfaces(5),
ifupdown-addons-interfaces(5)