| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| adminVersion |
The configured version of IGMP which is running for this Host.
type=int access=read-create default=3 Displayed(tab/group)=IGMP Configured Version |
| bondingConnIndex |
Specifies the bonding connection index of the session of this host.
A value of 0 indicates this session is not part of a bonding context.
type=int access=read-only default=0 Displayed(tab/group)=Bonding Connection Index |
| bondingId |
Specifies the bonding identifier of the session of this host.
type=string access=read-only Displayed(tab/group)=Bonding ID |
| disableRtrAlertCheck |
Indicates whether router alert checking for IGMP messages is enabled or disabled.
If this flag is set to 'true', checking is disabled
type=generic.TruthValue access=read-only default=false Displayed(tab/group)=Disabled Router Alert Check |
| fwdServiceId |
The forwarding service ID for a subscriber interface in a retailer context.
type=long access=read-create default=0 |
| fwdServiceSitePointer |
Pointer to the The forwarding service
type=Pointer access=read-create Mandatory on create Displayed(tab/group)=Service |
| groupCount |
The number of multicast groups subscribered by this Host.
type=long access=read-create Mandatory on create Displayed(tab/group)=Number of Groups |
| grpIfPointer |
Pointer to the group interface on this virtual router.
type=Pointer access=read-create Mandatory on create Displayed(tab/group)=Group Interface |
| grpIfindex |
The unique value which identifies this interface of this virtual router.
type=long access=read-create Mandatory on create |
| igmp.HostGroup-Set |
type=Children-Set |
| igmpPolicyName |
Name of the Igmp Policy profile
type=string access=read-create Mandatory on create |
| igmpPolicyPointer |
Pointer to the IGMP Policy
type=Pointer access=read-create Mandatory on create Displayed(tab/group)=IGMP Policy |
| ipAddrType |
type=rtr.InetAddressType access=read-create default=ipv4 |
| ipAddress |
The IP address of this host
type=InetAddress access=read-create Mandatory on create Displayed(tab/group)=IP Address |
| lastLstnrQryIntvl |
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.
This value may be tuned to modify the leave latency of the network. A reduced value
results in reduced time to detect the loss of the last member of a group.
type=int access=read-only default=0 minimum=0 maximum=1023 units=seconds Displayed(tab/group)=Last Member Query Interval |
| macAddress |
The MAC address of this host
type=MacAddress access=read-create Mandatory on create Displayed(tab/group)=MAC Address |
| maxGroups |
Specifies the maximum number of groups for which IGMP can have local receiver information based
on received IGMP reports on this subscriber host. When this configuration is changed
dynamically to a value lower than currently accepted number of groups,
the groups that are already accepted are not deleted. Only new groups will not be allowed.
When this object has a value of 0, there is no limit to the number of groups.
type=long access=read-create Mandatory on create Displayed(tab/group)=Max Number of Groups |
| maxGroupsTillNow |
The highest value that maxGroups had till now.
type=long access=read-create Mandatory on create Displayed(tab/group)=Max Number of Groups Until Now |
| maxGrpSources |
Specifies the maximum number of group sources per group for which IGMP can have local receiver
information based on received IGMP reports on this subscriber host.
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 access=read-create default=0 minimum=0 maximum=1000 Displayed(tab/group)=Max Number of Group Sources |
| maxSources |
Specifies the maximum number of sources per group for which IGMP can have local receiver information
based on received IGMP reports on this subscriber host. 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 access=read-create default=0 minimum=0 maximum=1000 Displayed(tab/group)=Max Number of Sources |
| nextGenQueryTime |
The time remaining before the general query is sent for this Host.
type=long access=read-create units=seconds Mandatory on create Displayed(tab/group)=Time To Next Query |
| operState |
The current operational state
type=igmp.GroupIfOperState access=read-create Mandatory on create Displayed(tab/group)=Operational State |
| operVersion |
The operational version of IGMP which is running for this Host.
type=int access=read-create Mandatory on create Displayed(tab/group)=IGMP Operational Version |
| pppoeSessionId |
The PPPoE session id of this host
type=long access=read-create Mandatory on create Displayed(tab/group)=PPPoE Session ID |
| queryInterval |
Specifies the frequency at which the IGMP Host-Query packets are transmitted for this SAP.
Valid range for query interval is 0 or 2..1024.
type=int access=read-only default=0 minimum=0 maximum=1024 units=seconds Displayed(tab/group)=Query Interval |
| queryResponseIntvl |
Specifies maximum query response time advertised in IGMP queries for this SAP.
type=int access=read-only default=0 minimum=0 maximum=1023 units=seconds Displayed(tab/group)=Response Query Interval |
| routerId |
type=int access=read-create default=1 minimum=1 maximum=10240 |
| siteId |
type=string access=read-create default= Mandatory on create |
| subIdent |
The Subscriber Id of this host
type=string access=read-create Mandatory on create Displayed(tab/group)=Subscriber |
| totalBW |
Specifies the total BW of all the Channels that is subscribed by this Host
type=long access=read-create units=kbps Mandatory on create |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
aInSiteId
: string - Specifies the network element to which the IGMP Host resides. This attribute is mandatory.
aInSubId
: string - Specifies Subscriber Identifier that IGMP Host is associated with. This attribute is mandatory.
aInMCacPolicyPointer
: string - Specifies the MCAC Policy that IGMP Host bandwidth will be calculated from.
This attribute is mandatory, but the value can be empty.
If the value is empty, IGMP Host bandwidth will be 0.
When this attribute contains a valid MCAC Policy Pointer, bandwidth will
calculated and returned based on the specified MCAC Policy.
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
result
: List (generic.CommonManagedEntityInformation) -
igmp.IgmpHost.retrieveIgmpHostsException
-