bier
BierPingDefinition

Test definition. Bier Ping performs a Bit Index Explicit Replication (BIER) multicast connectivity test.



public class BierPingDefinition

Properties
bfrId The value of bfrId specifies the start of a contiguous range of Bit-Forwarding Router (BFR) identifiers to be ping. Each bfrId in the range must be a member of the tested sub-domain (as configured using bierSubDomain). Otherwise, the test will fail. Zero indicates no start for the bfrId range has been configured. There are three methods to configure the destination(s) to be ping 1. bfrId. 2. bfrIdStart, bfrIdEnd. 3. bfrPrefixAddrType, bfrPrefixAddress. Exactly one of the methods must be used. Otherwise, the test will fail.

type=int
default=0
minimum=0
maximum=4096

bfrIdEnd The value of bfrIdEnd specifies the start of a contiguous range of Bit-Forwarding Router (BFR) identifiers to be ping. bfrIdStart specifies the start of the range. Each bfrId in the range must be a member of the tested sub-domain (as configured using bierSubDomain). Otherwise, the test will fail. Zero indicates no start for the BFR-ID range has been configured. There are three methods to configure the destination(s) to be pinged 1. bfrId. 2. bfrIdStart, bfrIdEnd. 3. bfrPrefixAddrType, bfrPrefixAddress. Exactly one of the methods must be used. Otherwise, the test will fail.

type=int
default=0
minimum=0
maximum=4096

bfrIdEndPointer Pointer to the instance of BIER Sub Domain object.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=BFR ID End (/BFR ID Range)

bfrIdPointer Pointer to the instance of BIER Sub Domain object.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=BFR-ID (/BFR-ID)

bfrIdStart The value of bfrIdStart specifies the start of a contiguous range of Bit-Forwarding Router (BFR) identifiers to be ping. bfrIdEnd specifies the end of the range. Each bfrId in the range must be a member of the tested sub-domain (as configured using bierSubDomain). Otherwise, the test will fail. Zero indicates no start for the bfrIdrange has been configured. There are three methods to configure the destination(s) to be ping 1. bfrId. 2. bfrIdStart, bfrIdEnd. 3. bfrPrefixAddrType, bfrPrefixAddress. Exactly one of the methods must be used. Otherwise, the test will fail.

type=int
default=0
minimum=0
maximum=4096

bfrIdStartPointer Pointer to the instance of BIER Sub Domain object.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=BFR ID Start (/BFR ID Range)

bier.BierPingBfrPrefixDef-Set type=Children-Set
bierSubDomain The value of tmnxOamBierPingCtlSubDomain specifies the BIER sub-domain to be tested. Zero indicates the default sub-domain.

type=int
default=0
minimum=0
maximum=255
Displayed(tab/group)=Sub-Domain ID (/BFR-ID), Sub-Domain ID (/BFR ID Range), Sub-Domain ID (/BFR Prefix)

bierTestTargetType Specifies the target type of the BIER Ping Test. The target may either be an bfr id, bfr range , or a bfr prefix.

A target of bfrId signifies that the targeted test will run against a specific BFR Id.

A target of bfrRange signifies that the targeted test will run against the specified BFR Range in an BIER Template. The bfrRange parameter is mandatory when type is bfrRange.

A target of router requires the bfrPrefixesto be configured. The targeted test will run on a router and attempt an BIER ping to a destination router(s) specified in the bierPrefixes.

type=bier.BIERPingTargetType
default=bfrId
Displayed(tab/group)=BIER Target Type

forwardingClass Specifies the forwarding class the BIER ping will use.

type=qos.FcEnum
default=be
Displayed(tab/group)=Forwarding Class (Test Parameters/Execution Details)

profile Specifies the profile value to be used with the forwarding class specified in forwardingClass.

type=qos.Profile
default=out
Displayed(tab/group)=Forwarding Profile (Test Parameters/Execution Details)

routerId A number used to identify a virtual router instance in the system

type=int
default=1
minimum=1
maximum=10240

testTargetType

type=sas.TestTarget
access=read-create
default=srIsis
Displayed(tab/group)=Target Type

timeToLive Specifies the MPLS Time To Live (TTL) to be used for the test.

type=int
default=255
minimum=1
maximum=255
Displayed(tab/group)=Time To Live (Test Parameters/Execution Details)

 
Overridden Properties
packetSize The size of the packets to send.

default=141
minimum=92

packetTimeout Specifies the number of seconds to wait for the response of a sent probe.

default=10
maximum=120

 
Properties inherited from sas.PingDefinition
assurance, maxHistoryRows, packetFailureThreshold, packetInterval, packetSize, packetTimeout, packetsToSend, testFailureThreshold, trapGenerationPolicy
 
Properties inherited from sas.TestDefinition
executionOrder, nePersistent, neSchedulable, probeHistory, publishTopic, sas.ThresholdEventDefinition-Set, testDefinitionmodified
 
Properties inherited from sas.AbstractTest
administrativeState, description, displayedName, failures, globalId, id, lastRunResult, runs, weight
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods inherited from sas.AbstractTest
execute, stop