NM.SettingBridge¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|
||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class NM.SettingBridge(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Bridging Settings
- classmethod new()¶
- Returns:
the new empty
NM.SettingBridgeobject- Return type:
Creates a new
NM.SettingBridgeobject with default values.
- add_vlan(vlan)¶
- Parameters:
vlan (
NM.BridgeVlan) – the vlan to add
Appends a new vlan and associated information to the setting. The given vlan gets sealed and a reference to it is added.
New in version 1.18.
- clear_vlans()¶
Removes all configured VLANs.
New in version 1.18.
- get_ageing_time()¶
- Returns:
the
NM.SettingBridge:ageing-timeproperty of the setting- Return type:
- get_forward_delay()¶
- Returns:
the
NM.SettingBridge:forward-delayproperty of the setting- Return type:
- get_group_address()¶
- Returns:
the
NM.SettingBridge:group-addressproperty of the setting- Return type:
New in version 1.24.
- get_group_forward_mask()¶
- Returns:
the
NM.SettingBridge:group-forward-maskproperty of the setting- Return type:
New in version 1.10.
- get_hello_time()¶
- Returns:
the
NM.SettingBridge:hello-timeproperty of the setting- Return type:
- get_mac_address()¶
- Returns:
the
NM.SettingBridge:mac-addressproperty of the setting- Return type:
- get_max_age()¶
- Returns:
the
NM.SettingBridge:max-ageproperty of the setting- Return type:
- get_multicast_hash_max()¶
- Returns:
the
NM.SettingBridge:multicast-hash-maxproperty of the setting- Return type:
New in version 1.26.
- get_multicast_last_member_count()¶
- Returns:
the
NM.SettingBridge:multicast-last-member-countproperty of the setting- Return type:
New in version 1.26.
- get_multicast_last_member_interval()¶
- Returns:
the
NM.SettingBridge:multicast-last-member-intervalproperty of the setting- Return type:
New in version 1.26.
- get_multicast_membership_interval()¶
- Returns:
the
NM.SettingBridge:multicast-membership-intervalproperty of the setting- Return type:
New in version 1.26.
- get_multicast_querier()¶
- Returns:
the
NM.SettingBridge:multicast-querierproperty of the setting- Return type:
New in version 1.24.
- get_multicast_querier_interval()¶
- Returns:
the
NM.SettingBridge:multicast-querier-intervalproperty of the setting- Return type:
New in version 1.26.
- get_multicast_query_interval()¶
- Returns:
the
NM.SettingBridge:multicast-query-intervalproperty of the setting- Return type:
New in version 1.26.
- get_multicast_query_response_interval()¶
- Returns:
the
NM.SettingBridge:multicast-query-response-intervalproperty of the setting- Return type:
New in version 1.26.
- get_multicast_query_use_ifaddr()¶
- Returns:
the
NM.SettingBridge:multicast-query-use-ifaddrproperty of the setting- Return type:
New in version 1.24.
- get_multicast_router()¶
- Returns:
the
NM.SettingBridge:multicast-routerproperty of the setting- Return type:
New in version 1.24.
- get_multicast_snooping()¶
- Returns:
the
NM.SettingBridge:multicast-snoopingproperty of the setting- Return type:
New in version 1.2.
- get_multicast_startup_query_count()¶
- Returns:
the
NM.SettingBridge:multicast-query-response-intervalproperty of the setting- Return type:
New in version 1.26.
- get_multicast_startup_query_interval()¶
- Returns:
the
NM.SettingBridge:multicast-startup-query-intervalproperty of the setting- Return type:
New in version 1.26.
- get_priority()¶
- Returns:
the
NM.SettingBridge:priorityproperty of the setting- Return type:
- get_stp()¶
- Returns:
the
NM.SettingBridge:stpproperty of the setting- Return type:
- get_vlan(idx)¶
- Parameters:
idx (
int) – index number of the VLAN to return- Returns:
the VLAN at index idx
- Return type:
New in version 1.18.
- get_vlan_default_pvid()¶
- Returns:
the
NM.SettingBridge:vlan-default-pvidproperty of the setting- Return type:
New in version 1.18.
- get_vlan_filtering()¶
- Returns:
the
NM.SettingBridge:vlan-filteringproperty of the setting- Return type:
New in version 1.18.
- get_vlan_protocol()¶
- Returns:
the
NM.SettingBridge:vlan-protocolproperty of the setting- Return type:
New in version 1.24.
- get_vlan_stats_enabled()¶
- Returns:
the
NM.SettingBridge:vlan-stats-enabledproperty of the setting- Return type:
New in version 1.24.
- remove_vlan(idx)¶
- Parameters:
idx (
int) – index number of the VLAN.
Removes the vlan at index idx.
New in version 1.18.
- remove_vlan_by_vid(vid_start, vid_end)¶
- Parameters:
- Returns:
- Return type:
Remove the VLAN with range vid_start to vid_end. If vid_end is zero, it is assumed to be equal to vid_start and so the single-id VLAN with id vid_start is removed.
New in version 1.18.
Property Details¶
- NM.SettingBridge.props.ageing_time¶
- Name:
ageing-time- Type:
- Default Value:
300- Flags:
The Ethernet MAC address aging time, in seconds.
- NM.SettingBridge.props.forward_delay¶
- Name:
forward-delay- Type:
- Default Value:
15- Flags:
The Spanning Tree Protocol (STP) forwarding delay, in seconds.
- NM.SettingBridge.props.group_address¶
- Name:
group-address- Type:
- Default Value:
- Flags:
If specified, The MAC address of the multicast group this bridge uses for STP.
The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:py:data::C2<NM.SettingBridge.props.C2>:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:py:data::C2<NM.SettingBridge.props.C2>:00:00:00.
New in version 1.24.
- NM.SettingBridge.props.group_forward_mask¶
- Name:
group-forward-mask- Type:
- Default Value:
0- Flags:
A mask of group addresses to forward. Usually, group addresses in the range from 01:80:py:data::C2<NM.SettingBridge.props.C2>:00:00:00 to 01:80:py:data::C2<NM.SettingBridge.props.C2>:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can’t have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.
New in version 1.10.
- NM.SettingBridge.props.hello_time¶
- Name:
hello-time- Type:
- Default Value:
2- Flags:
The Spanning Tree Protocol (STP) hello time, in seconds.
- NM.SettingBridge.props.mac_address¶
- Name:
mac-address- Type:
- Default Value:
- Flags:
If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.
If this field is left unspecified, the “ethernet.cloned-mac-address” is referred instead to generate the initial MAC address. Note that setting “ethernet.cloned-mac-address” anyway overwrites the MAC address of the bridge later while activating the bridge.
Deprecated since version 1.12: Use the
NM.SettingWired:cloned-mac-addressproperty instead.
- NM.SettingBridge.props.max_age¶
- Name:
max-age- Type:
- Default Value:
20- Flags:
The Spanning Tree Protocol (STP) maximum message age, in seconds.
- NM.SettingBridge.props.multicast_hash_max¶
- Name:
multicast-hash-max- Type:
- Default Value:
4096- Flags:
Set maximum size of multicast hash table (value must be a power of 2).
- NM.SettingBridge.props.multicast_last_member_count¶
- Name:
multicast-last-member-count- Type:
- Default Value:
2- Flags:
Set the number of queries the bridge will send before stopping forwarding a multicast group after a “leave” message has been received.
- NM.SettingBridge.props.multicast_last_member_interval¶
- Name:
multicast-last-member-interval- Type:
- Default Value:
100- Flags:
Set interval (in deciseconds) between queries to find remaining members of a group, after a “leave” message is received.
- NM.SettingBridge.props.multicast_membership_interval¶
- Name:
multicast-membership-interval- Type:
- Default Value:
26000- Flags:
Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.
- NM.SettingBridge.props.multicast_querier¶
- Name:
multicast-querier- Type:
- Default Value:
- Flags:
Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.
- NM.SettingBridge.props.multicast_querier_interval¶
- Name:
multicast-querier-interval- Type:
- Default Value:
25500- Flags:
If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.
- NM.SettingBridge.props.multicast_query_interval¶
- Name:
multicast-query-interval- Type:
- Default Value:
12500- Flags:
Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.
- NM.SettingBridge.props.multicast_query_response_interval¶
- Name:
multicast-query-response-interval- Type:
- Default Value:
1000- Flags:
Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.
- NM.SettingBridge.props.multicast_query_use_ifaddr¶
- Name:
multicast-query-use-ifaddr- Type:
- Default Value:
- Flags:
If enabled the bridge’s own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.
- NM.SettingBridge.props.multicast_router¶
- Name:
multicast-router- Type:
- Default Value:
- Flags:
Sets bridge’s multicast router. Multicast-snooping must be enabled for this option to work.
Supported values are: ‘auto’, ‘disabled’, ‘enabled’ to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is ‘auto’ (1).
- NM.SettingBridge.props.multicast_snooping¶
- Name:
multicast-snooping- Type:
- Default Value:
- Flags:
Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.
New in version 1.2.
- NM.SettingBridge.props.multicast_startup_query_count¶
- Name:
multicast-startup-query-count- Type:
- Default Value:
2- Flags:
Set the number of IGMP queries to send during startup phase.
- NM.SettingBridge.props.multicast_startup_query_interval¶
- Name:
multicast-startup-query-interval- Type:
- Default Value:
3125- Flags:
Sets the time (in deciseconds) between queries sent out at startup to determine membership information.
- NM.SettingBridge.props.priority¶
- Name:
priority- Type:
- Default Value:
32768- Flags:
Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are “better”; the lowest priority bridge will be elected the root bridge.
- NM.SettingBridge.props.stp¶
- Name:
stp- Type:
- Default Value:
- Flags:
Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
- NM.SettingBridge.props.vlan_default_pvid¶
- Name:
vlan-default-pvid- Type:
- Default Value:
1- Flags:
The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.
New in version 1.18.
- NM.SettingBridge.props.vlan_filtering¶
- Name:
vlan-filtering- Type:
- Default Value:
- Flags:
Control whether VLAN filtering is enabled on the bridge.
New in version 1.18.
- NM.SettingBridge.props.vlan_protocol¶
- Name:
vlan-protocol- Type:
- Default Value:
- Flags:
If specified, the protocol used for VLAN filtering.
Supported values are: ‘802.1Q’, ‘802.1ad’. If not specified the default value is ‘802.1Q’.
New in version 1.24.
- NM.SettingBridge.props.vlan_stats_enabled¶
- Name:
vlan-stats-enabled- Type:
- Default Value:
- Flags:
Controls whether per-VLAN stats accounting is enabled.
- NM.SettingBridge.props.vlans¶
- Name:
vlans- Type:
- Default Value:
- Flags:
Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.
In nmcli the VLAN list can be specified with the following syntax:
$vid ‘pvid [untagged]’ [, $vid ‘pvid [untagged]’]…
where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.
New in version 1.18.