CISCO-IP-LOCAL-POOL-MIB

All MIBs › CISCO-IP-LOCAL-POOL-MIB

Organization: Cisco Systems, Inc.

Last Updated: 2007-11-12

Category: Cisco Devices, IP and Core Protocols

Description: Manages local IP address pools used for dynamic address assignment in dial and VPN access scenarios.

Start monitoring vendor-neutral, standards-based MIB, any SNMPv3-capable network device (SNMP engine identity/boot/clock status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

What Is CISCO-IP-LOCAL-POOL-MIB?

CISCO-IP-LOCAL-POOL-MIB manages and monitors local IP address pools used for dynamically assigning addresses to dial-in, VPN, or similar remote-access clients on Cisco routers and access servers. It exposes a configuration table defining each pool's name, address type, and address range, with pools organized into groups and controlled via row-status provisioning. Its key monitoring role is reporting real-time pool utilization -- free versus in-use address counts -- letting operators track address-pool exhaustion, a software-resource-health indicator analogous to monitoring free disk space or memory but for IP address inventory, and receive notifications on relevant pool events. It is largely self-contained but complements AAA/dial and VPN session MIBs that assign addresses drawn from these pools. It is deployed on Cisco VPN/dial access gateways and broadband aggregation routers handing out addresses to remote-access clients. Engineers can download the CISCO-IP-LOCAL-POOL-MIB file directly to load it into their MIB browser.

IPNetwork Monitor allows you to monitor SNMP objects defined in CISCO-IP-LOCAL-POOL-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.

Supported Devices

Cisco VPN/dial access gateways and broadband aggregation routers

Monitoring Examples

cIpLocalPoolConfigTable/cIpLocalPoolConfigEntry defines each pool's cIpLocalPoolName, cIpLocalPoolAddressLo/Hi range, and cIpLocalPoolGroupContainedIn; polling cIpLocalPoolFreeAddrs versus cIpLocalPoolInUseAddrs for a given pool reveals how close it is to exhaustion. If cIpLocalPoolFreeAddrs approaches zero for a heavily used pool, new VPN or dial-in clients will start failing to obtain an address, which is exactly the condition this MIB is designed to surface before it happens; cIpLocalPoolPriority governs which pool in a group is drawn from first.

What Can Be Monitored

free addresses per IP pool
in-use addresses per IP pool
pool group membership/priority
pool address range configuration

Imported Objects

From CISCO-SMI

ciscoMgmt

OBJECT-IDENTITY

From IF-MIB

InterfaceIndexOrZero

From INET-ADDRESS-MIB

InetAddress
InetAddressType

From SNMP-FRAMEWORK-MIB

SnmpAdminString

From SNMPv2-CONF

MODULE-COMPLIANCE
NOTIFICATION-GROUP
OBJECT-GROUP

From SNMPv2-SMI

Gauge32
MODULE-IDENTITY
NOTIFICATION-TYPE
OBJECT-TYPE
Unsigned32

From SNMPv2-TC

RowStatus
TEXTUAL-CONVENTION
TruthValue

How to Use in IPNetwork Monitor

Example using cIpLocalPoolFreeAddrs OID:

Select a Cisco VPN/dial access gateway or broadband aggregation router as the target host to create a monitor — the SNMP service should be up and running on it. Click New Monitor, then check SNMP Custom on the Favorites tab, click Next, and confirm the host. On the next page, click Select... to open the built-in SNMP MIB Browser and type cIpLocalPoolFreeAddrs into the Find box to locate it in the OID tree, selecting the specific row/instance you want to monitor since this is a table column, then select it and click OK. The number of IP addresses available for use in the range of IP addresses. On the monitor's Main parameters page you can set the target's SNMP port (default 161), credentials, polling interval, and other settings — see the SNMP Monitor help for details. On the State conditions and Alerting tabs, configure when the monitor should change state and trigger an alert; since this is a Gauge32-type OID, Value bounds is the most useful condition here — trigger an alert if the counter increases sharply between polls relative to its normal baseline, since an unexpected spike often reflects a real change in traffic or activity. Click Finish to create the monitor; you can adjust any parameter later.

OIDs

OID symbolic	OID numeric	Type	Access	Description
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.
ciscoIpLocalPoolMIBNotifs	1.3.6.1.4.1.9.9.326.0
NTF 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.
NTF 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.
NTF 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.
ciscoIpLocalPoolMIBObjects	1.3.6.1.4.1.9.9.326.1
cIpLocalPoolConfig	1.3.6.1.4.1.9.9.326.1.1
T/F cIpLocalPoolNotificationsEnable	1.3.6.1.4.1.9.9.326.1.1.1	TruthValue	read-write	An indication of whether the notifications defined by the ciscoIpLocalPoolNotifGroup are enabled.
cIpLocalPoolConfigTable	1.3.6.1.4.1.9.9.326.1.1.2		not-accessible	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.
cIpLocalPoolConfigEntry	1.3.6.1.4.1.9.9.326.1.1.2.1		not-accessible	Each entry provides information about a particular IP local pool, including the number of free and used addresses and its priority.
CIP cIpLocalPoolName	1.3.6.1.4.1.9.9.326.1.1.2.1.1	CIpLocalPoolName	not-accessible	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.
IPt cIpLocalPoolAddrType	1.3.6.1.4.1.9.9.326.1.1.2.1.2	InetAddressType	not-accessible	This object specifies the address type of cIpLocalPoolAddressLo and cIpLocalPoolAddressHi.
IP cIpLocalPoolAddressLo	1.3.6.1.4.1.9.9.326.1.1.2.1.3	InetAddress	not-accessible	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.
IP cIpLocalPoolAddressHi	1.3.6.1.4.1.9.9.326.1.1.2.1.4	InetAddress	read-create	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.
G32 cIpLocalPoolFreeAddrsEx	1.3.6.1.4.1.9.9.326.1.1.2.1.5	Gauge32	read-only	The number of IP addresses available for use in the range of IP addresses.
G32 cIpLocalPoolInUseAddrs	1.3.6.1.4.1.9.9.326.1.1.2.1.6	Gauge32	read-only	The number of IP addresses being used in the range of IP addresses.
CIP cIpLocalPoolGroupContainedIn	1.3.6.1.4.1.9.9.326.1.1.2.1.7	CIpLocalPoolGroupNameOrNull	read-create	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.
ROW cIpLocalPoolRowStatus	1.3.6.1.4.1.9.9.326.1.1.2.1.8	RowStatus	read-create	This object facilitates the creation, or deletion of a conceptual row in this table.
U32 cIpLocalPoolPriority	1.3.6.1.4.1.9.9.326.1.1.2.1.9	Unsigned32	read-create	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.
cIpLocalPoolGroup	1.3.6.1.4.1.9.9.326.1.2
cIpLocalPoolGroupContainsTable	1.3.6.1.4.1.9.9.326.1.2.1		not-accessible	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.
cIpLocalPoolGroupContainsEntry	1.3.6.1.4.1.9.9.326.1.2.1.1		not-accessible	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.
CIP cIpLocalPoolGroupName	1.3.6.1.4.1.9.9.326.1.2.1.1.1	CIpLocalPoolGroupNameOrNull	not-accessible	A unique group name that identifies the IP pool group. The null string represents the base IP pool group.
CIP cIpLocalPoolChildIndex	1.3.6.1.4.1.9.9.326.1.2.1.1.2	CIpLocalPoolName	read-only	The value of cIpLocalPoolName for the contained IP local pool.
cIpLocalPoolGroupTable	1.3.6.1.4.1.9.9.326.1.2.2		not-accessible	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.
cIpLocalPoolGroupEntry	1.3.6.1.4.1.9.9.326.1.2.2.1		not-accessible	Each entry provides information about a particular IP pool group and the number of free and used addresses in an IP pool group.
G32 cIpLocalPoolGroupFreeAddrs	1.3.6.1.4.1.9.9.326.1.2.2.1.1	Gauge32	read-only	The number of IP addresses available for use in the IP pool group.
G32 cIpLocalPoolGroupInUseAddrs	1.3.6.1.4.1.9.9.326.1.2.2.1.2	Gauge32	read-only	The number of IP addresses that have been allocated from the IP pool group.
cIpLocalPoolStats	1.3.6.1.4.1.9.9.326.1.3
cIpLocalPoolStatsTable	1.3.6.1.4.1.9.9.326.1.3.1		not-accessible	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.
cIpLocalPoolStatsEntry	1.3.6.1.4.1.9.9.326.1.3.1.1		not-accessible	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.
G32 cIpLocalPoolStatFreeAddrs	1.3.6.1.4.1.9.9.326.1.3.1.1.1	Gauge32	read-only	The number of IP addresses available for use in this IP local pool.
G32 cIpLocalPoolStatInUseAddrs	1.3.6.1.4.1.9.9.326.1.3.1.1.2	Gauge32	read-only	The number of IP addresses being used in this IP local pool.
U32 cIpLocalPoolStatHiWaterUsedAddrs	1.3.6.1.4.1.9.9.326.1.3.1.1.3	Unsigned32	read-write	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.
U32 cIpLocalPoolStatInUseAddrThldLo	1.3.6.1.4.1.9.9.326.1.3.1.1.4	Unsigned32	read-write	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.
U32 cIpLocalPoolStatInUseAddrThldHi	1.3.6.1.4.1.9.9.326.1.3.1.1.5	Unsigned32	read-write	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.
CIP cIpLocalPoolPercentAddrThldLo	1.3.6.1.4.1.9.9.326.1.3.1.1.6	CIpLocalPoolPercentage	read-write	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.
CIP cIpLocalPoolPercentAddrThldHi	1.3.6.1.4.1.9.9.326.1.3.1.1.7	CIpLocalPoolPercentage	read-write	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.
cIpLocalPoolAllocTable	1.3.6.1.4.1.9.9.326.1.3.2		not-accessible	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.
cIpLocalPoolAllocEntry	1.3.6.1.4.1.9.9.326.1.3.2.1		not-accessible	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.
IPt cIpLocalPoolAllocAddrType	1.3.6.1.4.1.9.9.326.1.3.2.1.1	InetAddressType	not-accessible	This object specifies the address type of cIpLocalPoolAllocAddr.
IP cIpLocalPoolAllocAddr	1.3.6.1.4.1.9.9.326.1.3.2.1.2	InetAddress	not-accessible	This object specifies the allocated IP address. The address type of this object is described by cIpLocalPoolAllocAddrType.
NUM cIpLocalPoolAllocIfIndex	1.3.6.1.4.1.9.9.326.1.3.2.1.3	InterfaceIndexOrZero	read-only	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.
STR cIpLocalPoolAllocUser	1.3.6.1.4.1.9.9.326.1.3.2.1.4	SnmpAdminString	read-only	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.
ciscoIpLocalPoolMIBConform	1.3.6.1.4.1.9.9.326.2
ciscoIpLocalPoolMIBCompliances	1.3.6.1.4.1.9.9.326.2.1
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.
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.
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.
ciscoIpLocalPoolMIBGroups	1.3.6.1.4.1.9.9.326.2.2
ciscoIpLocalPoolConfigGroup	1.3.6.1.4.1.9.9.326.2.2.1			Objects for providing configuration for IP local pools.
ciscoIpLocalPoolGroupGroup	1.3.6.1.4.1.9.9.326.2.2.2			Objects for providing configuration for IP local pools.
ciscoIpLocalPoolStatsGroup	1.3.6.1.4.1.9.9.326.2.2.3			Objects for providing IP local pool statistics and status.
ciscoIpLocalPoolNotifGroup	1.3.6.1.4.1.9.9.326.2.2.4			The collection of notifications used for monitoring IP local pool utilization.
ciscoIpLocalPoolStatsGroupSup1	1.3.6.1.4.1.9.9.326.2.2.5			Supplemental objects for providing IP local pool statistics and status.
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.
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.

RFC description

Configuration and monitoring of local IP pools for address allocation on Cisco devices.

Start monitoring Cisco VPN/dial access gateways and broadband aggregation routers with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download CISCO-IP-LOCAL-POOL-MIB