multicastmgr
BSR

BSR represents the BSR information.



public class BSR

Properties
bsrAddress Indicates the address of the elected bootstrap router.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=BSR Address (BootStrap Router/Elected BootStrap Router)

bsrAddressType Indicates the type of address of the elected bootstrap router.

type=rtr.InetAddressType
access=read-create
default=ipv4

bsrCandidateAddress It is used to configure the address of the Candidate Bootstrap Router(CBSR). To participate in the bootstrap election, the router sends bootstrap messages(BSM). These messages carry the BSR address of the router.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=CBSR Address (BootStrap Router/Candidate BootStrap Router)

bsrCandidateAddressType Indicates the address type of the Candidate Bootstrap Router(IPv4, IPV6,...).

type=rtr.InetAddressType
access=read-create
default=ipv4

bsrCandidateAdminState It is used to administratively enable/disable participating in the Bootstrap election. Note that even if the value of the object is set to 'inService', if the vRtrPimGenCBSRAddress is not set or vRtrPimGenCBSRPriority is zero, bootstrap messages will not be sent.

type=netw.AdministrativeState
access=read-only
default=pimDown
Displayed(tab/group)=CBSR Admin State (BootStrap Router/Candidate BootStrap Router)

bsrCandidateHashMaskLength It is used to configure the length of a mask that is to be ANDed with the group address before the hash function is called. All groups with the same hash map to the same RP. For example, if this value is 24, only the first 24 bits of the group addresses matter. This mechanism is used to map one group or multiple groups to a RP.

type=int
default=30
minimum=0
maximum=32
Displayed(tab/group)=CBSR Hash Mask Length (BootStrap Router/Candidate BootStrap Router)

bsrCandidateOperState It indicates the operational status of the Bootstrap mechanism. If the BSR operational state is 'outOfService', it could be because the router interface corresponding to vRtrPimGenCBSRAddress is down or PIM is not enabled on that interface or vRtrPimGenCBSRPriority is zero.

type=netw.OperationalState
access=read-only
default=pimUp
Displayed(tab/group)=CBSR Operational State (BootStrap Router/Candidate BootStrap Router)

bsrCandidatePriority Indicates whether the router is eligible to be a bootstrap router. If the value of this object is set to zero, the router does not participate in the bootstrap election. The highest priority is 255.

type=int
access=read-only
default=0
minimum=0
maximum=255
Displayed(tab/group)=CBSR Priority (BootStrap Router/Candidate BootStrap Router)

bsrExpiryTime If vRtrPimGenBSRState is not 'electedBSR', vRtrPimGenBSRExpiryTime indicates the minimum time remaining before the elected bootstrap router will be declared down. If vRtrPimGenBSRState is 'electedBSR', vRtrPimGenBSRExpiryTime indicates the time remaining before the router sends the next Bootstrap Message(BSM).

type=long
access=read-only
units=seconds
Displayed(tab/group)=BSR Expiry Time (BootStrap Router/Elected BootStrap Router)

bsrHashMaskLength Indicates the hash mask length of the the elected BSR.

type=int
access=read-only
Displayed(tab/group)=BSR Hash Mask Length (BootStrap Router/Elected BootStrap Router)

bsrPriority Indicates the priority of the elected bootstrap router. Higher value means higher priority.

type=int
access=read-only
Displayed(tab/group)=BSR Priority (BootStrap Router/Elected BootStrap Router)

bsrRpfIfIndex It indicates the RPF interface towards the elected BSR. The value of this object will be zero if there is no elected BSR in the network.

type=int
access=read-only
Displayed(tab/group)=BSR RPF Index (BootStrap Router/Elected BootStrap Router)

bsrRpfInterfaceName It indicates the name of RPF interface towards the elected BSR. The value of this object will be zero if there is no elected BSR in the network.

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=BSR RPF Interface (BootStrap Router/Elected BootStrap Router)

bsrState Indicates the state of the router with respect to the bootstrap mechanism. 'candidateBSR', 'pendingBSR' and 'electedBSR' are the states of the router participating in the Bootstrap election. 'acceptAny' and 'acceptPreferred' are the states of the router not participating in the Bootstrap election.

type=pim.BSRState
access=read-only
Displayed(tab/group)=BSR State (BootStrap Router/BootStrap Router)

bsrUpTime Indicates the time since the current E-BSR became the elected BSR.

type=Time
access=read-only
Displayed(tab/group)=BSR Up Time (BootStrap Router/Elected BootStrap Router)

siteId Represents the Pim Site Id.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=PIM Site (BootStrap Router/Candidate BootStrap Router)

siteIdAddrType

type=rtr.InetAddressType
access=read-create
default=ipv4

  
Properties inherited from multicastmgr.MCContainedObject
nwId, serviceId, vRtrId
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 8.0.R1 until 10.0.R1
  • Excluded chassis types: 7450-ESS1, 7450-ESS6, 7450-ESS6V
  • Required Capabilities: MixedMode
Supported from 10.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS