NM.SettingTun¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`get_group` ()
	`get_mode` ()
	`get_multi_queue` ()
	`get_owner` ()
	`get_pi` ()
	`get_vnet_hdr` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: NM.Setting (1)

Name	Type	Flags
`group`	`str`	r/w/en
`mode`	`int`	r/w/en
`multi-queue`	`bool`	r/w/en
`owner`	`str`	r/w/en
`pi`	`bool`	r/w/en
`vnet-hdr`	`bool`	r/w/en

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class NM.SettingTun(**kwargs)¶

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

Tunnel Settings

classmethod new()¶

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

Creates a new NM.SettingTun object with default values.

New in version 1.2.

get_group()¶

Returns:: the NM.SettingTun :group property of the setting
Return type:: str

New in version 1.2.

get_mode()¶

Returns:: the NM.SettingTun :mode property of the setting
Return type:: NM.SettingTunMode

New in version 1.2.

get_multi_queue()¶

Returns:: the NM.SettingTun :multi-queue property of the setting
Return type:: bool

New in version 1.2.

get_owner()¶

Returns:: the NM.SettingTun :owner property of the setting
Return type:: str

New in version 1.2.

get_pi()¶

Returns:: the NM.SettingTun :pi property of the setting
Return type:: bool

New in version 1.2.

get_vnet_hdr()¶

Returns:: the #NMSettingTun:vnet_hdr property of the setting
Return type:: bool

New in version 1.2.

Property Details¶

NM.SettingTun.props.group¶

Name:: group
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The group ID which will own the device. If set to None everyone will be able to use the device.

New in version 1.2.

NM.SettingTun.props.mode¶

Name:: mode
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The operating mode of the virtual device. Allowed values are NM.SettingTunMode.TUN to create a layer 3 device and NM.SettingTunMode.TAP to create an Ethernet-like layer 2 one.

New in version 1.2.

NM.SettingTun.props.multi_queue¶

Name:: multi-queue
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If the property is set to True, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.

New in version 1.2.

NM.SettingTun.props.owner¶

Name:: owner
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The user ID which will own the device. If set to None everyone will be able to use the device.

New in version 1.2.

NM.SettingTun.props.pi¶

Name:: pi
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If True the interface will prepend a 4 byte header describing the physical interface to the packets.

New in version 1.2.

NM.SettingTun.props.vnet_hdr¶

Name:: vnet-hdr
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If True the IFF_VNET_HDR the tunnel packets will include a virtio network header.

New in version 1.2.