mld
GroupInterfaceSapGroup

The IP multicast groups for which there are members on a particular SAP. Each instance represents a group address for which receivers are interested/not interested in receiving multicast traffic.



public class GroupInterfaceSapGroup

Properties
compatibilityMode This is used in order for routers to be compatible with older version routers. MLDv3 hosts MUST operate in version 1 and version 2 compatibility modes. MLDv3 SAPs MUST keep state per local SAP regarding the compatibility mode of each attached network. A SAPs compatibility mode is determined from the Host Compatibility Mode variable which can be in one of three states: MLDv1, MLDv2 or MLDv3. This variable is kept per interface and is dependent on the version of General Queries heard on that SAP as well as the Older Version Queries Present timers for the SAP.

type=long
access=read-only
Displayed(tab/group)=Compatibility Mode

creationOrigin

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

encapVal The value of the label used to identify this SAP on the access port specified by sapPortId.

type=long
access=read-only
default=0
minimum=0
maximum=4294967295

expiryTime The minimum amount of time remaining before this entry will be aged out. A value of 0 indicates that the entry is only present because mldCacheSelf is true and that if the router left the group, this entry would be aged out immediately.

type=Time
access=read-only
Displayed(tab/group)=Expiry Time (/Timers)

fwdServiceId The forwarding service ID for a subscriber interface in a retailer context.

type=long
access=read-only
default=0

groupAddress The IP multicast group address.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Group Address

groupAddressType The IP multicast group address type.

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

grpIfindex The unique value which identifies this interface of this virtual router.

type=long
access=read-only

mld.GroupInterfaceSapGroupSource-Set type=Children-Set
mode The type of membership report(s) received on the SAP for the group. In the 'include' mode, reception of packets sent to the specified multicast address is requested only from those IP source addresses listed in the source-list parameter of the MLD membership report. In 'exclude' mode, reception of packets sent to the given multicast address is requested from all IP source addresses except those listed in the source-list parameter.

type=mld.GroupModeType
access=read-only
Displayed(tab/group)=Mode

portId The ID of the access port where this SAP is defined.

type=long
access=read-only
default=0

routerId

type=int
access=read-create
default=1

siteId

type=string
access=read-only
default=

type Indicates how this group entry was learned. If this group entry was learned by MLD, it will be set to 'dynamic'. For statically configured groups, the value will be set to 'static'.

type=mld.GroupType
access=read-only
Displayed(tab/group)=Group Type

upTime The time elapsed since this object was created.

type=Time
access=read-only
Displayed(tab/group)=Up Time (/Timers)

ver1HostTmr The time remaining until the local router will assume that there are no longer any MLD version 1 members on the IP subnet attached to this SAP. Upon hearing any MLDv1 Membership Report, this value is reset to the group membership timer. While this time remaining is non-zero, the local router ignores any MLDv2 Leave messages for this group that it receives on this SAP.

type=Time
access=read-only
Displayed(tab/group)=MLD Version 1 Timeout (/Timers)

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveMldGroupIfSapGrp

Method used to query the NE for group address entries under a GroupInterfaceSap.
Input Parameters:
aInGrpIfSapFdn : string - The FDN for GrpInterfaceSap. If an existing GrpInterfaceSap object is found with the passed in value, the remaining input parameters will be ignored. If this value is left empty or an existing GrpInterfaceSap object can not be found according to the value, the values in the aInMldSapParams structure will be used to perform the retrieve.
aInMldSapParams :
mld.MldSapStruct - (Optional)
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:
result : List (generic.CommonManagedEntityInformation) -
Exceptions:
mld.GroupInterfaceSapGroup.retrieveMldGroupIfSapGrpException -
Supported Network Elements
7750 SR Supported from 12.0.R1
7450 ESS Supported from 12.0.R1
  • Required Capabilities: MixedMode
7250 IXR Supported from 19.10.R1