CISCO-IP-LOCAL-POOL-MIB

File: CISCO-IP-LOCAL-POOL-MIB.mib (31518 bytes)

Imported modules

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

Imported symbols

MODULE-IDENTITY OBJECT-TYPE NOTIFICATION-TYPE
Unsigned32 Gauge32 MODULE-COMPLIANCE
OBJECT-GROUP NOTIFICATION-GROUP TEXTUAL-CONVENTION
TruthValue RowStatus InetAddressType
InetAddress InterfaceIndexOrZero SnmpAdminString
ciscoMgmt

Defined Types

CIpLocalPoolName  
A non-empty string that uniquely identifies an IP local pool.
TEXTUAL-CONVENTION    
  OCTET STRING Size(1..48)  

CIpLocalPoolGroupNameOrNull  
A string that uniquely identifies an IP pool group. The value of null is object-specific and must therefore be defined as part of the description of any object which uses this syntax.
TEXTUAL-CONVENTION    
  OCTET STRING Size(0..48)  

CIpLocalPoolPercentage  
A percentage associated with the addresses used in a IP local pool.
TEXTUAL-CONVENTION    
  Gauge32 0..100  

CIpLocalPoolConfigEntry  
SEQUENCE    
  cIpLocalPoolName CIpLocalPoolName
  cIpLocalPoolAddrType InetAddressType
  cIpLocalPoolAddressLo InetAddress
  cIpLocalPoolAddressHi InetAddress
  cIpLocalPoolFreeAddrs Gauge32
  cIpLocalPoolInUseAddrs Gauge32
  cIpLocalPoolGroupContainedIn CIpLocalPoolGroupNameOrNull
  cIpLocalPoolRowStatus RowStatus
  cIpLocalPoolPriority Unsigned32

CIpLocalPoolGroupContainsEntry  
SEQUENCE    
  cIpLocalPoolGroupName CIpLocalPoolGroupNameOrNull
  cIpLocalPoolChildIndex CIpLocalPoolName

CIpLocalPoolGroupEntry  
SEQUENCE    
  cIpLocalPoolGroupFreeAddrs Gauge32
  cIpLocalPoolGroupInUseAddrs Gauge32

CIpLocalPoolStatsEntry  
SEQUENCE    
  cIpLocalPoolStatFreeAddrs Gauge32
  cIpLocalPoolStatInUseAddrs Gauge32
  cIpLocalPoolStatHiWaterUsedAddrs Unsigned32
  cIpLocalPoolStatInUseAddrThldLo Unsigned32
  cIpLocalPoolStatInUseAddrThldHi Unsigned32
  cIpLocalPoolPercentAddrThldLo CIpLocalPoolPercentage
  cIpLocalPoolPercentAddrThldHi CIpLocalPoolPercentage

CIpLocalPoolAllocEntry  
SEQUENCE    
  cIpLocalPoolAllocAddrType InetAddressType
  cIpLocalPoolAllocAddr InetAddress
  cIpLocalPoolAllocIfIndex InterfaceIndexOrZero
  cIpLocalPoolAllocUser SnmpAdminString

Defined Values

ciscoIpLocalPoolMIB 1.3.6.1.4.1.9.9.326
This MIB defines the configuration and monitoring capabilities relating to local IP pools. Local IP pools have the following characteristics: - An IP local pool consists of one or more IP address ranges. - An IP pool group consists of one or more IP local pools. - An IP local pool can only belong to one IP pool group. - IP local pools that belong to different groups can have overlapping addresses. - IP local pool names are unique even when they belong to different groups. - Addresses within an IP pool group can not overlap. - IP local pools without an explicit group name are considered members of the base system group. In this MIB, the base system group is represented by a null IP pool group name. This MIB defines objects that expose the relationship between IP pool groups and IP local pools. There exist other objects that maintain statistics about the address usage of IP local pools.
MODULE-IDENTITY    

ciscoIpLocalPoolMIBNotifs 1.3.6.1.4.1.9.9.326.0
OBJECT IDENTIFIER    

ciscoIpLocalPoolMIBObjects 1.3.6.1.4.1.9.9.326.1
OBJECT IDENTIFIER    

ciscoIpLocalPoolMIBConform 1.3.6.1.4.1.9.9.326.2
OBJECT IDENTIFIER    

cIpLocalPoolConfig 1.3.6.1.4.1.9.9.326.1.1
OBJECT IDENTIFIER    

cIpLocalPoolGroup 1.3.6.1.4.1.9.9.326.1.2
OBJECT IDENTIFIER    

cIpLocalPoolStats 1.3.6.1.4.1.9.9.326.1.3
OBJECT IDENTIFIER    

cIpLocalPoolNotificationsEnable 1.3.6.1.4.1.9.9.326.1.1.1
An indication of whether the notifications defined by the ciscoIpLocalPoolNotifGroup are enabled.
OBJECT-TYPE    
  TruthValue  

cIpLocalPoolConfigTable 1.3.6.1.4.1.9.9.326.1.1.2
This table manages the creation, modification, and deletion of IP local pools using the RowStatus textual convention. An entry in this table defines an IP address range that is associated with an IP local pool. A conceptual row in this table can not be modified while cIpLocalPoolRowStatus is set to 'active'. Since IP local pool names are unique even when they belong to different groups, and addresses within a group can not overlap, a row in this table is uniquely indexed by the pool name, and by the low address of the IP local pool together with its address type.
OBJECT-TYPE    
  SEQUENCE OF  
    CIpLocalPoolConfigEntry

cIpLocalPoolConfigEntry 1.3.6.1.4.1.9.9.326.1.1.2.1
Each entry provides information about a particular IP local pool, including the number of free and used addresses and its priority.
OBJECT-TYPE    
  CIpLocalPoolConfigEntry  

cIpLocalPoolName 1.3.6.1.4.1.9.9.326.1.1.2.1.1
An arbitrary non-empty string that uniquely identifies the IP local pool. This name must be unique among all the local IP pools even when they belong to different pool groups.
OBJECT-TYPE    
  CIpLocalPoolName  

cIpLocalPoolAddrType 1.3.6.1.4.1.9.9.326.1.1.2.1.2
This object specifies the address type of cIpLocalPoolAddressLo and cIpLocalPoolAddressHi.
OBJECT-TYPE    
  InetAddressType  

cIpLocalPoolAddressLo 1.3.6.1.4.1.9.9.326.1.1.2.1.3
This object specifies the first IP address of the range of IP addresses contained by this pool entry. The address type of this object is described by cIpLocalPoolAddrType. This address must be less than or equal to the address in cIpLocalPoolAddressHi.
OBJECT-TYPE    
  InetAddress  

cIpLocalPoolAddressHi 1.3.6.1.4.1.9.9.326.1.1.2.1.4
This object specifies the last IP address of the range of IP addresses mapped by this pool entry. The address type of this object is described by cIpLocalPoolAddrType. If only a single address is being mapped, the value of this object is equal to the value of cIpLocalPoolAddressLo.
OBJECT-TYPE    
  InetAddress  

cIpLocalPoolFreeAddrs 1.3.6.1.4.1.9.9.326.1.1.2.1.5
The number of IP addresses available for use in the range of IP addresses.
OBJECT-TYPE    
  Gauge32  

cIpLocalPoolInUseAddrs 1.3.6.1.4.1.9.9.326.1.1.2.1.6
The number of IP addresses being used in the range of IP addresses.
OBJECT-TYPE    
  Gauge32  

cIpLocalPoolGroupContainedIn 1.3.6.1.4.1.9.9.326.1.1.2.1.7
This object relates an IP local pool to its IP pool group. A null string indicates this IP local pool is not contained in a named IP pool group, but that it is contained in the base IP pool group. An IP local pool can only belong to one IP pool group.
OBJECT-TYPE    
  CIpLocalPoolGroupNameOrNull  

cIpLocalPoolRowStatus 1.3.6.1.4.1.9.9.326.1.1.2.1.8
This object facilitates the creation, or deletion of a conceptual row in this table.
OBJECT-TYPE    
  RowStatus  

cIpLocalPoolPriority 1.3.6.1.4.1.9.9.326.1.1.2.1.9
This object specifies priority of the IP local pool, where smaller value indicates the lower priority. The priority value is used in assigning IP Address from local pools.
OBJECT-TYPE    
  Unsigned32 1..255  

cIpLocalPoolGroupContainsTable 1.3.6.1.4.1.9.9.326.1.2.1
A table which exposes the container/'containee' relationships between local IP pools and IP pool groups. Entries in this table are created or deleted as a by-product of creating or deleting entries in the cIpLocalPoolConfigTable. When an entry is created and activated in the cIpLocalPoolConfigTable table, an entry in this table will come into existence if it does not already exist. When an entry is deleted in the cIpLocalPoolConfigTable table, if there is no other entry existing in that table with the same cIpLocalPoolGroupContainedIn and cIpLocalPoolName, the entry in this table with the respective cIpLocalPoolGroupName and cIpLocalPoolName indices will be removed.
OBJECT-TYPE    
  SEQUENCE OF  
    CIpLocalPoolGroupContainsEntry

cIpLocalPoolGroupContainsEntry 1.3.6.1.4.1.9.9.326.1.2.1.1
Each entry describes single container/'containee' relationship. Pool names can only be associated with one group. Pools carry implicit group identifiers because pool names can only be associated with one group. An entry in this table describes such an association.
OBJECT-TYPE    
  CIpLocalPoolGroupContainsEntry  

cIpLocalPoolGroupName 1.3.6.1.4.1.9.9.326.1.2.1.1.1
A unique group name that identifies the IP pool group. The null string represents the base IP pool group.
OBJECT-TYPE    
  CIpLocalPoolGroupNameOrNull  

cIpLocalPoolChildIndex 1.3.6.1.4.1.9.9.326.1.2.1.1.2
The value of cIpLocalPoolName for the contained IP local pool.
OBJECT-TYPE    
  CIpLocalPoolName  

cIpLocalPoolGroupTable 1.3.6.1.4.1.9.9.326.1.2.2
This table provides statistics for configured IP pool groups. Entries in this table are created as the result of adding a new IP pool group to the cIpLocalPoolConfigTable. Entries in this table are deleted as the result of removing all IP local pools that are contained in an IP pool group in the cIpLocalPoolConfigTable. An entry in this table is uniquely indexed by IP pool group name.
OBJECT-TYPE    
  SEQUENCE OF  
    CIpLocalPoolGroupEntry

cIpLocalPoolGroupEntry 1.3.6.1.4.1.9.9.326.1.2.2.1
Each entry provides information about a particular IP pool group and the number of free and used addresses in an IP pool group.
OBJECT-TYPE    
  CIpLocalPoolGroupEntry  

cIpLocalPoolGroupFreeAddrs 1.3.6.1.4.1.9.9.326.1.2.2.1.1
The number of IP addresses available for use in the IP pool group.
OBJECT-TYPE    
  Gauge32  

cIpLocalPoolGroupInUseAddrs 1.3.6.1.4.1.9.9.326.1.2.2.1.2
The number of IP addresses that have been allocated from the IP pool group.
OBJECT-TYPE    
  Gauge32  

cIpLocalPoolStatsTable 1.3.6.1.4.1.9.9.326.1.3.1
A table providing statistics for each IP local pool. Entries in this table are created as the result of adding a new IP local pool to the cIpLocalPoolConfigTable. Entries in this table are deleted as the result of removing all the address ranges that are contained in an IP local pool in the cIpLocalPoolConfigTable. Entries in this table are uniquely indexed by the name of the IP local pool.
OBJECT-TYPE    
  SEQUENCE OF  
    CIpLocalPoolStatsEntry

cIpLocalPoolStatsEntry 1.3.6.1.4.1.9.9.326.1.3.1.1
Each entry provides statistical information about a particular IP local pool, and the total number of free and used addresses of all the ranges in an IP local pool.
OBJECT-TYPE    
  CIpLocalPoolStatsEntry  

cIpLocalPoolStatFreeAddrs 1.3.6.1.4.1.9.9.326.1.3.1.1.1
The number of IP addresses available for use in this IP local pool.
OBJECT-TYPE    
  Gauge32  

cIpLocalPoolStatInUseAddrs 1.3.6.1.4.1.9.9.326.1.3.1.1.2
The number of IP addresses being used in this IP local pool.
OBJECT-TYPE    
  Gauge32  

cIpLocalPoolStatHiWaterUsedAddrs 1.3.6.1.4.1.9.9.326.1.3.1.1.3
This object contains the high water mark of used addresses in an IP local pool since pool creation, since the system was restarted, or since this object was reset, whichever occurred last. This object can only be set to zero, and by doing so, it is reset to the value of cIpLocalPoolStatInUseAddrs. Since the number of addresses in a pool can be reduced (e.g. by deleting one of its ranges), the value of this object may be greater than the sum of cIpLocalPoolStatFreeAddrs and cIpLocalPoolStatInUseAddrs.
OBJECT-TYPE    
  Unsigned32  

cIpLocalPoolStatInUseAddrThldLo 1.3.6.1.4.1.9.9.326.1.3.1.1.4
When the number of used addresses in an IP local pool falls below this threshold value, the ciscoIpLocalPoolInUseAddrNoti notification will be rearmed. The value of this object should never be greater than the value of cIpLocalPoolStatInUseAddrThldHi.
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cIpLocalPoolStatInUseAddrThldHi 1.3.6.1.4.1.9.9.326.1.3.1.1.5
When the number of used addresses in an IP local pool is equal or exceeds this threshold value, a ciscoIpLocalPoolInUseAddrNoti notification will be generated. Once this notification is generated, it will be disarmed and it will not be generated again until the number of used address falls below the value indicated by cIpLocalPoolStatInUseAddrThldLo. The value of this object should never be smaller than the value of cIpLocalPoolStatInUseAddrThldLo.
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cIpLocalPoolPercentAddrThldLo 1.3.6.1.4.1.9.9.326.1.3.1.1.6
When the percentage of used addresses in an IP local pool falls below this threshold value, a cilpPercentAddrUsedLoNotif notification will be generated. Once the notification is generated, it will be disarmed and it will not be generated again until the number of used addresses equals or exceeds the value indicated by cIpLocalPoolPercentAddrThldHi. The value of this object should never be greater than the value of cIpLocalPoolPercentAddrThldHi.
OBJECT-TYPE    
  CIpLocalPoolPercentage  

cIpLocalPoolPercentAddrThldHi 1.3.6.1.4.1.9.9.326.1.3.1.1.7
When the percentage of used addresses in an IP local pool is equal or exceeds this threshold value, a cilpPercentAddrUsedHiNotif notification will be generated. Once the notification is generated, it will be disarmed and it will not be generated again until the number of used addresses falls below the value indicated by cIpLocalPoolPercentAddrThldLo. The value of this object should never be smaller than the value of cIpLocalPoolPercentAddrThldLo.
OBJECT-TYPE    
  CIpLocalPoolPercentage  

cIpLocalPoolAllocTable 1.3.6.1.4.1.9.9.326.1.3.2
This table lists all addresses that have been allocated out of an IP local pool. Entries in this table are created when a remote peer allocates an address from one of the IP local pools in the cIpLocalPoolConfigTable. Entries in this table are deleted when a remote peer deallocates an address from one of the IP local pool in the cIpLocalPoolConfigTable. Entries in this table are uniquely indexed by the name of the IP local pool, and the allocated address, together with its address type.
OBJECT-TYPE    
  SEQUENCE OF  
    CIpLocalPoolAllocEntry

cIpLocalPoolAllocEntry 1.3.6.1.4.1.9.9.326.1.3.2.1
Each entry refers to conceptual row that associates an IP addresses with the interface where the request was received, and the user that requested the address.
OBJECT-TYPE    
  CIpLocalPoolAllocEntry  

cIpLocalPoolAllocAddrType 1.3.6.1.4.1.9.9.326.1.3.2.1.1
This object specifies the address type of cIpLocalPoolAllocAddr.
OBJECT-TYPE    
  InetAddressType  

cIpLocalPoolAllocAddr 1.3.6.1.4.1.9.9.326.1.3.2.1.2
This object specifies the allocated IP address. The address type of this object is described by cIpLocalPoolAllocAddrType.
OBJECT-TYPE    
  InetAddress  

cIpLocalPoolAllocIfIndex 1.3.6.1.4.1.9.9.326.1.3.2.1.3
This object indicates the interface from which the allocation message was sent. In the case that the interface can not be determined, the value of this object will be zero.
OBJECT-TYPE    
  InterfaceIndexOrZero  

cIpLocalPoolAllocUser 1.3.6.1.4.1.9.9.326.1.3.2.1.4
This object indicates the user name of the person from whom the allocation message was sent. In the case that the user name can not be determined, the value of this object will the null string.
OBJECT-TYPE    
  SnmpAdminString  

ciscoIpLocalPoolInUseAddrNoti 1.3.6.1.4.1.9.9.326.0.1
A notification indicating that number of used addresses of an IP local pool exceeded the threshold value indicated by cIpLocalPoolStatInUseAddrThldHi.
NOTIFICATION-TYPE    

cilpPercentAddrUsedLoNotif 1.3.6.1.4.1.9.9.326.0.2
A notification indicating that the percentage of used addresses of an IP local pool went below the threshold value indicated by cIpLocalPoolPercentAddrThldLo.
NOTIFICATION-TYPE    

cilpPercentAddrUsedHiNotif 1.3.6.1.4.1.9.9.326.0.3
A notification indicating that the percentage of used addresses of an IP local pool is equal to or exceeds the threshold value indicated by cIpLocalPoolPercentAddrThldHi.
NOTIFICATION-TYPE    

ciscoIpLocalPoolMIBCompliances 1.3.6.1.4.1.9.9.326.2.1
OBJECT IDENTIFIER    

ciscoIpLocalPoolMIBGroups 1.3.6.1.4.1.9.9.326.2.2
OBJECT IDENTIFIER    

ciscoIpLocalPoolMIBCompliance 1.3.6.1.4.1.9.9.326.2.1.1
The compliance statement for entities which implement the Cisco IP Local Pool MIB.
MODULE-COMPLIANCE    

ciscoIpLocalPoolMIBCompliance1 1.3.6.1.4.1.9.9.326.2.1.2
The compliance statement for entities which implement the Cisco IP Local Pool MIB.
MODULE-COMPLIANCE    

ciscoIpLocalPoolMIBCompliance2 1.3.6.1.4.1.9.9.326.2.1.3
The compliance statement for entities which implement the Cisco IP Local Pool MIB.
MODULE-COMPLIANCE    

ciscoIpLocalPoolConfigGroup 1.3.6.1.4.1.9.9.326.2.2.1
Objects for providing configuration for IP local pools.
OBJECT-GROUP    

ciscoIpLocalPoolGroupGroup 1.3.6.1.4.1.9.9.326.2.2.2
Objects for providing configuration for IP local pools.
OBJECT-GROUP    

ciscoIpLocalPoolStatsGroup 1.3.6.1.4.1.9.9.326.2.2.3
Objects for providing IP local pool statistics and status.
OBJECT-GROUP    

ciscoIpLocalPoolNotifGroup 1.3.6.1.4.1.9.9.326.2.2.4
The collection of notifications used for monitoring IP local pool utilization.
NOTIFICATION-GROUP    

ciscoIpLocalPoolStatsGroupSup1 1.3.6.1.4.1.9.9.326.2.2.5
Supplemental objects for providing IP local pool statistics and status.
OBJECT-GROUP    

ciscoIpLocalPoolNotifGroupSup1 1.3.6.1.4.1.9.9.326.2.2.6
The collection of suplemantal notifications used for monitoring IP local pool utilization.
NOTIFICATION-GROUP    

ciscoIpLocalPoolPriorityGroup 1.3.6.1.4.1.9.9.326.2.2.7
A collection of object which provides priority configuration of IP local pools.
OBJECT-GROUP