NM.SettingTeam

g GObject.Object GObject.Object NM.Setting NM.Setting GObject.Object->NM.Setting NM.SettingTeam NM.SettingTeam NM.Setting->NM.SettingTeam

Subclasses:

None

Methods

Inherited:

NM.Setting (21), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

add_link_watcher (link_watcher)

add_runner_tx_hash (txhash)

clear_link_watchers ()

get_config ()

get_link_watcher (idx)

get_mcast_rejoin_count ()

get_mcast_rejoin_interval ()

get_notify_peers_count ()

get_notify_peers_interval ()

get_num_link_watchers ()

get_num_runner_tx_hash ()

get_runner ()

get_runner_active ()

get_runner_agg_select_policy ()

get_runner_fast_rate ()

get_runner_hwaddr_policy ()

get_runner_min_ports ()

get_runner_sys_prio ()

get_runner_tx_balancer ()

get_runner_tx_balancer_interval ()

get_runner_tx_hash (idx)

remove_link_watcher (idx)

remove_link_watcher_by_value (link_watcher)

remove_runner_tx_hash (idx)

remove_runner_tx_hash_by_value (txhash)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

NM.Setting (1)

Name

Type

Flags

Short Description

config

str

r/w

link-watchers

GLib.PtrArray

r/w

mcast-rejoin-count

int

r/w

mcast-rejoin-interval

int

r/w

notify-peers-count

int

r/w

notify-peers-interval

int

r/w

runner

str

r/w

runner-active

bool

r/w

runner-agg-select-policy

str

r/w

runner-fast-rate

bool

r/w

runner-hwaddr-policy

str

r/w

runner-min-ports

int

r/w

runner-sys-prio

int

r/w

runner-tx-balancer

str

r/w

runner-tx-balancer-interval

int

r/w

runner-tx-hash

[str]

r/w

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class NM.SettingTeam(**kwargs)
Bases:

NM.Setting

Abstract:

No

Structure:

NM.SettingTeamClass

Teaming Settings

classmethod new()
Returns:

the new empty NM.SettingTeam object

Return type:

NM.Setting

Creates a new NM.SettingTeam object with default values.

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.

New in version 1.12.

add_runner_tx_hash(txhash)
Parameters:

txhash (str) – the element to add to txhash

Returns:

True if the txhash element was added; False if the element was already knnown.

Return type:

bool

Adds a new txhash element to the setting.

New in version 1.12.

Removes all configured link watchers.

New in version 1.12.

get_config()
Returns:

the NM.SettingTeam :config property of the setting

Return type:

str

Parameters:

idx (int) – index number of the link watcher to return

Returns:

the link watcher at index idx.

Return type:

NM.TeamLinkWatcher

New in version 1.12.

get_mcast_rejoin_count()
Returns:

the #:obj:NM.SettingTeam :mcast-rejoin-count property of the setting

Return type:

int

New in version 1.12.

get_mcast_rejoin_interval()
Returns:

the #:obj:NM.SettingTeam :mcast-rejoin-interval property of the setting

Return type:

int

New in version 1.12.

get_notify_peers_count()
Returns:

the #:obj:NM.SettingTeam :notify-peers-count property of the setting

Return type:

int

New in version 1.12.

get_notify_peers_interval()
Returns:

the #:obj:NM.SettingTeam :notify-peers-interval property of the setting

Return type:

int

New in version 1.12.

Returns:

the number of configured link watchers

Return type:

int

New in version 1.12.

get_num_runner_tx_hash()
Returns:

the number of elements in txhash

Return type:

int

New in version 1.12.

get_runner()
Returns:

the #:obj:NM.SettingTeam :runner property of the setting

Return type:

str

New in version 1.12.

get_runner_active()
Returns:

the ##NMSettingTeam:runner_active property of the setting

Return type:

bool

New in version 1.12.

get_runner_agg_select_policy()
Returns:

the #:obj:NM.SettingTeam :runner-agg-select-policy property of the setting

Return type:

str

New in version 1.12.

get_runner_fast_rate()
Returns:

the #:obj:NM.SettingTeam :runner-fast-rate property of the setting

Return type:

bool

New in version 1.12.

get_runner_hwaddr_policy()
Returns:

the #:obj:NM.SettingTeam :runner-hwaddr-policy property of the setting

Return type:

str

New in version 1.12.

get_runner_min_ports()
Returns:

the #:obj:NM.SettingTeam :runner-min-ports property of the setting

Return type:

int

New in version 1.12.

get_runner_sys_prio()
Returns:

the #:obj:NM.SettingTeam :runner-sys-prio property of the setting

Return type:

int

New in version 1.12.

get_runner_tx_balancer()
Returns:

the #:obj:NM.SettingTeam :runner-tx-balancer property of the setting

Return type:

str

New in version 1.12.

get_runner_tx_balancer_interval()
Returns:

the ##NMSettingTeam:runner-tx-balancer_interval property of the setting

Return type:

int

New in version 1.12.

get_runner_tx_hash(idx)
Parameters:

idx (int) – index number of the txhash element to return

Returns:

the txhash element at index idx

Return type:

str

New in version 1.12.

Parameters:

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

Removes the link watcher at index #idx.

New in version 1.12.

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.

New in version 1.12.

remove_runner_tx_hash(idx)
Parameters:

idx (int) – index number of the element to remove from txhash

Removes the txhash element at index idx.

New in version 1.12.

remove_runner_tx_hash_by_value(txhash)
Parameters:

txhash (str) – the txhash element to remove

Returns:

True if the txhash element was found and removed; False if it was not.

Return type:

bool

Removes the txhash element #txhash

New in version 1.12.

Property Details

NM.SettingTeam.props.config
Name:

config

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The JSON configuration for the team network interface. 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.

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.

New in version 1.12.

NM.SettingTeam.props.mcast_rejoin_count
Name:

mcast-rejoin-count

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

Corresponds to the teamd mcast_rejoin.count.

New in version 1.12.

NM.SettingTeam.props.mcast_rejoin_interval
Name:

mcast-rejoin-interval

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

Corresponds to the teamd mcast_rejoin.interval.

New in version 1.12.

NM.SettingTeam.props.notify_peers_count
Name:

notify-peers-count

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

Corresponds to the teamd notify_peers.count.

New in version 1.12.

NM.SettingTeam.props.notify_peers_interval
Name:

notify-peers-interval

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

Corresponds to the teamd notify_peers.interval.

New in version 1.12.

NM.SettingTeam.props.runner
Name:

runner

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.name. Permitted values are: “roundrobin”, “broadcast”, “activebackup”, “loadbalance”, “lacp”, “random”.

New in version 1.12.

NM.SettingTeam.props.runner_active
Name:

runner-active

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.active.

New in version 1.12.

NM.SettingTeam.props.runner_agg_select_policy
Name:

runner-agg-select-policy

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.agg_select_policy.

New in version 1.12.

NM.SettingTeam.props.runner_fast_rate
Name:

runner-fast-rate

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.fast_rate.

New in version 1.12.

NM.SettingTeam.props.runner_hwaddr_policy
Name:

runner-hwaddr-policy

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.hwaddr_policy.

New in version 1.12.

NM.SettingTeam.props.runner_min_ports
Name:

runner-min-ports

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.min_ports.

New in version 1.12.

NM.SettingTeam.props.runner_sys_prio
Name:

runner-sys-prio

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.sys_prio.

New in version 1.12.

NM.SettingTeam.props.runner_tx_balancer
Name:

runner-tx-balancer

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.tx_balancer.name.

New in version 1.12.

NM.SettingTeam.props.runner_tx_balancer_interval
Name:

runner-tx-balancer-interval

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.tx_balancer.interval.

New in version 1.12.

NM.SettingTeam.props.runner_tx_hash
Name:

runner-tx-hash

Type:

[str]

Default Value:

[]

Flags:

READABLE, WRITABLE

Corresponds to the teamd runner.tx_hash.

New in version 1.12.