[mirror_ifupdown2.git] / docs / source / intro.rst

python-ifupdown2
----------------

The python-ifupdown2 package provides the infrastructure for
parsing /etc/network/interfaces file, loading, scheduling, template parsing,
state management and interface dependency generation of interfaces.

It dynamically loads python modules from /usr/share/ifupdownmodules (provided
by the python-ifupdown2-addons package). To remain compatible with other
packages that depend on ifupdown, it also executes scripts under /etc/network/.
To make the transition smoother, a python module under
/usr/share/ifupdownmodules will override a script by the same name under
/etc/network/.

It publishes an interface object which is passed to all loadble python
modules. For more details on adding a addon module, see the section on
adding python modules.

ifupdown2 module calls all modules for every interface declared in the
/etc/network/interfaces file.
Commit	Line	Data
2c0ad8b3 RP	1	python-ifupdown2
	2	----------------
	3
	4	The python-ifupdown2 package provides the infrastructure for
	5	parsing /etc/network/interfaces file, loading, scheduling, template parsing,
	6	state management and interface dependency generation of interfaces.
	7
	8	It dynamically loads python modules from /usr/share/ifupdownmodules (provided
904908bc	9	by the python-ifupdown2-addons package). To remain compatible with other
2c0ad8b3 RP	10	packages that depend on ifupdown, it also executes scripts under /etc/network/.
	11	To make the transition smoother, a python module under
	12	/usr/share/ifupdownmodules will override a script by the same name under
	13	/etc/network/.
	14
	15	It publishes an interface object which is passed to all loadble python
	16	modules. For more details on adding a addon module, see the section on
	17	adding python modules.
	18
	19	ifupdown2 module calls all modules for every interface declared in the
	20	/etc/network/interfaces file.