CISCO-IP-LOCAL-POOL-MIB
- Registered at
- 1.3.6.1.4.1.9.9.326
- Last updated
- 2007-11-12 00:00
- Organization
- Cisco Systems, Inc.
- Revisions
- 2007-11-12 00:00, 2005-01-11 00:00, 2003-04-03 20:00
- Namespace
- cisco
- Source file
CISCO-IP-LOCAL-POOL-MIB- Digest
sha256:09dd4389352fdbc040bf6632366812442b6433f038fd4b88fdb7e98adab8b97b
Description
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.
Contact
Cisco Systems Customer Service Postal: 170 W Tasman Drive San Jose, CA 95134 USA Tel: +1 800 553-NETS E-mail: cs-snmp@cisco.com
Imports
| From | Symbols |
|---|---|
| CISCO-SMI | ciscoMgmt |
| IF-MIB | InterfaceIndexOrZero |
| INET-ADDRESS-MIB | InetAddress, InetAddressType |
| SNMP-FRAMEWORK-MIB | SnmpAdminString |
| SNMPv2-CONF | MODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUP |
| SNMPv2-SMI | Gauge32, MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-IDENTITY, OBJECT-TYPE, Unsigned32, iso |
| SNMPv2-TC | DisplayString, RowStatus, TEXTUAL-CONVENTION, TruthValue |
Imported by
Nothing in this corpus imports this module.
Load order
Every file a consumer needs in order to load this module, dependencies first.
CISCO-IP-LOCAL-POOL-MIB CISCO-SMI IANAifType-MIB IF-MIB INET-ADDRESS-MIB SNMP-FRAMEWORK-MIB SNMPv2-CONF SNMPv2-MIB SNMPv2-SMI SNMPv2-TC
Textual conventions
| Name | OID | Syntax | Access | Status |
|---|---|---|---|---|
| CIpLocalPoolGroupNameOrNull TEXTUAL-CONVENTION 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. | current | |||
| CIpLocalPoolName TEXTUAL-CONVENTION A non-empty string that uniquely identifies an IP local pool. | current | |||
| CIpLocalPoolPercentage TEXTUAL-CONVENTION A percentage associated with the addresses used in a IP local pool. | current |
Objects
| Name | OID | Syntax | Access | Status |
|---|---|---|---|---|
| ciscoIpLocalPoolMIBNotifs OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.0 | |||
| ciscoIpLocalPoolMIBObjects OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.1 | |||
| cIpLocalPoolConfig OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.1.1 | |||
| cIpLocalPoolNotificationsEnable OBJECT-TYPE An indication of whether the notifications defined by the ciscoIpLocalPoolNotifGroup are enabled. | 1.3.6.1.4.1.9.9.326.1.1.1 | TruthValue | read-write | current |
| cIpLocalPoolConfigTable OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.1.2 | not-accessible | current | |
| cIpLocalPoolConfigEntry OBJECT-TYPE Each entry provides information about a particular IP local pool, including the number of free and used addresses and its priority. | 1.3.6.1.4.1.9.9.326.1.1.2.1 | not-accessible | current | |
| cIpLocalPoolName OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.1.2.1.1 | CIpLocalPoolName | not-accessible | current |
| cIpLocalPoolAddrType OBJECT-TYPE This object specifies the address type of cIpLocalPoolAddressLo and cIpLocalPoolAddressHi. | 1.3.6.1.4.1.9.9.326.1.1.2.1.2 | InetAddressType | not-accessible | current |
| cIpLocalPoolAddressLo OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.1.2.1.3 | InetAddress | not-accessible | current |
| cIpLocalPoolAddressHi OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.1.2.1.4 | InetAddress | read-create | current |
| cIpLocalPoolFreeAddrs OBJECT-TYPE The number of IP addresses available for use in the range of IP addresses. | 1.3.6.1.4.1.9.9.326.1.1.2.1.5 | Gauge32 | read-only | current |
| cIpLocalPoolInUseAddrs OBJECT-TYPE The number of IP addresses being used in the range of IP addresses. | 1.3.6.1.4.1.9.9.326.1.1.2.1.6 | Gauge32 | read-only | current |
| cIpLocalPoolGroupContainedIn OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.1.2.1.7 | CIpLocalPoolGroupNameOrNull | read-create | current |
| cIpLocalPoolRowStatus OBJECT-TYPE This object facilitates the creation, or deletion of a conceptual row in this table. | 1.3.6.1.4.1.9.9.326.1.1.2.1.8 | RowStatus | read-create | current |
| cIpLocalPoolPriority OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.1.2.1.9 | Unsigned32 (1..255) | read-create | current |
| cIpLocalPoolGroup OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.1.2 | |||
| cIpLocalPoolGroupContainsTable OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.2.1 | not-accessible | current | |
| cIpLocalPoolGroupContainsEntry OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.2.1.1 | not-accessible | current | |
| cIpLocalPoolGroupName OBJECT-TYPE A unique group name that identifies the IP pool group. The null string represents the base IP pool group. | 1.3.6.1.4.1.9.9.326.1.2.1.1.1 | CIpLocalPoolGroupNameOrNull | not-accessible | current |
| cIpLocalPoolChildIndex OBJECT-TYPE The value of cIpLocalPoolName for the contained IP local pool. | 1.3.6.1.4.1.9.9.326.1.2.1.1.2 | CIpLocalPoolName | read-only | current |
| cIpLocalPoolGroupTable OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.2.2 | not-accessible | current | |
| cIpLocalPoolGroupEntry OBJECT-TYPE Each entry provides information about a particular IP pool group and the number of free and used addresses in an IP pool group. | 1.3.6.1.4.1.9.9.326.1.2.2.1 | not-accessible | current | |
| cIpLocalPoolGroupFreeAddrs OBJECT-TYPE The number of IP addresses available for use in the IP pool group. | 1.3.6.1.4.1.9.9.326.1.2.2.1.1 | Gauge32 | read-only | current |
| cIpLocalPoolGroupInUseAddrs OBJECT-TYPE The number of IP addresses that have been allocated from the IP pool group. | 1.3.6.1.4.1.9.9.326.1.2.2.1.2 | Gauge32 | read-only | current |
| cIpLocalPoolStats OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.1.3 | |||
| cIpLocalPoolStatsTable OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.1 | not-accessible | current | |
| cIpLocalPoolStatsEntry OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.1.1 | not-accessible | current | |
| cIpLocalPoolStatFreeAddrs OBJECT-TYPE The number of IP addresses available for use in this IP local pool. | 1.3.6.1.4.1.9.9.326.1.3.1.1.1 | Gauge32 | read-only | current |
| cIpLocalPoolStatInUseAddrs OBJECT-TYPE The number of IP addresses being used in this IP local pool. | 1.3.6.1.4.1.9.9.326.1.3.1.1.2 | Gauge32 | read-only | current |
| cIpLocalPoolStatHiWaterUsedAddrs OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.1.1.3 | Unsigned32 | read-write | current |
| cIpLocalPoolStatInUseAddrThldLo OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.1.1.4 | Unsigned32 (0..4294967295) | read-write | current |
| cIpLocalPoolStatInUseAddrThldHi OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.1.1.5 | Unsigned32 (0..4294967295) | read-write | current |
| cIpLocalPoolPercentAddrThldLo OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.1.1.6 | CIpLocalPoolPercentage | read-write | current |
| cIpLocalPoolPercentAddrThldHi OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.1.1.7 | CIpLocalPoolPercentage | read-write | current |
| cIpLocalPoolAllocTable OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.2 | not-accessible | current | |
| cIpLocalPoolAllocEntry OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.2.1 | not-accessible | current | |
| cIpLocalPoolAllocAddrType OBJECT-TYPE This object specifies the address type of cIpLocalPoolAllocAddr. | 1.3.6.1.4.1.9.9.326.1.3.2.1.1 | InetAddressType | not-accessible | current |
| cIpLocalPoolAllocAddr OBJECT-TYPE This object specifies the allocated IP address. The address type of this object is described by cIpLocalPoolAllocAddrType. | 1.3.6.1.4.1.9.9.326.1.3.2.1.2 | InetAddress | not-accessible | current |
| cIpLocalPoolAllocIfIndex OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.2.1.3 | InterfaceIndexOrZero | read-only | current |
| cIpLocalPoolAllocUser OBJECT-TYPE 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. | 1.3.6.1.4.1.9.9.326.1.3.2.1.4 | SnmpAdminString | read-only | current |
| ciscoIpLocalPoolMIBConform OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.2 | |||
| ciscoIpLocalPoolMIBCompliances OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.2.1 | |||
| ciscoIpLocalPoolMIBGroups OBJECT-IDENTITY | 1.3.6.1.4.1.9.9.326.2.2 |
Notifications
| Name | OID | Status |
|---|---|---|
| ciscoIpLocalPoolInUseAddrNoti NOTIFICATION-TYPE A notification indicating that number of used addresses of an IP local pool exceeded the threshold value indicated by cIpLocalPoolStatInUseAddrThldHi. | 1.3.6.1.4.1.9.9.326.0.1 | current |
| cilpPercentAddrUsedLoNotif NOTIFICATION-TYPE A notification indicating that the percentage of used addresses of an IP local pool went below the threshold value indicated by cIpLocalPoolPercentAddrThldLo. | 1.3.6.1.4.1.9.9.326.0.2 | current |
| cilpPercentAddrUsedHiNotif NOTIFICATION-TYPE 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. | 1.3.6.1.4.1.9.9.326.0.3 | current |
Conformance
| Name | OID | Status |
|---|---|---|
| ciscoIpLocalPoolMIBCompliance MODULE-COMPLIANCE The compliance statement for entities which implement the Cisco IP Local Pool MIB. | 1.3.6.1.4.1.9.9.326.2.1.1 | deprecated |
| ciscoIpLocalPoolMIBCompliance1 MODULE-COMPLIANCE The compliance statement for entities which implement the Cisco IP Local Pool MIB. | 1.3.6.1.4.1.9.9.326.2.1.2 | deprecated |
| ciscoIpLocalPoolMIBCompliance2 MODULE-COMPLIANCE The compliance statement for entities which implement the Cisco IP Local Pool MIB. | 1.3.6.1.4.1.9.9.326.2.1.3 | current |
| ciscoIpLocalPoolConfigGroup OBJECT-GROUP Objects for providing configuration for IP local pools. | 1.3.6.1.4.1.9.9.326.2.2.1 | current |
| ciscoIpLocalPoolGroupGroup OBJECT-GROUP Objects for providing configuration for IP local pools. | 1.3.6.1.4.1.9.9.326.2.2.2 | current |
| ciscoIpLocalPoolStatsGroup OBJECT-GROUP Objects for providing IP local pool statistics and status. | 1.3.6.1.4.1.9.9.326.2.2.3 | current |
| ciscoIpLocalPoolNotifGroup NOTIFICATION-GROUP The collection of notifications used for monitoring IP local pool utilization. | 1.3.6.1.4.1.9.9.326.2.2.4 | current |
| ciscoIpLocalPoolStatsGroupSup1 OBJECT-GROUP Supplemental objects for providing IP local pool statistics and status. | 1.3.6.1.4.1.9.9.326.2.2.5 | current |
| ciscoIpLocalPoolNotifGroupSup1 NOTIFICATION-GROUP The collection of suplemantal notifications used for monitoring IP local pool utilization. | 1.3.6.1.4.1.9.9.326.2.2.6 | current |
| ciscoIpLocalPoolPriorityGroup OBJECT-GROUP A collection of object which provides priority configuration of IP local pools. | 1.3.6.1.4.1.9.9.326.2.2.7 | current |