clmgmtLicenseActionEntry

An entry for each action that is being executed or was
executed recently. The management application executes an
action
by creating this entry. This can be done in the following
2 methods
            
1. CREATE-AND-GO method
    Management application sets clmgmtLicenseActionRowStatus to
    createAndGo(4) and all other required objects to valid
    values in a single SNMP SET request. If all the values
    are valid, the device creates the entry and executes the
    action. If the SET request fails, the entry will not be
    created.
2. CREATE-AND-WAIT method
    Management application sets clmgmtLicenseActionRowStatus to
    createAndWait(5) to create an entry. Management application
    can set all other required objects to valid
    values in more than one SNMP SET request. If SET request
    for any of the objects fails, management application can
set
    just only that object. Once all the required objects
    are set to valid values, management application triggers
action
    execution by setting clmgmtLicenseActionRowStatus to
    active(1).
            
To stop the action from being executed, the management
application
can delete the entry by setting clmgmtLicenseActionRowStatus
to destroy(6) when clmgmtLicenseActionState is pending(2).
            
The status of action execution can be known by querying
clmgmtLicenseActionState. If the action is still in
pending(2) or in inProgress(3) state, the management
application need to check back again after few seconds.
Once the action completes and status of the action is
failed(6), the reason for failure can be retrieved
from clmgmtLicenseActionFailCause. If the status of the
action is partiallySuccessful(5), results of individual
licenses can be queried from clmgmtLicenseActionResultTable.
            
Not all objects in the entry are needed to execute every
action. Below is the list of actions and the required
objects that are needed to be set for executing that
action.
            
1. Installing a license
   The following MIB objects need to be set for installing a
   license
     a. clmgmtLicenseActionTransferProtocol
     b. clmgmtLicenseServerAddressType
     c. clmgmtLicenseServerAddress
     d. clmgmtLicenseServerUsername
     e. clmgmtLicenseServerPassword
     f. clmgmtLicenseFile
     g. clmgmtLicenseStore
     h. clmgmtLicenseStopOnFailure
     i. clmgmtLicenseAcceptEULA
     j. clmgmtLicenseAction
            
   clmgmtLicenseActionEntPhysicalIndex need not be set
   explicitly for license installs. License itself identifes
   the device where the license needs to be installed.
            
   clmgmtLicenseStore need to be set to store the licenses
   in a non-default license store. But, if a license file
   has more than one license and licenses need to be
   installed on multiple devices (for example to multiple
   members with in a stack), then value of clmgmtLicenseStore
   is ignored and the licenses will be installed in default
   license stores of the respective devices.
            
2. Clearing a license
   The following MIB objects need to be set for clearing a
   license
     a. clmgmtLicenseActionEntPhysicalIndex
     b. clmgmtLicenseActionLicenseIndex
     c. clmgmtLicenseStore
     d. clmgmtLicenseAction
            
3. Revoking a license
   The following MIB objects need to be set for revoking a
   license
     a. clmgmtLicenseActionTransferProtocol
     b. clmgmtLicenseServerAddressType
     c. clmgmtLicenseServerAddress
     d. clmgmtLicenseServerUsername
     e. clmgmtLicenseServerPassword
     f. clmgmtLicensePermissionTicketFile
     g. clmgmtLicenseRehostTicketFile
     h. clmgmtLicenseStopOnFailure
     i. clmgmtLicenseAction
            
4. Regenerate last rehost ticket
   The following MIB objects need to be set for regenerating
   last rehost ticket
     a. clmgmtLicenseActionTransferProtocol
     b. clmgmtLicenseServerAddressType
     c. clmgmtLicenseServerAddress
     d. clmgmtLicenseServerUsername
     e. clmgmtLicenseServerPassword
     f. clmgmtLicensePermissionTicketFile
     g. clmgmtLicenseRehostTicketFile
     h. clmgmtLicenseStopOnFailure
     i. clmgmtLicenseAction
            
            
5. Save all licenses to a backup storage
   The following MIB objects need to be set for storing all
   licenses to a backup store
     a. clmgmtLicenseActionEntPhysicalIndex
     b. clmgmtLicenseActionTransferProtocol
     c. clmgmtLicenseServerAddressType
     d. clmgmtLicenseServerAddress
     e. clmgmtLicenseServerUsername
     f. clmgmtLicenseServerPassword
     g. clmgmtLicenseBackupFile
     h. clmgmtLicenseAction
            
6. Generate and export EULA if the licenses need EULA to be
   accepted for installing.
   The following MIB objects need to be set exporting required
   EULAs
     a. clmgmtLicenseActionTransferProtocol
     b. clmgmtLicenseServerAddressType
     c. clmgmtLicenseServerAddress
     d. clmgmtLicenseServerUsername
     e. clmgmtLicenseServerPassword
     f. clmgmtLicenseFile
     g. clmgmtLicenseEULAFile
     h. clmgmtLicenseAction
            
For any action, if clmgmtLicenseActionTransferProtocol
is set to local(2), the following objects need not be set.
     a. clmgmtLicenseServerAddressType
     b. clmgmtLicenseServerAddress
     c. clmgmtLicenseServerUsername
     d. clmgmtLicenseServerPassword
            
Entry can be deleted except when clmgmtLicenseAction is set
to pending(2). All entries are volatile and are cleared
on agent reset.

MIB

CISCO-LICENSE-MGMT-MIB

OID

.1.3.6.1.4.1.9.9.543.1.1.2.1

Type

row

Status

current

Parent

clmgmtLicenseActionTable

Table

clmgmtLicenseActionTable

Children

22