GI.NM.Objects.SettingVxlan

VXLAN Settings

Exported types

newtype SettingVxlan

Memory-managed wrapper type.

Constructors

SettingVxlan (ManagedPtr SettingVxlan)

Instances

Eq SettingVxlan

Defined in GI.NM.Objects.SettingVxlan

Methods

(==) :: SettingVxlan -> SettingVxlan -> Bool

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

GObject SettingVxlan

Defined in GI.NM.Objects.SettingVxlan

ManagedPtrNewtype SettingVxlan

Defined in GI.NM.Objects.SettingVxlan

Methods

toManagedPtr :: SettingVxlan -> ManagedPtr SettingVxlan

TypedObject SettingVxlan

Defined in GI.NM.Objects.SettingVxlan

Methods

glibType :: IO GType

HasParentTypes SettingVxlan

Defined in GI.NM.Objects.SettingVxlan

IsGValue (Maybe SettingVxlan)

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

Defined in GI.NM.Objects.SettingVxlan

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingVxlan

Defined in GI.NM.Objects.SettingVxlan

type ParentTypes SettingVxlan = '[Setting, Object]

class (GObject o, IsDescendantOf SettingVxlan o) => IsSettingVxlan o

Type class for types which can be safely cast to SettingVxlan, for instance with toSettingVxlan.

Instances

(GObject o, IsDescendantOf SettingVxlan o) => IsSettingVxlan o

Defined in GI.NM.Objects.SettingVxlan

toSettingVxlan :: (MonadIO m, IsSettingVxlan o) => o -> m SettingVxlan

Cast to SettingVxlan, 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

getAgeing, getData, getDbusPropertyType, getDestinationPort, getId, getL2Miss, getL3Miss, getLearning, getLimit, getLocal, getName, getParent, getProperty, getProxy, getQdata, getRemote, getRsc, getSecretFlags, getSourcePortMax, getSourcePortMin, getTos, getTtl.

Setters

setData, setDataFull, setProperty, setSecretFlags.

getAgeing

settingVxlanGetAgeing

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:ageing property of the setting

No description available in the introspection data.

Since: 1.2

getDestinationPort

settingVxlanGetDestinationPort

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:destinationPort property of the setting

No description available in the introspection data.

Since: 1.2

getId

settingVxlanGetId

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:id property of the setting

No description available in the introspection data.

Since: 1.2

getL2Miss

settingVxlanGetL2Miss

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Bool

Returns: the SettingVxlan:l2_miss property of the setting

No description available in the introspection data.

Since: 1.2

getL3Miss

settingVxlanGetL3Miss

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Bool

Returns: the SettingVxlan:l3_miss property of the setting

No description available in the introspection data.

Since: 1.2

getLearning

settingVxlanGetLearning

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Bool

Returns: the SettingVxlan:learning property of the setting

No description available in the introspection data.

Since: 1.2

getLimit

settingVxlanGetLimit

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:limit property of the setting

No description available in the introspection data.

Since: 1.2

getLocal

settingVxlanGetLocal

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Text

Returns: the SettingVxlan:local property of the setting

No description available in the introspection data.

Since: 1.2

getParent

settingVxlanGetParent

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Text

Returns: the SettingVxlan:parent property of the setting

No description available in the introspection data.

Since: 1.2

getProxy

settingVxlanGetProxy

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Bool

Returns: the SettingVxlan:proxy property of the setting

No description available in the introspection data.

Since: 1.2

getRemote

settingVxlanGetRemote

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Text

Returns: the SettingVxlan:remote property of the setting

No description available in the introspection data.

Since: 1.2

getRsc

settingVxlanGetRsc

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Bool

Returns: the SettingVxlan:rsc property of the setting

No description available in the introspection data.

Since: 1.2

getSourcePortMax

settingVxlanGetSourcePortMax

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:sourcePortMax property of the setting

No description available in the introspection data.

Since: 1.2

getSourcePortMin

settingVxlanGetSourcePortMin

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:sourcePortMin property of the setting

No description available in the introspection data.

Since: 1.2

getTos

settingVxlanGetTos

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:tos property of the setting

No description available in the introspection data.

Since: 1.2

getTtl

settingVxlanGetTtl

Arguments

:: (HasCallStack, MonadIO m, IsSettingVxlan a)

=> a

setting: the SettingVxlan

-> m Word32

Returns: the SettingVxlan:ttl property of the setting

No description available in the introspection data.

Since: 1.2

new

settingVxlanNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingVxlan

Returns: the new empty SettingVxlan object

Creates a new SettingVxlan object with default values.

Since: 1.2

Properties

ageing

Specifies the lifetime in seconds of FDB entries learnt by the kernel.

Since: 1.2

constructSettingVxlanAgeing :: (IsSettingVxlan o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingVxlanAgeing :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

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

get settingVxlan #ageing

setSettingVxlanAgeing :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

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

set settingVxlan [ #ageing := value ]

destinationPort

Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.

Since: 1.2

constructSettingVxlanDestinationPort :: (IsSettingVxlan o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingVxlanDestinationPort :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

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

get settingVxlan #destinationPort

setSettingVxlanDestinationPort :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

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

set settingVxlan [ #destinationPort := value ]

id

Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.

Since: 1.2

constructSettingVxlanId :: (IsSettingVxlan o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingVxlanId :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

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

get settingVxlan #id

setSettingVxlanId :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

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

set settingVxlan [ #id := value ]

l2Miss

Specifies whether netlink LL ADDR miss notifications are generated.

Since: 1.2

constructSettingVxlanL2Miss :: (IsSettingVxlan o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingVxlanL2Miss :: (MonadIO m, IsSettingVxlan o) => o -> m Bool

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

get settingVxlan #l2Miss

setSettingVxlanL2Miss :: (MonadIO m, IsSettingVxlan o) => o -> Bool -> m ()

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

set settingVxlan [ #l2Miss := value ]

l3Miss

Specifies whether netlink IP ADDR miss notifications are generated.

Since: 1.2

constructSettingVxlanL3Miss :: (IsSettingVxlan o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingVxlanL3Miss :: (MonadIO m, IsSettingVxlan o) => o -> m Bool

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

get settingVxlan #l3Miss

setSettingVxlanL3Miss :: (MonadIO m, IsSettingVxlan o) => o -> Bool -> m ()

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

set settingVxlan [ #l3Miss := value ]

learning

Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.

Since: 1.2

constructSettingVxlanLearning :: (IsSettingVxlan o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingVxlanLearning :: (MonadIO m, IsSettingVxlan o) => o -> m Bool

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

get settingVxlan #learning

setSettingVxlanLearning :: (MonadIO m, IsSettingVxlan o) => o -> Bool -> m ()

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

set settingVxlan [ #learning := value ]

limit

Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.

Since: 1.2

constructSettingVxlanLimit :: (IsSettingVxlan o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingVxlanLimit :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

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

get settingVxlan #limit

setSettingVxlanLimit :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

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

set settingVxlan [ #limit := value ]

local

If given, specifies the source IP address to use in outgoing packets.

Since: 1.2

clearSettingVxlanLocal :: (MonadIO m, IsSettingVxlan o) => o -> m ()

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

clear #local

constructSettingVxlanLocal :: (IsSettingVxlan 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.

getSettingVxlanLocal :: (MonadIO m, IsSettingVxlan o) => o -> m Text

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

get settingVxlan #local

setSettingVxlanLocal :: (MonadIO m, IsSettingVxlan o) => o -> Text -> m ()

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

set settingVxlan [ #local := value ]

parent

If given, specifies the parent interface name or parent connection UUID.

Since: 1.2

clearSettingVxlanParent :: (MonadIO m, IsSettingVxlan o) => o -> m ()

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

clear #parent

constructSettingVxlanParent :: (IsSettingVxlan 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.

getSettingVxlanParent :: (MonadIO m, IsSettingVxlan o) => o -> m Text

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

get settingVxlan #parent

setSettingVxlanParent :: (MonadIO m, IsSettingVxlan o) => o -> Text -> m ()

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

set settingVxlan [ #parent := value ]

proxy

Specifies whether ARP proxy is turned on.

Since: 1.2

constructSettingVxlanProxy :: (IsSettingVxlan o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingVxlanProxy :: (MonadIO m, IsSettingVxlan o) => o -> m Bool

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

get settingVxlan #proxy

setSettingVxlanProxy :: (MonadIO m, IsSettingVxlan o) => o -> Bool -> m ()

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

set settingVxlan [ #proxy := value ]

remote

Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.

Since: 1.2

clearSettingVxlanRemote :: (MonadIO m, IsSettingVxlan o) => o -> m ()

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

clear #remote

constructSettingVxlanRemote :: (IsSettingVxlan 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.

getSettingVxlanRemote :: (MonadIO m, IsSettingVxlan o) => o -> m Text

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

get settingVxlan #remote

setSettingVxlanRemote :: (MonadIO m, IsSettingVxlan o) => o -> Text -> m ()

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

set settingVxlan [ #remote := value ]

rsc

Specifies whether route short circuit is turned on.

Since: 1.2

constructSettingVxlanRsc :: (IsSettingVxlan o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingVxlanRsc :: (MonadIO m, IsSettingVxlan o) => o -> m Bool

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

get settingVxlan #rsc

setSettingVxlanRsc :: (MonadIO m, IsSettingVxlan o) => o -> Bool -> m ()

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

set settingVxlan [ #rsc := value ]

sourcePortMax

Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.

Since: 1.2

constructSettingVxlanSourcePortMax :: (IsSettingVxlan o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingVxlanSourcePortMax :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

Get the value of the “source-port-max” property. When overloading is enabled, this is equivalent to

get settingVxlan #sourcePortMax

setSettingVxlanSourcePortMax :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

Set the value of the “source-port-max” property. When overloading is enabled, this is equivalent to

set settingVxlan [ #sourcePortMax := value ]

sourcePortMin

Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.

Since: 1.2

constructSettingVxlanSourcePortMin :: (IsSettingVxlan o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingVxlanSourcePortMin :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

Get the value of the “source-port-min” property. When overloading is enabled, this is equivalent to

get settingVxlan #sourcePortMin

setSettingVxlanSourcePortMin :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

Set the value of the “source-port-min” property. When overloading is enabled, this is equivalent to

set settingVxlan [ #sourcePortMin := value ]

tos

Specifies the TOS value to use in outgoing packets.

Since: 1.2

constructSettingVxlanTos :: (IsSettingVxlan 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.

getSettingVxlanTos :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

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

get settingVxlan #tos

setSettingVxlanTos :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

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

set settingVxlan [ #tos := value ]

ttl

Specifies the time-to-live value to use in outgoing packets.

Since: 1.2

constructSettingVxlanTtl :: (IsSettingVxlan 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.

getSettingVxlanTtl :: (MonadIO m, IsSettingVxlan o) => o -> m Word32

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

get settingVxlan #ttl

setSettingVxlanTtl :: (MonadIO m, IsSettingVxlan o) => o -> Word32 -> m ()

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

set settingVxlan [ #ttl := value ]