GI.NM.Objects.SettingOvsPort

OvsPort Link Settings

Exported types

newtype SettingOvsPort

Memory-managed wrapper type.

Constructors

SettingOvsPort (ManagedPtr SettingOvsPort)

Instances

Eq SettingOvsPort

Defined in GI.NM.Objects.SettingOvsPort

Methods

(==) :: SettingOvsPort -> SettingOvsPort -> Bool

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

GObject SettingOvsPort

Defined in GI.NM.Objects.SettingOvsPort

ManagedPtrNewtype SettingOvsPort

Defined in GI.NM.Objects.SettingOvsPort

Methods

toManagedPtr :: SettingOvsPort -> ManagedPtr SettingOvsPort

TypedObject SettingOvsPort

Defined in GI.NM.Objects.SettingOvsPort

Methods

glibType :: IO GType

HasParentTypes SettingOvsPort

Defined in GI.NM.Objects.SettingOvsPort

IsGValue (Maybe SettingOvsPort)

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

Defined in GI.NM.Objects.SettingOvsPort

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingOvsPort

Defined in GI.NM.Objects.SettingOvsPort

type ParentTypes SettingOvsPort = '[Setting, Object]

class (GObject o, IsDescendantOf SettingOvsPort o) => IsSettingOvsPort o

Type class for types which can be safely cast to SettingOvsPort, for instance with toSettingOvsPort.

Instances

(GObject o, IsDescendantOf SettingOvsPort o) => IsSettingOvsPort o

Defined in GI.NM.Objects.SettingOvsPort

toSettingOvsPort :: (MonadIO m, IsSettingOvsPort o) => o -> m SettingOvsPort

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

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

Getters

getBondDowndelay, getBondMode, getBondUpdelay, getData, getDbusPropertyType, getLacp, getName, getNumTrunks, getProperty, getQdata, getSecretFlags, getTag, getTrunk, getVlanMode.

Setters

setData, setDataFull, setProperty, setSecretFlags.

addTrunk

settingOvsPortAddTrunk

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

setting: the SettingOvsPort

-> Range

trunk: the trunk to add

-> m ()

Appends a new trunk range to the setting. This takes a reference to trunk.

Since: 1.42

clearTrunks

settingOvsPortClearTrunks

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

setting: the SettingOvsPort

-> m ()

Removes all configured trunk ranges.

Since: 1.42

getBondDowndelay

settingOvsPortGetBondDowndelay

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

self: the SettingOvsPort

-> m Word32

Returns: the SettingOvsPort:bondDowndelay property of the setting

No description available in the introspection data.

Since: 1.10

getBondMode

settingOvsPortGetBondMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

self: the SettingOvsPort

-> m Text

Returns: the SettingOvsPort:bondMode property of the setting

No description available in the introspection data.

Since: 1.10

getBondUpdelay

settingOvsPortGetBondUpdelay

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

self: the SettingOvsPort

-> m Word32

Returns: the SettingOvsPort:bondUpdelay property of the setting

No description available in the introspection data.

Since: 1.10

getLacp

settingOvsPortGetLacp

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

self: the SettingOvsPort

-> m Text

Returns: the SettingOvsPort:lacp property of the setting

No description available in the introspection data.

Since: 1.10

getNumTrunks

settingOvsPortGetNumTrunks

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

setting: the SettingOvsPort

-> m Word32

Returns: the number of trunk ranges

No description available in the introspection data.

Since: 1.42

getTag

settingOvsPortGetTag

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

self: the SettingOvsPort

-> m Word32

Returns: the SettingOvsPort:tag property of the setting

No description available in the introspection data.

Since: 1.10

getTrunk

settingOvsPortGetTrunk

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

setting: the SettingOvsPort

-> Word32

idx: index number of the trunk range to return

-> m Range

Returns: the trunk range at index idx

No description available in the introspection data.

Since: 1.42

getVlanMode

settingOvsPortGetVlanMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

self: the SettingOvsPort

-> m Text

Returns: the SettingOvsPort:vlanMode property of the setting

No description available in the introspection data.

Since: 1.10

new

settingOvsPortNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingOvsPort

Returns: the new empty SettingOvsPort object

Creates a new SettingOvsPort object with default values.

Since: 1.10

removeTrunk

settingOvsPortRemoveTrunk

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

setting: the SettingOvsPort

-> Word32

idx: index number of the trunk range.

-> m ()

Removes the trunk range at index idx.

Since: 1.42

removeTrunkByValue

settingOvsPortRemoveTrunkByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsPort a)

=> a

setting: the SettingOvsPort

-> Word32

start: the trunk range start index

-> Word32

end: the trunk range end index

-> m Bool

Returns: True if the trunk range was found and removed; False otherwise

Remove the trunk range with range start to end.

Since: 1.42

Properties

bondDowndelay

The time port must be inactive in order to be considered down.

Since: 1.10

constructSettingOvsPortBondDowndelay :: (IsSettingOvsPort o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingOvsPortBondDowndelay :: (MonadIO m, IsSettingOvsPort o) => o -> m Word32

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

get settingOvsPort #bondDowndelay

setSettingOvsPortBondDowndelay :: (MonadIO m, IsSettingOvsPort o) => o -> Word32 -> m ()

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

set settingOvsPort [ #bondDowndelay := value ]

bondMode

Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".

Since: 1.10

clearSettingOvsPortBondMode :: (MonadIO m, IsSettingOvsPort o) => o -> m ()

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

clear #bondMode

constructSettingOvsPortBondMode :: (IsSettingOvsPort o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingOvsPortBondMode :: (MonadIO m, IsSettingOvsPort o) => o -> m Text

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

get settingOvsPort #bondMode

setSettingOvsPortBondMode :: (MonadIO m, IsSettingOvsPort o) => o -> Text -> m ()

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

set settingOvsPort [ #bondMode := value ]

bondUpdelay

The time port must be active before it starts forwarding traffic.

Since: 1.10

constructSettingOvsPortBondUpdelay :: (IsSettingOvsPort o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingOvsPortBondUpdelay :: (MonadIO m, IsSettingOvsPort o) => o -> m Word32

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

get settingOvsPort #bondUpdelay

setSettingOvsPortBondUpdelay :: (MonadIO m, IsSettingOvsPort o) => o -> Word32 -> m ()

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

set settingOvsPort [ #bondUpdelay := value ]

lacp

LACP mode. One of "active", "off", or "passive".

Since: 1.10

clearSettingOvsPortLacp :: (MonadIO m, IsSettingOvsPort o) => o -> m ()

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

clear #lacp

constructSettingOvsPortLacp :: (IsSettingOvsPort o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingOvsPortLacp :: (MonadIO m, IsSettingOvsPort o) => o -> m Text

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

get settingOvsPort #lacp

setSettingOvsPortLacp :: (MonadIO m, IsSettingOvsPort o) => o -> Text -> m ()

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

set settingOvsPort [ #lacp := value ]

tag

The VLAN tag in the range 0-4095.

Since: 1.10

constructSettingOvsPortTag :: (IsSettingOvsPort o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingOvsPortTag :: (MonadIO m, IsSettingOvsPort o) => o -> m Word32

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

get settingOvsPort #tag

setSettingOvsPortTag :: (MonadIO m, IsSettingOvsPort o) => o -> Word32 -> m ()

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

set settingOvsPort [ #tag := value ]

trunks

vlanMode

The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.

Since: 1.10

clearSettingOvsPortVlanMode :: (MonadIO m, IsSettingOvsPort o) => o -> m ()

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

clear #vlanMode

constructSettingOvsPortVlanMode :: (IsSettingOvsPort o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingOvsPortVlanMode :: (MonadIO m, IsSettingOvsPort o) => o -> m Text

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

get settingOvsPort #vlanMode

setSettingOvsPortVlanMode :: (MonadIO m, IsSettingOvsPort o) => o -> Text -> m ()

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

set settingOvsPort [ #vlanMode := value ]