NM.SettingIPTunnel¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`get_encapsulation_limit` ()
	`get_flags` ()
	`get_flow_label` ()
	`get_fwmark` ()
	`get_input_key` ()
	`get_local` ()
	`get_mode` ()
	`get_mtu` ()
	`get_output_key` ()
	`get_parent` ()
	`get_path_mtu_discovery` ()
	`get_remote` ()
	`get_tos` ()
	`get_ttl` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: NM.Setting (1)

Name	Type	Flags
`encapsulation-limit`	`int`	r/w/en
`flags`	`int`	r/w/en
`flow-label`	`int`	r/w/en
`fwmark`	`int`	r/w/en
`input-key`	`str`	r/w/en
`local`	`str`	r/w/en
`mode`	`int`	r/w/en
`mtu`	`int`	r/w/en
`output-key`	`str`	r/w/en
`parent`	`str`	r/w/en
`path-mtu-discovery`	`bool`	r/w/en
`remote`	`str`	r/w/en
`tos`	`int`	r/w/en
`ttl`	`int`	r/w/en

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class NM.SettingIPTunnel(**kwargs)¶

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

IP Tunneling Settings

classmethod new()¶

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

Creates a new NM.SettingIPTunnel object with default values.

New in version 1.2.

get_encapsulation_limit()¶

Returns:: the encapsulation limit value
Return type:: int

Returns the NM.SettingIPTunnel :encapsulation-limit property of the setting.

New in version 1.42.

get_flags()¶

Returns:: the tunnel flags
Return type:: NM.IPTunnelFlags

Returns the NM.SettingIPTunnel :flags property of the setting.

New in version 1.12.

get_flow_label()¶

Returns:: the flow label value
Return type:: int

Returns the NM.SettingIPTunnel :flow-label property of the setting.

New in version 1.42.

get_fwmark()¶

Returns:: the fwmark value
Return type:: int

Returns the NM.SettingIPTunnel :fwmark property of the setting.

New in version 1.42.

get_input_key()¶

Returns:: the input key
Return type:: str

Returns the NM.SettingIPTunnel :input-key property of the setting.

New in version 1.2.

get_local()¶

Returns:: the local endpoint
Return type:: str

Returns the NM.SettingIPTunnel :local property of the setting.

New in version 1.2.

get_mode()¶

Returns:: the tunnel mode
Return type:: NM.IPTunnelMode

Returns the NM.SettingIPTunnel :mode property of the setting.

New in version 1.2.

get_mtu()¶

Returns:: the MTU
Return type:: int

Returns the NM.SettingIPTunnel :mtu property of the setting.

New in version 1.2.

get_output_key()¶

Returns:: the output key
Return type:: str

Returns the NM.SettingIPTunnel :output-key property of the setting.

New in version 1.2.

get_parent()¶

Returns:: the parent device
Return type:: str

Returns the NM.SettingIPTunnel :parent property of the setting

New in version 1.2.

get_path_mtu_discovery()¶

Returns:: whether path MTU discovery is enabled
Return type:: bool

Returns the NM.SettingIPTunnel :path-mtu-discovery property of the setting.

New in version 1.2.

get_remote()¶

Returns:: the remote endpoint
Return type:: str

Returns the NM.SettingIPTunnel :remote property of the setting.

New in version 1.2.

get_tos()¶

Returns:: the TOS value
Return type:: int

Returns the NM.SettingIPTunnel :tos property of the setting.

New in version 1.2.

get_ttl()¶

Returns:: the Time-to-live value
Return type:: int

Returns the NM.SettingIPTunnel :ttl property of the setting.

New in version 1.2.

Property Details¶

NM.SettingIPTunnel.props.encapsulation_limit¶

Name:: encapsulation-limit
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM.IPTunnelFlags.IP6_IGN_ENCAP_LIMIT to ip-tunnel flags.

New in version 1.2.

NM.SettingIPTunnel.props.flags¶

Name:: flags
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Tunnel flags. Currently, the following values are supported: NM.IPTunnelFlags.IP6_IGN_ENCAP_LIMIT, NM.IPTunnelFlags.IP6_USE_ORIG_TCLASS, NM.IPTunnelFlags.IP6_USE_ORIG_FLOWLABEL, NM.IPTunnelFlags.IP6_MIP6_DEV, NM.IPTunnelFlags.IP6_RCV_DSCP_COPY, NM.IPTunnelFlags.IP6_USE_ORIG_FWMARK. They are valid only for IPv6 tunnels.

New in version 1.12.

NM.SettingIPTunnel.props.flow_label¶

Name:: flow-label
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.

New in version 1.2.

NM.SettingIPTunnel.props.fwmark¶

Name:: fwmark
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.

New in version 1.42.

NM.SettingIPTunnel.props.input_key¶

Name:: input-key
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

New in version 1.2.

NM.SettingIPTunnel.props.local¶

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

The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.

New in version 1.2.

NM.SettingIPTunnel.props.mode¶

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

The tunneling mode. Valid values: NM.IPTunnelMode.IPIP, NM.IPTunnelMode.GRE, NM.IPTunnelMode.SIT, NM.IPTunnelMode.ISATAP, NM.IPTunnelMode.VTI, NM.IPTunnelMode.IP6IP6, NM.IPTunnelMode.IPIP6, NM.IPTunnelMode.IP6GRE, NM.IPTunnelMode.VTI6, NM.IPTunnelMode.GRETAP and NM.IPTunnelMode.IP6GRETAP

New in version 1.2.

NM.SettingIPTunnel.props.mtu¶

Name:: mtu
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

New in version 1.2.

NM.SettingIPTunnel.props.output_key¶

Name:: output-key
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

New in version 1.2.

NM.SettingIPTunnel.props.parent¶

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

If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.

New in version 1.2.

NM.SettingIPTunnel.props.path_mtu_discovery¶

Name:: path-mtu-discovery
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether to enable Path MTU Discovery on this tunnel.

New in version 1.2.

NM.SettingIPTunnel.props.remote¶

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

The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.

New in version 1.2.

NM.SettingIPTunnel.props.tos¶

Name:: tos
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.

New in version 1.2.

NM.SettingIPTunnel.props.ttl¶

Name:: ttl
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.

New in version 1.2.