gi-nm-1.0.1: NM bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.NM.Objects.DeviceVxlan

Description

No description available in the introspection data.

Since: 1.2

Synopsis

Exported types

newtype DeviceVxlan Source #

Memory-managed wrapper type.

class (GObject o, IsDescendantOf DeviceVxlan o) => IsDeviceVxlan o Source #

Type class for types which can be safely cast to DeviceVxlan, for instance with toDeviceVxlan.

Instances

Instances details
(GObject o, IsDescendantOf DeviceVxlan o) => IsDeviceVxlan o Source # 
Instance details

Defined in GI.NM.Objects.DeviceVxlan

toDeviceVxlan :: (MonadIO m, IsDeviceVxlan o) => o -> m DeviceVxlan Source #

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

Methods

getAgeing

deviceVxlanGetAgeing Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the lifetime in seconds of FDB entries learnt by the kernel

No description available in the introspection data.

Since: 1.2

getCarrier

deviceVxlanGetCarrier Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Bool

Returns: True if the device has carrier.

This property is not implemented yet, and the function always returns FALSE.

Whether the device has carrier.

Since: 1.42

getDstPort

deviceVxlanGetDstPort Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the UDP destination port

No description available in the introspection data.

Since: 1.2

getGroup

deviceVxlanGetGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Text

Returns: The unicast destination IP address or the multicast IP address joined

No description available in the introspection data.

Since: 1.2

getId

deviceVxlanGetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the device's VXLAN ID.

No description available in the introspection data.

Since: 1.2

getL2miss

deviceVxlanGetL2miss Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Bool

Returns: whether netlink LL ADDR miss notifications are generated

No description available in the introspection data.

Since: 1.2

getL3miss

deviceVxlanGetL3miss Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Bool

Returns: whether netlink IP ADDR miss notifications are generated

No description available in the introspection data.

Since: 1.2

getLearning

deviceVxlanGetLearning Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Bool

Returns: whether address learning is enabled

No description available in the introspection data.

Since: 1.2

getLimit

deviceVxlanGetLimit Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the maximum number of entries that can be added to the forwarding table

No description available in the introspection data.

Since: 1.2

getLocal

deviceVxlanGetLocal Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Text

Returns: the source IP address to use in outgoing packets

No description available in the introspection data.

Since: 1.2

getParent

deviceVxlanGetParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Device

Returns: the device's parent device

No description available in the introspection data.

Since: 1.2

getProxy

deviceVxlanGetProxy Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Bool

Returns: whether ARP proxy is turned on

No description available in the introspection data.

Since: 1.2

getRsc

deviceVxlanGetRsc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Bool

Returns: whether route short circuit is turned on

No description available in the introspection data.

Since: 1.42

getSrcPortMax

deviceVxlanGetSrcPortMax Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the maximum UDP source port

No description available in the introspection data.

Since: 1.2

getSrcPortMin

deviceVxlanGetSrcPortMin Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the minimum UDP source port

No description available in the introspection data.

Since: 1.2

getTos

deviceVxlanGetTos Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the TOS value to use in outgoing packets

No description available in the introspection data.

Since: 1.2

getTtl

deviceVxlanGetTtl Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceVxlan a) 
=> a

device: a DeviceVxlan

-> m Word32

Returns: the time-to-live value to use in outgoing packets

No description available in the introspection data.

Since: 1.2

Properties

ageing

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

Since: 1.2

getDeviceVxlanAgeing :: (MonadIO m, IsDeviceVxlan o) => o -> m Word32 Source #

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

get deviceVxlan #ageing

carrier

Whether the device has carrier.

This property is not implemented yet, and the property is always FALSE.

Since: 1.2

getDeviceVxlanCarrier :: (MonadIO m, IsDeviceVxlan o) => o -> m Bool Source #

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

get deviceVxlan #carrier

dstPort

The UDP destination port used to communicate with the remote VXLAN tunnel endpoint.

Since: 1.2

getDeviceVxlanDstPort :: (MonadIO m, IsDeviceVxlan o) => o -> m Word32 Source #

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

get deviceVxlan #dstPort

group

The unicast destination IP address used in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database or the multicast IP address joined.

Since: 1.2

getDeviceVxlanGroup :: (MonadIO m, IsDeviceVxlan o) => o -> m Text Source #

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

get deviceVxlan #group

id

The device's VXLAN ID.

Since: 1.2

getDeviceVxlanId :: (MonadIO m, IsDeviceVxlan o) => o -> m Word32 Source #

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

get deviceVxlan #id

l2miss

Whether netlink LL ADDR miss notifications are generated.

Since: 1.2

getDeviceVxlanL2miss :: (MonadIO m, IsDeviceVxlan o) => o -> m Bool Source #

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

get deviceVxlan #l2miss

l3miss

Whether netlink IP ADDR miss notifications are generated.

Since: 1.2

getDeviceVxlanL3miss :: (MonadIO m, IsDeviceVxlan o) => o -> m Bool Source #

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

get deviceVxlan #l3miss

learning

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

Since: 1.2

getDeviceVxlanLearning :: (MonadIO m, IsDeviceVxlan o) => o -> m Bool Source #

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

get deviceVxlan #learning

limit

The maximum number of entries that can be added to the forwarding table.

Since: 1.2

getDeviceVxlanLimit :: (MonadIO m, IsDeviceVxlan o) => o -> m Word32 Source #

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

get deviceVxlan #limit

local

The source IP address to use in outgoing packets.

Since: 1.2

getDeviceVxlanLocal :: (MonadIO m, IsDeviceVxlan o) => o -> m Text Source #

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

get deviceVxlan #local

parent

The devices's parent device.

Since: 1.2

getDeviceVxlanParent :: (MonadIO m, IsDeviceVxlan o) => o -> m Device Source #

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

get deviceVxlan #parent

proxy

Whether ARP proxy is turned on.

Since: 1.2

getDeviceVxlanProxy :: (MonadIO m, IsDeviceVxlan o) => o -> m Bool Source #

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

get deviceVxlan #proxy

rsc

Whether route short circuit is turned on.

Since: 1.2

getDeviceVxlanRsc :: (MonadIO m, IsDeviceVxlan o) => o -> m Bool Source #

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

get deviceVxlan #rsc

srcPortMax

The maximum UDP source port used to communicate with the remote VXLAN tunnel endpoint.

Since: 1.2

getDeviceVxlanSrcPortMax :: (MonadIO m, IsDeviceVxlan o) => o -> m Word32 Source #

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

get deviceVxlan #srcPortMax

srcPortMin

The minimum UDP source port used to communicate with the remote VXLAN tunnel endpoint.

Since: 1.2

getDeviceVxlanSrcPortMin :: (MonadIO m, IsDeviceVxlan o) => o -> m Word32 Source #

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

get deviceVxlan #srcPortMin

tos

ttl