CHAPTER 6 This section provides information about administrative tasks. It includes these topics: Stopping and Restarting the Cisco License Manager Server, page 6-1 How to Manage Users, page 6-2 Working with Alerts, page 6-6 Viewing Job Status, page 6-8 Viewing Logs, page 6-11 Understanding Errors in the Error Dialog Box, page 6-12 How to Use Report Manager, page 6-13 Generating, Viewing, Printing, and Exporting Reports, page 6-17 Setting the License Polling Frequency and Checking for Expiring Licenses, page 6-18 Stopping and Restarting the Cisco License Manager Server Before you can log in to Cisco License Manager, the server must be running. After installation, the server automatically starts. Table 6-1 shows how to stop and start the Cisco License Manager server. Table 6-1 Starting and Stopping the Cisco License Manager Server Configuration Task Windows platform Where to Do It Stop the Cisco License Manager server. Choose Start > All Programs > Cisco License Manager > CLM Server > Stop Server. Start the Cisco License Manager server. Choose Start > All Programs > Cisco License Manager > CLM Server > Start Server. Solaris platform Stop the Cisco License Manager server. Start the Cisco License Manager server. Run the $CLM_HOME/bin/clm_stop.sh command. Run the $CLM_HOME/bin/clm_start.sh command. 6-1
How to Manage Users How to Manage Users The user management portion of Cisco License Manager controls the authentication and authorization of its functions. The default user (administrator) is created during the installation setup. Only a user with an Administrator role can add, delete, and edit other user accounts. The administrator account cannot be deleted. This section contains these user management topics: Adding a New User, page 6-2 Editing User Profile Information, page 6-3 Editing User Roles, page 6-5 Deleting a User Account, page 6-6 Adding a New User You can use this procedure to add a new user. Restrictions Only a user with an Administrator role can add or delete user accounts. For valid characters and guidelines for entering data, see the Understanding Naming Rules section on page 9-15. If you do not have an Administrator role, you can edit your own information but not information for another user. Procedure Step 1 Step 2 Step 3 Choose Manage > Manage Users, or click Users in the Quick Links pane. The Manage Users explorer appears in the Content Area pane. Click New User. The New User dialog box appears. Add any of the information in Table 6-2, and click OK. 6-2
How to Manage Users Table 6-2 Field Descriptions for the Users Tab Field User ID Password Confirm Password Assign Role Description Username. Note Username and User ID are the same. Cisco License Manager password. Confirm Cisco License Manager password. Choose one of these roles: Administrator Inventory Management PAK Management License Management Report Management How Cisco License Manager Authenticates Users, page 1-3 How Cisco License Manager Handles Stackable Devices, page 1-5 Manage Users Explorer, page 5-14 Understanding Naming Rules, page 9-15 Editing User Profile Information You can change your own user information, including your user password for Cisco License Manager and for your Cisco login. Before You Begin Before users can receive license information, they must register and have valid Cisco.com user IDs. Users must add their Cisco.com user IDs, passwords, and e-mail addresses to their user profiles for Cisco License Manager to work properly. Restrictions If you are a user with an Administrator role, you can add, edit, and delete other user profiles. For valid characters and guidelines for entering data, see the Understanding Naming Rules section on page 9-15. If you do not have an Administrator role, you can edit your own information but not information for other users. 6-3
How to Manage Users Procedure Step 1 Step 2 Step 3 Choose Manage > Manage Users, or click Users in the Quick Links pane. The Manage Users explorer appears in the Content Area pane. Select the appropriate user, and click Edit Info. The Edit User Information dialog box appears. Change any of the information in Table 6-3, and click OK. Table 6-3 Field Descriptions for the Edit User Information Dialog Box Field User Information User Login Name Password Confirm Password First Name Last Name Company Name Reseller Email Notification Email Address Notification by Email Cisco Authentication Cisco Username Cisco Password Confirm Cisco Password Proxy Server Username Proxy Server Password Confirm Proxy Server Password License Options Show Expired/Expiring Licenses Days to Expire Description Username for logging in to Cisco License Manager. This field cannot be changed. Username and User ID are the same. Cisco License Manager password. Confirm Cisco License Manager password. (Optional) First name of the user. (Optional) Last name of the user. (Optional) Company name of the user. (Optional) Reseller name of the user. Valid e-mail address to receive notifications from the Cisco License Manager server. (Optional) Allows e-mail from Cisco License Manager to the user. Valid Cisco.com username. Cisco user password. Confirm Cisco user password. Valid Cisco.com proxy username. Proxy user password. Proxy server password. Displays the expired and expiring licenses for the specified user upon user login. Specifies the time in days of the licenses for the server to return. The server returns all the license IDs set to expire before the time specified. 6-4
How to Manage Users How Cisco License Manager Authenticates Users, page 1-3 How Cisco License Manager Handles Stackable Devices, page 1-5 Manage Users Explorer, page 5-14 Adding a New User, page 6-2 Understanding Naming Rules, page 9-15 Editing User Roles You can use this procedure to edit the role of a user. Restrictions A user with an Administrator role can edit the role of another user. Note If you change the role for users while they are logged in to Cisco License Manager, the system logs them off of Cisco License Manager. Procedure Step 1 Step 2 Step 3 Choose Manage > Manage Users, or click Users in the Quick Links pane. The Manage Users explorer appears in the Content Area pane. Select a user, and click Edit Role. The Edit User Role dialog box appears. Select the new role to be assigned to the user from the options, and click OK. How Cisco License Manager Authenticates Users, page 1-3 How Cisco License Manager Handles Stackable Devices, page 1-5 Manage Users Explorer, page 5-14 Understanding Naming Rules, page 9-15 6-5
Working with Alerts Deleting a User Account You can use this procedure to delete a user account. Restrictions If you are a user with an Administrator role, you can add, edit, and delete other user profiles. For valid characters and guidelines for entering data, see the Understanding Naming Rules section on page 9-15. If there is only one user, that user must have an Administrator role. If you do not have an Administrator role, you can edit your own information but not information for other users. Procedure Step 1 Step 2 Step 3 Choose Manage > Manage Users, or click Users in the Quick Links pane. The Manage Users explorer appears in the Content Area pane. Select the appropriate user, and click Delete User. The Delete User dialog box appears. Confirm your user deletion, and click Yes. How Cisco License Manager Authenticates Users, page 1-3 How Cisco License Manager Handles Stackable Devices, page 1-5 Manage Users Explorer, page 5-14 Working with Alerts You can view the notifications (alerts) that your Cisco devices and Cisco License Manager Server send about license information. For example, an alert is sent if a corrupt license is identified. The alerts that appear in the Alerts Monitor dialog box are the ones that have been received during your current login session. Use this procedure to view, filter, export, or clear alerts. Procedure Step 1 Choose Troubleshoot > View Alerts, or click View Alerts in the Quick Links pane. The Alerts Monitor dialog box appears. 6-6
Working with Alerts Table 6-4 describes the fields in the dialog box. Table 6-4 Field Descriptions for the Alerts Monitor Dialog Box Field Filter Device Group Device Name Device Model Clear Filters Alerts Monitor Table Severity Time Operation Message Group Description Choose the appropriate device group for filtering. Choose the appropriate device name for filtering. Choose the appropriate device model for filtering. Click the button to clear the filters. Color-coded with the severity: Critical Red Major Orange Minor Yellow Warning Teal Informational Green Date and time at which the alert occurred. Unicast message. Information on system status. Device group. 6-7
Viewing Job Status Step 2 Perform these actions as required: To filter the alerts, choose the appropriate device group, device name, or device model from the drop-down menus. You can choose just one way to filter, or you can choose something from each drop-down menu. The contents of these filters are populated based on information in your Cisco License Manager database. For example, you will be allowed to filter only on device names that are currently in your inventory. Note To clear the filters and restart your filtering process, click Clear Filters. To export the alerts to a.csv file, click Export, browse to the location where you want to save the file, and click Save. To clear the alert flag from the main window status bar, click Clear. Note Clicking Clear does not clear the individual alerts. It simply classifies the alerts as being read and changes the alerts icon back to No new Alerts. Step 3 Click Close to close the dialog box. Status Area, page 5-16 Viewing Job Status, page 6-8 FAQs and Troubleshooting, page A-1 Viewing Job Status The Cisco License Manager server maintains a list of server jobs. For each server job, the job ID, request comments string, creation date and time, status of the request (such as complete or not complete), and returned status are shown. The returned status provides the error code and error message for each item in the request. This view is periodically updated. When a job is pending, you can view the progress status. The asynchronous server requests are discover device, poll license, download product authorization key (PAK) information, obtain license, deploy licenses, annotate licenses, and execute policies. Use this procedure to view job status. Procedure Step 1 Choose Manage > View Job Status, or click View Job Status in the Quick Links pane. The View Job Status dialog box appears. 6-8
Viewing Job Status For information about status error levels, see the Understanding Status Error Levels section on page 6-10. Table 6-5 describes the fields in the dialog box. Table 6-5 Field Descriptions for the View Job Status Dialog Box Field View Job Status Table Creation Time Job Description User Can Retry Job Status Description Date and time at which the request was entered. Term to describe the function name. Username of the person who initiated the operation. A check mark ( ) appears if the failed operation can be retried. Status of the job (Complete-Success, Pending, Complete-Error). Note If the job status is Complete-Success, the operation completed with no errors. If the job status is Complete-Error, the operation completed, but there were errors on some items. % Complete Percentage of the job that is completed. Item Count Number of items of this request. Function Name Function name of the operation. Job ID Job ID for the request. ID Status Status Code Overall status of the operation (Success or an error code). 6-9
Viewing Job Status Table 6-5 Field Descriptions for the View Job Status Dialog Box (continued) Field Status Message Job ID ID Status Item Table Show All Items PAK Name Status Code Status Message Detailed Message Description Overall error message if the code is not Success. Unique string that represents the asynchronous function. Shows all devices included in the selected job. ID of the individual device, license, or PAK that is involved. Status of the individual operation (Success or error numbers). Individual error message if the status code is not Success. Extra error messages provided by the server, if necessary. Step 2 (Optional) Perform other tasks in this dialog box as required: To view the progress of a job, highlight the job, right-click, and choose View Progress. If a job has failed, highlight the job, right-click, and choose Retry Failed Items. To cancel one or more jobs, check the check box next to the job and click Abort. To remove one or more jobs, check the check box next to the job and click Delete. To refresh the View Job Status dialog box, click Refresh. To check the Cisco Product License Registration Portal connection, click Check License Portal. Status Area, page 5-16 Working with Alerts, page 6-6 FAQs and Troubleshooting, page A-1 Understanding Status Error Levels Cisco License Manager provides two status levels: Overall operation status Provides status on bulk requests such as polling, annotating, obtaining, and deploying licenses. Status might be shown for one or more devices. If the bulk operation completes, the status reads Complete. The operation then provides individual status results that are listed in the ID Status Item table. Individual operation status Provides status on the individual results of a bulk request. Job requests are assigned an ID (for example, reqid1157740568514) and can be viewed by selecting the row. Individual operations can return errors even if the bulk operation status is successful. Be sure always to check the individual status. The two levels of status are displayed in the status ID as follows: Bulk operation status:individual result status For example, Complete-Success might be displayed when a polling operation has completed. This status message indicates that the polling operation was successful and there are no individual item errors. If the top-level status is Complete-Error, the operation has completed, but there are individual item errors. 6-10
Viewing Logs In viewing the individual messages, you might find that the poll result included an error in reaching a device. That would happen because individual results of an action are not marked at the operation level; only the status of the request as a whole is marked. Status Area, page 5-16 Working with Alerts, page 6-6 Viewing Job Status, page 6-8 Troubleshooting Tips, page A-8 Viewing Logs You can view the logs if you want to look at the audit trail of all past activities. The logs allow you to view the last n entries in the audit trail. Procedure Step 1 Choose Troubleshoot > View Audit Log, or click View Audit Log in the Quick Links pane. The Log Viewer dialog box appears. Table 6-6 describes the fields in the dialog box. 6-11
Understanding Errors in the Error Dialog Box Table 6-6 Field Descriptions for the Log Viewer Dialog Box Field Start Time End Time Message Status Affected Objects User Description Start time of the task. End time of the task. Task performed. Status of the task (success or failure). Objects that were affected by the task. User who performed the task. Step 2 Perform other tasks in this dialog box as required: Double-click a log to view the log details. Click a column heading to sort the logs by the heading title. To purge the logs from the Log Viewer dialog box, click Purge. This action removes any logs in excess of 5000. To refresh the dialog box and retrieve new entries from the server, click Refresh. This dialog box does not automatically refresh with new data. You must click Refresh. Understanding Errors in the Error Dialog Box The Cisco License Manager Error dialog box appears when an error occurs within Cisco License Manager. Table 6-7 describes the fields in the dialog box. Table 6-7 Field Descriptions for the Error Dialog Box Field Status Error Code Fault Detailed Message Possible Cause Possible Remedy Item Status Item # Item ID Error Code Fault Description Server-assigned error code. Translation of the error code. Detailed error message regarding this error, if provided by the Cisco License Manager server. Possible reason for the error. Possible solution to remove the error or problem. Item number. Error item ID. Server-assigned error code. Translation of the error code. 6-12
How to Use Report Manager Table 6-7 Field Descriptions for the Error Dialog Box (continued) Field Detailed Message Possible Cause Possible Remedy Description Detailed error message regarding this error, if provided by the Cisco License Manager server. Possible reason for the error. Possible solution to remove the error or problem. Troubleshooting Tips, page A-8 How to Use Report Manager Understanding Report Manager, page 6-13 Audit Trail Report, page 6-14 Device Summary Report, page 6-14 License Discrepancy Report, page 6-15 License Expiry Report, page 6-15 Newly Discovered Device Report, page 6-16 Redeployable License Report, page 6-16 RMA Discrepancy Report, page 6-16 Undeployed License Report, page 6-17 Generating, Viewing, Printing, and Exporting Reports, page 6-17 Understanding Report Manager The Report Manager provides the reports that you can use to monitor and track license information for all devices in your inventory. You can display reports in HTML or in plain text format. Large reports are presented as multiple HTML pages in the browser. You cannot save reports; you can view them only from the reports window. Table 6-8 list the reports available in Report Manager. Table 6-8 Reports Available in Report Manager Report Name Where to Find More Information Audit Trail Report Audit Trail Report section on page 6-14 Device Summary Report Device Summary Report section on page 6-14 License Discrepancy Report License Discrepancy Report section on page 6-15 License Expiry Report License Expiry Report section on page 6-15 Newly Discovered Device Report Newly Discovered Device Report section on page 6-16 Redeployable License Report Redeployable License Report section on page 6-16 6-13
How to Use Report Manager Table 6-8 Reports Available in Report Manager (continued) Report Name Where to Find More Information RMA Discrepancy Report RMA Discrepancy Report section on page 6-16 Undeployed License Report Undeployed License Report section on page 6-17 Note You can run reports by using the application programming interface (API) if you purchase the Cisco License Manager Java and Perl Software Developer Kit (SDK). To place an order, visit the Cisco ordering page at www.cisco.com/web/ordering/or13/or8/order_customer_help_how_to_order_listing.html. Audit Trail Report The Audit Trail Report contains an audit trail of Cisco License Manager operations. Use this report to track the usage of Cisco License Manager. The Audit Trail Report contains this information: Audit trail ID Username Operation Start time End time Status Affected object Message Generating, Viewing, Printing, and Exporting Reports, page 6-17 Device Summary Report The Device Summary Report contains all the device and license information in the current database.the report displays a summary that contains the Device Model Statistics. You can click each model to view the show device summary table for that model. The Device Summary Report contains this information: Device ID UDI Device Model State Licensable features 6-14
How to Use Report Manager Manage Licenses Explorer, page 5-7 Manage Devices Explorer, page 5-10 Generating, Viewing, Printing, and Exporting Reports, page 6-17 How to Manage Devices, page 7-1 How to Manage Licenses, page 8-1 License Discrepancy Report The License Discrepancy Report lists discrepancies between the Cisco License Manager license inventory and the actual licenses deployed in the network. For example, if you deploy licenses to your network through the API, they do not exist in the Cisco License Manager license inventory until polling occurs. The License Discrepancy Report contains this information: Device Name UDI Feature names License line ID Deployed status Activation state Source Deploy Licenses Explorer, page 5-14 Generating, Viewing, Printing, and Exporting Reports, page 6-17 How to Manage Licenses, page 8-1 Deploying a License, page 8-5 License Expiry Report The License Expiry Report provides license expiry information for your devices. Use this report to identify devices with software features that have expired or that expire at a future date. The License Expiry Report contains this information: Device Name UDI Model State Licensable features (feature, type, expiration date) Generating, Viewing, Printing, and Exporting Reports, page 6-17 6-15
How to Use Report Manager Newly Discovered Device Report The Newly Discovered Device Report shows the list of devices that are added to the database in the most recent discovery. Each time a device discovery is completed, the previous report is overwritten. The Newly Discovered Device Report contains this information: Device Name UDI Hostname IP Address Model Type Generating, Viewing, Printing, and Exporting Reports, page 6-17 Redeployable License Report The Redeployable License Report compares the licensed features actively being used on the device with the feature licenses installed on the device. Any feature license that is deployed on the device but is not being used by that device can be deployed elsewhere. The Redeployable License Report contains this information: Device Name UDI Feature name License line ID Status Manage Licenses Explorer, page 5-7 Deploy Licenses Explorer, page 5-14 Generating, Viewing, Printing, and Exporting Reports, page 6-17 How to Manage Licenses, page 8-1 Deploying a License, page 8-5 RMA Discrepancy Report The RMA Discrepancy Report provides details about devices that are shown as being returned through the return merchandise authorization (RMA) process but are still operational on your network. If you need further assistance with your RMA, contact your Cisco support representative. The RMA Discrepancy Report contains this information: Device Name 6-16
Generating, Viewing, Printing, and Exporting Reports UDI Model State Licensable features Generating, Viewing, Printing, and Exporting Reports, page 6-17 Undeployed License Report The Undeployed License Report lists all the licenses that users have obtained but not yet deployed and shows to which devices in inventory the license can apply. Undeployed status can mean that a license was never installed or that it was installed, but later cleared. For example, if you needed to deploy some advanced IP services on a device, you could use this report and find the licenses that might fit that need. You could then go into the PAK folder, locate the license, and deploy it on the device. If you want to deploy a license on a different device, you can rehost that license and put it on another device. The Undeployed License Report contains this information: Device Name UDI Undeployed license information License line ID Feature name Manage Licenses Explorer, page 5-7 Deploy Licenses Explorer, page 5-14 Generating, Viewing, Printing, and Exporting Reports, page 6-17 How to Manage Licenses, page 8-1 Deploying a License, page 8-5 Generating, Viewing, Printing, and Exporting Reports You can generate and display a report to monitor and track license information for all devices in your inventory. Before You Begin If you have large quantity of devices in the inventory, generating reports might take a very long time. Also the report might be too large for you to browse effectively. In such a case, use report filters to generate smaller reports, one at a time. 6-17
Setting the License Polling Frequency and Checking for Expiring Licenses Procedure Step 1 Step 2 Step 3 Click Reports in the Quick Links pane. The Report Manager dialog box appears showing the first report generated. If you want to generate a different report, choose the report type from the drop-down list, and then click View Report. Click View Report. The report filter dialog box appears. Set your filters. For example, set the number of days in the License Expiring In filter to generate a report that shows expiring licenses. Note The Audit Trail Report, Hardware Ene of Sale and End of Life Report, Software End of Sale and End of Life Report, Newly Discovered Device Report, PSIRT Summary Report, and PSIRT Details Report do not provide any filters. Step 4 Step 5 Click Regenerate to generate the new report, or click Retrieve to retrieve the current report. Perform other tasks in this dialog box as required: To print the report, click Print. Set your printer options, and click Print. To export the report, right-click the Download CSV File link at the bottom of the dialog box. When you are prompted to save, enter the filename in which to save the comma separated value (CSV) filtered data. Understanding Report Manager, page 6-13 Setting the License Polling Frequency and Checking for Expiring Licenses You can use the Options feature to set the frequency of Cisco License Manager license polling and to check for expiring licenses. You can set the options by clicking these tabs: License EOS/EOL PSIRT You must set up EOS/EOL and PSIRT configurations before the EOS/EOL and PSIRT reports can be generated on the server. Procedure Step 1 Choose Edit > Options. 6-18
Setting the License Polling Frequency and Checking for Expiring Licenses The Options dialog box appears. Step 2 (Optional) Set the options for polling licenses: Check the Poll Licenses check box. Enter the start date. Enter the start time. Set the frequency of checking the license polling in number of days. Note Enter dates using the mm/dd/yyyy format. Enter times using the hh:mm am/pm format. Step 3 Step 4 (Optional) Set the options for checking expiring features for all devices: Check the Check Expiring Features For All Devices check box. Enter the number of days prior to license expiration that you want to be notified. Enter the start date. Enter the start time. Set the frequency of checking the expiring features for all devices by specifying the number of days. Click OK. Manage Licenses Explorer, page 5-7 License Properties, page 5-8 6-19
Setting the License Polling Frequency and Checking for Expiring Licenses 6-20