2007-10-16
The MIB module for managing the running image level of a Cisco device. Cisco's licensing mechanism provides flexibility to run a device on a chosen image level. This mechanism is referred to as image level licensing. Image level licensing leverages the universal image based licensing solution. The image level licensing mechanism works as follows - A universal image that contains all levels of software packages is loaded on to the device. At boot time, the device determines the highest level of license and brings up the appropriate software features or subsystems. The user can configure the image level with which the device has to boot. The system will verify whether the appropriate license is available for the configured image level. The image level for the next boot will be determined based on the availability of the license. The following scenarios explains some use-cases of image level licensing: Scenario 1: - Customer selects advsecurityk9 based image. - Manufacturing installs advsecurity license on the device. - This device will run all features that are part of the base advsecurity license. - Customer upgrades to advipservicesk9 license. - The next boot level is set to advipservicesk9. - The device will run advsecurityk9 feature until the next reboot. After reboot the device will run advipservicesk9 features. Scenario 2: - Customer selects advipservicesk9 based image. - Manufacturing installs advipservices and advsecurity license on the device. - This device will run all features that are part of the base advipservices license. - No upgrades available for advipservices license. The user has to accept the End User License Agreement(EULA) before using this MIB to configure the image level. This MIB should be used in conjuntion with CISCO-LICENSE-MGMT-MIB module to achieve the image level licensing functionality. This MIB module defines objects which provides the different image levels supported by the device and the license required to enable a particular image level. It also defines objects to let the user configure the required image level. The MIB module contains notification which will be triggered when the user changes the image level for next boot. The CISCO-LICENSE-MGMT-MIB module should be used to export the EULA and to configure the required license. This MIB module is defined generically so it can be used for both stand-alone as well as stackable devices. The entPhysicalIndex imported from ENTITY-MIB is used to identify the device uniquely.
Download CISCO-IMAGE-LICENSE-MGMT-MIB.txt Open CISCO-IMAGE-LICENSE-MGMT-MIB.txt in a new tab
SCALARS (2) · TABLES (2) · TRAPS (1)
| Name | OID |
|---|---|
| cilmEULAAccepted | 1.3.6.1.4.1.9.9.640.1.3 |
| cilmImageLevelChangedNotif | 1.3.6.1.4.1.9.9.640.1.4.1 |
| Name | OID |
|---|---|
| cilmBootImageLevelTable | 1.3.6.1.4.1.9.9.640.1.1 |
| cilmImageLevelToLicenseMapTable | 1.3.6.1.4.1.9.9.640.1.2 |
| Name | OID |
|---|---|
| cilmBootImageLevelChanged | 1.3.6.1.4.1.9.9.640.0.1 |
END OF TOC
1.3.6.1.4.1.9.9.640.1.3
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object when set to TRUE means that the user has accepted the END USER LICENSE AGREEMENT. This object has to be set to TRUE by the user before using the objects in the cilmBootImageLevelTable to configure the license.
1.3.6.1.4.1.9.9.640.1.4.1
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
Reference: See also RFC3413 for explanation that notifications are under the ultimate control of the MIB module in this document.
Specify whether or not a notification should be generated on the detection of change in next boot image level. If set to TRUE, cilmBootImageLevelChanged notification will be generated. It is the responsibility of the management entity to ensure that the SNMP administrative model is configured in such a way as to allow the notification to be delivered.
1.3.6.1.4.1.9.9.640.1.1
Index: entPhysicalIndex · cilmModuleName
A table that contains the configuration information of current and next boot image level. This table contains entries for each software module running in an image loaded in the device. The software module is identified by cilmModuleName and the device is identified by entPhysicalIndex.
from ENTITY-MIB
PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d
The index for this entry.
1.3.6.1.4.1.9.9.640.1.1.1.1
SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object is used as one of the two indices in cilmBootImageLevelTable. This object indicates the module name of the software package. There can be multiple modules in an image performing specific functionality. For example, in a wireless image there can be two modules - a base image module and a wireless module.
1.3.6.1.4.1.9.9.640.1.1.1.2
BootImageLevelThis textual convention is used to define the image level. If the device is running at advipservices image level, then the boot image level will be 'advipservices'. SIZE (0..255) · OCTET STRING
This object indicates the current image level that the module is running.
1.3.6.1.4.1.9.9.640.1.1.1.3
BootImageLevelThis textual convention is used to define the image level. If the device is running at advipservices image level, then the boot image level will be 'advipservices'. SIZE (0..255) · OCTET STRING
This object indicates the configured image level of the module for the next boot. Note: The configured next boot image level may not be the actual next boot image level. The actual next boot image level is denoted by cilmNextBootImageLevel which is determined based on the license availability.
1.3.6.1.4.1.9.9.640.1.1.1.4
BootImageLevelThis textual convention is used to define the image level. If the device is running at advipservices image level, then the boot image level will be 'advipservices'. SIZE (0..255) · OCTET STRING
This object indicates the next boot image level. The next boot image level can be different from configured level. The next boot image level is determined based on the availability of required license.
1.3.6.1.4.1.9.9.640.1.1.1.5
Unsigned32
This object indicates the license store index where the currently used license is stored. This object has the same value as clmgmtLicenseStoreIndex object and uniquely identifies an entry in clmgmtLicenseStoreInfoTable in CISCO-LICENSE-MGMT-MIB. Note: The license store index can be '0' if no license is installed and device is running base image.
1.3.6.1.4.1.9.9.640.1.1.1.6
Unsigned32
This object indicates the license index of the currently used license. This object has the same value as clmgmtLicenseIndex and uniquely identifies an entry in clmgmtLicenseInfoTable in CISCO-LICENSE-MGMT-MIB. Note: The license index can be '0' if no license is installed and device is running base image.
1.3.6.1.4.1.9.9.640.1.1.1.7
Unsigned32
This object indicates the license store index where the next boot license is stored. This object has the same value as clmgmtLicenseStoreIndex object and uniquely identifies an entry in clmgmtLicenseStoreInfoTable in CISCO-LICENSE-MGMT-MIB. Note: The license store index can be '0' if no license is installed for the next boot.
1.3.6.1.4.1.9.9.640.1.1.1.8
Unsigned32
This object indicates the license index of the next boot license. This object has the same value as clmgmtLicenseIndex and uniquely identifies an entry in clmgmtLicenseInfoTable in CISCO-LICENSE-MGMT-MIB. Note: The license index can be '0' if no license is installed for the next boot.
1.3.6.1.4.1.9.9.640.1.2
Index: entPhysicalIndex · cilmModuleName · cilmImageLicenseMapIndex
This table contains the mapping between different image levels of each modules in the image and the license required to run the modules at a particular image level. This table can be used to identify the different image levels and the appropriate licenses required for each.
from ENTITY-MIB
PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d
The index for this entry.
1.3.6.1.4.1.9.9.640.1.2.1.1
Unsigned32
This is a running index used to identify an entry of this table.
1.3.6.1.4.1.9.9.640.1.2.1.2
BootImageLevelThis textual convention is used to define the image level. If the device is running at advipservices image level, then the boot image level will be 'advipservices'. SIZE (0..255) · OCTET STRING
This object indicates the image level at which a module can be run. A module can be run at different image levels. An entry will be created in this table for every module and image level combination.
1.3.6.1.4.1.9.9.640.1.2.1.3
LicenseNameListThis textual convention is used to define the list of license names. If multiple licenses are present then this string will contain all the licenses seperated by the ',' character. If the license required to run a device at advipservices image level is advipservices and advsecurity, then the license name list will be 'advipservices,advsecurity'. SIZE (0..255) · OCTET STRING
This object indicates the list of licenses needed to be installed for the module to run at the image level mentioned by cilmImageLicenseImageLevel object of this entry.
1.3.6.1.4.1.9.9.640.1.2.1.4
Unsigned32 (1..255)
This object indicates the priority of the image level mentioned by cilmImageLicenseImageLevel object of this entry. The image level with the highest priority license will be considered as the default level in the absense of next boot image level configuration. For example if there are three licenses l1, l2 and l3 in the ascending order of priority, then by default l1 will be the level at which the module will be running. If the next boot level is configured then the configuration will override the priority. The highest priority license supports a feature set which is a super set of all other licenses.
1.3.6.1.4.1.9.9.640.0.1
This notification is triggered when next boot image level is changed in the management entity. The current and configured image level are indicated by cilmCurrentImageLevel and cilmConfiguredBootImageLevel objects respectively.
1.3.6.1.4.1.9.9.640.1.1.1.2
BootImageLevelThis textual convention is used to define the image level. If the device is running at advipservices image level, then the boot image level will be 'advipservices'. SIZE (0..255) · OCTET STRING
This object indicates the current image level that the module is running.
1.3.6.1.4.1.9.9.640.1.1.1.3
BootImageLevelThis textual convention is used to define the image level. If the device is running at advipservices image level, then the boot image level will be 'advipservices'. SIZE (0..255) · OCTET STRING
This object indicates the configured image level of the module for the next boot. Note: The configured next boot image level may not be the actual next boot image level. The actual next boot image level is denoted by cilmNextBootImageLevel which is determined based on the license availability.