NM.SettingTeamPort¶

Subclasses:: None

Methods¶

Inherited:: NM.Setting (21), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`add_link_watcher` (link_watcher)
	`clear_link_watchers` ()
	`get_config` ()
	`get_lacp_key` ()
	`get_lacp_prio` ()
	`get_link_watcher` (idx)
	`get_num_link_watchers` ()
	`get_prio` ()
	`get_queue_id` ()
	`get_sticky` ()
	`remove_link_watcher` (idx)
	`remove_link_watcher_by_value` (link_watcher)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: NM.Setting (1)

Name	Type	Flags
`config`	`str`	r/w
`lacp-key`	`int`	r/w
`lacp-prio`	`int`	r/w
`link-watchers`	`GLib.PtrArray`	r/w
`prio`	`int`	r/w
`queue-id`	`int`	r/w
`sticky`	`bool`	r/w

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class NM.SettingTeamPort(**kwargs)¶

Bases:: NM.Setting
Abstract:: No
Structure:: NM.SettingTeamPortClass

Team Port Settings

classmethod new()¶

Returns:: the new empty NM.SettingTeamPort object
Return type:: NM.Setting

Creates a new NM.SettingTeamPort object with default values.

add_link_watcher(link_watcher)¶

Parameters:: link_watcher (NM.TeamLinkWatcher) – the link watcher to add
Returns:: True if the link watcher is added; False if an identical link watcher was already there.
Return type:: bool

Appends a new link watcher to the setting.

Added in version 1.12.

clear_link_watchers()¶: Removes all configured link watchers.

Added in version 1.12.

get_config()¶

Returns:: the NM.SettingTeamPort :config property of the setting
Return type:: str

get_lacp_key()¶

Returns:: the NM.SettingTeamPort :lacp-key property of the setting
Return type:: int

Added in version 1.12.

get_lacp_prio()¶

Returns:: the NM.SettingTeamPort :lacp-prio property of the setting
Return type:: int

Added in version 1.12.

get_link_watcher(idx)¶

Parameters:: idx (int) – index number of the link watcher to return
Returns:: the link watcher at index idx.
Return type:: NM.TeamLinkWatcher

Added in version 1.12.

get_num_link_watchers()¶

Returns:: the number of configured link watchers
Return type:: int

Added in version 1.12.

get_prio()¶

Returns:: the NM.SettingTeamPort :prio property of the setting
Return type:: int

Added in version 1.12.

get_queue_id()¶

Returns:: the #NMSettingTeamPort:queue_id property of the setting
Return type:: int

Added in version 1.12.

get_sticky()¶

Returns:: the NM.SettingTeamPort :sticky property of the setting
Return type:: bool

Added in version 1.12.

remove_link_watcher(idx)¶

Parameters:: idx (int) – index number of the link watcher to remove

Removes the link watcher at index #idx.

Added in version 1.12.

remove_link_watcher_by_value(link_watcher)¶

Parameters:: link_watcher (NM.TeamLinkWatcher) – the link watcher to remove
Returns:: True if the link watcher was found and removed, False otherwise.
Return type:: bool

Removes the link watcher entry matching link_watcher.

Added in version 1.12.

Property Details¶

NM.SettingTeamPort.props.config¶

Name:: config
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

NM.SettingTeamPort.props.lacp_key¶

Name:: lacp-key
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Corresponds to the teamd ports.PORTIFNAME.lacp_key.

Added in version 1.12.

NM.SettingTeamPort.props.lacp_prio¶

Name:: lacp-prio
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Corresponds to the teamd ports.PORTIFNAME.lacp_prio.

Added in version 1.12.

NM.SettingTeamPort.props.link_watchers¶

Name:: link-watchers
Type:: GLib.PtrArray
Default Value:: None
Flags:: READABLE, WRITABLE

Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are ‘ethtool’, ‘nsna_ping’ and ‘arp_ping’ and it is specified in the dictionary with the key ‘name’. Available keys are: ethtool: ‘delay-up’, ‘delay-down’, ‘init-wait’; nsna_ping: ‘init-wait’, ‘interval’, ‘missed-max’, ‘target-host’; arp_ping: all the ones in nsna_ping and ‘source-host’, ‘validate-active’, ‘validate-inactive’, ‘send-always’. See teamd.conf man for more details.

Added in version 1.12.

NM.SettingTeamPort.props.prio¶

Name:: prio
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Corresponds to the teamd ports.PORTIFNAME.prio.

Added in version 1.12.

NM.SettingTeamPort.props.queue_id¶

Name:: queue-id
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.

Added in version 1.12.

NM.SettingTeamPort.props.sticky¶

Name:: sticky
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Corresponds to the teamd ports.PORTIFNAME.sticky.

Added in version 1.12.