CISCO-IGMP-FILTER-MIB
AI MIB Summary
The CISCO-IGMP-FILTER-MIB manages Cisco IOS devices to enforce IGMP join filtering policies by mapping specific IP multicast groups to permitted interface ports. This module monitors and configures the system's interception logic to restrict multicast group membership to authorized network segments.
IGMP Filter configuration MIB. This MIB provides a mechanism for users to configure the system to intercept IGMP joins for IP Multicast groups identified in this MIB and only allow certain ports to join certain multicast groups.
Main OID:
ciscoIGMPFilterMIB.1.3.6.1.4.1.9.9.238
30
Objects
Active
Status
6
Dependencies
Imported Objects
Objects
30 total| Object Name |
|---|
ciscoIGMPFilterMIBIGMP Filter configuration MIB. This MIB provides a
mechanism for users to configure the system to intercept
IGMP joins for IP Multicast groups identified in this
MIB and only allow certain ports to join certain
multicast groups. MODULE-IDENTITY .1.3.6.1.4.1.9.9.238 |
ciscoIgmpFilterMIBObjects OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.238.1 |
cIgmpFilterGeneral OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.238.1.1 |
cIgmpFilterEnableThis object controls whether the IGMP filtering
is enabled on the device. A false(2) value will
prevent the IGMP filtering action on the device.rw TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.238.1.1.1 |
cIgmpFilterMaxProfilesIndicates the maximum number of profiles supported by
this device. A value of zero indicates no limitation on
the number of profiles.ro Unsigned32 UNITS "profiles" .1.3.6.1.4.1.9.9.238.1.1.2 |
cIgmpFilterInfo OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.238.1.2 |
cIgmpFilterTableThis table contains entries that identify lists of
IP Multicast groups for each profile configured on
the device.
Each entry contains a range of contiguous IP
Multicast groups associated to a profile index.
Multiple cIgmpFilterEntry may be associated
with the same cIgmpFilterProfileIndex.
All the cIgmpFilterEntry with the same profile index
are subjected to the same IGMP filtering action as
defined in cIgmpFilterProfileAction.
Each profile index may be associated with zero or more
interfaces through cIgmpFilterInterfaceIfIndex
object in cIgmpFilterInterfaceTable.
The maximum number of entries is determined by
cIgmpFilterMaxProfiles. SEQUENCE OF CIgmpFilterEntry .1.3.6.1.4.1.9.9.238.1.2.1 |
cIgmpFilterEntryAn entry (conceptual row) in the cIgmpFilterTable.
The creation, deletion or modification of an entry
is controlled through the MIB objects defined under
cIgmpFilterEditor group. CIgmpFilterEntry .1.3.6.1.4.1.9.9.238.1.2.1.1 |
cIgmpFilterProfileIndexIndex identifying this entry. Unsigned32 .1.3.6.1.4.1.9.9.238.1.2.1.1.1 |
cIgmpFilterStartAddressTypeThis object describes the type of Internet
address used to determine the start address
of IP multicast group for a profile. InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.9.9.238.1.2.1.1.2 |
cIgmpFilterStartAddressThis object describes the start of the IP multicast
group address of a contiguous range which will be
subjected to filtering operation. InetAddress .1.3.6.1.4.1.9.9.238.1.2.1.1.3 |
cIgmpFilterEndAddressTypeThis object indicates the type of Internet
address used to determine the end address
of IP multicast group for a profile.ro InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.9.9.238.1.2.1.1.4 |
cIgmpFilterEndAddressThis object indicates the end of the IP multicast
group address of a contiguous range which will be
subjected to filtering operation.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.9.9.238.1.2.1.1.5 |
cIgmpFilterProfileActionThis object defines the action for
filtering IGMP reports for this profile.
If the object is set to deny(2):
then all IGMP reports associated to IP multicast
groups included in the profile identified by
cIgmpFilterInterfaceProfileIndex will be dropped.
If the object is set to permit(1):
then all IGMP reports associated to IP multicast
groups not included in the profile identified by
cIgmpFilterInterfaceProfileIndex will be dropped.ro Enumeration .1.3.6.1.4.1.9.9.238.1.2.1.1.6 |
cIgmpFilterInterfaceTableThis table contains the list of interfaces that can
support IGMP filter feature. SEQUENCE OF CIgmpFilterInterfaceEntry .1.3.6.1.4.1.9.9.238.1.2.2 |
cIgmpFilterInterfaceEntryEach entry contains the configuration for associating
the IGMP filter profile index with the interface.
An entry is created for each of the IGMP filter capable
interface on the system.
The entry is removed on removal of corresponding
interface from system. CIgmpFilterInterfaceEntry .1.3.6.1.4.1.9.9.238.1.2.2.1 |
cIgmpFilterInterfaceProfileIndexSpecifies which IGMP filter profile applies to this
interface. If the value of this MIB object matches the
value of cIgmpFilterProfileIndex in cIgmpFilterTable,
the corresponding profile configuration will apply to
this interface.
Agent returns inconsistentValue if this profile
does not exist in cIgmpFilterTable.
A value of zero indicates no profile is associated
with corresponding interface.
The filtering action on each interface is also
defined by the associated profile.rw Unsigned32 .1.3.6.1.4.1.9.9.238.1.2.2.1.1 |
cIgmpFilterEditor OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.238.1.3 |
cIgmpFilterEditSpinLockThis object is used to facilitate modification of
IGMP Filter Editor Group in the CISCO-IGMP-FILTER-MIB
module by multiple managers. In particular, it is
useful when modifying the value of the cIgmpFilterEditor
object.
The procedure for modifying the cIgmpFilterEditor
object is as follows:
1. Retrieve the value of cIgmpFilterEditSpinLock and
of object within cIgmpFilterEditor group.
2. Generate new values for 'writeable' objects
in the cIgmpFilterEditor group except for
cIgmpFilterEditSpinLock object.
3. Set the value of cIgmpFilterEditSpinLock to the
retrieved value, and the value of objects in
cIgmpFilterEditor to the new value. If the set
fails for the cIgmpFilterEditSpinLock object,
go back to step 1.
The cIgmpFilterApplyStatus and cIgmpFilterEditSpinLock
should be read together by NMS to make sure that the
result is associated with its configuration request.
To add/delete or modify a profile ( through cIgmpFilterEditor
objects ) following procedure may be followed as an example.:
1. GET(cIgmpFilterEditSpinLock.0) and save in sValue.
2. SET(cIgmpFilterEditSpinLock.0 = sValue,
cIgmpFilterEditProfileIndex.0 = validProfileNumber,
cIgmpFilterEditStartAddress.0 = validStartAddress,
cIgmpFilterEditEndAddress.0 = validEndAddress,
cIgmpFilterEditOperation.0 = validOperation)
3. If the SET in step 2 is not successful go back
to step 1.
4. If the SET in step 2 is successful, user should
GET(cIgmpFilterEditSpinLock.0) and
GET(cIgmpFilterApplyStatus.0) simultaneously.
5. The cIgmpFilterApplyStatus.0 reflects the outcome of
step 2 only if
cIgmpFilterEditSpinLock.0 = sValue + 1 or
cIgmpFilterEditSpinLock.0 = 0 if sValue reaches
value at which cIgmpFilterEditSpinLock wraps
around.rw TestAndIncr (SNMPv2-TC) .1.3.6.1.4.1.9.9.238.1.3.1 |
cIgmpFilterEditProfileIndexBuffer object to edit corresponding object
cIgmpFilterProfileIndex in cIgmpFilterTable.
Maximum value this object can be set to is
determined by cIgmpFilterMaxProfiles object.rw Unsigned32 .1.3.6.1.4.1.9.9.238.1.3.2 |
cIgmpFilterEditStartAddressTypeBuffer object to edit corresponding object
cIgmpFilterStartAddressType in cIgmpFilterTable.
This object describes the type of Internet
address used to determine the start address
of IP multicast group for a profile.rw InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.9.9.238.1.3.3 |
cIgmpFilterEditStartAddressBuffer object to edit corresponding object
cIgmpFilterStartAddress in cIgmpFilterTable
to establish start address of filtering
range for a profile.rw InetAddress .1.3.6.1.4.1.9.9.238.1.3.4 |
cIgmpFilterEditEndAddressTypeBuffer object to edit corresponding object
cIgmpFilterEndAddressType in cIgmpFilterTable.
This object describes the type of Internet
address used to determine the start address
of IP multicast group for a profile.rw InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.9.9.238.1.3.5 |
cIgmpFilterEditEndAddressBuffer object to edit corresponding object
cIgmpFilterEndAddress in cIgmpFilterTable
to establish end address of filtering
range for a profile.rw InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.9.9.238.1.3.6 |
cIgmpFilterEditProfileActionBuffer object to edit corresponding object in
cIgmpFilterTable to determine filtering action
of each profile.rw Enumeration .1.3.6.1.4.1.9.9.238.1.3.7 |
cIgmpFilterEditOperationThe function of this object is to allow user to
apply the changes in cIgmpFilterEditor objects to
cIgmpFilterTable.
This object always has the value 'none' when read.
When written each value causes the appropriate action:
'add' - tries to insert the information contained
in cIgmpFilterEditor objects into cIgmpFilterTable.
If the entry already exists in the table the 'add'
fails.
'delete' - tries to delete corresponding entry from
cIgmpFilterTable. If a user completely deletes a profile
that has corresponding entries in the
cIgmpFilterInterfaceTable, then all the interfaces mapped
to corresponding profile will be cleared and set to zero.
'modify' - Mode of operation used to edit an entry in
cIgmpFilterTable. If the corresponding entry does not
exist, modify operation fails. This mode allows user to
extend/truncate a contiguous filtered range, type of
Internet addressing and filtering action for a profile.
'none' - no operation is performed.rw Enumeration .1.3.6.1.4.1.9.9.238.1.3.8 |
cIgmpFilterApplyStatusThe current status of an 'add', 'delete' or 'modify'
operation. If no apply is currently active, the status
represented is that of the most recently completed 'add',
'delete' or 'modify' operation.
The value of this objects indicates succeeded(2) state
initially when no 'add', 'delete', 'modify' operation
has been carried out.
The possible values are:
someOtherError - the 'add', 'delete' or 'modify' failed
due to undefined error(s) in apply operation.
(e.g., insufficient memory).
succeeded - the 'add', 'delete' or 'modify' operation
was successful. (This value is also used when no
apply has been invoked since the last time the local
system restarted.)
inconsistentEdit - the 'add', 'delete' or 'modify' failed
due to inconsistency of the data.
entryPresentError - the 'add' operation failed as the
corresponding entry already exists in cIgmpFilterTable.
entryNotPresentError - the 'modify' operation failed
as no corresponding entry exists in cIgmpFilterTable.ro Enumeration .1.3.6.1.4.1.9.9.238.1.3.9 |
ciscoIgmpFilterMIBConformance OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.238.2 |
ciscoIgmpFilterMIBCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.238.2.1 |
ciscoIgmpFilterMIBGroups OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.238.2.2 |