CISCO-SMART-LIC-MIB
AI MIB Summary
The CISCO-SMART-LIC-MIB module enables SNMP-based monitoring and management of Cisco Smart Licensing states, including registration tokens, entitlement tags, and grace period counters, for Cisco IOS XE and NX-OS software instances communicating with the Cisco Smart Software Manager (CSSM). It facilitates the retrieval of device-specific UDI data, evaluation license expiration timers, and counted license usage limits while triggering asynchronous notifications for critical licensing events such as authorization failures or policy violations.
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.
Main OID:
ciscoSmartLicMIB.1.3.6.1.4.1.9.9.831
71
Objects
Active
Status
5
Dependencies
Imported Objects
Objects
71 total| Object Name |
|---|
ciscoSmartLicMIBThe 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 .1.3.6.1.4.1.9.9.831 |
ciscoSlaMIBObjects OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0 |
ciscoSlaInstanceIdThis object indicates the smart licence agent's instance
number.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.1 |
ciscoSlaSUDIInfoThis object indicates the device identifier informationro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.2 |
ciscoSlaVersionThis object indicates the smart licensing version information
in the below shown sample format.
sample format: Cisco Smart Licensing Agent, Version 1.1.0_290ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.3 |
ciscoSlaEnabledThis object indicates whether the smart licensing mode is
enabled. A value of 'true' indicates the mode is enabled.ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.831.0.4 |
ciscoSlaEntitlementInfo OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.5 |
ciscoSlaEntitlementInfoTableThis table contains information about all entitlements being
requested from this device SEQUENCE OF CiscoSlaEntitlementInfoEntry .1.3.6.1.4.1.9.9.831.0.5.1 |
ciscoSlaEntitlementInfoEntryAn 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 CiscoSlaEntitlementInfoEntry .1.3.6.1.4.1.9.9.831.0.5.1.1 |
ciscoSlaEntitlementInfoIndexThis object uniquely identifies an entitlement record Unsigned32 .1.3.6.1.4.1.9.9.831.0.5.1.1.1 |
ciscoSlaEntitlementRequestCountNumber of count that was requested for this entitlement tag. A
value of 'zero' indicates that this entitlement is
not in use.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.5.1.1.2 |
ciscoSlaEntitlementTagThe tag name for the entitlement in use.
This is abbreviated form of the entitlement tag.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.5.1.1.3 |
ciscoSlaEntitlementVersionThis object indicates the entitlement version.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.5.1.1.4 |
ciscoSlaEntitlementEnforceModeThis 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.ro Enumeration .1.3.6.1.4.1.9.9.831.0.5.1.1.5 |
ciscoSlaEntitlementDescriptionThis 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.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.5.1.1.6 |
ciscoSlaEntitlementFeatureNameThis 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.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.5.1.1.7 |
ciscoSlaRegistrationStatusInfo OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.6 |
ciscoSlaRegistrationStatusSmart Agent Registration Status. This is the status of the
registration initiated using the token generated from the
Cisco
Licensing portal.ro Enumeration .1.3.6.1.4.1.9.9.831.0.6.1 |
ciscoSlaVirtualAccountThe virtual account name created in the Licensing Portal to
which this device will be registered.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.6.2 |
ciscoSlaNextCertificateExpireTimeThe next expiration date/time of ID Certificate in UTC epoch
seconds.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.6.3 |
ciscoSlaEnterpriseAccountNameThe enterprise account name as configured in the Cisco
Licensing Portal.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.6.4 |
ciscoSlaRegisterTime OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.6.5 |
ciscoSlaRegisterInitTimeTime in UTC epoch seconds when the Registration of the Smart
Agent
was initialized.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.6.5.1 |
ciscoSlaRegisterSuccessStatus of the last attempted Registration of Smart Agentro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.831.0.6.5.2 |
ciscoSlaRegisterFailureReasonReason for the failure of the last Registration Attemptro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.6.5.3 |
ciscoSlaRegisterNextRetryTimeTime in UTC epoch seconds when the next registration attempt
will be made.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.6.5.4 |
ciscoSlaRenewTime OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.6.6 |
ciscoSlaRenewInitTimeTime in UTC epoch seconds when the ID Cert renewal was
initializedro Unsigned32 .1.3.6.1.4.1.9.9.831.0.6.6.1 |
ciscoSlaRenewSuccessStatus of Renewal of ID Certificatero TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.831.0.6.6.2 |
ciscoSlaRenewFailureReasonReason for the failure of the last attempted ID Cert Renewalro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.6.6.3 |
ciscoSlaRenewNextRetryTimeTime in UTC epoch seconds when the next ID Cert renewal will
be tried.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.6.6.4 |
ciscoSlaAuthorizationInfo OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.7 |
ciscoSlaAuthExpireTimeThe time in UTC epoch seconds when the authorization will
expire if
not renewedro Unsigned32 .1.3.6.1.4.1.9.9.831.0.7.1 |
ciscoSlaAuthComplianceStatusOverall enforcement status of Smart Licensing in the device.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.7.2 |
ciscoSlaAuthOOCStartTimeThe time in UTC epoch seconds Smart Agent entered Out of
Compliance state for this
device.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.7.3 |
ciscoSlaAuthEvalPeriod OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.7.4 |
ciscoSlaAuthEvalPeriodInUseIndicates if the Evaluation Period is in Use or notro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.831.0.7.4.1 |
ciscoSlaAuthEvalExpiredTimeTime in UTC epoch seconds when the Evaluation Period had
expired.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.7.4.2 |
ciscoSlaAuthEvalPeriodLeftAmount of Time left in the Evaluation Periodro Unsigned32 .1.3.6.1.4.1.9.9.831.0.7.4.3 |
ciscoSlaAuthRenewTime OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.7.5 |
ciscoSlaAuthRenewInitTimeSmart Agent Authorization Renewal Initialization Time in UTC
epoch secondsro Unsigned32 .1.3.6.1.4.1.9.9.831.0.7.5.1 |
ciscoSlaAuthRenewSuccessThis object indicates the authorization renewal status. A
value of 'true' indicates the renewal was successful.ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.831.0.7.5.2 |
ciscoSlaAuthRenewFailureReasonThis object indicates the reason for the failure of the last
renewal request.ro SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.9.9.831.0.7.5.3 |
ciscoSlaAuthRenewNextRetryTimeTime in UTC epoch seconds when the next renewal will be
retried.ro Unsigned32 .1.3.6.1.4.1.9.9.831.0.7.5.4 |
ciscoSlaNotifObjects OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.0.8 |
ciscoSlaGlobalNotifEnableThis 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,
ciscoSlaSmartAgentNotifyIdCertExpiryWarningrw TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.831.0.8.1 |
ciscoSlaEntitlementNotifEnableThis object indicates whether the device should generate
the notifications related to entitlement enforce mode in Smart
Agent. This object
enables/disables sending following notifications:
ciscoSlaSmartAgentNotifyEntitlementEnforceModerw TruthValue (SNMPv2-TC) .1.3.6.1.4.1.9.9.831.0.8.2 |
ciscoSlaMIBNotifs OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.1 |
ciscoSlaSmartAgentNotifyEnforcementModeThe device generates this notification when the overall
enforcement mode in the agent changes. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.1 |
ciscoSlaSmartAgentNotifyReadyThe device generates this notification when the Smart agent is
initialized and ready. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.2 |
ciscoSlaSmartAgentNotifyEnabledThe device generates this notification when Smart licensing has
been enabled. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.3 |
ciscoSlaSmartAgentNotifyDisabledThe device generates this notification when Smart licensing has
been disabled NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.4 |
ciscoSlaSmartAgentNotifyRegisterFailedThe device generates this notification when Smart licensing
registration with Cisco Software Manager has failed NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.5 |
ciscoSlaSmartAgentNotifyRegisterSuccessThe device generates this notification when smart licensing
registration with Cisco Software Manager has succeeded. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.6 |
ciscoSlaSmartAgentNotifyIdCertExpiredThe device generates this notification when Smart licensing ID
(node) certificate has expired NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.7 |
ciscoSlaSmartAgentNotifyIdCertRenewSuccessThe device generates this notification when Smart licensing ID
(node) certificate renewal has succeded. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.8 |
ciscoSlaSmartAgentNotifyIdCertRenewFailThe device generates this notification when Smart licensing ID
(node) certificate renewal has failed. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.9 |
ciscoSlaSmartAgentNotifyAuthRenewSuccessThe device generates this notification when Smart licensing
entitlement (AUTH) renew was successful. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.10 |
ciscoSlaSmartAgentNotifyAuthRenewFailThe device generates this notification when Smart licensing
entitlement (AUTH) renew has failed NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.11 |
ciscoSlaSmartAgentNotifyCommunicationFailureThe device generates this notification when Smart Agent
failed to communicate with CSSM. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.12 |
ciscoSlaSmartAgentNotifyCommunicationRestoredThe device generates this notification when Smart Agent
communication with CSSM has been restored NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.13 |
ciscoSlaSmartAgentNotifyIdCertRenewNotStartedThe device generates this notification when Smart Agent
Id (Node) certificate renewal is not started NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.14 |
ciscoSlaSmartAgentNotifyEntitlementEnforceModeThe device generates this notification when the enforcement
mode of an entitlement has changed. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.15 |
ciscoSlaSmartAgentNotifyIdCertOutOfRangeThe 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. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.16 |
ciscoSlaSmartAgentNotifySystemClockChangedThe device generates this notification when the system clock
has changed. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.17 |
ciscoSlaSmartAgentNotifyEvalExpiryWarningThe device generates this notification to warn regarding the
impending evaluation time expiry. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.18 |
ciscoSlaSmartAgentNotifyEvalExpiredThe device generates this notification to notify the expiration
of the evaluation period. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.19 |
ciscoSlaSmartAgentNotifyIdCertExpiryWarningThe device generates this notification to warn regarding the
impending expiry of the id (node) certificate. NOTIFICATION-TYPE .1.3.6.1.4.1.9.9.831.1.20 |
ciscoSlaMIBConform OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.2 |
ciscoSlaMIBCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.2.1 |
ciscoSlaMIBGroups OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.831.2.2 |