Aal5If Object


Description:

ATM AAL5 interface object.

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

Affiliated group interface.

ApplicableOnPhy
(ApplicableOnPhy)

AtmPhy

Specifies physical layer compatibility

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

Link source.

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

Otv top level private interface.

PrimaryIfSource
(PrimaryIf)

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

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

RelayBlockConfig
(RelayIf)

Dhcpv4BlockConfig, Dhcpv4BlockConfig

Config to relay agent interface.


(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

Config to Udp source custom interface.

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

Aal5If Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Clp

Cell loss priority.

Type: u8

Default: 0

Range: 0 - 1

Cpi

Common part indicator.

Type: u8

Default: 0

Gfc

Generic flow control.

Type: u8

Default: 0

Range: 0 - 15

IfCountPerLowerIf

Number of interfaces in this interface object.

Type: u32

Default: 1

IfRecycleCount

Number of times to increment the VPI before returning to the starting value. See IsRange for more information.

Type: u32

Default: 0

IsLoopbackIf

Whether this is a loopback interface.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

This is a loopback interface.

FALSE

This is not a loopback interface.

IsRange

Method to use for creating VCIs and VPIs. You can generate a range or specify a list (VciList and VpiList).

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Generate a range of VCIs and VPIs using a combination of attributes as follows:

VCIs: Vci, VciRepeatCount, VciStep, VciStepMask, VciRecycleCount.

VPIs: Vpi, VpiRepeatCount, VpiStep, VpiStepMask, IfRecycleCount.

FALSE

Use VciList and VpiList to specify VCIs and VPIs.

PtiCell

Payload type identifier (user data cell/management cell).

Type: u8

Default: 0

Range: 0 - 1

PtiCongestion

Payload type identifier (explicit forward congestion indication).

Type: u8

Default: 0

Range: 0 - 1

Uu

User-to-user indication.

Type: u8

Default: 0

VcEncapsulation

VC encapsulation to use.

Type: enum

Default: VC_MULTIPLEXED

Possible Values:

Value Description
VC_MULTIPLEXED

VC multiplexed.

LLC_ENCAPSULATED

LLC encapsulated.

Vci

Virtual channel indicator. You can generate more than one VCI by using combinations of Vci, VciRepeatCount, VciStep, VciStepMask, and VciRecycleCount. If you do that, then Vci is the starting point.

To use this attribute, the IsRange attribute must be TRUE (the default).

Type: u16

Default: 32

Range: 0 - 65535

VciList

A list of virtual channel indicators. To use this attribute, IsRange must be FALSE.

Type: u16

Default: 0

VciRecycleCount

Number of times to increment the VCI before returning to the starting value. See IsRange for more information.

Type: u32

Default: 0

VciRepeatCount

How many times to repeat the virtual channel indicator (VCI) before incrementing it. See IsRange for more information.

Type: u32

Default: 0

VciStep

Step value for generated VCIs. See IsRange for more information.

Type: s16

Default: 1

VciStepMask

VCI step mask. Indicates which parts of the VCI will change when incremented. See IsRange for more information.

Type: u16

Default: 65535

Vpi

Virtual path indicator. You can generate more than one VPI by using combinations of Vpi, VpiRepeatCount, VpiStep, VpiStepMask, and IfRecycleCount. If you do that, then Vpi is the starting point.

To use this attribute, the IsRange attribute must be TRUE (the default).

Type: u16

Default: 0

Range: 0 - 4095

VpiList

A list of virtual path indicators. To use this attribute, IsRange must be FALSE.

Type: u16

Default: 0

VpiRepeatCount

How many times to repeat the virtual path indicator (VPI) before incrementing it. See IsRange for more information.

Type: u32

Default: 0

VpiStep

Step value for generated VPIs. See IsRange for more information.

Type: s16

Default: 1

VpiStepMask

VPI step mask. Indicates which parts of the VPI will change when incremented. See IsRange for more information.

Type: u16

Default: 255

Aal5If Read-Only Attributes

Read-Only Attribute Description
EffectiveBlockCount

Effective block count.

Type: u32

Default: 1

IfState

Interface state.

Type: enum

Default: DISABLED

Possible Values:

Value Description
READY

Ready.

DISABLED

Not ready.

DELETING

Marked for delete.

PARTIALLY_READY

Partially ready.