NM.SettingMacsec¶

Subclasses:: None

Methods¶

Inherited:: NM.Setting (21), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get_encrypt` ()
	`get_mka_cak` ()
	`get_mka_cak_flags` ()
	`get_mka_ckn` ()
	`get_mode` ()
	`get_offload` ()
	`get_parent` ()
	`get_port` ()
	`get_send_sci` ()
	`get_validation` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: NM.Setting (1)

Name	Type	Flags
`encrypt`	`bool`	r/w/en
`mka-cak`	`str`	r/w/en
`mka-cak-flags`	`NM.SettingSecretFlags`	r/w/en
`mka-ckn`	`str`	r/w/en
`mode`	`int`	r/w/en
`offload`	`int`	r/w/en
`parent`	`str`	r/w/en
`port`	`int`	r/w/en
`send-sci`	`bool`	r/w/en
`validation`	`int`	r/w/en

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class NM.SettingMacsec(**kwargs)¶

Bases:: NM.Setting
Abstract:: No
Structure:: NM.SettingMacsecClass

MACSec Settings

classmethod new()¶

Returns:: the new empty NM.SettingMacsec object
Return type:: NM.Setting

Creates a new NM.SettingMacsec object with default values.

Added in version 1.6.

get_encrypt()¶

Returns:: the NM.SettingMacsec :encrypt property of the setting
Return type:: bool

Added in version 1.6.

get_mka_cak()¶

Returns:: the NM.SettingMacsec :mka-cak property of the setting
Return type:: str

Added in version 1.6.

get_mka_cak_flags()¶

Returns:: the NM.SettingSecretFlags pertaining to the NM.SettingMacsec :mka-cak
Return type:: NM.SettingSecretFlags

Added in version 1.6.

get_mka_ckn()¶

Returns:: the NM.SettingMacsec :mka-ckn property of the setting
Return type:: str

Added in version 1.6.

get_mode()¶

Returns:: the NM.SettingMacsec :mode property of the setting
Return type:: NM.SettingMacsecMode

Added in version 1.6.

get_offload()¶

Returns:: the NM.SettingMacsec :offload property of the setting
Return type:: NM.SettingMacsecOffload

Added in version 1.46.

get_parent()¶

Returns:: the NM.SettingMacsec :parent property of the setting
Return type:: str

Added in version 1.6.

get_port()¶

Returns:: the NM.SettingMacsec :port property of the setting
Return type:: int

Added in version 1.6.

get_send_sci()¶

Returns:: the NM.SettingMacsec :send-sci property of the setting
Return type:: bool

Added in version 1.12.

get_validation()¶

Returns:: the NM.SettingMacsec :validation property of the setting
Return type:: NM.SettingMacsecValidation

Added in version 1.6.

Property Details¶

NM.SettingMacsec.props.encrypt¶

Name:: encrypt
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the transmitted traffic must be encrypted.

Added in version 1.6.

NM.SettingMacsec.props.mka_cak¶

Name:: mka-cak
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Added in version 1.6.

NM.SettingMacsec.props.mka_cak_flags¶

Name:: mka-cak-flags
Type:: NM.SettingSecretFlags
Default Value:: NM.SettingSecretFlags.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Flags indicating how to handle the NM.SettingMacsec :mka-cak property.

Added in version 1.6.

NM.SettingMacsec.props.mka_ckn¶

Name:: mka-ckn
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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.

Added in version 1.6.

NM.SettingMacsec.props.mode¶

Name:: mode
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Added in version 1.6.

NM.SettingMacsec.props.offload¶

Name:: offload
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the MACsec offload mode.

NM.SettingMacsecOffload.OFF disables MACsec offload.

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

NM.SettingMacsecOffload.DEFAULT uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is NM.SettingMacsecOffload.OFF.

Added in version 1.46.

NM.SettingMacsec.props.parent¶

Name:: parent
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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 NM.SettingWired setting with a NM.SettingWired :mac-address property.

Added in version 1.6.

NM.SettingMacsec.props.port¶

Name:: port
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Added in version 1.6.

NM.SettingMacsec.props.send_sci¶

Name:: send-sci
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Added in version 1.12.

NM.SettingMacsec.props.validation¶

Name:: validation
Type:: int
Default Value:: 2
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the validation mode for incoming frames.

Added in version 1.6.