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.
    
Source file
CISCO-IP-ADDRESS-POOL-MIB
Last revised
Identity
ciscoIpAddressPoolMIB
Base OID
1.3.6.1.4.1.9.9.748
Net-SNMP examples using the cisco MIB directory Show commands

These commands use the standard Observium installation path and load the selected MIB variant before the RFC and Net-SNMP directories.

Translate the module identity
/usr/bin/snmptranslate -Pud -Ir -On -m 'CISCO-IP-ADDRESS-POOL-MIB' -M '/opt/observium/mibs/cisco:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'CISCO-IP-ADDRESS-POOL-MIB::ciscoIpAddressPoolMIB'
Walk the MIB subtree
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'CISCO-IP-ADDRESS-POOL-MIB' -M '/opt/observium/mibs/cisco:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'CISCO-IP-ADDRESS-POOL-MIB::ciscoIpAddressPoolMIB'
How SNMP, Net-SNMP, MIB paths, and variants work
Objects (87)
.1.3.6.1.4.1.9.9.748
.1.3.6.1.4.1.9.9.748.0
.1.3.6.1.4.1.9.9.748.1
.1.3.6.1.4.1.9.9.748.1.1
.1.3.6.1.4.1.9.9.748.1.1.1
.1.3.6.1.4.1.9.9.748.1.1.2
Unsigned32
.1.3.6.1.4.1.9.9.748.1.1.3
Unsigned32
.1.3.6.1.4.1.9.9.748.1.1.4
.1.3.6.1.4.1.9.9.748.1.2
.1.3.6.1.4.1.9.9.748.1.2.1
.1.3.6.1.4.1.9.9.748.1.2.2
.1.3.6.1.4.1.9.9.748.1.2.2.1
.1.3.6.1.4.1.9.9.748.1.2.2.1.1
IP addresses/prefixesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.2.2.1.10
IP addresses/prefixesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.2.2.1.11
.1.3.6.1.4.1.9.9.748.1.2.2.1.2
.1.3.6.1.4.1.9.9.748.1.2.2.1.3
.1.3.6.1.4.1.9.9.748.1.2.2.1.4
Enumeration
.1.3.6.1.4.1.9.9.748.1.2.2.1.5
.1.3.6.1.4.1.9.9.748.1.2.2.1.6
.1.3.6.1.4.1.9.9.748.1.2.2.1.7
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.2.1.8
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.2.1.9
.1.3.6.1.4.1.9.9.748.1.2.3
.1.3.6.1.4.1.9.9.748.1.2.4
.1.3.6.1.4.1.9.9.748.1.2.4.1
.1.3.6.1.4.1.9.9.748.1.2.4.1.1
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.4.1.10
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.4.1.11
IP addressesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.2.4.1.12
IP addressesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.2.4.1.13
OctetString
.1.3.6.1.4.1.9.9.748.1.2.4.1.2
.1.3.6.1.4.1.9.9.748.1.2.4.1.3
.1.3.6.1.4.1.9.9.748.1.2.4.1.4
.1.3.6.1.4.1.9.9.748.1.2.4.1.5
IP addressesUnsigned32
.1.3.6.1.4.1.9.9.748.1.2.4.1.6
secondsUnsigned32
.1.3.6.1.4.1.9.9.748.1.2.4.1.7
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.4.1.8
.1.3.6.1.4.1.9.9.748.1.2.4.1.9
.1.3.6.1.4.1.9.9.748.1.2.5
.1.3.6.1.4.1.9.9.748.1.2.6
.1.3.6.1.4.1.9.9.748.1.2.6.1
.1.3.6.1.4.1.9.9.748.1.2.6.1.1
.1.3.6.1.4.1.9.9.748.1.2.6.1.10
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.6.1.11
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.6.1.12
.1.3.6.1.4.1.9.9.748.1.2.6.1.13
.1.3.6.1.4.1.9.9.748.1.2.6.1.14
OctetString
.1.3.6.1.4.1.9.9.748.1.2.6.1.2
OctetString
.1.3.6.1.4.1.9.9.748.1.2.6.1.3
.1.3.6.1.4.1.9.9.748.1.2.6.1.4
.1.3.6.1.4.1.9.9.748.1.2.6.1.5
.1.3.6.1.4.1.9.9.748.1.2.6.1.6
IP prefixesUnsigned32
.1.3.6.1.4.1.9.9.748.1.2.6.1.7
secondsUnsigned32
.1.3.6.1.4.1.9.9.748.1.2.6.1.8
Unsigned32
.1.3.6.1.4.1.9.9.748.1.2.6.1.9
.1.3.6.1.4.1.9.9.748.1.2.7
.1.3.6.1.4.1.9.9.748.1.3
.1.3.6.1.4.1.9.9.748.1.3.1
.1.3.6.1.4.1.9.9.748.1.3.2
.1.3.6.1.4.1.9.9.748.1.3.2.1
.1.3.6.1.4.1.9.9.748.1.3.2.1.1
.1.3.6.1.4.1.9.9.748.1.3.2.1.2
.1.3.6.1.4.1.9.9.748.1.3.2.1.3
Unsigned32
.1.3.6.1.4.1.9.9.748.1.3.2.1.4
Unsigned32
.1.3.6.1.4.1.9.9.748.1.3.2.1.5
IP addresses/prefixesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.3.2.1.6
IP addresses/prefixesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.3.2.1.7
.1.3.6.1.4.1.9.9.748.1.3.3
.1.3.6.1.4.1.9.9.748.1.3.3.1
.1.3.6.1.4.1.9.9.748.1.3.3.1.1
.1.3.6.1.4.1.9.9.748.1.4
.1.3.6.1.4.1.9.9.748.1.4.1
.1.3.6.1.4.1.9.9.748.1.4.1.1
.1.3.6.1.4.1.9.9.748.1.4.1.1.1
OctetString
.1.3.6.1.4.1.9.9.748.1.4.1.1.2
OctetString
.1.3.6.1.4.1.9.9.748.1.4.1.1.3
.1.3.6.1.4.1.9.9.748.1.5
.1.3.6.1.4.1.9.9.748.1.5.1
.1.3.6.1.4.1.9.9.748.1.5.2
Unsigned32
.1.3.6.1.4.1.9.9.748.1.5.3
Unsigned32
.1.3.6.1.4.1.9.9.748.1.5.4
IP addresses/prefixesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.5.5
IP addresses/prefixesSNMPv2-SMIGauge32
.1.3.6.1.4.1.9.9.748.1.5.6
.1.3.6.1.4.1.9.9.748.2
.1.3.6.1.4.1.9.9.748.2.1
.1.3.6.1.4.1.9.9.748.2.2
Dependencies (6) 6 direct Show tree and compile order Hide dependency details

Each imported module is resolved in the importing module's source directory first, then through the normal default-variant rules.

Dependency tree
Conformance Groups (7)
This group contains objects describing data that applies to the
IP address pool manager as a whole.
.1.3.6.1.4.1.9.9.748.2.2.1
This group contains objects describing IP address pools.
.1.3.6.1.4.1.9.9.748.2.2.2
This group contains objects describing IP addresses comprising
an IP address pool.
.1.3.6.1.4.1.9.9.748.2.2.3
This group contains objects describing IP prefixes comprising
an IP address pool.
.1.3.6.1.4.1.9.9.748.2.2.4
This group contains objects describing IP address pool groups.
.1.3.6.1.4.1.9.9.748.2.2.5
This group contains objects describing data conveyed by
notifications defined by this MIB module.
.1.3.6.1.4.1.9.9.748.2.2.6
This group contains notifications used to indicate threshold
crossing events relating to ranges of IP addresses.
.1.3.6.1.4.1.9.9.748.2.2.7
Compliance Statements (1)

OID .1.3.6.1.4.1.9.9.748.2.1.1
This compliance statement specifies the minimal requirements an
implementation must meet in order to claim full compliance with
the definition of the CISCO-IP-ADDRESS-POOL-MIB.
Required groups
mandatory ciapGlobalGroup
mandatory ciapPoolGroup
mandatory ciapRangeGroup
mandatory ciapPoolGroupGroup
mandatory ciapNotifDataGroup
mandatory ciapNotifsGroup
optional ciapPrefixGroup This group is mandatory only for those implementations that
support IP prefix pools.
Object refinements
ObjectAccessSyntaxDescription
ciapGlobalNotifyEnable readonly
An implementation must at least provide read-only access to
this object.
ciapGlobalThresholdUnits readonly
An implementation must at least provide read-only access to
this object.
ciapGlobalThresholdRising readonly
An implementation must at least provide read-only access to
this object.
ciapGlobalThresholdFalling readonly
An implementation must at least provide read-only access to
this object.
ciapPoolName readonly
An implementation must at least provide read-only access to
this object.
ciapPoolStatus readonly
An implementation must at least provide read-only access to
this object.
ciapPoolStorage readonly
An implementation must at least provide read-only access to
this object.
ciapPoolType readonly
An implementation must at least provide read-only access to
this object.
ciapPoolContainedIn readonly
An implementation must at least provide read-only access to
this object.
ciapPoolThresholdUnits readonly
An implementation must at least provide read-only access to
this object.
ciapPoolThresholdRising readonly
An implementation must at least provide read-only access to
this object.
ciapPoolThresholdFalling readonly
An implementation must at least provide read-only access to
this object.
ciapRangeStatus readonly
An implementation must at least provide read-only access to
this object.
ciapRangeStorage readonly
An implementation must at least provide read-only access to
this object.
ciapRangeAddressUpper readonly
An implementation must at least provide read-only access to
this object.
ciapRangeCacheSize readonly
An implementation must at least provide read-only access to
this object.
ciapRangeRecycleDelay readonly
An implementation must at least provide read-only access to
this object.
ciapRangePriority readonly
An implementation must at least provide read-only access to
this object.
ciapRangeThresholdUnits readonly
An implementation must at least provide read-only access to
this object.
ciapRangeThresholdRising readonly
An implementation must at least provide read-only access to
this object.
ciapRangeThresholdFalling readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixStatus readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixStorage readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixAssignedLength readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixCacheSize readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixRecycleDelay readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixPriority readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixThresholdUnits readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixThresholdRising readonly
An implementation must at least provide read-only access to
this object.
ciapPrefixThresholdFalling readonly
An implementation must at least provide read-only access to
this object.
ciapPoolGroupThresholdUnits readonly
An implementation must at least provide read-only access to
this object.
ciapPoolGroupThresholdRising readonly
An implementation must at least provide read-only access to
this object.
ciapPoolGroupThresholdFalling readonly
An implementation must at least provide read-only access to
this object.
Notifications / Traps (2)
NameOIDDescription
.1.3.6.1.4.1.9.9.748.0.1
The system generates this notification when the IP address pool
manager transitions the state of the in-use gauge associated
with a resource from 'Off' to 'On'.

For more detail, see the description of IP address pool
threshold monitoring provided by the descriptive text associated
with the MODULE-IDENTITY statement.
.1.3.6.1.4.1.9.9.748.0.2
The system generates this notification when the IP address pool
manager transitions the state of the in-use gauge associated
with a resource from 'On' to 'Off'.

For more detail, see the description of IP address pool
threshold monitoring provided by the descriptive text associated
with the MODULE-IDENTITY statement.