igmp
Interface

Interface represents an interface on this router that participates in the IGMP protocol.



public class Interface

Stats:
igmp.InterfaceGNEStats igmp.InterfaceStats igmp.InterfaceStatsExtension

Properties
adminVersion

type=igmp.IgmpVersion
default=version_three
Displayed(tab/group)=Administrative Version (/States)

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)

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)

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)

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

disRtrAlertChk It is used to enable/disable router alert checking for IGMP messages received on this interface. If this flag is set to 'true', checking is disabled.

type=boolean
default=false
Displayed(tab/group)=Disable Router Alert Check (Behavior)

groupCount

type=long
access=read-only
default=1
Displayed(tab/group)=Group Count (Behavior)

igmp.IfGroup-Set type=Children-Set
igmp.IfSSMTranslate-Set type=Children-Set
igmp.McastCacLagPortDown-Set type=Children-Set
igmp.McastCacLevel-Set type=Children-Set
igmp.StaticGrpRangeSrc-Set type=Children-Set
igmp.StaticGrpSrc-Set type=Children-Set
importPolicy

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Import Policy (Behavior)

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)

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)

lastMembQueryIntvl Specifies the Max Response Time inserted into Group-Specific Queries sent in response to Leave Group messages, and is also the amount of time between Group-Specific Query messages.

type=int
default=0
minimum=0
maximum=1023
units=seconds
Displayed(tab/group)=Last Member Query Interval (Behavior)

mCacConstAdminState The administrative state of the multicast CAC policy's constraints.

type=netw.AdministrativeState
default=tmnxInService
Displayed(tab/group)=Constraint Administration State (Multicast CAC.General)

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)

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)

maxGroups

type=long
default=0
minimum=0
maximum=16000
Displayed(tab/group)=Maximum Number of Groups (Behavior)

maxGroupsTillNow

type=long
access=read-only
default=0
Displayed(tab/group)=Maximum Number of Groups Until Now (Behavior)

maxGrpSources Specifies the maximum number of group sources for which IGMP can have local receiver information based on received IGMP reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed. When this object has a value of 0, there is no limit to the number of group sources.

type=long
default=0
minimum=0
maximum=32000
Displayed(tab/group)=Maximum Number of Group Sources (Behavior)

maxSources Specifies the maximum number of sources for which IGMP can have local receiver information based on received IGMP reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of sources, the sources that are already accepted are not deleted. Only new sources will not be allowed. When this object has a value of 0, there is no limit to the number of sources."

type=long
default=0
minimum=0
maximum=1000
Displayed(tab/group)=Maximum Number of Sources (Behavior)

nextGenQueryTime

type=Time
access=read-only
Displayed(tab/group)=Next Query Time (Behavior/Querier Parameters)

operVersion

type=igmp.IgmpVersion
access=read-only
default=version_three
Displayed(tab/group)=Operational Version (/States)

pimDomainPointer Points to PIM Domain.

type=Pointer
access=read-only
default=

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)

querier

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Querier (Behavior/Querier Parameters)

querierExpiryTime

type=Time
access=read-only
Displayed(tab/group)=Querier Expiry Time (Behavior/Querier Parameters)

querierUpTime

type=Time
access=read-only
Displayed(tab/group)=Querier Up Time (Behavior/Querier Parameters)

queryInterval Specifies the frequency at which the IGMP Host-Query packets are transmitted on this interface.

type=int
default=0
minimum=0
maximum=1024
units=seconds
Displayed(tab/group)=Query Interval (Behavior)

queryResponseIntvl Specifies maximum query response time advertised in Igmpv2 queries on this interface

type=int
default=0
minimum=0
maximum=1023
units=seconds
Displayed(tab/group)=Query Response Interval (Behavior)

redundantMcast Specifies if this system includes state information about this interface with the Multi-Chassis-Redundancy Synchronization (MCS) peer associated with its port, for the purpose of forwarding Multicast traffic.

type=generic.TruthValue
default=false
Displayed(tab/group)=Redundant Multicast (Behavior)

redundantMcastFwding Indicates if this interface is the forwarding interface of a pair of redundant multicast interfaces. The value of this object is only relevant while the value of redundantMcast is equal to 'true'.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Redundant Multicast Forwarding (Behavior)

subnetCheck

type=generic.TruthValue
default=true
Displayed(tab/group)=Subnet Check (Behavior)

templateVersionPointer Pointer to the template if this object was created from a template.

type=Pointer
default=
Displayed(tab/group)=Associated Template (Template/Associated Template)

unconstrainedBandwidth The bandwidth assigned for interface's multicast cac policy traffic in kilo-bits per second(kbps). If the default value of '0' 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)

useLagPortWeight useLagPortWeight is used to enable/disable router alert checking for IGMP messages received on this interface. If this flag is set to 'true', checking is disabled.

type=boolean
default=false
Displayed(tab/group)=Use Lag Port Weight (Behavior)

 
Overridden Properties
administrativeState

default=tmnxInService

application

default=igmp

displayedName

default=IGMP Interface

operationalState

default=tmnxOutOfService

 
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.ConnectableInterface
actualMtu, ctpPointer, encapType, isExclusiveTermination, mtuMismatch, portId, portName, provisionedMtu, routerId, routerName, terminatedObjectId, terminatedObjectName, terminatedObjectPointer, terminatedPortClassName, terminatedPortCombinedEncapValue, terminatedPortInnerEncapValue, terminatedPortOuterEncapValue, terminatedPortPointer, terminationParticipationType
 
Properties inherited from netw.LogicalInterface
application, description, displayedName, domain, nodeId, nodeName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

find

DEPRECATED - 8.0.R1
Use root find instead.
Input Parameters:
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
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -
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
Generic NE 1.0.0
7950 XRS
7705 SAR Supported from 6.0.R1
7705 SAR H Supported from 6.1.R1
7210 SAS M Supported from 7.0.R1
7210 SAS R Supported from 7.0.R1
7210 SAS T Supported from 8.0.R1
7210 SAS Mxp
7210 SAS S/Sx Supported from 9.0.R1
7210 SAS X Supported from 7.0.R1
7250 IXR
7210 SAS K Supported from 10.0.R5
  • Required Capabilities: NetworkMode
Product Specifics
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx (all versions)
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T (all versions)
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7705 SAR Gen 2 (all versions)
7705 SAR Gen 2 25.0
7705 SAR H (all versions)
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR (all versions)
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0