Documentation for the ifupdownaddons default addons modules

address

class address.address(*args, **kargs)

ifupdown2 addon module to configure address, mtu, hwaddress, alias (description) on an interface

run(ifaceobj, operation, query_ifaceobj=None, **extra_args)

run address configuration on the interface object passed as argument

Args:

ifaceobj (object): iface object

operation (str): any of ‘up’, ‘down’, ‘query-checkcurr’,

‘query-running’

Kwargs:

query_ifaceobj (object): query check ifaceobject. This is only

valid when op is ‘query-checkcurr’. It is an object same as ifaceobj, but contains running attribute values and its config status. The modules can use it to return queried running state of interfaces. status is success if the running state is same as user required state in ifaceobj. error otherwise.

get_ops()

returns list of ops supported by this module

bridge

class bridge.bridge(*args, **kargs)

ifupdown2 addon module to configure linux bridges

run(ifaceobj, operation, query_ifaceobj=None, ifaceobj_getfunc=None)

run bridge configuration on the interface object passed as argument. Can create bridge interfaces if they dont exist already

Args:

ifaceobj (object): iface object

operation (str): any of ‘pre-up’, ‘post-down’, ‘query-checkcurr’,

‘query-running’

Kwargs:

query_ifaceobj (object): query check ifaceobject. This is only

valid when op is ‘query-checkcurr’. It is an object same as ifaceobj, but contains running attribute values and its config status. The modules can use it to return queried running state of interfaces. status is success if the running state is same as user required state in ifaceobj. error otherwise.

get_ops()

returns list of ops supported by this module

dhcp

class dhcp.dhcp(*args, **kargs)

ifupdown2 addon module to configure dhcp on interface

ethtool

class ethtool.ethtool(*args, **kargs)

ifupdown2 addon module to configure ethtool attributes

ifenslave

class ifenslave.ifenslave(*args, **kargs)

ifupdown2 addon module to configure bond interfaces

mstpctl

class mstpctl.mstpctl(*args, **kargs)

ifupdown2 addon module to configure mstp attributes

usercmds

class usercmds.usercmds(*args, **kargs)

ifupdown2 addon module to configure user specified commands

vlan

class vlan.vlan(*args, **kargs)

ifupdown2 addon module to configure vlans