CISCO-LICENSE-MGR-MIB

TEXTUAL-CONVENTION

This textual convention identifies the license type and the license that can be acquired on. portActivation(1) - License for port activation for ports with port speed 1/2/4G. This is per interface. portActivation10G(2) - License for port activation for ports with port speed 10G. This is per interface.

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-TYPE

This object contains the 'License hostid' of the local system. Its value is an opaque string, and is used to identify the local system when requesting license(s) for this system.

OBJECT-TYPE

This object indicates whether the system should generate notifications specified in 'clmNotificationGroup' or not.

OBJECT-IDENTITY

OBJECT-TYPE

This object is used to facilitate modification of clmLicenseFileURI, clmLicenseFileTargetName and clmLicenseConfigCommand objects by multiple managers. The procedure for modifying the above three objects are as follows: 1. Determine new values for clmLicenseFileURI, clmLicenseFileTargetName and clmLicenseConfigCommand. 2. Retrieve the value of clmLicenseConfigSpinLock. 3. Set the value of clmLicenseConfigSpinLock to the retrieved value, and (in the same PDU) the value of clmLicenseFileURI to the new value. If the set fails for the clmLicenseConfigSpinLock object, go back to step 2. 4. Set the value of clmLicenseConfigSpinLock to the retrieved value incremented by one, and (in the same PDU) the value of clmLicenseFileTargetName to its new value. If the set fails for clmLicenseConfigSpinLock, go back to step 2. 5. Set the value of clmLicenseConfigSpinLock to the retrieved value incremented by two, and (in the same PDU) the value of clmLicenseConfigCommand to 'install' or 'uninstall' or 'update'. If the set fails for clmLicenseConfigSpinLock, go back to step 2. Note that if it's possible to include clmLicenseFileTargetName and/or clmLicenseConfigCommand in the (Set Request) PDU of an earlier step, then step 4 and/or 5, can be eliminated.

OBJECT-TYPE

This object represents the location on the local system, from which the license file will be picked for installation or updating. User should have copied the license file provided by CISCO-CCO , by some other means ( for example, thru CLI) to this location. For example, the value of this object could be 'bootflash:licfile1.lic'. This object MUST be set to a valid value before or concurrently with setting the value of the clmLicenseConfigCommand object to 'install' or 'update'. For uninstall operation the value of this object is not considered, it is irrelevant.

OBJECT-TYPE

This object represents the name with which the license file will be installed, or the name of the license file for uninstall, or the name of the license file to be updated. For 'uninstall' operation, this object must be set to the appropriate value, i.e., a non-zero length string, before or concurrently with setting the value of clmLicenseConfigCommand object to 'uninstall'. For 'install' operation, this object is set either to the file name with which the license will be installed, or to the zero-length string. In the latter case, the filename specified through clmLicenseFileURI will be used for installing the license. For example, if the value of clmLicenseFileURI object is set to 'bootflash:licfile1.lic' and this object is set to 'target1.lic', then the license will be installed with the filename 'target1.lic'. If this object contains zero length string then license will be installed with the filename 'licfile1.lic'. For 'update' operation, this object is set either to the file name which is to be updated (overwritten), or to the zero-length string. In the latter case, the filename specified through clmLicenseFileURI, will be updated. For example, if the value of clmLicenseFileURI object is set to 'bootflash:licfile2.lic' and this object is set to 'target2.lic', then the already installed license file 'target2.lic' will be updated by the contents of 'bootflash:licfile2.lic'. If this object contains zero length string then the already installed license file 'licfile2.lic' will be updated with the contents of 'bootflash:licfile2.lic'.

OBJECT-TYPE

The command to be executed. Command Remarks install Installs the license file specified thru the clmLicenseFileURI on the system, also performs some verification on the license file before installing. uninstall Uninstalls the license file specified in the clmLicenseFileTargetName object. noOp no operation will be performed. update Updates (Overwrites) an already installed license file. The value of this object when read is always 'noOp'.

OBJECT-TYPE

The status of the license install / uninstall / update operation. success (1) - install/uninstall/update operation completed successfully. inProgress (2) - License install/uninstall/update operation is in progress. corruptedLicenseFile (3) - License file content is Invalid/Corrupted. targetLicenseFileAlreadyExist (4) - Target license file name already exist. invalidLicenseFileName (5) - Invalid license file target name for install / uninstall operation. duplicateLicense (6) - License file is already installed. licenseInUse (7) - Can't uninstall a license file which is in use. generalLicensingFailure (8) - General error from license Manager. none (9) - no install/uninstall/update operation is performed. licenseExpiryConflict(10) - License exists for the feature. invalidLicenseCount(11) - License count is invalid for the feature. notThisHost (12) - License host-id in the license file doesn't match. licenseInGraceExceeded (13) - Number of licenses in grace period is more than the number in install license file. licenseFileNotFound (14) - License file not found, for install / uninstall / update operation. licenseFileMissing (15) - A previously installed license file is found missing. invalidLicenseFileExtension (16) - License file does not have a .lic extension. invalidURI (17) - Invalid license file URI, specified for install operation. noDemoLicenseSupport (18) - Demo License Not Supported. invalidPlatform (19) - Invalid Platform. licenseServerBusy (20) - License server is busy. Retry in a few seconds. invalidLicenseFeature (21) - Invalid license feature. noFeatureSupport (22) - License server does not support this feature. emptyLicenseFile (23) - License file has no features. invalidServerLine (24) - SERVER line in license file should have 'this_host ANY'. invalidVendorLine (25) - VENDOR line in license should have 'cisco'. invalidLicFilenameSize (26) - If filename size exceeds 30 chars. permanetLicenseExpiryConflict (27) - Permanent license exists for feature.

OBJECT-TYPE

This object is used to facilitate modification of clmLicenseRequestFeatureName , clmLicenseRequestAppName and clmLicenseRequestCommand objects by multiple managers. The procedure for modifying the above three objects are as follows: 1. Determine new values for clmLicenseRequestFeatureName, clmLicenseRequestAppName and clmLicenseConfigCommand. 2. Retrieve the value of clmLicenseRequestSpinLock. 3. Set the value of clmLicenseRequestSpinLock to the retrieved value, and (in the same PDU) the value of clmLicenseRequestFeatureName to the new value. If the set fails for the clmLicenseRequestSpinLock object, go back to step 2. 4. Set the value of clmLicenseRequestSpinLock to the retrieved value incremented by one, and (in the same PDU) the value of clmLicenseRequestAppName to its new value. If the set fails for clmLicenseRequestSpinLock, go back to step 2. 5. Set the value of clmLicenseRequestSpinLock to the retrieved value incremented by two, and (in the same PDU) the value of clmLicenseRequestCommand to 'checkIn' or 'checkOut'. If the set fails for clmLicenseRequestSpinLock, go back to step 2. Note that if it's possible to include clmLicenseRequestAppName and/or clmLicenseRequestCommand in the (Set Request) PDU of an earlier step, then step 4 and/or 5, can be eliminated.

OBJECT-TYPE

This object represents the licensed feature name, requested for checkin / checkout a license. This object MUST be set to a valid value before or concurrently with setting the value of the clmLicenseRequestCommand object to 'checkIn' or 'checkOut'.

OBJECT-TYPE

This object is used to optionally associate an ID with a license checkin/checkout request for the feature name specified in the 'clmLicenseRequestFeatureName' object. The application can choose to set a meaningful name for this object. If 2 requests have the same value for clmLicenseRequestAppName then they are treated as same requests. If this object is not set or contains zero length string then each checkin/checkout request is treated as a distinct request.

OBJECT-TYPE

The command to be executed. Command Remarks checkIn checkin a license for the feature name specified thru 'clmLicenseRequestFeatureName' object. checkOut checkout a license for the feature name specified thru 'clmLicenseRequestFeatureName' object. noOp no operation will be performed. The value of this object when read is always 'noOp'.

OBJECT-TYPE

The status of the license checkin/checkout operation. success (1) - license checkin/checkout operation completed successfully. none (2) - no license checkin/checkout operation is performed. licenseDenied (3) - No license available for the requested feature. licenseTooMany (4) - license count exceed for counted license. generalLicensingFailure (5) - General error from license Manager. invalidFeature (6) - Invalid license feature. licenseExpired (7) - License expired. licenseServerDown (8) - License server down. .

OBJECT-IDENTITY

OBJECT-TYPE

This object represents the number of license files currently installed on this system.

OBJECT-TYPE

Contains information about all the license files installed on the system. License file is a 'textual file' provided by the CISCO-CCO, when the user buys the license. This file contains licensing details for one or more 'Feature License'. 'Feature License' is the specification of the permission to use a particular feature. The following attributes are specified in the 'Feature License' FEATURE - specifies the license feature name. HOSTID - specifies the hostid of the system, where the feature has to be used. For Demo license, 'HOSTID' is specified as 'HOSTID=DEMO'. permanent - specifies permanent license. uncounted- specifies the uncounted license for this feature. For counted license, instead of the attribute 'uncounted' , a number indicating the 'maximum number of concurrent usages' of this license feature is specified. The date specified in the 'Feature License', indicates the expiry date of this license feature. Other attributes in the license file are irrelevant to the user. Example: 1 - A Demo license file contents # An example ficon license FEATURE ficon cisco 1.00 31-aug-2003 uncounted HOSTID=DEMO\ SIGN=95D7C8860EE0 Example: 2 - A Permanent license file contents SERVER this_host ANY VENDOR cisco # An example fcports license FEATURE fcports cisco 1.00 permanent 30 HOSTID=VDH=4C0A3364\ SIGN=C3ACA6D831D6 .

OBJECT-TYPE

A license file contains one or more 'rows' containing ASCII character strings, where each occurrence of an LF character terminates the 'row' containing it. A string of 255 characters after one LF character (or at the beginning of the file) which does not contain another LF character is also treated as a 'row' of the license file. This object represents information about a particular 'row' in the license file contents.

OBJECT-TYPE

Specifies the the installed License file name.

OBJECT-TYPE

Represents the row number. For example, 1 for the first row, two for the second, ..., N for the last (N-th) row.

OBJECT-TYPE

Represents the time when the license file contents was last modified.

OBJECT-TYPE

This object represents the number of 'rows' in the license file named by the the value of the corresponding instance of 'clmLicenseFileName'.

OBJECT-TYPE

This object represents the contents of the 'row' for which the row number is given by the value of the corresponding instance of 'clmLicenseFileRowNumber' in the license file named by the the value of the corresponding instance of 'clmLicenseFileName'.

OBJECT-TYPE

This object represents the current number of entries in the clmLicenseFeatureUsageTable. Indicates the number of licensed features in the local system.

OBJECT-TYPE

Represents the current license usage on the system. Contains one entry for each licensed feature in system.

OBJECT-TYPE

Licensing information for a particular feature can appear in multiple license files. This object contains the consolidated licensing information for the particular feature from all the installed license files.

OBJECT-TYPE

This object represents the name of the licensed feature.

OBJECT-TYPE

Information about the license type. bit positions, 0 - demo license, if bit is set. 1 - permanent license, if bit is set. permanent means, the license for the feature has no expiry date. if bit is reset, then the license for the feature has expiry date. 2 - counted license, if bit is set. uncounted license, if bit is reset. 3 - unlicensed, if bit is set, means no license for this feature is installed. 4 - feature is in grace period, if bit is set. This means that applications are allowed to to use this feature license till the expiry of the grace period, mentioned in the corresponding instance of 'clmLicenseGracePeriodLeft' object. Feature is not in grace period, if bit is reset. 5 - feature is in honor period, if bit is set. This means that applications are allowed to use this feature license even though there is no corresponding license installed. when 'unlicensed' (i.e.) bit '3' is set, then the value of bit 0,1 and 2 are irrelevant. Whether or not this value can have 'demo' and 'permanent' set at the same time is a policy issue, and some implementations will prohibit such usage.

OBJECT-TYPE

Maximum number of concurrent usages of this license feature. This is the cumulative license usage count for this feature from all the installed license files, containing this feature's license information. If the clmLicenseFlag object has value of bit 2 'reset', ( means uncounted license), then the value of this object is irrelevant.

OBJECT-TYPE

This object represents the number of missing usage licenses of this feature, when one or more installed license files containing this feature's license, are missing in the local system. Under normal condition, the value of this object is '0'.

OBJECT-TYPE

Represents the number of current usages of this licensed feature.

OBJECT-TYPE

Expiry date of the licensed feature. If the corresponding instances of clmLicenseFlag indicates 'permanent' or 'unlicensed' , then the value of this object is irrelevant.

OBJECT-TYPE

This object represents the grace period left for this feature, in seconds. Grace period is the number of seconds either an unlicensed feature or a feature whose license has expired is allowed to run. The value of this object is relevant only when the corresponding instances of clmLicenseFlag indicates 'ingraceperiod'.

OBJECT-TYPE

This object represents whether the license is enabled or not. The value 'true' signifies that license is enabled. The value 'false' signifies that the license is disabled.

OBJECT-TYPE

This object represents the grace period left for this license feature, in seconds. Grace period is the number of seconds either an unlicensed feature or a feature whose license has expired is allowed to run. The value of this object is relevant only when the corresponding instances of clmLicenseFlag indicates 'ingraceperiod'. If the corresponding instanses of clmLicenseFlag indicates 'inhonorperiod', this object represents the honor period start for this license feature, in seconds. Honor period is the number of seconds either an unlicensed feature or a feature whose license has expired is running.

OBJECT-TYPE

This object represents the maximum number of concurrent usages of this license feature that is included by default. The value of this object is relevant only when the corresponding instances of clmLicenseFlag indicates 'counted' (value of bit 2 'set')

OBJECT-TYPE

Represents the list of applications which have checked out the licensed features.

OBJECT-TYPE

An Entry represents an application instance which has checked out a license for the feature.

OBJECT-TYPE

This is an index to the applications for a licensed feature.

OBJECT-TYPE

Represents the name of the application instance, which has checked out the feature. It is the value of 'clmLicenseRequestAppName' object set while checking out the license.

OBJECT-TYPE

If one or more application instance has checked out any feature, without a valid license file installed for that feature in the system, is termed as 'License Violation'. This object indicates whether any license violation has been detected in the system and the grace period left for the corresponding feature is less than '30' days. The value of this object set to 'true' indicates a 'License Violation' detected in the system , and the grace period left for the corresponding feature is less than 30 days. The value of this object set to 'false' indicates either there is 'NO License Violation' detected in the system, or a 'License Violation' is detected, but the grace period left for the corresponding feature is more than 30 days.

OBJECT-TYPE

This table contains information about port licensing. Each entry of this table represents one license of a particular type for the interface identified by ifIndex. The agent creates one entry in this table for each type of license for which a given interface is capable of being eligible. An interface which is not capable of being eligible for any type of license will not be represented in this table.

OBJECT-TYPE

Each entry contains port licensing information for an interface.

OBJECT-TYPE

Type of license which can be acquired on a given interface.

OBJECT-TYPE

This object is used to assign the state of a port license for an interface. This object is configurable by the network management application. 'eligible' - the interface will be configured to be eligible to acquire a given port license. 'inEligible' - the interface will be configured not to be eligible to acquire a given port license. If the interface has already acquired a port license, the license is released and the interface is then configured not to be eligible to acquire port license. 'acquire' - the interface will first be made eligible to acquire a port license, and will then attempt to acquire one. If a port license is available, the interface will acquire it and this object's value will remain as 'acquire'. If port licenses are insufficient, the interface is made eligible, and this object's value will become 'eligible'. Given that there are enough port licenses available, a port license will be acquired on a given interface only under the following conditions: 1. The user configures this object to 'acquire' (OR) 2. When a linkUp notification (defined in IF-MIB) is generated on a Fibre Channel interface for which the value of fcIfPortType (defined in CISCO-FC-FE-MIB) is 'internal', and the value of clmPortLicensingConfig is 'eligible'. The conditions under which a port license will be acquired when a linkUp notification is generated on other types of interfaces will be added to this definition in the future, as and when appropriate.

OBJECT-TYPE

This object gives the current state of port license on the interface. 'notAcquired' - the interface has not acquired port license 'acquired' - the interface has acquired port license.

OBJECT-TYPE

This table maintains count-based statistics of the system related to port licensing. The entries of this table are indexed based on clmPortLicensingType. The agent creates one entry in this table for each value of clmPortLicensingType.

OBJECT-TYPE

An entry in the clmPortLicCountTable. Each entry consists of the following four counts related to port licensing, for a given clmPortLicensingType: 1. Maximum number of port licenses that can be acquired, 2. Number of port licenses that are currently acquired, 3. Maximum number of internal port licenses that can be acquired, if internal port licenses are applicable, and 4. Number of internal port licenses that are currently acquired, if internal port licenses are applicable. Any one of these four counts that does not pertain to the given clmPortLicensingType will not be instantiated in this entry.

OBJECT-TYPE

This object gives the maximum number port licenses that can be acquired for the given clmPortLicensingType.

OBJECT-TYPE

This object gives the number of port licenses that are currently acquired for the given clmPortLicensingType.

OBJECT-TYPE

This object gives the maximum number of internal port licenses that can be acquired for a given clmPortLicensingType. To obtain the maximum number of external port licenses that can be acquired, the user needs to obtain clmPortLicCountMax and subtract clmPortLicCountMaxInternal from it.

OBJECT-TYPE

This object gives the number of internal port licenses that are currently acquired for a given clmPortLicensingType. To obtain the number of external port licenses currently acquired, the user needs to obtain clmPortLicCountUsed and subtract clmPortLicCountUsedInternal from it.

OBJECT-IDENTITY

OBJECT-TYPE

This object represents the maximum number of ssl transactions allowed per second for the license purchased.

OBJECT-TYPE

This object represents the maximum number of virtualized context available for the license purchased.

OBJECT-TYPE

This object represents the maximum bandwidth in Gbps allowed for the license purchased.

OBJECT-TYPE

This object represents the compression performance in Mbps allowed for the license purchased.

OBJECT-TYPE

This object represents the maximum value of web optimization in cps allowed for the license purchased.

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-IDENTITY

OBJECT-IDENTITY