MacsecIf Object


Description:

Class for MACsec interface.

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Children: GroupIf, MplsGeneralizedPwBindInfo, MplsIpv4MultiLayerStaticBindInfo, MplsIpv4PrefixBindInfo, MplsIpv4VpnBindInfo, MplsIpv6MultiLayerStaticBindInfo, MplsIpv6PrefixBindInfo, MplsIpv6VpnBindInfo, MplsRsvpTunnelBindInfo, MplsRsvpTunnelSrcDstBindInfo, MplsSrBindInfo, MplsTpStaticLspBindInfo, MplsTpStaticPseudoWireBindInfo, MplsVcBindInfo, MplsVplsBindInfo, Rfc4814EthIIIfDecorator

Relations:

Side name
(Type)
Relative Description
GroupIf
(AffiliatedGroupIf)

GroupIf

DstBoundTo
(DstBinding)

PathDescriptor, StreamBlock, TrafficDescriptor

Specifies destination endpoints bound to StreamBlock.

EncapsulationSource
(Encapsulation)

PathDescriptor

Specifies the encapsulation.

NetworkLink
(LinkSrc)

CustomLink, CustomLink, DualStackLiteLink, DualStackLiteLink, EoamLink, EoamLink, EthernetBridgeLink, EthernetBridgeLink, EvpnCeToPeLink, EvpnCeToPeLink, IpForwardingLink, IpForwardingLink, Ipv6RapidDeploymentLink, Ipv6RapidDeploymentLink, ItagServiceLink, ItagServiceLink, L2GreTunnelLink, L2GreTunnelLink, L2tpv3ForwardingLink, L2tpv3ForwardingLink, MplsForwardingLink, MplsForwardingLink, MplsHierarchicalLink, MplsHierarchicalLink, MplsIpv4VpnCeToPeLink, MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsL2VpnPeToPLink, MplsL2VpnPeToPLink, MplsL3VpnPeToPLink, MplsL3VpnPeToPLink, MVpnGreCeToPeLink, MVpnGreCeToPeLink, MVpnGrePeToPLink, MVpnGrePeToPLink, OtvEdgeDeviceLink, OtvEdgeDeviceLink, StationToScompLink, StationToScompLink, VifToVicLink, VifToVicLink, VlanSwitchLink, VlanSwitchLink, VplsBgpCeToPeLink, VplsBgpCeToPeLink, VplsLdpCeToPeLink, VplsLdpCeToPeLink, VsiToStationLink, VsiToStationLink, VxlanGpeLink, VxlanGpeLink, VxlanVmToVtepLink, VxlanVmToVtepLink

MemberOfVpn
(MemberOfVpn)

EthernetVpnSiteInfo, VpnIdGroup, VpnSiteInfo6Pe, VpnSiteInfoMplsTpStatic, VpnSiteInfoRfc2547, VpnSiteInfoRfc4659, VpnSiteInfoVplsBgp, VpnSiteInfoVplsLdp

Do not use, to be removed

MulticastExpectedRxPorts
(MulticastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as multicast traffic by any of the ports connected through this relation.

OptionallyStackedUnder
(OptionallyStackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies an optionally-selected lower interface in the stack. Selection is controlled by protocol implementations which decide based on other criteria whether they should include the target interface in their stack.

OtvEdgeDeviceConfig
(OtvTopLevelIf)

OtvEdgeDeviceConfig

PrimaryIfSource
(PrimaryIf)

EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Specifies if a top-level interface is facing the DUT.

RelayBlockConfig
(RelayIf)

Dhcpv4BlockConfig, Dhcpv4BlockConfig


(ResolvesInterface)

BgpRouterConfig, IsisRouterConfig, LdpRouterConfig, LispRouterConfig, Ospfv2RouterConfig, Ospfv3RouterConfig, RsvpIngressTunnelParams, RsvpRouterConfig

Use this to link the traffic binding interfaces and traffic binding resolver.

SrcBoundTo
(SrcBinding)

PathDescriptor, StreamBlock, TrafficDescriptor

Specifies the source endpoint bound to StreamBlock.

StackedOn
(StackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies network endpoint stacking.

TopLevelIfSource
(TopLevelIf)

EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Specifies the top-level interface in the interface stack.

L2tpv2UdpConfig
(UdpSrcCustomIf)

L2tpv2BlockConfig

UnicastExpectedRxPorts
(UnicastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as unicast traffic by any of the ports connected through this relation.

UsesIfSource
(UsesIf)

AncpAccessNodeConfig, AppPerfClientConfig, AppPerfServerConfig, AutosarTimeSyncConfig, BfdRouterConfig, BridgePortConfig, CifsClientProtocolConfig, CifsServerProtocolConfig, CoapServerConfig, CuspProtocolConfig, Dhcpv4BlockConfig, Dhcpv4ServerConfig, Dhcpv6BlockConfig, Dhcpv6PdBlockConfig, Dhcpv6ServerConfig, Dot1xSupplicantBlockConfig, DpgClientProtocolConfig, DpgServerProtocolConfig, DualStackLiteConfig, EcpriProtocolConfig, EoamNodeConfig, FcEPortConfig, FcFPortConfig, FcHostConfig, FcoeHostConfig, FcoeVePortConfig, FcoeVfPortConfig, FtpClientProtocolConfig, FtpServerProtocolConfig, HttpClientProtocolConfig, HttpServerProtocolConfig, Ieee1588v2ClockConfig, Ieee80211AccessPointConfig, Ieee80211ClientConfig, Ieee8021asClockConfig, IgmpHostConfig, IgmpRouterConfig, IperfClientProtocolConfig, IperfServerProtocolConfig, Ipv6RapidDeploymentConfig, L2tpv2BlockConfig, L2tpv3BlockConfig, LacpPortConfig, LagBfdPortConfig, LinkOamRouterConfig, LispRouterConfig, LldpNodeConfig, LspPingProtocolConfig, MacsecSupplicantBlockConfig, MldHostConfig, MldRouterConfig, MplsTpConfig, MplsTpOamNodeConfig, MsdpProtocolConfig, NetconfClientConfig, NetconfProtocolConfig, NtpClientConfig, OamFlexeClientConfig, OpenflowControllerProtocolConfig, OpflexDeviceConfig, OseSwitchConfig, Ospfv2RouterConfig, Ospfv3RouterConfig, OtvEdgeDeviceConfig, OtvSiteDeviceConfig, OvsdbServerConfig, PacketChannel, PcepProtocolConfig, PimRouterConfig, PppoaClientBlockConfig, PppoaServerBlockConfig, PppoeClientBlockConfig, PppoeServerBlockConfig, PppoL2tpv2ClientBlockConfig, PppoL2tpv2ServerBlockConfig, PppoL2tpv3ClientBlockConfig, PppoL2tpv3ServerBlockConfig, PppProtocolConfig, RawTcpClientProtocolConfig, RawTcpServerProtocolConfig, RipRouterConfig, RoEBlockConfig, SaaDeviceConfig, SipUaProtocolConfig, SrpConfig, Srv6OamProtocolConfig, StorageWorkerConfig, SyncEthDeviceConfig, TrillRbridgeConfig, TwampClientConfig, TwampServerConfig, VdpStationConfig, VicAdapterConfig, VideoClientProtocolConfig, VideoServerProtocolConfig, VifConfig, VsiBlockConfig, VxlanVtepConfig, XmppvJClientConfig

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

MacsecIf 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.

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.

IfCountPerLowerIf

Type: u32

Default: 1

IfRecycleCount

Type: u32

Default: 0

IsLoopbackIf

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

FALSE

IsRange

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

FALSE

MacsecMode

Macsec mode

Type: enum

Default: STATIC_SAK

Possible Values:

Value Description
STATIC_SAK

Static SAK

STATIC_CAK

Static CAK

DYNAMIC_CAK

Dynamic 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: 0

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

VlanTags

Number of VLAN Headers in clear.

Type: u8

Default: 1

Range: 1 - 2

MacsecIf Read-Only Attributes

Read-Only Attribute Description
EffectiveBlockCount

Type: u32

Default: 1

IfState

Type: enum

Default: DISABLED

Possible Values:

Value Description
READY

DISABLED

DELETING

PARTIALLY_READY