CISCO-SMART-LIC-MIB
File:
CISCO-SMART-LIC-MIB.mib (39617 bytes)
Imported modules
Imported symbols
Defined Types
CiscoSlaEntitlementInfoEntry |
|
SEQUENCE |
|
|
|
|
ciscoSlaEntitlementInfoIndex |
Unsigned32 |
|
|
ciscoSlaEntitlementRequestCount |
Unsigned32 |
|
|
ciscoSlaEntitlementTag |
SnmpAdminString |
|
|
ciscoSlaEntitlementVersion |
SnmpAdminString |
|
|
ciscoSlaEntitlementEnforceMode |
INTEGER |
|
|
ciscoSlaEntitlementDescription |
SnmpAdminString |
|
|
ciscoSlaEntitlementFeatureName |
SnmpAdminString |
|
Defined Values
ciscoSmartLicMIB |
1.3.6.1.4.1.9.9.831 |
The MIB module for managing licenses on the system.
The licensing mechanism provides flexibility to
enforce licensing for various features in the system.
The following description introduces different concepts and
terminologies necessary to understand the MIB
definition and to perform license management.
Product Instance: An instance of a Cisco software image that
runs on a hardware platform and requires some licensing
capability.
Software ID tag: A string generated by the Cisco
Connected Software IT team to uniquely identify a Cisco
software product.
Smart Account: A Smart Licensing account that is created
for Cisco customers or partners to manage their Smart
Licensing product instances and licenses. The account is
created on the Cisco Smart Software Manager portal. An
enterprise account can have several virtual accounts (a.k.a.
pools) of licenses.
Cisco Smart Software Manager (CSSM): The Smart Licensing
back-end system, hosted on Cisco IT infrastructure, is
responsible for managing all Smart Licensing services and
transactions. It provides a set of APIs that the Smart Agent
can communicate with and an external-facing
UI for Cisco customers and partners to log into and
manage their Smart Licensing account.
Registration Token: A token that is generated from the
Cisco Smart Software Manager. The token is used to register a
product instance with the Cisco Smart Software Manager.
Smart Agent: A Smart Licensing software client that runs
on a product instance and communicates with the Cisco Smart
Software Manager.
Entitlement Tag: A unique string that identifies a
feature that can be enabled on a product instance. The tags are
used by both the Smart Agent and the Cisco Smart Software
Manager to track entitlement requests.
Transport Mode: The Smart Agent uses the Smart Call Home
(SCH) service as a transport medium to communicate with the
Smart Licensing back-end.
Crypto (LCS) Service: In addition to HTTPS exchanged
messages are further signed and verified on both sides to ensure
the authenticity of all communication. The Smart Software
Licensing system uses a crypto service and underlying crypto
library (either CiscoSSL or PKI). The Smart Software Licensing
back-end leverages the Licensing Crypto Service (LCS) service.
UDI: Unique Device Identifier that uniquely identifies a
device. Primarily it consists of a product ID, version ID and
serial number of the Customers device.
Grace Period: A product enters into a grace period when
the authorization period expires. This is the result of
multiple authorization attempt failures which occurring 90 days
after the last successful authorization. The grace period
continues until the grace period expires - 90 days after the
grace period starts.
Counted License: Limits the number of similar entities that can
consume a license. For example, a counted license when used
by a feature can limit the number of
IP phones that can connect or the number of tunnels that can be
created.
Evaluation License: An Evaluation License grants the
right to a customer to enable functionality of a product
instance before registering it and without an explicit portal
based license for a limited amount of time. This amount of time
ranges on average between 60 to 90 days. Evaluation licenses
are available for most functionality, but may be limited for a
variety of
reasons such as legal, royalty, regulatory, or other
causes.
This MIB module also defines various notifications that
will be triggered to asynchronously notify the management
application of any critical events. |
MODULE-IDENTITY |
|
|
|
ciscoSlaInstanceId |
1.3.6.1.4.1.9.9.831.0.1 |
This object indicates the smart licence agent's instance
number. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaSUDIInfo |
1.3.6.1.4.1.9.9.831.0.2 |
This object indicates the device identifier information |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
ciscoSlaVersion |
1.3.6.1.4.1.9.9.831.0.3 |
This object indicates the smart licensing version information
in the below shown sample format.
sample format: Cisco Smart Licensing Agent, Version 1.1.0_290 |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
ciscoSlaEnabled |
1.3.6.1.4.1.9.9.831.0.4 |
This object indicates whether the smart licensing mode is
enabled. A value of 'true' indicates the mode is enabled. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
ciscoSlaEntitlementInfoEntry |
1.3.6.1.4.1.9.9.831.0.5.1.1 |
An entry in ciscoSlaEntitlementInfoEntry. Each entry contains
information about a entitlement requested on the device. This
entry gets created when a license is requested successfully.
Management application can not create these entries directly |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
CiscoSlaEntitlementInfoEntry |
|
|
ciscoSlaEntitlementRequestCount |
1.3.6.1.4.1.9.9.831.0.5.1.1.2 |
Number of count that was requested for this entitlement tag. A
value of 'zero' indicates that this entitlement is
not in use. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaEntitlementTag |
1.3.6.1.4.1.9.9.831.0.5.1.1.3 |
The tag name for the entitlement in use.
This is abbreviated form of the entitlement tag. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
ciscoSlaEntitlementEnforceMode |
1.3.6.1.4.1.9.9.831.0.5.1.1.5 |
This object indicates the enforce mode for the entitlement tag.
In Entitlement notifications this will indicate the
enforcement mode of an individual entitlement.
In global notifications this indicates the overall
enforcement mode in the agent. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
initialized(1), waiting(2), authorized(3), outOfCompliance(4), overage(5), evaluationPeriod(6), evaluationExpired(7), gracePeriod(8), gracePeriodExpired(9), disabled(10), invalidTag(11) |
|
ciscoSlaEntitlementDescription |
1.3.6.1.4.1.9.9.831.0.5.1.1.6 |
This object indicates the description for the entitlements.
This value is only available after the agent receives a
response from CSSM to an Authorization request. If the
description is unknown this object will contain a null string. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
ciscoSlaEntitlementFeatureName |
1.3.6.1.4.1.9.9.831.0.5.1.1.7 |
This value is the short feature name for the entitlement and is
only available after the agent receives a response from CSSM to
an Authorization request. If its value is unknown this object
will contain a null string. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
ciscoSlaRegistrationStatus |
1.3.6.1.4.1.9.9.831.0.6.1 |
Smart Agent Registration Status. This is the status of the
registration initiated using the token generated from the
Cisco
Licensing portal. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
notRegistered(1), registrationInProgress(2), registrationFailed(3), registrationRetryinProgress(4), registrationCompleted(5) |
|
ciscoSlaVirtualAccount |
1.3.6.1.4.1.9.9.831.0.6.2 |
The virtual account name created in the Licensing Portal to
which this device will be registered. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
ciscoSlaRegisterInitTime |
1.3.6.1.4.1.9.9.831.0.6.5.1 |
Time in UTC epoch seconds when the Registration of the Smart
Agent
was initialized. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaRegisterSuccess |
1.3.6.1.4.1.9.9.831.0.6.5.2 |
Status of the last attempted Registration of Smart Agent |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
ciscoSlaRenewInitTime |
1.3.6.1.4.1.9.9.831.0.6.6.1 |
Time in UTC epoch seconds when the ID Cert renewal was
initialized |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaRenewNextRetryTime |
1.3.6.1.4.1.9.9.831.0.6.6.4 |
Time in UTC epoch seconds when the next ID Cert renewal will
be tried. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaAuthExpireTime |
1.3.6.1.4.1.9.9.831.0.7.1 |
The time in UTC epoch seconds when the authorization will
expire if
not renewed |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaAuthOOCStartTime |
1.3.6.1.4.1.9.9.831.0.7.3 |
The time in UTC epoch seconds Smart Agent entered Out of
Compliance state for this
device. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaAuthRenewInitTime |
1.3.6.1.4.1.9.9.831.0.7.5.1 |
Smart Agent Authorization Renewal Initialization Time in UTC
epoch seconds |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
ciscoSlaAuthRenewSuccess |
1.3.6.1.4.1.9.9.831.0.7.5.2 |
This object indicates the authorization renewal status. A
value of 'true' indicates the renewal was successful. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
ciscoSlaGlobalNotifEnable |
1.3.6.1.4.1.9.9.831.0.8.1 |
This object indicates whether the device should generate
the global notifications related to Smart Agent. This object
enables/disables sending following notifications:
ciscoSlaSmartAgentNotifyEnforcementMode,
ciscoSlaSmartAgentNotifyReady,
ciscoSlaSmartAgentNotifyEnabled,
ciscoSlaSmartAgentNotifyDisabled,
ciscoSlaSmartAgentNotifyRegisterFailed,
ciscoSlaSmartAgentNotifyRegisterSuccess,
ciscoSlaSmartAgentNotifyIdCertExpired,
ciscoSlaSmartAgentNotifyIdCertRenewSuccess,
ciscoSlaSmartAgentNotifyIdCertRenewFail,
ciscoSlaSmartAgentNotifyAuthRenewSuccess,
ciscoSlaSmartAgentNotifyAuthRenewFail,
ciscoSlaSmartAgentNotifyCommunicationFailure,
ciscoSlaSmartAgentNotifyCommunicationRestored,
ciscoSlaSmartAgentNotifyIdCertRenewNotStarted,
ciscoSlaSmartAgentNotifyIdCertOutOfRange,
ciscoSlaSmartAgentNotifySystemClockChanged,
ciscoSlaSmartAgentNotifyEvalExpiryWarning,
ciscoSlaSmartAgentNotifyEvalExpired,
ciscoSlaSmartAgentNotifyIdCertExpiryWarning |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
ciscoSlaEntitlementNotifEnable |
1.3.6.1.4.1.9.9.831.0.8.2 |
This object indicates whether the device should generate
the notifications related to entitlement enforce mode in Smart
Agent. This object
enables/disables sending following notifications:
ciscoSlaSmartAgentNotifyEntitlementEnforceMode |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
ciscoSlaSmartAgentNotifyEnforcementMode |
1.3.6.1.4.1.9.9.831.1.1 |
The device generates this notification when the overall
enforcement mode in the agent changes. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyReady |
1.3.6.1.4.1.9.9.831.1.2 |
The device generates this notification when the Smart agent is
initialized and ready. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyEnabled |
1.3.6.1.4.1.9.9.831.1.3 |
The device generates this notification when Smart licensing has
been enabled. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyDisabled |
1.3.6.1.4.1.9.9.831.1.4 |
The device generates this notification when Smart licensing has
been disabled |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyRegisterFailed |
1.3.6.1.4.1.9.9.831.1.5 |
The device generates this notification when Smart licensing
registration with Cisco Software Manager has failed |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyRegisterSuccess |
1.3.6.1.4.1.9.9.831.1.6 |
The device generates this notification when smart licensing
registration with Cisco Software Manager has succeeded. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyIdCertExpired |
1.3.6.1.4.1.9.9.831.1.7 |
The device generates this notification when Smart licensing ID
(node) certificate has expired |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyIdCertRenewSuccess |
1.3.6.1.4.1.9.9.831.1.8 |
The device generates this notification when Smart licensing ID
(node) certificate renewal has succeded. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyIdCertRenewFail |
1.3.6.1.4.1.9.9.831.1.9 |
The device generates this notification when Smart licensing ID
(node) certificate renewal has failed. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyAuthRenewSuccess |
1.3.6.1.4.1.9.9.831.1.10 |
The device generates this notification when Smart licensing
entitlement (AUTH) renew was successful. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyAuthRenewFail |
1.3.6.1.4.1.9.9.831.1.11 |
The device generates this notification when Smart licensing
entitlement (AUTH) renew has failed |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyIdCertOutOfRange |
1.3.6.1.4.1.9.9.831.1.16 |
The device generates this notification when the ID certificate
is out of the valid range after the system clock changed.
It means the current time is either before the start time or
after the end time of the certificate. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyEvalExpiryWarning |
1.3.6.1.4.1.9.9.831.1.18 |
The device generates this notification to warn regarding the
impending evaluation time expiry. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyEvalExpired |
1.3.6.1.4.1.9.9.831.1.19 |
The device generates this notification to notify the expiration
of the evaluation period. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaSmartAgentNotifyIdCertExpiryWarning |
1.3.6.1.4.1.9.9.831.1.20 |
The device generates this notification to warn regarding the
impending expiry of the id (node) certificate. |
Status: current |
Access: read-write |
NOTIFICATION-TYPE |
|
|
|
ciscoSlaMIBCompliance |
1.3.6.1.4.1.9.9.831.2.1.1 |
Compliance statement for Cisco Smart license MIB. |
Status: current |
Access: read-write |
MODULE-COMPLIANCE |
|
|
|
ciscoSlaMIBEntitlementInfoGroup |
1.3.6.1.4.1.9.9.831.2.2.1 |
A collection of objects for Entitlements requested and their
related information. |
Status: current |
Access: read-write |
OBJECT-GROUP |
|
|
|
ciscoSlaMIBRegistrationStatusInfoGroup |
1.3.6.1.4.1.9.9.831.2.2.2 |
A collection of objects representing the information regarding
the registration status of the device. |
Status: current |
Access: read-write |
OBJECT-GROUP |
|
|
|
ciscoSlaMIBGlobalNotificationGroup |
1.3.6.1.4.1.9.9.831.2.2.3 |
A collection of global notifications related to Smart Agent |
Status: current |
Access: read-write |
NOTIFICATION-GROUP |
|
|
|
ciscoSlaMIBAgentInfoGroup |
1.3.6.1.4.1.9.9.831.2.2.4 |
A collection of objects representing meta data related to Smart
Agent state |
Status: current |
Access: read-write |
OBJECT-GROUP |
|
|
|
ciscoSlaMIBEntitlementNotifGroup |
1.3.6.1.4.1.9.9.831.2.2.5 |
A collection of notifications related to entitlement enforce
mode in SmartAgent |
Status: current |
Access: read-write |
NOTIFICATION-GROUP |
|
|
|
ciscoSlaMIBNotificationEnableGroup |
1.3.6.1.4.1.9.9.831.2.2.6 |
A collection of objects for controlling
(enabling/disabling) license notifications to a management
application. |
Status: current |
Access: read-write |
OBJECT-GROUP |
|
|
|
ciscoSlaMIBAuthorizationInfoGroup |
1.3.6.1.4.1.9.9.831.2.2.7 |
A collection of MIB objects representing the Authorization
State
of the Smart Agent. |
Status: current |
Access: read-write |
OBJECT-GROUP |
|
|
|