| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| addressFamilyIpV4 |
type=pim.PIMAddressFamily access=read-only default=ipv4Multicast |
| administrativeStateIpV4 |
type=netw.AdministrativeState default=pimUp Displayed(tab/group)=IPv4 Administrative State (Behavior.IPv4/States) |
| assertPeriod |
the period in seconds for periodic refreshes of PIM Assert messages on an interface.
type=long default=60 minimum=1 maximum=300 Displayed(tab/group)=Assert Period (Behavior.General/Interface Properties) |
| autoCreated |
type=generic.TruthValue access=read-only Displayed(tab/group)=Interface Auto Created (Behavior.General/Interface Properties) |
| availableMandatoryBw |
The available bandwidth on the interface for mandatory channels
type=long access=read-only default=0 units=kbps Displayed(tab/group)=Available Bandwidth for Mandatory Channels (Multicast CAC.General/Multicast CAC) |
| availableOptionalBw |
The available bandwidth on the interface for optional channels
type=long access=read-only default=0 units=kbps Displayed(tab/group)=Available Bandwidth for Optional Channels (Multicast CAC.General/Multicast CAC) |
| bfdEnabled |
specifies whether Bi-directional Forwarding Detection is enabled in this
interface. When the value is 'true', this interface can establish BFD sessions
and use BFD as a signalling mechanism. When it is 'false', it cannot
use BFD.
type=boolean default=false Displayed(tab/group)=BFD Enabled (/States) |
| bierSignalingType |
Specifies the option to
to join a P2MP BIER Tunnel towards the multicast source. When the value
of this object is set to other than 'none', then a PIM multicast join
received on an interface is processed to join P2MP BIER Tunnel using
in-band signaling of the PIM joins over the BIER core for the same multicast flow.
P2MP BIER Tunnel is setup towards the multicast source.
When the value is set to 'ipv4' or 'ipv6', it enables BIER in-band
signaling for IPv4 or IPv6 PIM joins respectively. When both 'ipv4'
and 'ipv6' are set then it enables BIER in-band signaling for IPv4 and
IPv6 PIM joins. When it is 'none', the BIER tunnel is disjoined from
the multicast source.
type=pim.BierSignalingType Displayed(tab/group)=BIER Signaling (/States) |
| bsmCheckRouterAlert |
type=generic.TruthValue default=false Displayed(tab/group)=BSM Check Router Alert (Behavior.General/Interface Properties) |
| bwValuesInTransit |
Indicates that the operational (available and in-use mandatory/optional) value for the
following objects are in transition due to configuration change:
inUseMandatoryBw
inUseOptionalBw
availableMandatoryBw
availableOptionalBw
When Multicast CAC Policy is applied on the interface for the join
of the next channel, the operational values will be recalculated and
applied to the above objects and the value for bwValuesInTransit
will be set to 'false'.
If the value of bwValuesInTransit is 'true' then the values are in transition.
type=boolean access=read-only default=false Displayed(tab/group)=Bandwidth Values in Transit (Multicast CAC.General/Multicast CAC) |
| creationOrigin |
type=svt.L2RouteOriginType access=read-create default=manual |
| currentGroups |
The value of currentGroups indicates the number of groups
that currently have this interface as an outgoing interface.
type=long access=read-only Displayed(tab/group)=Current Groups (Behavior.IPv4/Interface Properties) |
| drIPAddress |
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=DR IP Address (Behavior.IPv4/Designated Router) |
| drIPAddressType |
type=rtr.InetAddressType access=read-only default=ipv4 |
| drPriority |
type=long default=1 minimum=1 maximum=4294967295 Displayed(tab/group)=DR Priority (Behavior.General/Designated Router) |
| graftRetryInterval |
type=int default=3 minimum=0 maximum=65535 units=seconds Displayed(tab/group)=Graft Retry Interval (Behavior.General/Interface Properties) |
| helloHoldTime |
type=int default=105 minimum=0 maximum=65535 units=seconds Displayed(tab/group)=Hello Hold Time (Behavior.General/Interface Properties) |
| helloInterval |
type=int default=30 minimum=0 maximum=255 units=seconds Displayed(tab/group)=Hello Interval (Behavior.General/Interface Properties) |
| helloMultiplier |
type=long default=35 minimum=20 maximum=100 Displayed(tab/group)=Hello Multiplier (Behavior.General/Interface Properties) |
| igpLinkPointer |
type=Pointer default= Displayed(tab/group)=Igp Link (/IGP Link) |
| improvedAssert |
type=generic.TruthValue default=true Displayed(tab/group)=Improved assert (Behavior.General/Interface Properties) |
| inUseMandatoryBw |
The bandwidth already taken on the interface by mandatory channels
type=long access=read-only default=0 units=kbps Displayed(tab/group)=In Use Bandwidth by Mandatory Channels (Multicast CAC.General/Multicast CAC) |
| inUseOptionalBw |
The bandwidth already taken on the interface by optional channels
type=long access=read-only default=0 units=kbps Displayed(tab/group)=In Use Bandwidth by Optional Channels (Multicast CAC.General/Multicast CAC) |
| instantPruneEcho |
type=generic.TruthValue default=false Displayed(tab/group)=Instant Prune Echo Enabled (Behavior.General/Interface Properties) |
| ipv6BfdEnabled |
specifies whether Bi-directional Forwarding Detection is enabled in this
interface for ipv6. When the value is 'true', this interface can establish ipv6 BFD sessions
and use BFD as a signalling mechanism. When it is 'false', it cannot
use BFD.
type=boolean default=false Displayed(tab/group)=IPv6 BFD Enabled (/States) |
| isMdtInterface |
This property is used internally by NFM-P. Do not set
via OSSI interface.
type=generic.TruthValue default=false |
| joinPruneHoldTime |
type=int default=210 minimum=0 maximum=65535 units=seconds Displayed(tab/group)=Join/Prune Hold Time (Behavior.General/Interface Properties) |
| joinPruneInterval |
type=int default=60 minimum=0 maximum=18000 units=seconds Displayed(tab/group)=Join/Prune Interval (Behavior.General/Interface Properties) |
| mCacConstAdminState |
The administrative state of the multicast CAC policy's constraints.
type=netw.AdministrativeState default=pimUp Displayed(tab/group)=Constraint Administration State (Multicast CAC.General/Multicast CAC) |
| mCastCacIntfPolicyPointer |
Pointer to the instance of the multicast cac interface policy object.
type=Pointer default= Displayed(tab/group)=Multicast CAC Interface Policy (Multicast CAC.General/Multicast CAC) |
| mCastCacPolicyName |
The name of the multicast CAC policy.
type=string access=read-only default= minimum=0 maximum=32 |
| mCastCacPolicyPointer |
Pointer to the instance of the multicast cac policy object.
type=Pointer default= Displayed(tab/group)=Multicast CAC Policy (Multicast CAC.General/Multicast CAC) |
| maxGroups |
The value of maxGroups specifies the maximum number of groups
for which PIM can have downstream state based on received PIM Joins on
this interface
type=long default=0 minimum=0 maximum=16000 Displayed(tab/group)=Max Groups (Behavior.General/Interface Properties) |
| maxGroupsTillNow |
The value of maxGroupsTillNow indicates the highest value
that currentGroups had till now
type=long access=read-only Displayed(tab/group)=Max Groups Till Now (Behavior.IPv4/Interface Properties) |
| mdtGroupIPAddress |
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=MDT Default Group Address (Behavior.IPv4/Multicast Distribution Configurations), IPMSI Group Address (Behavior.IPv4/IPMSI Group Address) |
| mdtGroupIPAddressType |
type=rtr.InetAddressType access=read-only default=ipv4 |
| monitorOperGroupName |
Specifies the operational group whose state PIM will monitor.
type=string default= |
| multiCastSenders |
type=int default=auto Displayed(tab/group)=Multicast Senders (Behavior.General/Interface Properties) enums= 0: auto - Auto 1: always - Always 2: never - Never |
| nextHelloTime |
type=long access=read-only units=seconds Displayed(tab/group)=Next Hello Time (Behavior.IPv4/Interface Properties) |
| operDRPriority |
type=long access=read-only minimum=0 maximum=4294967295 Displayed(tab/group)=Operational DR Priority (Behavior.IPv4/Designated Router) |
| operGroupDPAction |
Specifies the action that needs to be performed on DR priority if the status of the operational
group changes to up. When the value is set to 'add', it specifies that the operGroupDeltaPriority needs to be
added to DR priority. If it is set to 'subtract', it specifies that the operGroupDeltaPriority needs to be subtracted
from DR priority. If it is set to 'set', it specifies that DR priority needs to be set to operGroupDeltaPriority.
type=pim.ActionType default=none Displayed(tab/group)=Delta Priority Action (Behavior.IPv4/Operational Group) |
| operGroupDeltaPriority |
Specifies the value by which the DR priority needs to change when the status of the
operational group specified by monitorOperGroupName changes to up.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Operational Group Delta Priority (Behavior.IPv4/Operational Group) |
| operationalStateIpV4 |
type=netw.OperationalState access=read-only default=pimUp Displayed(tab/group)=IPv4 Operational State (Behavior.IPv4/States) |
| overrideInterval |
type=int default=2500 minimum=0 maximum=65535 units=milliseconds Displayed(tab/group)=Override Interval (Behavior.General/Interface Properties) |
| p2mpLdpTreeJoinEnabled |
Specifies whether to join a P2MP LDP tree towards a multicast source.
When the value is 'true', a multicast join received on an interface is
processed to join a PIM multicast tree and also copied over to LDP to
join the in-band signaled P2MP tree for the same multicast flow. LDP
P2MP tree is setup either to RP (ASM group) or source (SSM group). The
route to the RP or the source of the multicast node is looked up from
the RTM. The next-hop address for the route to RP or source is set as
the root of LDP P2MP tree. When it is 'false', the P2MP LDP tree is
disjoined from the multicast source."
When the value is set it enables dynamic mLDP in-band signaling for IPv4
When both 'ipv4' and 'ipv6' are set then it enables dynamic mLDP in-band signaling
for IPv4 and IPv6 PIM joins. When it is 'none', the P2MP LDP tree is disjoined from
the multicast source.
type=boolean default=false Displayed(tab/group)=IPv4 (Behavior.General/P2MP to LDP Tree Join) |
| p2mpLdpTreeJoinIPv6Enabled |
Specifies whether to join a P2MP LDP tree towards a multicast source.
When the value is 'true', a multicast join received on an interface is
processed to join a PIM multicast tree and also copied over to LDP to
join the in-band signaled P2MP tree for the same multicast flow. LDP
P2MP tree is setup either to RP (ASM group) or source (SSM group). The
route to the RP or the source of the multicast node is looked up from
the RTM. The next-hop address for the route to RP or source is set as
the root of LDP P2MP tree. When it is 'false', the P2MP LDP tree is
disjoined from the multicast source."
When the value is set it enables dynamic mLDP in-band signaling for IPv6.
When both 'ipv4' and 'ipv6' are set then it enables dynamic mLDP in-band signaling
for IPv4 and IPv6 PIM joins. When it is 'none', the P2MP LDP tree is disjoined from
the multicast source.
type=boolean default=false Displayed(tab/group)=IPv6 (Behavior.General/P2MP to LDP Tree Join) |
| pim.InclusiveBierPmsiInterface-Set |
type=Children-Set |
| pim.InclusiveLdpPmsiInterface-Set |
type=Children-Set |
| pim.InclusiveRsvpPmsiInterface-Set |
type=Children-Set |
| pim.InclusiveSegmentRoutingPmsiInterface-Set |
type=Children-Set |
| pim.InterfaceExtension-Set |
type=Children-Set |
| pim.McastCacLagPortDown-Set |
type=Children-Set |
| pim.McastCacLevel-Set |
type=Children-Set |
| pim.MulticastToMulticast-Set |
type=Children-Set |
| pim.Neighbor-Set |
type=Children-Set |
| pim.UnicastToMulticast-Set |
type=Children-Set |
| pimDomainPointer |
Points to PIM Domain.
type=Pointer access=read-only default= |
| pimInterfaceType |
type=pim.PimInterfaceType access=read-only default=network |
| preRsvdMandatoryBandwidth |
The value of preRsvdMandatoryBandwidth specifies the bandwidth
pre-reserved for all the mandatory channels on a given interface
in kilo-bits per second(kbps).
If the value of unconstrainedBandwidth is '0', no mandatory
channels are allowed. If the value of unconstrainedBandwidth
is '-1', then all mandatory and optional channels are allowed.
If the value of preRsvdMandatoryBandwidth is equal to the value of
unconstrainedBandwidth, then all the unconstrained bandwidth
on a given interface is allocated to mandatory channels configured
through multicast cac policy on that interface and no optional
groups (channels) are allowed.
The default value of '-1' can be set only by setting
unconstrainedBandwidth object to '-1'. An attempt to set
the value of preRsvdMandatoryBandwidth to '-1' will result
in inconsistent value error.
The value of preRsvdMandatoryBandwidth will be set to the same as
unconstrainedBandwidth if the latter is set to either '-1'
or '0'.
The value of preRsvdMandatoryBandwidth should always be less than
or equal to that of unconstrainedBandwidth. An attempt to set
the value of preRsvdMandatoryBandwidth greater than that of
unconstrainedBandwidth will result in inconsistent value error.
type=int default=-1 minimum=-1 maximum=2147483647 units=kbps Displayed(tab/group)=Mandatory Bandwidth (Multicast CAC.General/Multicast CAC) |
| pruneDelay |
type=int default=500 minimum=0 maximum=32767 units=milliseconds Displayed(tab/group)=Propagation Delay (Behavior.General/Interface Properties) |
| pruneLimitInterval |
type=int default=60 minimum=0 maximum=65535 units=seconds Displayed(tab/group)=Prune Limit Interval (Behavior.General/Interface Properties) |
| service.OperGrpBindingMonitor-Set |
type=Children-Set |
| stickyDR |
type=generic.TruthValue default=false Displayed(tab/group)=Sticky DR (Behavior.General/Designated Router) |
| stickyDRPriority |
type=long default=1024 minimum=1 maximum=4294967295 Displayed(tab/group)=Sticky DR Priority (Behavior.General/Sticky DR Priority) |
| stub |
type=generic.TruthValue default=false Displayed(tab/group)=Stub (Behavior.General/Interface Properties) |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| threeWayHello |
type=pim.ThreeWayHelloType default=disabled Displayed(tab/group)=Three Way Hello (Behavior.General/Interface Properties) |
| trackingSupport |
type=generic.TruthValue default=false Displayed(tab/group)=Tracking Support (Behavior.General/Interface Properties) |
| trackingSupportOperState |
Specifies the operational status of PIM tracking support.
The value is set to 'true'/'inService' when all PIM routers on a LAN support join or prune tracking.
type=pim.TrackingSupportOperState access=read-only Displayed(tab/group)=Tracking Support Operational State (Behavior.IPv4/Interface Properties) |
| triggeredHello |
type=int default=5 minimum=0 maximum=60 units=seconds Displayed(tab/group)=Triggered Hello Interval (Behavior.General/Interface Properties) |
| tunnelInterfacePtr |
type=string default=null |
| unconstrainedBandwidth |
The bandwidth assigned for interface's multicast cac policy traffic
in kilo-bits per second(kbps). If the default value of '-1' is set,
then the value will be set to the physical bandwidth available for
the interface.
type=int default=-1 minimum=-1 maximum=2147483647 units=kbps Displayed(tab/group)=Unconstrained Bandwidth (Multicast CAC.General/Multicast CAC) |
| useLagPortWeight |
The value of useLagPortWeight specifies if this system must use the LAG port weight while calculating Multicast CAC constraints.
type=boolean default=false Displayed(tab/group)=Use Lag Port Weight (Behavior.General/Interface Properties) |
| Overridden Properties | |
|---|---|
| administrativeState |
default=pimUp |
| application |
default=pim |
| operationalState |
default=pimUp |
| Properties inherited from netw.RouterTerminatingNonIpInterface |
|---|
| additionalForNamingInterfaceName, interfaceId |
| Properties inherited from netw.RouterTerminatingInterface |
|---|
| interfaceClass, serviceId, serviceType, subscriberId |
| Properties inherited from netw.StatefullConnectableInterface |
|---|
| administrativeState, compositeState, encapType, operationalState, resourceState, underlyingResourceState |
| Properties inherited from netw.LogicalInterface |
|---|
| application, description, displayedName, domain, nodeId, nodeName |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
filter
: FilterHolder -
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
infoList
: List (generic.CommonManagedEntityInformation) -