GI.NM.Objects.SettingMacsec

MACSec Settings

Exported types

newtype SettingMacsec

Memory-managed wrapper type.

Constructors

SettingMacsec (ManagedPtr SettingMacsec)

Instances

Eq SettingMacsec

Defined in GI.NM.Objects.SettingMacsec

Methods

(==) :: SettingMacsec -> SettingMacsec -> Bool

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

GObject SettingMacsec

Defined in GI.NM.Objects.SettingMacsec

ManagedPtrNewtype SettingMacsec

Defined in GI.NM.Objects.SettingMacsec

Methods

toManagedPtr :: SettingMacsec -> ManagedPtr SettingMacsec

TypedObject SettingMacsec

Defined in GI.NM.Objects.SettingMacsec

Methods

glibType :: IO GType

HasParentTypes SettingMacsec

Defined in GI.NM.Objects.SettingMacsec

IsGValue (Maybe SettingMacsec)

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

Defined in GI.NM.Objects.SettingMacsec

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingMacsec

Defined in GI.NM.Objects.SettingMacsec

type ParentTypes SettingMacsec = '[Setting, Object]

class (GObject o, IsDescendantOf SettingMacsec o) => IsSettingMacsec o

Type class for types which can be safely cast to SettingMacsec, for instance with toSettingMacsec.

Instances

(GObject o, IsDescendantOf SettingMacsec o) => IsSettingMacsec o

Defined in GI.NM.Objects.SettingMacsec

toSettingMacsec :: (MonadIO m, IsSettingMacsec o) => o -> m SettingMacsec

Cast to SettingMacsec, 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, getEncrypt, getMkaCak, getMkaCakFlags, getMkaCkn, getMode, getName, getOffload, getParent, getPort, getProperty, getQdata, getSecretFlags, getSendSci, getValidation.

Setters

setData, setDataFull, setProperty, setSecretFlags.

getEncrypt

settingMacsecGetEncrypt

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m Bool

Returns: the SettingMacsec:encrypt property of the setting

No description available in the introspection data.

Since: 1.6

getMkaCak

settingMacsecGetMkaCak

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m Text

Returns: the SettingMacsec:mkaCak property of the setting

No description available in the introspection data.

Since: 1.6

getMkaCakFlags

settingMacsecGetMkaCakFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m [SettingSecretFlags]

Returns: the SettingSecretFlags pertaining to the SettingMacsec:mkaCak

No description available in the introspection data.

Since: 1.6

getMkaCkn

settingMacsecGetMkaCkn

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m Text

Returns: the SettingMacsec:mkaCkn property of the setting

No description available in the introspection data.

Since: 1.6

getMode

settingMacsecGetMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m SettingMacsecMode

Returns: the SettingMacsec:mode property of the setting

No description available in the introspection data.

Since: 1.6

getOffload

settingMacsecGetOffload

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m SettingMacsecOffload

Returns: the SettingMacsec:offload property of the setting

No description available in the introspection data.

Since: 1.46

getParent

settingMacsecGetParent

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m Text

Returns: the SettingMacsec:parent property of the setting

No description available in the introspection data.

Since: 1.6

getPort

settingMacsecGetPort

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m Int32

Returns: the SettingMacsec:port property of the setting

No description available in the introspection data.

Since: 1.6

getSendSci

settingMacsecGetSendSci

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m Bool

Returns: the SettingMacsec:sendSci property of the setting

No description available in the introspection data.

Since: 1.12

getValidation

settingMacsecGetValidation

Arguments

:: (HasCallStack, MonadIO m, IsSettingMacsec a)

=> a

setting: the SettingMacsec

-> m SettingMacsecValidation

Returns: the SettingMacsec:validation property of the setting

No description available in the introspection data.

Since: 1.6

new

settingMacsecNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingMacsec

Returns: the new empty SettingMacsec object

Creates a new SettingMacsec object with default values.

Since: 1.6

Properties

encrypt

Whether the transmitted traffic must be encrypted.

Since: 1.6

constructSettingMacsecEncrypt :: (IsSettingMacsec o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingMacsecEncrypt :: (MonadIO m, IsSettingMacsec o) => o -> m Bool

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

get settingMacsec #encrypt

setSettingMacsecEncrypt :: (MonadIO m, IsSettingMacsec o) => o -> Bool -> m ()

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

set settingMacsec [ #encrypt := value ]

mkaCak

The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.

Since: 1.6

clearSettingMacsecMkaCak :: (MonadIO m, IsSettingMacsec o) => o -> m ()

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

clear #mkaCak

constructSettingMacsecMkaCak :: (IsSettingMacsec o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingMacsecMkaCak :: (MonadIO m, IsSettingMacsec o) => o -> m Text

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

get settingMacsec #mkaCak

setSettingMacsecMkaCak :: (MonadIO m, IsSettingMacsec o) => o -> Text -> m ()

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

set settingMacsec [ #mkaCak := value ]

mkaCakFlags

Flags indicating how to handle the SettingMacsec:mkaCak property.

Since: 1.6

constructSettingMacsecMkaCakFlags :: (IsSettingMacsec o, MonadIO m) => [SettingSecretFlags] -> m (GValueConstruct o)

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

getSettingMacsecMkaCakFlags :: (MonadIO m, IsSettingMacsec o) => o -> m [SettingSecretFlags]

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

get settingMacsec #mkaCakFlags

setSettingMacsecMkaCakFlags :: (MonadIO m, IsSettingMacsec o) => o -> [SettingSecretFlags] -> m ()

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

set settingMacsec [ #mkaCakFlags := value ]

mkaCkn

The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.

Since: 1.6

clearSettingMacsecMkaCkn :: (MonadIO m, IsSettingMacsec o) => o -> m ()

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

clear #mkaCkn

constructSettingMacsecMkaCkn :: (IsSettingMacsec o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingMacsecMkaCkn :: (MonadIO m, IsSettingMacsec o) => o -> m Text

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

get settingMacsec #mkaCkn

setSettingMacsecMkaCkn :: (MonadIO m, IsSettingMacsec o) => o -> Text -> m ()

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

set settingMacsec [ #mkaCkn := value ]

mode

Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.

Since: 1.6

constructSettingMacsecMode :: (IsSettingMacsec o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingMacsecMode :: (MonadIO m, IsSettingMacsec o) => o -> m Int32

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

get settingMacsec #mode

setSettingMacsecMode :: (MonadIO m, IsSettingMacsec o) => o -> Int32 -> m ()

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

set settingMacsec [ #mode := value ]

offload

Specifies the MACsec offload mode.

SettingMacsecOffloadOff disables MACsec offload.

SettingMacsecOffloadPhy and SettingMacsecOffloadMac request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail.

SettingMacsecOffloadDefault uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is SettingMacsecOffloadOff.

Since: 1.46

constructSettingMacsecOffload :: (IsSettingMacsec o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingMacsecOffload :: (MonadIO m, IsSettingMacsec o) => o -> m Int32

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

get settingMacsec #offload

setSettingMacsecOffload :: (MonadIO m, IsSettingMacsec o) => o -> Int32 -> m ()

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

set settingMacsec [ #offload := value ]

parent

If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an SettingWired setting with a SettingWired:macAddress property.

Since: 1.6

clearSettingMacsecParent :: (MonadIO m, IsSettingMacsec o) => o -> m ()

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

clear #parent

constructSettingMacsecParent :: (IsSettingMacsec 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.

getSettingMacsecParent :: (MonadIO m, IsSettingMacsec o) => o -> m Text

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

get settingMacsec #parent

setSettingMacsecParent :: (MonadIO m, IsSettingMacsec o) => o -> Text -> m ()

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

set settingMacsec [ #parent := value ]

port

The port component of the SCI (Secure Channel Identifier), between 1 and 65534.

Since: 1.6

constructSettingMacsecPort :: (IsSettingMacsec o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingMacsecPort :: (MonadIO m, IsSettingMacsec o) => o -> m Int32

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

get settingMacsec #port

setSettingMacsecPort :: (MonadIO m, IsSettingMacsec o) => o -> Int32 -> m ()

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

set settingMacsec [ #port := value ]

sendSci

Specifies whether the SCI (Secure Channel Identifier) is included in every packet.

Since: 1.12

constructSettingMacsecSendSci :: (IsSettingMacsec o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingMacsecSendSci :: (MonadIO m, IsSettingMacsec o) => o -> m Bool

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

get settingMacsec #sendSci

setSettingMacsecSendSci :: (MonadIO m, IsSettingMacsec o) => o -> Bool -> m ()

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

set settingMacsec [ #sendSci := value ]

validation

Specifies the validation mode for incoming frames.

Since: 1.6

constructSettingMacsecValidation :: (IsSettingMacsec o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingMacsecValidation :: (MonadIO m, IsSettingMacsec o) => o -> m Int32

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

get settingMacsec #validation

setSettingMacsecValidation :: (MonadIO m, IsSettingMacsec o) => o -> Int32 -> m ()

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

set settingMacsec [ #validation := value ]