MacsecSupplicantBlockConfig Object


Description:

MACsec Supplicant Block Config

Parents: EmulatedDevice

Children: MacsecPskConfig

Relations:

Side name
(Type)
Relative Description
ClientLoadProfile
(AffiliatedClientLoadProfile)

ClientLoadProfile

Relation to specify association with client load profile.

AffiliatedProtocolProfile
(AffiliatedProtocolProfile)

OpenflowProtocolProfile, OtvProtocolProfile

Relation to specify association with protocol profile.

ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

Result of the MPLS control plane binding.

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

Primary convergence config.

ProtocolConnectionDestination
(ProtocolConnectionDestination)

AutosarTimeSyncConfig, CoapServerConfig, EcpriProtocolConfig, Ieee80211AccessPointConfig, Ieee80211ClientConfig, MacsecSupplicantBlockConfig, OamFlexeClientConfig, OpenflowControllerProtocolConfig, OpflexDeviceConfig, OseSwitchConfig, OtvEdgeDeviceConfig, OtvSiteDeviceConfig, OvsdbServerConfig, TrillRbridgeConfig, VdpStationConfig, VsiBlockConfig, VxlanVtepConfig

Connection destination association.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

Source protocol.

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

MacsecSupplicantBlockConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AssociationNumber

Association Number.

Type: u8

Default: 0

Range: 0 - 3

AssociationNumberStep

Association Number step.

Type: u8

Default: 1

Range: 0 - 3

CipherSuite

Cipher suite.

Type: enum

Default: GCMAES128

Possible Values:

Value Description
GCMAES128

Cipher Suite GCM-AES-128.

GCMAES256

Cipher Suite GCM-AES-256.

DynamicLoad

Dynamic load.

Type: s32

Default: 30

Range: 1 - 1000000

EnableSci

Include SCI in MACsec Tag.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include SCI in MACsec Tag.

FALSE

Exclude SCI in MACsec Tag.

EnableXpn

Enable XPN.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables extended packet number.

FALSE

Disable extended packet number.

EncryptionOffset

Encryption offset.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

Encrypt all.

VLAN

Keep VLAN header unencrypted.

IPV4

Keep IPv4 header unencrypted.

IPV6

Keep IPv6 header unencrypted.

ALL

Keep payload unencrypted.

EndpointConnectionPattern

Endpoint Connection Pattern

Type: enum

Default: PAIR

Possible Values:

Value Description
PAIR

Pairwise connection pattern.

BACKBONE_SRC_FIRST

Backbone source first connection pattern.

BACKBONE_DST_FIRST

Backbone destination first connection pattern.

BACKBONE_INTERLEAVED

Backbone interleaved connection pattern.

MacsecMode

MACsec mode

Type: enum

Default: STATIC_CAK

Possible Values:

Value Description
STATIC_SAK

Static SAK

STATIC_CAK

Static CAK

PeerAssociationNumber

Peer Association Number.

Type: u8

Default: 0

Range: 0 - 3

PeerAssociationNumberStep

Peer Association Number step.

Type: u8

Default: 1

Range: 0 - 3

PeerMac

Peer MAC address.

Type: mac

Default: 00:10:94:00:00:01

PeerMacStep

Peer MAC address step.

Type: mac

Default: 00:00:00:00:00:01

PortId

Port Identifier.

Type: u16

Default: 1

PortIdStep

Port Identifier step.

Type: u16

Default: 1

ReplayProtectionWindow

Replay protection window size.

Type: u16

Default: 0

SessionKey

Session encryption/decryption static key(256-bit) represented in 32-bytes

Type: u8

Default: 1

SessionKeyStep

Session encryption/decryption static key(256-bit) step represented in 32-bytes

Type: u8

Default: 0

StartingPacketNumber

Starting packet number.

Type: u64

Default: 1

Range: 1 - 18446744073709551615

UsePartialBlockState

Use partial block state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use partial block state.

FALSE

Do not use partial block state.

VlanTags

Number of VLAN Headers in clear.

Type: u8

Default: 1

Range: 1 - 2

MacsecSupplicantBlockConfig Read-Only Attributes

Read-Only Attribute Description
AuthState

Authentication State.

Type: enum

Default: UNAUTHORIZED

Possible Values:

Value Description
UNAUTHORIZED

Unauthorized

AUTHENTICATING

Authenticating

REAUTHENTICATING

Reauthenticating

AUTH_SUCCESS

Authenticated

AUTH_FAILED

Authentication Failed

LOGGING_OFF

Logging Off

LoadProfileRunState

Load profile run state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Load profile is running.

FALSE

Load profile is stopped.