CISCO-IP-ADDRESS-POOL-MIB

This MIB modules defines objects that describe common aspects
of IP address pools.

IP Address Pool Manager
=======================
The IP address pool manager consists of the software that
maintains IP address pools and supports the
following capabilities:

    - Create an IP address pool group.

    - Destroy an IP address pool group.

    - Create an IP address pool and add it to an IP address
      pool group.

    - Remove an IP address pool from an IP address pool group
      and destroy it.

    - Create a range of IP addresses and add it to an IP
      address pool.

    - Remove a range of IP addresses from an IP address pool and
      destroy it.

    - Allocate an IP address from an IP address pool.

    - Return a previously allocated IP address to the IP address
      pool that it was allocated from.

    - Create a set of IP prefixes and adding it to an IP address
      pool.

    - Remove a set of IP prefixes from an IP address pool and
      destroy it.

    - Allocate an IP prefix from an IP address pool.

    - Return a previously allocated IP prefix to the IP address
      pool that it was allocated from.

IP Address Pool
===============
An IP address pool consists of a collection of IP addresses from
which a client (e.g., PPP or DHCP) can allocate an IP address
for the purpose of assigning it to a remote peer.  This
collection consists of a one or more range of IP addresses.

Observe that human interfaces allow a user to specify ranges of
IP addresses using a variety of means to simplify the process.
For example, a human interface may simply allow a user to
specify a subnet.  No matter what abstraction a human interface
employs, the end result is always one or more range of IP
addresses.  Thus, this MIB module abstracts an IP address pool
as one or more range of IP addresses.  This places the burden on
any application employing other abstractions to transform to the
abstraction defined by this MIB module.

Alternatively, an IP address pool can also consist of a
collection of IP prefixes from which a client can allocate an IP
prefix for the purpose of assigning it to a remote peer.  This
collection consists of one or more set of IP prefixes.  Observe
that the term 'IP prefix' here can refer to an IPv4 subnet or an
IPv6 prefix.

IP Address Pool Group
=====================
An IP address pool group contains the IP address pools belonging
to the same administrative domain.  Examples of administrative
domains include a Virtual Route Forwarding (VRF) instance and a
Virtual Private Network (VPN).  Observe that the IP addresses
contained by the IP address pools in two distinct IP address
pool groups may overlap.

IP Address Pool Threshold Monitoring
====================================
An IP address pool manager maintains a number of gauges for the
purpose of monitoring the number of allocated IP addresses.  We
refer to these gauges as 'in-use gauges'.

Each in-use gauge has a corresponding state that can have one of
two values:

1)  Off

    The IP address pool manager monitors the number of allocated
    addresses or prefixes.  If this value is greater than or
    equal to the configured rising threshold and the previous
    value was less than the same rising threshold, then the IP
    address manager transitions the state to 'On'.

2)  On

    The IP address pool manager monitors the number of allocated
    addresses or prefixes.  If the value is less than or equal
    to the configured falling threshold and the previous value
    was greater than the same falling threshold, then the IP
    address manager transitions the state to 'Off'.

Observe that while the values of the configured rising and
falling thresholds may be the same, this may result in
undesirable behavior (i.e., the IP address pool manager may
generate more threshold crossing notifications than desirable).

The IP address pool manager only generates threshold crossing
notifications when it transitions the corresponding state of an
in-use gauge and the value of ciapSystemNotifyEnable is 'true'.

The IP address pool manager may maintain in-use gauges for the
following:

    - A range of IP addresses comprising an IP address pool

    - A set of IP prefixes comprising an IP address pool

    - An IP address pool

    - An IP address pool group

Observe that the IP address pool manager must initialize the
state of each in-use gauge to 'Off' for threshold monitoring to
operate in the prescribed manner.

Imported Objects

IpAddressPoolThresholdUnits, IpAddressPoolGroupNameOrNull, IpAddressPoolGroupName, IpAddressPoolNameOrNull, IpAddrPoolInstanceIdentifierOrZero, IpAddrPoolInstanceIdentifierCISCO-IP-ADDRESS-POOL-TC-MIB
ciscoMgmtCISCO-SMI
InetAddressPrefixLength, InetAddress, InetAddressTypeINET-ADDRESS-MIB
MODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUPSNMPv2-CONF
NOTIFICATION-TYPE, Unsigned32, Gauge32, OBJECT-TYPE, MODULE-IDENTITYSNMPv2-SMI
TruthValue, TimeStamp, StorageType, RowStatus, RowPointerSNMPv2-TC
ciscoIpAddressPoolMIB.1.3.6.1.4.1.9.9.748
ciscoIpAddressPoolMIBNotifs .1.3.6.1.4.1.9.9.748.0
ciapEventThresholdRising .1.3.6.1.4.1.9.9.748.0.1
ciapEventThresholdFalling .1.3.6.1.4.1.9.9.748.0.2
ciscoIpAddressPoolMIBObjects .1.3.6.1.4.1.9.9.748.1
ciapGlobal .1.3.6.1.4.1.9.9.748.1.1
ciapGlobalNotifyEnable .1.3.6.1.4.1.9.9.748.1.1.1
ciapGlobalThresholdUnits .1.3.6.1.4.1.9.9.748.1.1.2
ciapGlobalThresholdRising .1.3.6.1.4.1.9.9.748.1.1.3
ciapGlobalThresholdFalling .1.3.6.1.4.1.9.9.748.1.1.4
ciapPools .1.3.6.1.4.1.9.9.748.1.2
ciapPoolIdNext .1.3.6.1.4.1.9.9.748.1.2.1
ciapPoolTable .1.3.6.1.4.1.9.9.748.1.2.2
ciapPoolEntry .1.3.6.1.4.1.9.9.748.1.2.2.1
ciapPoolId .1.3.6.1.4.1.9.9.748.1.2.2.1.1
ciapPoolAddressesInUse .1.3.6.1.4.1.9.9.748.1.2.2.1.10
ciapPoolAddressesFree .1.3.6.1.4.1.9.9.748.1.2.2.1.11
ciapPoolStatus .1.3.6.1.4.1.9.9.748.1.2.2.1.2
ciapPoolStorage .1.3.6.1.4.1.9.9.748.1.2.2.1.3
ciapPoolName .1.3.6.1.4.1.9.9.748.1.2.2.1.4
ciapPoolType .1.3.6.1.4.1.9.9.748.1.2.2.1.5
ciapPoolContainedIn .1.3.6.1.4.1.9.9.748.1.2.2.1.6
ciapPoolThresholdUnits .1.3.6.1.4.1.9.9.748.1.2.2.1.7
ciapPoolThresholdRising .1.3.6.1.4.1.9.9.748.1.2.2.1.8
ciapPoolThresholdFalling .1.3.6.1.4.1.9.9.748.1.2.2.1.9
ciapPoolTableChanged .1.3.6.1.4.1.9.9.748.1.2.3
ciapRangeTable .1.3.6.1.4.1.9.9.748.1.2.4
ciapRangeEntry .1.3.6.1.4.1.9.9.748.1.2.4.1
ciapRangeAddressType .1.3.6.1.4.1.9.9.748.1.2.4.1.1
ciapRangeThresholdRising .1.3.6.1.4.1.9.9.748.1.2.4.1.10
ciapRangeThresholdFalling .1.3.6.1.4.1.9.9.748.1.2.4.1.11
ciapRangeAddressesInUse .1.3.6.1.4.1.9.9.748.1.2.4.1.12
ciapRangeAddressesFree .1.3.6.1.4.1.9.9.748.1.2.4.1.13
ciapRangeAddressLower .1.3.6.1.4.1.9.9.748.1.2.4.1.2
ciapRangeStatus .1.3.6.1.4.1.9.9.748.1.2.4.1.3
ciapRangeStorage .1.3.6.1.4.1.9.9.748.1.2.4.1.4
ciapRangeAddressUpper .1.3.6.1.4.1.9.9.748.1.2.4.1.5
ciapRangeCacheSize .1.3.6.1.4.1.9.9.748.1.2.4.1.6
ciapRangeRecycleDelay .1.3.6.1.4.1.9.9.748.1.2.4.1.7
ciapRangePriority .1.3.6.1.4.1.9.9.748.1.2.4.1.8
ciapRangeThresholdUnits .1.3.6.1.4.1.9.9.748.1.2.4.1.9
ciapRangeTableChanged .1.3.6.1.4.1.9.9.748.1.2.5
ciapPrefixTable .1.3.6.1.4.1.9.9.748.1.2.6
ciapPrefixEntry .1.3.6.1.4.1.9.9.748.1.2.6.1
ciapPrefixType .1.3.6.1.4.1.9.9.748.1.2.6.1.1
ciapPrefixThresholdUnits .1.3.6.1.4.1.9.9.748.1.2.6.1.10
ciapPrefixThresholdRising .1.3.6.1.4.1.9.9.748.1.2.6.1.11
ciapPrefixThresholdFalling .1.3.6.1.4.1.9.9.748.1.2.6.1.12
ciapPrefixPrefixesInUse .1.3.6.1.4.1.9.9.748.1.2.6.1.13
ciapPrefixPrefixesFree .1.3.6.1.4.1.9.9.748.1.2.6.1.14
ciapPrefixAddress .1.3.6.1.4.1.9.9.748.1.2.6.1.2
ciapPrefixAddressMask .1.3.6.1.4.1.9.9.748.1.2.6.1.3
ciapPrefixStatus .1.3.6.1.4.1.9.9.748.1.2.6.1.4
ciapPrefixStorage .1.3.6.1.4.1.9.9.748.1.2.6.1.5
ciapPrefixAssignedLength .1.3.6.1.4.1.9.9.748.1.2.6.1.6
ciapPrefixCacheSize .1.3.6.1.4.1.9.9.748.1.2.6.1.7
ciapPrefixRecycleDelay .1.3.6.1.4.1.9.9.748.1.2.6.1.8
ciapPrefixPriority .1.3.6.1.4.1.9.9.748.1.2.6.1.9
ciapPrefixTableChanged .1.3.6.1.4.1.9.9.748.1.2.7
ciapPoolGroups .1.3.6.1.4.1.9.9.748.1.3
ciapPoolGroupIdNext .1.3.6.1.4.1.9.9.748.1.3.1
ciapPoolGroupTable .1.3.6.1.4.1.9.9.748.1.3.2
ciapPoolGroupEntry .1.3.6.1.4.1.9.9.748.1.3.2.1
ciapPoolGroupId .1.3.6.1.4.1.9.9.748.1.3.2.1.1
ciapPoolGroupName .1.3.6.1.4.1.9.9.748.1.3.2.1.2
ciapPoolGroupThresholdUnits .1.3.6.1.4.1.9.9.748.1.3.2.1.3
ciapPoolGroupThresholdRising .1.3.6.1.4.1.9.9.748.1.3.2.1.4
ciapPoolGroupThresholdFalling .1.3.6.1.4.1.9.9.748.1.3.2.1.5
ciapPoolGroupAddressesInUse .1.3.6.1.4.1.9.9.748.1.3.2.1.6
ciapPoolGroupAddressesFree .1.3.6.1.4.1.9.9.748.1.3.2.1.7
ciapPoolGroupContainsTable .1.3.6.1.4.1.9.9.748.1.3.3
ciapPoolGroupContainsEntry .1.3.6.1.4.1.9.9.748.1.3.3.1
ciapPoolGroupContainsId .1.3.6.1.4.1.9.9.748.1.3.3.1.1
ciapAllocatedAddresses .1.3.6.1.4.1.9.9.748.1.4
ciapAllocatedAddressTable .1.3.6.1.4.1.9.9.748.1.4.1
ciapAllocatedAddressEntry .1.3.6.1.4.1.9.9.748.1.4.1.1
ciapAllocatedAddressType .1.3.6.1.4.1.9.9.748.1.4.1.1.1
ciapAllocatedAddress .1.3.6.1.4.1.9.9.748.1.4.1.1.2
ciapAllocatedAddressMask .1.3.6.1.4.1.9.9.748.1.4.1.1.3
ciapNotifyData .1.3.6.1.4.1.9.9.748.1.5
ciapNotifyResource .1.3.6.1.4.1.9.9.748.1.5.1
ciapNotifyThresholdUnits .1.3.6.1.4.1.9.9.748.1.5.2
ciapNotifyThresholdRising .1.3.6.1.4.1.9.9.748.1.5.3
ciapNotifyThresholdFalling .1.3.6.1.4.1.9.9.748.1.5.4
ciapNotifyInUse .1.3.6.1.4.1.9.9.748.1.5.5
ciapNotifyFree .1.3.6.1.4.1.9.9.748.1.5.6
ciscoIpAddressPoolMIBConform .1.3.6.1.4.1.9.9.748.2
ciscoIpAddressPoolMIBCompliances .1.3.6.1.4.1.9.9.748.2.1
ciscoIpAddressPoolMIBGroups .1.3.6.1.4.1.9.9.748.2.2