NM.SettingOvsPort

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

Subclasses:

None

Methods

Inherited:

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

Structs:

GObject.ObjectClass (5)

class

new ()

add_trunk (trunk)

clear_trunks ()

get_bond_downdelay ()

get_bond_mode ()

get_bond_updelay ()

get_lacp ()

get_num_trunks ()

get_tag ()

get_trunk (idx)

get_vlan_mode ()

remove_trunk (idx)

remove_trunk_by_value (start, end)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

NM.Setting (1)

Name

Type

Flags

Short Description

bond-downdelay

int

r/w/en

bond-mode

str

r/w/en

bond-updelay

int

r/w/en

lacp

str

r/w/en

tag

int

r/w/en

trunks

GLib.PtrArray

r/w

vlan-mode

str

r/w/en

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class NM.SettingOvsPort(**kwargs)
Bases:

NM.Setting

Abstract:

No

Structure:

NM.SettingOvsPortClass

OvsPort Link Settings

classmethod new()
Returns:

the new empty NM.SettingOvsPort object

Return type:

NM.Setting

Creates a new NM.SettingOvsPort object with default values.

New in version 1.10.

add_trunk(trunk)
Parameters:

trunk (NM.Range) – the trunk to add

Appends a new trunk range to the setting. This takes a reference to trunk.

New in version 1.42.

clear_trunks()

Removes all configured trunk ranges.

New in version 1.42.

get_bond_downdelay()
Returns:

the NM.SettingOvsPort :bond-downdelay property of the setting

Return type:

int

New in version 1.10.

get_bond_mode()
Returns:

the NM.SettingOvsPort :bond-mode property of the setting

Return type:

str

New in version 1.10.

get_bond_updelay()
Returns:

the NM.SettingOvsPort :bond-updelay property of the setting

Return type:

int

New in version 1.10.

get_lacp()
Returns:

the NM.SettingOvsPort :lacp property of the setting

Return type:

str

New in version 1.10.

get_num_trunks()
Returns:

the number of trunk ranges

Return type:

int

New in version 1.42.

get_tag()
Returns:

the NM.SettingOvsPort :tag property of the setting

Return type:

int

New in version 1.10.

get_trunk(idx)
Parameters:

idx (int) – index number of the trunk range to return

Returns:

the trunk range at index idx

Return type:

NM.Range

New in version 1.42.

get_vlan_mode()
Returns:

the NM.SettingOvsPort :vlan-mode property of the setting

Return type:

str

New in version 1.10.

remove_trunk(idx)
Parameters:

idx (int) – index number of the trunk range.

Removes the trunk range at index idx.

New in version 1.42.

remove_trunk_by_value(start, end)
Parameters:
  • start (int) – the trunk range start index

  • end (int) – the trunk range end index

Returns:

True if the trunk range was found and removed; False otherwise

Return type:

bool

Remove the trunk range with range start to end.

New in version 1.42.

Property Details

NM.SettingOvsPort.props.bond_downdelay
Name:

bond-downdelay

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The time port must be inactive in order to be considered down.

New in version 1.10.

NM.SettingOvsPort.props.bond_mode
Name:

bond-mode

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Bonding mode. One of “active-backup”, “balance-slb”, or “balance-tcp”.

New in version 1.10.

NM.SettingOvsPort.props.bond_updelay
Name:

bond-updelay

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The time port must be active before it starts forwarding traffic.

New in version 1.10.

NM.SettingOvsPort.props.lacp
Name:

lacp

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

LACP mode. One of “active”, “off”, or “passive”.

New in version 1.10.

NM.SettingOvsPort.props.tag
Name:

tag

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The VLAN tag in the range 0-4095.

New in version 1.10.

NM.SettingOvsPort.props.trunks
Name:

trunks

Type:

GLib.PtrArray

Default Value:

None

Flags:

READABLE, WRITABLE

A list of VLAN ranges that this port trunks.

The property is valid only for ports with mode “trunk”, “native-tagged”, or “native-untagged port”. If it is empty, the port trunks all VLANs.

New in version 1.42.

NM.SettingOvsPort.props.vlan_mode
Name:

vlan-mode

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The VLAN mode. One of “access”, “native-tagged”, “native-untagged”, “trunk”, “dot1q-tunnel” or unset.

New in version 1.10.