GI.NM.Objects.SettingIPTunnel

IP Tunneling Settings

Exported types

newtype SettingIPTunnel

Memory-managed wrapper type.

Constructors

SettingIPTunnel (ManagedPtr SettingIPTunnel)

Instances

Eq SettingIPTunnel

Defined in GI.NM.Objects.SettingIPTunnel

Methods

(==) :: SettingIPTunnel -> SettingIPTunnel -> Bool

(/=) :: SettingIPTunnel -> SettingIPTunnel -> Bool

GObject SettingIPTunnel

Defined in GI.NM.Objects.SettingIPTunnel

ManagedPtrNewtype SettingIPTunnel

Defined in GI.NM.Objects.SettingIPTunnel

Methods

toManagedPtr :: SettingIPTunnel -> ManagedPtr SettingIPTunnel

TypedObject SettingIPTunnel

Defined in GI.NM.Objects.SettingIPTunnel

Methods

glibType :: IO GType

HasParentTypes SettingIPTunnel

Defined in GI.NM.Objects.SettingIPTunnel

IsGValue (Maybe SettingIPTunnel)

Convert SettingIPTunnel to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Objects.SettingIPTunnel

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SettingIPTunnel -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SettingIPTunnel)

type ParentTypes SettingIPTunnel

Defined in GI.NM.Objects.SettingIPTunnel

type ParentTypes SettingIPTunnel = '[Setting, Object]

class (GObject o, IsDescendantOf SettingIPTunnel o) => IsSettingIPTunnel o

Type class for types which can be safely cast to SettingIPTunnel, for instance with toSettingIPTunnel.

Instances

(GObject o, IsDescendantOf SettingIPTunnel o) => IsSettingIPTunnel o

Defined in GI.NM.Objects.SettingIPTunnel

toSettingIPTunnel :: (MonadIO m, IsSettingIPTunnel o) => o -> m SettingIPTunnel

Cast to SettingIPTunnel, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getData, getDbusPropertyType, getEncapsulationLimit, getFlags, getFlowLabel, getFwmark, getInputKey, getLocal, getMode, getMtu, getName, getOutputKey, getParent, getPathMtuDiscovery, getProperty, getQdata, getRemote, getSecretFlags, getTos, getTtl.

Setters

setData, setDataFull, setProperty, setSecretFlags.

getEncapsulationLimit

settingIPTunnelGetEncapsulationLimit

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Word32

Returns: the encapsulation limit value

Returns the SettingIPTunnel:encapsulationLimit property of the setting.

Since: 1.42

getFlags

settingIPTunnelGetFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m [IPTunnelFlags]

Returns: the tunnel flags

Returns the SettingIPTunnel:flags property of the setting.

Since: 1.12

getFlowLabel

settingIPTunnelGetFlowLabel

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Word32

Returns: the flow label value

Returns the SettingIPTunnel:flowLabel property of the setting.

Since: 1.42

getFwmark

settingIPTunnelGetFwmark

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Word32

Returns: the fwmark value

Returns the SettingIPTunnel:fwmark property of the setting.

Since: 1.42

getInputKey

settingIPTunnelGetInputKey

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Text

Returns: the input key

Returns the SettingIPTunnel:inputKey property of the setting.

Since: 1.2

getLocal

settingIPTunnelGetLocal

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Text

Returns: the local endpoint

Returns the SettingIPTunnel:local property of the setting.

Since: 1.2

getMode

settingIPTunnelGetMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m IPTunnelMode

Returns: the tunnel mode

Returns the SettingIPTunnel:mode property of the setting.

Since: 1.2

getMtu

settingIPTunnelGetMtu

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Word32

Returns: the MTU

Returns the SettingIPTunnel:mtu property of the setting.

Since: 1.2

getOutputKey

settingIPTunnelGetOutputKey

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Text

Returns: the output key

Returns the SettingIPTunnel:outputKey property of the setting.

Since: 1.2

getParent

settingIPTunnelGetParent

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Text

Returns: the parent device

Returns the SettingIPTunnel:parent property of the setting

Since: 1.2

getPathMtuDiscovery

settingIPTunnelGetPathMtuDiscovery

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Bool

Returns: whether path MTU discovery is enabled

Returns the SettingIPTunnel:pathMtuDiscovery property of the setting.

Since: 1.2

getRemote

settingIPTunnelGetRemote

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Text

Returns: the remote endpoint

Returns the SettingIPTunnel:remote property of the setting.

Since: 1.2

getTos

settingIPTunnelGetTos

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Word32

Returns: the TOS value

Returns the SettingIPTunnel:tos property of the setting.

Since: 1.2

getTtl

settingIPTunnelGetTtl

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPTunnel a)

=> a

setting: the SettingIPTunnel

-> m Word32

Returns: the Time-to-live value

Returns the SettingIPTunnel:ttl property of the setting.

Since: 1.2

new

settingIPTunnelNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingIPTunnel

Returns: the new empty SettingIPTunnel object

Creates a new SettingIPTunnel object with default values.

Since: 1.2

Properties

encapsulationLimit

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 IPTunnelFlagsIp6IgnEncapLimit to ip-tunnel flags.

Since: 1.2

constructSettingIPTunnelEncapsulationLimit :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “encapsulation-limit” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelEncapsulationLimit :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “encapsulation-limit” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #encapsulationLimit

setSettingIPTunnelEncapsulationLimit :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “encapsulation-limit” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #encapsulationLimit := value ]

flags

Tunnel flags. Currently, the following values are supported: IPTunnelFlagsIp6IgnEncapLimit, IPTunnelFlagsIp6UseOrigTclass, IPTunnelFlagsIp6UseOrigFlowlabel, IPTunnelFlagsIp6Mip6Dev, IPTunnelFlagsIp6RcvDscpCopy, IPTunnelFlagsIp6UseOrigFwmark. They are valid only for IPv6 tunnels.

Since: 1.12

constructSettingIPTunnelFlags :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “flags” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelFlags :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “flags” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #flags

setSettingIPTunnelFlags :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “flags” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #flags := value ]

flowLabel

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

Since: 1.2

constructSettingIPTunnelFlowLabel :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “flow-label” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelFlowLabel :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “flow-label” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #flowLabel

setSettingIPTunnelFlowLabel :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “flow-label” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #flowLabel := value ]

fwmark

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

Since: 1.42

constructSettingIPTunnelFwmark :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “fwmark” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelFwmark :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “fwmark” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #fwmark

setSettingIPTunnelFwmark :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “fwmark” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #fwmark := value ]

inputKey

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

Since: 1.2

clearSettingIPTunnelInputKey :: (MonadIO m, IsSettingIPTunnel o) => o -> m ()

Set the value of the “input-key” property to Nothing. When overloading is enabled, this is equivalent to

clear #inputKey

constructSettingIPTunnelInputKey :: (IsSettingIPTunnel o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “input-key” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelInputKey :: (MonadIO m, IsSettingIPTunnel o) => o -> m Text

Get the value of the “input-key” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #inputKey

setSettingIPTunnelInputKey :: (MonadIO m, IsSettingIPTunnel o) => o -> Text -> m ()

Set the value of the “input-key” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #inputKey := value ]

local

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

Since: 1.2

clearSettingIPTunnelLocal :: (MonadIO m, IsSettingIPTunnel o) => o -> m ()

Set the value of the “local” property to Nothing. When overloading is enabled, this is equivalent to

clear #local

constructSettingIPTunnelLocal :: (IsSettingIPTunnel o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “local” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelLocal :: (MonadIO m, IsSettingIPTunnel o) => o -> m Text

Get the value of the “local” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #local

setSettingIPTunnelLocal :: (MonadIO m, IsSettingIPTunnel o) => o -> Text -> m ()

Set the value of the “local” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #local := value ]

mode

The tunneling mode. Valid values: IPTunnelModeIpip, IPTunnelModeGre, IPTunnelModeSit, IPTunnelModeIsatap, IPTunnelModeVti, IPTunnelModeIp6ip6, IPTunnelModeIpip6, IPTunnelModeIp6gre, IPTunnelModeVti6, IPTunnelModeGretap and IPTunnelModeIp6gretap

Since: 1.2

constructSettingIPTunnelMode :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “mode” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelMode :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “mode” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #mode

setSettingIPTunnelMode :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “mode” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #mode := value ]

mtu

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

Since: 1.2

constructSettingIPTunnelMtu :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “mtu” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelMtu :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “mtu” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #mtu

setSettingIPTunnelMtu :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “mtu” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #mtu := value ]

outputKey

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

Since: 1.2

clearSettingIPTunnelOutputKey :: (MonadIO m, IsSettingIPTunnel o) => o -> m ()

Set the value of the “output-key” property to Nothing. When overloading is enabled, this is equivalent to

clear #outputKey

constructSettingIPTunnelOutputKey :: (IsSettingIPTunnel o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “output-key” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelOutputKey :: (MonadIO m, IsSettingIPTunnel o) => o -> m Text

Get the value of the “output-key” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #outputKey

setSettingIPTunnelOutputKey :: (MonadIO m, IsSettingIPTunnel o) => o -> Text -> m ()

Set the value of the “output-key” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #outputKey := value ]

parent

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.

Since: 1.2

clearSettingIPTunnelParent :: (MonadIO m, IsSettingIPTunnel o) => o -> m ()

Set the value of the “parent” property to Nothing. When overloading is enabled, this is equivalent to

clear #parent

constructSettingIPTunnelParent :: (IsSettingIPTunnel o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “parent” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelParent :: (MonadIO m, IsSettingIPTunnel o) => o -> m Text

Get the value of the “parent” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #parent

setSettingIPTunnelParent :: (MonadIO m, IsSettingIPTunnel o) => o -> Text -> m ()

Set the value of the “parent” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #parent := value ]

pathMtuDiscovery

Whether to enable Path MTU Discovery on this tunnel.

Since: 1.2

constructSettingIPTunnelPathMtuDiscovery :: (IsSettingIPTunnel o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “path-mtu-discovery” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelPathMtuDiscovery :: (MonadIO m, IsSettingIPTunnel o) => o -> m Bool

Get the value of the “path-mtu-discovery” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #pathMtuDiscovery

setSettingIPTunnelPathMtuDiscovery :: (MonadIO m, IsSettingIPTunnel o) => o -> Bool -> m ()

Set the value of the “path-mtu-discovery” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #pathMtuDiscovery := value ]

remote

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

Since: 1.2

clearSettingIPTunnelRemote :: (MonadIO m, IsSettingIPTunnel o) => o -> m ()

Set the value of the “remote” property to Nothing. When overloading is enabled, this is equivalent to

clear #remote

constructSettingIPTunnelRemote :: (IsSettingIPTunnel o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “remote” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelRemote :: (MonadIO m, IsSettingIPTunnel o) => o -> m Text

Get the value of the “remote” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #remote

setSettingIPTunnelRemote :: (MonadIO m, IsSettingIPTunnel o) => o -> Text -> m ()

Set the value of the “remote” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #remote := value ]

tos

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

Since: 1.2

constructSettingIPTunnelTos :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “tos” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelTos :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “tos” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #tos

setSettingIPTunnelTos :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “tos” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #tos := value ]

ttl

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

Since: 1.2

constructSettingIPTunnelTtl :: (IsSettingIPTunnel o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ttl” property. This is rarely needed directly, but it is used by new.

getSettingIPTunnelTtl :: (MonadIO m, IsSettingIPTunnel o) => o -> m Word32

Get the value of the “ttl” property. When overloading is enabled, this is equivalent to

get settingIPTunnel #ttl

setSettingIPTunnelTtl :: (MonadIO m, IsSettingIPTunnel o) => o -> Word32 -> m ()

Set the value of the “ttl” property. When overloading is enabled, this is equivalent to

set settingIPTunnel [ #ttl := value ]