CISCO-SMART-LIC-MIB

        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.
    

Imported Objects

ciscoMgmtCISCO-SMI
SnmpAdminStringSNMP-FRAMEWORK-MIB
MODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUPSNMPv2-CONF
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, Unsigned32, Integer32, OBJECT-IDENTITYSNMPv2-SMI
TruthValueSNMPv2-TC

Objects

ciscoSmartLicMIB .1.3.6.1.4.1.9.9.831
ciscoSlaMIBObjects .1.3.6.1.4.1.9.9.831.0
ciscoSlaInstanceId .1.3.6.1.4.1.9.9.831.0.1
ciscoSlaThirdPartyAndUtilityInfo .1.3.6.1.4.1.9.9.831.0.10
ciscoSlaThirdPartyAndUtilityFailureMsg
.1.3.6.1.4.1.9.9.831.0.10.1
ciscoSlaExportInfo .1.3.6.1.4.1.9.9.831.0.11
ciscoSlaExportFailureReason .1.3.6.1.4.1.9.9.831.0.11.1
ciscoSlaExportFailureMessage
.1.3.6.1.4.1.9.9.831.0.11.2
ciscoSlaReportingInfo .1.3.6.1.4.1.9.9.831.0.12
ciscoSlaDaysRUMAckNotReceived .1.3.6.1.4.1.9.9.831.0.12.1
ciscoSlaDaysReportingRequired .1.3.6.1.4.1.9.9.831.0.12.2
ciscoSlaPolicyModeInfo .1.3.6.1.4.1.9.9.831.0.13
ciscoSlaPolicyModeFailureMessage
.1.3.6.1.4.1.9.9.831.0.13.1
ciscoSlaPolicyModeInitialACKState .1.3.6.1.4.1.9.9.831.0.13.2
ciscoSlaSUDIInfo
.1.3.6.1.4.1.9.9.831.0.2
ciscoSlaVersion
.1.3.6.1.4.1.9.9.831.0.3
ciscoSlaEnabled
.1.3.6.1.4.1.9.9.831.0.4
ciscoSlaEntitlementInfo .1.3.6.1.4.1.9.9.831.0.5
ciscoSlaEntitlementInfoTable .1.3.6.1.4.1.9.9.831.0.5.1
ciscoSlaEntitlementInfoEntry .1.3.6.1.4.1.9.9.831.0.5.1.1
ciscoSlaEntitlementInfoIndex .1.3.6.1.4.1.9.9.831.0.5.1.1.1
ciscoSlaEntitlementRequestCount .1.3.6.1.4.1.9.9.831.0.5.1.1.2
ciscoSlaEntitlementTag
.1.3.6.1.4.1.9.9.831.0.5.1.1.3
ciscoSlaEntitlementVersion
.1.3.6.1.4.1.9.9.831.0.5.1.1.4
ciscoSlaEntitlementEnforceMode .1.3.6.1.4.1.9.9.831.0.5.1.1.5
ciscoSlaEntitlementDescription
.1.3.6.1.4.1.9.9.831.0.5.1.1.6
ciscoSlaEntitlementFeatureName
.1.3.6.1.4.1.9.9.831.0.5.1.1.7
ciscoSlaEntitlementExportAllowed .1.3.6.1.4.1.9.9.831.0.5.1.1.8
ciscoSlaRegistrationStatusInfo .1.3.6.1.4.1.9.9.831.0.6
ciscoSlaRegistrationStatus .1.3.6.1.4.1.9.9.831.0.6.1
ciscoSlaVirtualAccount
.1.3.6.1.4.1.9.9.831.0.6.2
ciscoSlaNextCertificateExpireTime .1.3.6.1.4.1.9.9.831.0.6.3
ciscoSlaEnterpriseAccountName
.1.3.6.1.4.1.9.9.831.0.6.4
ciscoSlaRegisterTime .1.3.6.1.4.1.9.9.831.0.6.5
ciscoSlaRegisterInitTime .1.3.6.1.4.1.9.9.831.0.6.5.1
ciscoSlaRegisterSuccess
.1.3.6.1.4.1.9.9.831.0.6.5.2
ciscoSlaRegisterFailureReason
.1.3.6.1.4.1.9.9.831.0.6.5.3
ciscoSlaRegisterNextRetryTime .1.3.6.1.4.1.9.9.831.0.6.5.4
ciscoSlaRenewTime .1.3.6.1.4.1.9.9.831.0.6.6
ciscoSlaRenewInitTime .1.3.6.1.4.1.9.9.831.0.6.6.1
ciscoSlaRenewSuccess
.1.3.6.1.4.1.9.9.831.0.6.6.2
ciscoSlaRenewFailureReason
.1.3.6.1.4.1.9.9.831.0.6.6.3
ciscoSlaRenewNextRetryTime .1.3.6.1.4.1.9.9.831.0.6.6.4
ciscoSlaAuthorizationInfo .1.3.6.1.4.1.9.9.831.0.7
ciscoSlaAuthExpireTime .1.3.6.1.4.1.9.9.831.0.7.1
ciscoSlaAuthComplianceStatus
.1.3.6.1.4.1.9.9.831.0.7.2
ciscoSlaAuthOOCStartTime .1.3.6.1.4.1.9.9.831.0.7.3
ciscoSlaAuthEvalPeriod .1.3.6.1.4.1.9.9.831.0.7.4
ciscoSlaAuthEvalPeriodInUse
.1.3.6.1.4.1.9.9.831.0.7.4.1
ciscoSlaAuthEvalExpiredTime .1.3.6.1.4.1.9.9.831.0.7.4.2
ciscoSlaAuthEvalPeriodLeft .1.3.6.1.4.1.9.9.831.0.7.4.3
ciscoSlaAuthRenewTime .1.3.6.1.4.1.9.9.831.0.7.5
ciscoSlaAuthRenewInitTime .1.3.6.1.4.1.9.9.831.0.7.5.1
ciscoSlaAuthRenewSuccess
.1.3.6.1.4.1.9.9.831.0.7.5.2
ciscoSlaAuthRenewFailureReason
.1.3.6.1.4.1.9.9.831.0.7.5.3
ciscoSlaAuthRenewNextRetryTime .1.3.6.1.4.1.9.9.831.0.7.5.4
ciscoSlaNotifObjects .1.3.6.1.4.1.9.9.831.0.8
ciscoSlaGlobalNotifEnable
.1.3.6.1.4.1.9.9.831.0.8.1
ciscoSlaEntitlementNotifEnable
.1.3.6.1.4.1.9.9.831.0.8.2
ciscoSlaDeRegistrationInfo .1.3.6.1.4.1.9.9.831.0.9
ciscoSlaFailureReason .1.3.6.1.4.1.9.9.831.0.9.1
ciscoSlaDeRegisterFailureMsg
.1.3.6.1.4.1.9.9.831.0.9.2
ciscoSlaMIBNotifs .1.3.6.1.4.1.9.9.831.1
ciscoSlaMIBConform .1.3.6.1.4.1.9.9.831.2
ciscoSlaMIBCompliances .1.3.6.1.4.1.9.9.831.2.1
ciscoSlaMIBGroups .1.3.6.1.4.1.9.9.831.2.2

Notifications/Traps

NameOIDDescription
ciscoSlaSmartAgentNotifyEnforcementMode


.1.3.6.1.4.1.9.9.831.1.1
This notification is sent when the overall enforcement mode in
the agent changes.
ciscoSlaSmartAgentNotifyAuthRenewSuccess

.1.3.6.1.4.1.9.9.831.1.10
This notification is sent when Smart licensing entitlement
(AUTH) renew was successful.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyAuthRenewFail

.1.3.6.1.4.1.9.9.831.1.11
This notification is sent when Smart licensing entitlement
(AUTH) renew has failed.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyCommunicationFailure

.1.3.6.1.4.1.9.9.831.1.12
This notification is sent when Smart Agent
failed to communicate with CSSM.
ciscoSlaSmartAgentNotifyCommunicationRestored

.1.3.6.1.4.1.9.9.831.1.13
This notification is sent when Smart Agent
communication with CSSM has been restored
ciscoSlaSmartAgentNotifyIdCertRenewNotStarted

.1.3.6.1.4.1.9.9.831.1.14
This notification is sent when Smart Agent
Id (Node) certificate renewal is not started.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyEntitlementEnforceMode





.1.3.6.1.4.1.9.9.831.1.15
This notification is sent when the enforcement mode of an
entitlement has changed.
ciscoSlaSmartAgentNotifyIdCertOutOfRange

.1.3.6.1.4.1.9.9.831.1.16
This notification is sent 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.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifySystemClockChanged

.1.3.6.1.4.1.9.9.831.1.17
This notification is sent when the system clock has changed.
ciscoSlaSmartAgentNotifyEvalExpiryWarning

.1.3.6.1.4.1.9.9.831.1.18
This notification is sent to warn regarding the impending
evaluation  time expiry.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyEvalExpired

.1.3.6.1.4.1.9.9.831.1.19
This notification is sent to notify the expiration of the
evaluation period.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyReady

.1.3.6.1.4.1.9.9.831.1.2
This notification is sent when the Smart agent is initialized
and ready.
ciscoSlaSmartAgentNotifyIdCertExpiryWarning

.1.3.6.1.4.1.9.9.831.1.20
This notification is sent to warn regarding the impending
expiry of the id (node) certificate.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyDeRegisterSuccess

.1.3.6.1.4.1.9.9.831.1.21
This notification is sent to inform that the product has
successfully un-registered with the Cisco Smart Software 
Manager.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyDeRegisterFailed



.1.3.6.1.4.1.9.9.831.1.22
This notification is sent to inform that Cisco Smart Software
Manager has send error in de-registration response.
The agent will locally remove all registration information and 
transition back to the unidentified (not-registered) state.
CSSM would not know the agent is un-registered.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyThirdpartyModeEnabled

.1.3.6.1.4.1.9.9.831.1.23
This notification is sent to inform the Agent is now in
thirdparty mode.
ciscoSlaSmartAgentNotifyThirdpartyModeDisabled

.1.3.6.1.4.1.9.9.831.1.24
This notification is sent to inform the Agent is now out of
thirdparty mode.
ciscoSlaSmartAgentNotifyUtilityCertExpired

.1.3.6.1.4.1.9.9.831.1.25
This notification is sent to inform that Utility certificate
has expired.
ciscoSlaSmartAgentNotifyUtilityCertRenewFailed


.1.3.6.1.4.1.9.9.831.1.26
This notification is sent to inform that Utility certificate
renewal has failed.
ciscoSlaSmartAgentNotifyUtilityCertRenewSuccess

.1.3.6.1.4.1.9.9.831.1.27
This notification is sent to inform that Utility certificate
renewal successful.
ciscoSlaSmartAgentNotifyUtilityDataReportingStarted

.1.3.6.1.4.1.9.9.831.1.28
This notification is sent to inform that Utility data reporting
has started.
In TPBP this will occur when the product instance receives a 
utility certificate during registration.
In SPLA utility it occurs when utility is enabled, the URL is
set in the CLI and the agent has received subscription 
information.
ciscoSlaSmartAgentNotifyUtilityDataReportingStopped

.1.3.6.1.4.1.9.9.831.1.29
This notification is sent to inform that Utility data reporting
has stopped.
In TPBP this will occur on a de-registration or when the utility
certificate expires.
In SPLA it occurs when utility is utility is disabled, a 
de-registration occurs or the ID certificate expires.
ciscoSlaSmartAgentNotifyEnabled

.1.3.6.1.4.1.9.9.831.1.3
This notification is sent when Smart licensing has been
enabled.
ciscoSlaSmartAgentNotifyUtilitySendRUMFailed


.1.3.6.1.4.1.9.9.831.1.30
This notification is sent to inform that rum report send
failed.
ciscoSlaSmartAgentNotifyUtilityCertFQDNMismatch

.1.3.6.1.4.1.9.9.831.1.31
This notification is sent to inform Utility cert config
mismatch. The Smart licensing url setting does not match the 
FQDN embedded in the utility certificate.
ciscoSlaSmartAgentNotifySmartTransportNotConfigured

.1.3.6.1.4.1.9.9.831.1.32
This notification is sent when Utility is enabled and we have
subscription but smart transport is not configured
ciscoSlaSmartAgentNotifyHostnameMatchedWithUDI

.1.3.6.1.4.1.9.9.831.1.33
This notification is sent when Smart Agent receives a
HostnameChange event and new hostname is matched with one or
more fields in current UDI.
ciscoSlaSmartAgentNotifyExportRequestFailure




.1.3.6.1.4.1.9.9.831.1.34
This notification is sent when request for the export
authorization key has failed.
ciscoSlaSmartAgentNotifyExportHAMismatch



.1.3.6.1.4.1.9.9.831.1.35
This notification is sent when standby or members do not have
the export authorization keys for all the same features as the
active has.
ciscoSlaSmartAgentNotifyExportAuthKeyNotSupported

.1.3.6.1.4.1.9.9.831.1.36
This notification is sent when the request for export
authorization (or return) key is currently not supported by the
satellite.
ciscoSlaSmartAgentNotifyExportControlledTag



.1.3.6.1.4.1.9.9.831.1.37
This notification is sent to specify whether the Customer is
allowed or not allowed to use an export controlled entitlement.
ciscoSlaSmartAgentNotifyEndPointReset

.1.3.6.1.4.1.9.9.831.1.38
This notification is sent to platform so that it reports the
entire list of End Points to Smart Agent instead of delta.
ciscoSlaSmartAgentNotifyExportRequestSuccess



.1.3.6.1.4.1.9.9.831.1.39
This notification is sent when the request for the export
authorization key is successful.
ciscoSlaSmartAgentNotifyDisabled

.1.3.6.1.4.1.9.9.831.1.4
This notification is sent when Smart licensing has been
disabled
ciscoSlaSmartAgentNotifyAuthorizationInstall

.1.3.6.1.4.1.9.9.831.1.40
This notification is sent in all the below scenarios:
- A new Smart Licensing authorization code has been
installed.
- A new authorization code has been installed and has
overwritten a previous code.
- The platform has delivered a list of entitlements to the
agent that may be authorized.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyAuthorizationRemove

.1.3.6.1.4.1.9.9.831.1.41
This notification is sent when an authorization code has
been removed.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyPolicyInstalled

.1.3.6.1.4.1.9.9.831.1.42
This notification is sent when policy file is installed in
device.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyPolicyRemoved

.1.3.6.1.4.1.9.9.831.1.43
This notification is sent when policy file is removed from
device.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyRUMACKNotReceived


.1.3.6.1.4.1.9.9.831.1.44
This notification would be sent when RUM report ack has not
been received in the time (in days) specified by the installed
policy.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyRUMACKReceived

.1.3.6.1.4.1.9.9.831.1.45
This notification is sent when a RUM report ACK is received.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyAuthorizationInstallFailed

.1.3.6.1.4.1.9.9.831.1.46
This notification is sent when an attempt to install licensing
authorization code is failed.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyReportingRequired


.1.3.6.1.4.1.9.9.831.1.47
This notification is sent when a license is in use that was not
purchased so reporting will be required at the time specified.
This OID is only relevant when Smart Agent is operating in
Policy mode.
ciscoSlaSmartAgentNotifyPolicyInstallFailed


.1.3.6.1.4.1.9.9.831.1.48
This notification is sent when Policy installation fails.
          
Policy Mode Notification: This notificaiton/OID is exclussive
for Policy mode of operation.
ciscoSlaSmartAgentNotifyPolicyInstallSuccess

.1.3.6.1.4.1.9.9.831.1.49
This notification is sent when Policy installation is
Successful.
          
Policy Mode Notification: This notificaiton/OID is exclussive
for Policy mode of operation.
ciscoSlaSmartAgentNotifyRegisterFailed

.1.3.6.1.4.1.9.9.831.1.5
This notification is sent when Smart licensing registration
with Cisco Software Manager has failed.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyReportingNotSupported

.1.3.6.1.4.1.9.9.831.1.50
This notification is sent when backend sserver (in most cases
on-Prem) does not support reporting.
          
Policy Mode Notification: This notificaiton/OID is exclussive
for Policy mode of operation.
ciscoSlaSmartAgentNotifyTrustInstallSuccess

.1.3.6.1.4.1.9.9.831.1.51
This notification is sent when Trust is installed
successfully.
          
Policy Mode Notification: This notificaiton/OID is exclussive
for Policy mode of operation.
ciscoSlaSmartAgentNotifyTrustInstallFailed.1.3.6.1.4.1.9.9.831.1.52
This notification is sent when Trust installation fails.
          
Policy Mode Notification: This notificaiton/OID is exclussive
for Policy mode of operation.
ciscoSlaSmartAgentNotifyPolicyInitialACKState


.1.3.6.1.4.1.9.9.831.1.53
This notification is sent during device bootup. It contains
current RUM acknowledgement state, discated by installed
policy.
ciscoSlaSmartAgentNotifyRegisterSuccess

.1.3.6.1.4.1.9.9.831.1.6
This notification is sent when Smart licensing registration
with Cisco Software Manager has succeeded.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyIdCertExpired

.1.3.6.1.4.1.9.9.831.1.7
This notification is sent when Smart licensing ID (node)
certificate has expired.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyIdCertRenewSuccess

.1.3.6.1.4.1.9.9.831.1.8
This notification is sent when Smart licensing ID (node)
certificate renewal has succeded.
This OID is not relevant when Smart Agent is operating in Policy
mode.
ciscoSlaSmartAgentNotifyIdCertRenewFail

.1.3.6.1.4.1.9.9.831.1.9
This notification is sent when Smart licensing ID (node)
certificate renewal has failed.
This OID is not relevant when Smart Agent is operating in Policy
mode.