CISCO-IGMP-FILTER-MIB

File: CISCO-IGMP-FILTER-MIB.mib (24299 bytes)

Imported modules

SNMPv2-TC SNMPv2-SMI IF-MIB
CISCO-SMI INET-ADDRESS-MIB SNMPv2-CONF

Imported symbols

TruthValue TestAndIncr MODULE-IDENTITY
OBJECT-TYPE Unsigned32 ifIndex
ciscoMgmt InetAddressType InetAddress
MODULE-COMPLIANCE OBJECT-GROUP

Defined Types

CIgmpFilterEntry  
SEQUENCE    
  cIgmpFilterProfileIndex Unsigned32
  cIgmpFilterStartAddressType InetAddressType
  cIgmpFilterStartAddress InetAddress
  cIgmpFilterEndAddressType InetAddressType
  cIgmpFilterEndAddress InetAddress
  cIgmpFilterProfileAction INTEGER

CIgmpFilterInterfaceEntry  
SEQUENCE    
  cIgmpFilterInterfaceProfileIndex Unsigned32

Defined Values

ciscoIGMPFilterMIB 1.3.6.1.4.1.9.9.238
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.
MODULE-IDENTITY    

ciscoIgmpFilterMIBObjects 1.3.6.1.4.1.9.9.238.1
OBJECT IDENTIFIER    

cIgmpFilterGeneral 1.3.6.1.4.1.9.9.238.1.1
OBJECT IDENTIFIER    

cIgmpFilterInfo 1.3.6.1.4.1.9.9.238.1.2
OBJECT IDENTIFIER    

cIgmpFilterEditor 1.3.6.1.4.1.9.9.238.1.3
OBJECT IDENTIFIER    

cIgmpFilterEnable 1.3.6.1.4.1.9.9.238.1.1.1
This object controls whether the IGMP filtering is enabled on the device. A false(2) value will prevent the IGMP filtering action on the device.
OBJECT-TYPE    
  TruthValue  

cIgmpFilterMaxProfiles 1.3.6.1.4.1.9.9.238.1.1.2
Indicates the maximum number of profiles supported by this device. A value of zero indicates no limitation on the number of profiles.
OBJECT-TYPE    
  Unsigned32  

cIgmpFilterTable 1.3.6.1.4.1.9.9.238.1.2.1
This 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.
OBJECT-TYPE    
  SEQUENCE OF  
    CIgmpFilterEntry

cIgmpFilterEntry 1.3.6.1.4.1.9.9.238.1.2.1.1
An entry (conceptual row) in the cIgmpFilterTable. The creation, deletion or modification of an entry is controlled through the MIB objects defined under cIgmpFilterEditor group.
OBJECT-TYPE    
  CIgmpFilterEntry  

cIgmpFilterProfileIndex 1.3.6.1.4.1.9.9.238.1.2.1.1.1
Index identifying this entry.
OBJECT-TYPE    
  Unsigned32  

cIgmpFilterStartAddressType 1.3.6.1.4.1.9.9.238.1.2.1.1.2
This object describes the type of Internet address used to determine the start address of IP multicast group for a profile.
OBJECT-TYPE    
  InetAddressType  

cIgmpFilterStartAddress 1.3.6.1.4.1.9.9.238.1.2.1.1.3
This object describes the start of the IP multicast group address of a contiguous range which will be subjected to filtering operation.
OBJECT-TYPE    
  InetAddress Size(1..64)  

cIgmpFilterEndAddressType 1.3.6.1.4.1.9.9.238.1.2.1.1.4
This object indicates the type of Internet address used to determine the end address of IP multicast group for a profile.
OBJECT-TYPE    
  InetAddressType  

cIgmpFilterEndAddress 1.3.6.1.4.1.9.9.238.1.2.1.1.5
This object indicates the end of the IP multicast group address of a contiguous range which will be subjected to filtering operation.
OBJECT-TYPE    
  InetAddress  

cIgmpFilterProfileAction 1.3.6.1.4.1.9.9.238.1.2.1.1.6
This 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.
OBJECT-TYPE    
  INTEGER permit(1), deny(2)  

cIgmpFilterInterfaceTable 1.3.6.1.4.1.9.9.238.1.2.2
This table contains the list of interfaces that can support IGMP filter feature.
OBJECT-TYPE    
  SEQUENCE OF  
    CIgmpFilterInterfaceEntry

cIgmpFilterInterfaceEntry 1.3.6.1.4.1.9.9.238.1.2.2.1
Each 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.
OBJECT-TYPE    
  CIgmpFilterInterfaceEntry  

cIgmpFilterInterfaceProfileIndex 1.3.6.1.4.1.9.9.238.1.2.2.1.1
Specifies 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.
OBJECT-TYPE    
  Unsigned32  

cIgmpFilterEditSpinLock 1.3.6.1.4.1.9.9.238.1.3.1
This 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.
OBJECT-TYPE    
  TestAndIncr  

cIgmpFilterEditProfileIndex 1.3.6.1.4.1.9.9.238.1.3.2
Buffer object to edit corresponding object cIgmpFilterProfileIndex in cIgmpFilterTable. Maximum value this object can be set to is determined by cIgmpFilterMaxProfiles object.
OBJECT-TYPE    
  Unsigned32  

cIgmpFilterEditStartAddressType 1.3.6.1.4.1.9.9.238.1.3.3
Buffer 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.
OBJECT-TYPE    
  InetAddressType  

cIgmpFilterEditStartAddress 1.3.6.1.4.1.9.9.238.1.3.4
Buffer object to edit corresponding object cIgmpFilterStartAddress in cIgmpFilterTable to establish start address of filtering range for a profile.
OBJECT-TYPE    
  InetAddress Size(1..64)  

cIgmpFilterEditEndAddressType 1.3.6.1.4.1.9.9.238.1.3.5
Buffer 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.
OBJECT-TYPE    
  InetAddressType  

cIgmpFilterEditEndAddress 1.3.6.1.4.1.9.9.238.1.3.6
Buffer object to edit corresponding object cIgmpFilterEndAddress in cIgmpFilterTable to establish end address of filtering range for a profile.
OBJECT-TYPE    
  InetAddress  

cIgmpFilterEditProfileAction 1.3.6.1.4.1.9.9.238.1.3.7
Buffer object to edit corresponding object in cIgmpFilterTable to determine filtering action of each profile.
OBJECT-TYPE    
  INTEGER permit(1), deny(2)  

cIgmpFilterEditOperation 1.3.6.1.4.1.9.9.238.1.3.8
The 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.
OBJECT-TYPE    
  INTEGER none(1), add(2), delete(3), modify(4)  

cIgmpFilterApplyStatus 1.3.6.1.4.1.9.9.238.1.3.9
The 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.
OBJECT-TYPE    
  INTEGER someOtherError(1), succeeded(2), inconsistentEdit(3), entryPresentError(4), entryNotPresentError(5)  

ciscoIgmpFilterMIBConformance 1.3.6.1.4.1.9.9.238.2
OBJECT IDENTIFIER    

ciscoIgmpFilterMIBCompliances 1.3.6.1.4.1.9.9.238.2.1
OBJECT IDENTIFIER    

ciscoIgmpFilterMIBGroups 1.3.6.1.4.1.9.9.238.2.2
OBJECT IDENTIFIER    

ciscoIgmpFilterGolbalMIBCompliance 1.3.6.1.4.1.9.9.238.2.1.1
The compliance statement for entities providing global control of action and implementing IGMP Filter MIB. OBJECT cIgmpFilterEditStartAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEditStartAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEditEndAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEditEndAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterStartAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterStartAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEndAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEndAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses.
MODULE-COMPLIANCE    

ciscoIgmpFilterGlobalMIBComplianceRev1 1.3.6.1.4.1.9.9.238.2.1.2
The compliance statement for entities providing global control of action and implementing IGMP Filter MIB. OBJECT cIgmpFilterEditStartAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEditStartAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEditEndAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEditEndAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterStartAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterStartAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEndAddressType SYNTAX InetAddressType { ipv4(1) } DESCRIPTION An implementation is only required to support IPv4 addresses. OBJECT cIgmpFilterEndAddress SYNTAX InetAddress (SIZE(4)) DESCRIPTION An implementation is only required to support IPv4 addresses.
MODULE-COMPLIANCE    

ciscoIgmpFilterGlobalGroup 1.3.6.1.4.1.9.9.238.2.2.1
A collection of objects providing the configuration of IGMP filter for the system.
OBJECT-GROUP    

ciscoIgmpFilterInfoGroup 1.3.6.1.4.1.9.9.238.2.2.2
A collection of objects providing the configuration of IGMP filter for the system.
OBJECT-GROUP    

ciscoIgmpFilterEditorGroup 1.3.6.1.4.1.9.9.238.2.2.3
A collection of objects acting as a buffer to add/delete/modify the entries in read-only table cIgmpFilterTable.
OBJECT-GROUP