igmp
GroupInterfaceSapGroupSource

The listing the IP multicast sources corresponding to the IP multicast groups for which there are members on a particular SAP. Each instance represents a source address from which receivers are interested/not interested in receiving multicast traffic from.



public class GroupInterfaceSapGroupSource

Properties
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. If the expiry time is non-zero and the value of group interface SAP group mode corresponding to this entry is 'include', it means that there are currently one or more systems which desire to receive multicast traffic for this source. If this timer expires and the value of group interface SAP group mode is 'include', the router concludes that traffic from this particular source is no longer desired on the attached network, and deletes this entry. This timer is treated differently when the value of group interface SAP group mode is 'exclude'. If the expiry time is non-zero and router filter-mode for the group is 'exclude', it means that at least one system desires to receive multicast traffic from this source. It should therefore be forwarded by a router on the network.

type=long
access=read-only
Displayed(tab/group)=Expire Time

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-only
default=0.0.0.0

groupAddressType The IP multicast group address type.

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

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

type=long
access=read-only

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

type=long
access=read-only
default=0

routerId

type=int
access=read-only
default=1

siteId

type=string
access=read-only
default=

sourceAddress The address of the source sending multicast traffic to the group.

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

sourceAddressType The type of the address of the source sending multicast traffic to the group.

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

type This indicates how this source entry was learned. If this source entry was learned by IGMP, it will be set to 'dynamic'. For statically configured sources, the value will be set to 'static'.

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

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

retrieveIgmpGroupIfSapGrpSrc

Method used to query the NE for source address entries under a GroupInterfaceSapGroup.
Input Parameters:
aInSiteId : string -
aInRouterId : int -
aInFwdServiceId : long -
aInGrpIfindex : long -
aInPortId : long -
aInEncapVal : long -
aInGroupAddress : string -
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:
igmp.GroupInterfaceSapGroupSource.retrieveIgmpGroupIfSapGrpSrcException -
Supported Network Elements
7750 SR Supported from 9.0.R3
  • Excluded chassis types: 7750-SR1
7450 ESS Supported from 9.0.R3 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