mirror/CumulusNetworks-ifupdown2
1
0
Fork 0
mirror of https://github.com/CumulusNetworks/ifupdown2.git synced 2024-05-06 15:54:50 +00:00
Code
CumulusNetworks-ifupdown2/docs/source/addonshelperapiref.rst

45 lines
784 B
ReStructuredText
Raw Normal View History

Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
Documentation for the ifupdownaddons package helper modules
***********************************************************
This package contains modules that provide helper methods
for ifupdown2 addon modules to interact directly with tools
like iproute2, brctl etc.
bridgeutils
===========
Helper module to work with bridgeutil commands
.. automodule:: bridgeutils
.. autoclass:: brctl
Allow customer set bond defaults for CL with ifupdown2 Ticket: CM-6723 Reviewed By: roopa Testing Done: unit tested and testifupdown2 test suite This patch installs bond interface defaults in /etc/network/ifupdown2/policy.d/bond_defaults.json and allows users to modify this file. Users can then leave out these bond attributes in their configs to save typing and space. It also changes the ifenslave and ifenslaveutil module to bond and bondutil, respectively to be consistent with other modules (and also because customers think of "bond" interfaces not "ifenslave" interfaces.) For example, the default file installed looks like the following: { "README": "This file is user generated and modifiable.", "bond": { "defaults": { "bond-mode": "802.3ad", "bond-miimon": "100", "bond-use-carrier": "1", "bond-lacp-rate": "0", "bond-min-links": "1", "bond-xmic-hash-policy": "layer3+4" } } } Please enter the commit message for your changes. Lines starting
2015-07-22 18:38:07 -04:00
bondutil
========
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
Helper module to interact with linux api to create bonds.
Currently this is via sysfs.
Allow customer set bond defaults for CL with ifupdown2 Ticket: CM-6723 Reviewed By: roopa Testing Done: unit tested and testifupdown2 test suite This patch installs bond interface defaults in /etc/network/ifupdown2/policy.d/bond_defaults.json and allows users to modify this file. Users can then leave out these bond attributes in their configs to save typing and space. It also changes the ifenslave and ifenslaveutil module to bond and bondutil, respectively to be consistent with other modules (and also because customers think of "bond" interfaces not "ifenslave" interfaces.) For example, the default file installed looks like the following: { "README": "This file is user generated and modifiable.", "bond": { "defaults": { "bond-mode": "802.3ad", "bond-miimon": "100", "bond-use-carrier": "1", "bond-lacp-rate": "0", "bond-min-links": "1", "bond-xmic-hash-policy": "layer3+4" } } } Please enter the commit message for your changes. Lines starting
2015-07-22 18:38:07 -04:00
.. automodule:: bondutil
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
Allow customer set bond defaults for CL with ifupdown2 Ticket: CM-6723 Reviewed By: roopa Testing Done: unit tested and testifupdown2 test suite This patch installs bond interface defaults in /etc/network/ifupdown2/policy.d/bond_defaults.json and allows users to modify this file. Users can then leave out these bond attributes in their configs to save typing and space. It also changes the ifenslave and ifenslaveutil module to bond and bondutil, respectively to be consistent with other modules (and also because customers think of "bond" interfaces not "ifenslave" interfaces.) For example, the default file installed looks like the following: { "README": "This file is user generated and modifiable.", "bond": { "defaults": { "bond-mode": "802.3ad", "bond-miimon": "100", "bond-use-carrier": "1", "bond-lacp-rate": "0", "bond-min-links": "1", "bond-xmic-hash-policy": "layer3+4" } } } Please enter the commit message for your changes. Lines starting
2015-07-22 18:38:07 -04:00
.. autoclass:: bondutil
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
dhclient
========
Helper module to interact with dhclient tools.
.. automodule:: dhclient
.. autoclass:: dhclient
iproute2
========
Helper module to interact with iproute2 tools.
.. automodule:: iproute2
.. autoclass:: iproute2
Copy Permalink