| clmHostId |
.1.3.6.1.4.1.9.9.369.1.1.1 |
|
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.
|
| clmLicenseConfigSpinLock |
.1.3.6.1.4.1.9.9.369.1.2.1 |
|
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.
|
| clmLicenseFileURI |
.1.3.6.1.4.1.9.9.369.1.2.2 |
|
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.
|
| clmLicenseFileTargetName |
.1.3.6.1.4.1.9.9.369.1.2.3 |
|
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'.
|
| clmLicenseConfigCommand |
.1.3.6.1.4.1.9.9.369.1.2.4 |
|
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'.
|
| clmLicenseConfigCommandStatus |
.1.3.6.1.4.1.9.9.369.1.2.5 |
|
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 exist with a different
expiry date for the feature.
invalidLicenseCount(11) - License count is invalid for
the feature.
notThisHost (12) - License host-id in the license file
doesn't match.
licenseInGraceMore (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.
|
| clmLicenseRequestSpinLock |
.1.3.6.1.4.1.9.9.369.1.2.6 |
|
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.
|
| clmLicenseRequestFeatureName |
.1.3.6.1.4.1.9.9.369.1.2.7 |
|
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'.
|
| clmLicenseRequestAppName |
.1.3.6.1.4.1.9.9.369.1.2.8 |
|
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 appName
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.
|
| clmLicenseRequestCommand |
.1.3.6.1.4.1.9.9.369.1.2.9 |
|
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'.
|
| clmLicenseRequestCommandStatus |
.1.3.6.1.4.1.9.9.369.1.2.10 |
|
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.
.
|
| clmNoOfLicenseFilesInstalled |
.1.3.6.1.4.1.9.9.369.1.3.1 |
|
This object represents the number of license files
currently installed on this system.
|
| clmLicenseFileContentsEntry |
.1.3.6.1.4.1.9.9.369.1.3.2.1 |
|
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.
|
| clmNoOfLicensedFeatures |
.1.3.6.1.4.1.9.9.369.1.3.3 |
|
This object represents the current number of entries
in the clmLicenseFeatureUsageTable. Indicates the
number of licensed features in the local system.
|
| clmLicenseFeatureUsageEntry |
.1.3.6.1.4.1.9.9.369.1.3.4.1 |
|
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.
|
| clmFeatureUsageDetailsEntry |
.1.3.6.1.4.1.9.9.369.1.3.5.1 |
|
An Entry represents an application instance which
has checked out a license for the feature.
|
| clmLicenseViolationWarnFlag |
.1.3.6.1.4.1.9.9.369.1.3.6 |
|
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
eithor 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.
|
| clmNotificationsEnable |
.1.3.6.1.4.1.9.9.369.1.1.2 |
|
This object indicates whether the system should generate
notifications specified in 'clmNotificationGroup'
or not.
|
| clmLicenseFileName |
.1.3.6.1.4.1.9.9.369.1.3.2.1.1 |
|
Specifies the the installed License file name.
|
| clmLicenseFileRowNumber |
.1.3.6.1.4.1.9.9.369.1.3.2.1.2 |
|
Represents the row number. For example, 1 for the first
row, two for the second, ..., N for the last (N-th) row.
|
| clmLicenseFileTimeStamp |
.1.3.6.1.4.1.9.9.369.1.3.2.1.3 |
|
Represents the time when the license file contents
was last modified.
|
| clmLicenseFileNoOfRows |
.1.3.6.1.4.1.9.9.369.1.3.2.1.4 |
|
This object represents the number of 'rows'
in the license file named by the the value of the
corresponding instance of 'clmLicenseFileName'.
|
| clmLicenseFileRowContents |
.1.3.6.1.4.1.9.9.369.1.3.2.1.5 |
|
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'.
|
| clmLicenseFeatureName |
.1.3.6.1.4.1.9.9.369.1.3.4.1.1 |
|
This object represents the name of the licensed
feature.
|
| clmLicenseFlag |
.1.3.6.1.4.1.9.9.369.1.3.4.1.2 |
|
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 'clmLicenseGracePeriod'
object.
Feature is not in grace period, if bit is reset.
when 'unlicensed' (ie.) 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.
|
| clmNoOfLicenseMaxUsages |
.1.3.6.1.4.1.9.9.369.1.3.4.1.3 |
|
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.
|
| clmNoOfMissingUsageLicenses |
.1.3.6.1.4.1.9.9.369.1.3.4.1.4 |
|
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'.
|
| clmNoOfLicenseCurrentUsages |
.1.3.6.1.4.1.9.9.369.1.3.4.1.5 |
|
Represents the number of current usages of this
licensed feature.
|
| clmLicenseExpiryDate |
.1.3.6.1.4.1.9.9.369.1.3.4.1.6 |
|
Expiry date of the licensed feature.
If the corresponding instances of clmLicenseFlag indicates
'permanent' or 'unlicensed' , then the value of this
object is irrelevant.
|
| clmLicenseGracePeriod |
.1.3.6.1.4.1.9.9.369.1.3.4.1.7 |
|
This object represents the grace period left for this
feature, in seconds.
Grace period is the no.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'.
|
| clmLicensedAppIndex |
.1.3.6.1.4.1.9.9.369.1.3.5.1.1 |
|
This is an index to the applications for a
licensed feature.
|
| clmLicensedAppName |
.1.3.6.1.4.1.9.9.369.1.3.5.1.2 |
|
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.
|
| clmLicenseExpiryNotify |
.1.3.6.1.4.1.9.9.369.3.0.1 |
|
A clmLicenseCountExpiryNotify is sent, when a
feature license expires.
|
| clmNoLicenseForFeatureNotify |
.1.3.6.1.4.1.9.9.369.3.0.2 |
|
A 'clmNoLicenseForFeatureNotify' is sent, when an
license is issued for a feature which does
not have license. The license will expire after
a grace period, which is mentioned in the
'clmLicenseGracePeriod' object of this
notification. This notification is also sent once
every 24 hours from the start of the grace period.
In the last 7 days before grace period expiry this
notification is sent once every hour.
|
| clmLicenseFileMissingNotify |
.1.3.6.1.4.1.9.9.369.3.0.3 |
|
A clmLicenseFileMissingNotify is generated when the
system detects that one or more installed license
files are missing. To correct this fault, any
files which might be missing should be reinstalled,
e.g., if it's unknown which ones are missing, then
all files can be re-installed, ignoring any 'duplicate
license' messages.
|
| clmLicenseExpiryWarningNotify |
.1.3.6.1.4.1.9.9.369.3.0.4 |
|
A 'clmLicenseExpiryWarningNotify' is sent,
when an license issued for a feature is
going to expire, and the feature is use. This
notification is sent once in a day starting 30
days before license expiry. In the last 7 days
before expiry this notification is sent once
every hour.
The license will expire on the date and time,
mentioned in the 'clmLicenseExpiryDate' object of
this notification.
|
