The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Licenses determine the features you can use and the type and number of devices that Cisco EPN Manager can manage. When you connect to Cisco EPN Manager (without logging in), the login page displays a banner that identifies the type of license the server is running (see Types of Cisco EPN Manager Licenses). If Cisco EPN Manager is configured to use SSO (single sign-on), check the license type by viewing the banner contents.
Cisco EPN Manager supports Cisco Smart Licensing and traditional licensing. If you are currently using traditional licensing, Cisco recommends that you convert to Smart Licensing. For information on the differences between the two types of licensing, refer to the Cisco Smart Licensing Overview on Cisco.com.
How to use Cisco Smart Licensing and traditional licensing is explained in the following topics.
The following topics describe the feature- and time-based licenses supported by Cisco EPN Manager .
A base license enables all applications and all device drivers (without device count restrictions) on the server. It is displayed in the web GUI as Base License.
Extended RTM licenses for core, edge, aggregation, and access network devices. These licenses enable end-to-end network management: device lifecycle management, network provisioning, and network assurance.
Foundation RTM licenses for service provider Wi-Fi networks that have Wi-Fi access points, WAN routers, core switches, and data center switches. Along with device lifecycle management, these licenses enable assurance visibility and troubleshooting capabilities.
Devices that are configured as satellites (for example, Cisco ASR 903 with a Cisco ASR 9000v host) are counted as independent devices.
Cisco EPN Manager will also discover third party network devices using its Open License "best effort" detection process. The collected information is displayed in the web GUI, but results can vary widely (depending entirely on the responses Cisco EPN Manager receives from the devices). You do not have to purchase any licenses to enable this mechanism.
RTM licenses are displayed in the GUI as follows:
The Standby (SBY) license allows the setup of high availability deployments. In a high availability deployment, all the device and feature licenses must be installed on the primary server. No licenses are required on the secondary server.
The NBI license enables all MTOSI- and RESTConf-related APIs and administrative features on the server. If the NBI license is time-based, the remaining time is listed next to the license. This license is displayed in the GUI as NBI.
Most licenses can be purchased as a lab license or time-based license:
Lab—For lab or staging environments.
Time-Based (Evaluation)—For a 90-day trial period (the product is disabled when the trial period expires). If you purchase a time-based licenses, the days remaining are listed next to the license name.
These licenses can be converted to Permanent licenses.
Cisco recommends that you use the simple and efficient Cisco Smart Licensing mechanism to manage your licenses. A comparison of Smart and traditional licensing is provided in the Cisco Smart Licensing Overview on Cisco.com. After enabling Smart Licensing in Cisco EPN Manager , you must register Cisco EPN Manager with the Cisco Smart Software Manager (CSSM) on Cisco.com. After you are registered, all Cisco EPN Manager license types will be available to you from the Cisco EPN Manager web GUI
If you are currently using traditional licensing, you can convert your existing Cisco EPN Manager licenses to Smart entitlements at any time, as described in Convert Traditional Licenses to Smart Entitlements.
The following topics explain how to set up and manage Cisco EPN Manager licenses using Cisco Smart Licensing.
Follow these steps to set up Cisco Smart Licensing so you can use it to manage your licenses. If you are currently using traditional licensing, use these same procedures to use Cisco Smart Licensing and, when convenient, convert your existing Cisco EPN Manager licenses as described in Convert Traditional Licenses to Smart Entitlements.
|
Step |
See: |
1. |
Create a Smart Account with Cisco Systems. |
Go to Smart Account Request and follow the instructions on the web site. |
2. |
Set up communication between Cisco EPN Manager and the CSSM on Cisco.com. |
Set Up the Transport Mode Between Cisco EPN Manager and Cisco Smart Software Manager |
3. |
Enable Smart Licensing in Cisco EPN Manager . |
|
4. |
Register Cisco EPN Manager with the CSSM on Cisco.com by obtaining a token from the CSSM and entering it in the Cisco EPN Manager web GUI. |
Register Cisco EPN Manager with the Cisco Smart Software Manager |
5. |
Choose the licenses you want to use in Cisco EPN Manager . |
|
6. |
Set up the Smart License Dashboard so you can monitor your licensing usage. |
Configure License Thresholds for the Smart License Dashboard |
If you plan to use an HTTP proxy, you must first configure the proxy server. See Set Up the Cisco EPN Manager Proxy Server.
Step 1 | Choose , then choose . |
Step 2 | Click the
Smart
Licensing Transport tab and select a communication mode:
|
Step 3 | Click Save to save the transport settings. |
Step 4 | To revert to the default values, click Reset and Save. |
If you have not already done so, enable Smart Licensing. See Enable Smart Licensing in Cisco EPN Manager.
Make sure you have set up the transport mode. See Set Up the Transport Mode Between Cisco EPN Manager and Cisco Smart Software Manager.
Do one of the following:
If you have not yet registered Cisco EPN Manager with the CSSM on Cisco.com, Cisco EPN Manager will be in evaluation mode (which has a limit of 90 days). Register the product as described in Register Cisco EPN Manager with the Cisco Smart Software Manager.
If you have registered Cisco EPN Manager with the CSSM, select the licenses you want to use. See Choose Cisco EPN Manager Licenses Using Smart Licensing.
To register Cisco EPN Manager with the CSSM, you must obtain a token from the CSSM and enter it into the Cisco EPN Manager web GUI. This is a one-time requirement. If for any reason you have to re-register your product instance, you can do that by following this procedure. For information on how to use the CSSM, refer to the Cisco Smart Software Manager User Guide.
Note | Refer to the Cisco Smart Software Manager User Guide for information on other actions you can perform from the CSSM—for example, renewing license registration and license authorization, unregistering the product from Cisco Smart Licensing, and so forth. |
If your organization does not have a Smart Account, go to software.cisco.com, choose Request a Smart Account (under Administration), and follow the instructions to create an account.
Step 1 | Go to the Cisco Software Central web site (software.cisco.com). |
Step 2 | Obtain your
tokens. If you already have tokens (for example, you converted traditional
licensing PAKs to Smart entitlements), proceed to the next step.
If you are re-registering your product instance, your token will be listed in the CSSM user interface. If your token is no longer valid, you can obtain a new token using this procedure.
|
Step 3 | Enter the Token ID into the Cisco EPN Manager web GUI to register the product instance. |
Step 4 | Log out of the Cisco EPN Manager web GUI, then log back in. |
Choose the licenses you want to use. See Choose Cisco EPN Manager Licenses Using Smart Licensing.
After you have registered Cisco EPN Manager with the CSSM, all Cisco EPN Manager license types will be listed in the Cisco EPN Manager web GUI, and you can choose the ones you want to use.
Configure the Smart License Dashboard thresholds for the new licenses. See Configure License Thresholds for the Smart License Dashboard.
If you have been managing Cisco EPN Manager licenses using traditional licensing, you can enable and configure Smart Licensing by following the setup tasks in Set Up Cisco Smart Licensing in Cisco EPN Manager. When convenient, convert your existing traditional licenses to Smart entitlements described in this procedure. You will have to enter your PAK numbers in the License Registration Portal on Cisco Software Central site.
You must have a Cisco.com account to access Cisco Software Central. If you do not have an account, go to the Cisco.com registration page.
Make sure you have your existing traditional licensing Product Activation Key (PAK) numbers.
To efficiently manage your licenses, configure the Smart License Dashboard to indicate when Cisco EPN Manager is approaching the point where its licenses will be depleted. The settings you configure here system-wide .
Check current license usage using the Smart Licensing Dashboard. To open the dashboard, choose Types of Cisco EPN Manager Licenses.
. For an explanation of the basic license types, see
To view these license counts: |
Check this part of the dashboard: |
---|---|
For the current date |
License Summary Count—Green indicates compliant license counts; red indicates non-compliant license counts. |
For a specific week or month |
License Summary—Hover over a bar chart to view more details. |
For a specific license type |
Device Distribution for License—Click one of the license links at the top of the License Summary dashlet. Hover your mouse cursor over the chart to view the details. |
The License Registration Status reflects whether the product is properly registered with Cisco Smart Software Licensing on Cisco.com.
License Registration Status |
Description |
---|---|
Unregistered |
Smart Software Licensing is enabled on Cisco EPN Manager but Cisco EPN Manager is not registered with the CSSM. |
Registered |
Cisco EPN Manager is registered with the CSSM. Cisco EPN Manager has received an ID certificate that will be used for future communication with the Cisco licensing authority. |
Registration Expired |
Cisco EPN Manager did not successfully renew its registration prior to the expiration date and has been removed from CSSM. |
The License Authorization status reflects license usage against purchased licenses, and whether you are in compliance with Cisco Smart Licensing. If you exceed the number of purchased license, the product will be Out of Compliance.
License Authorization Status |
Description |
---|---|
Evaluation Mode |
Cisco EPN Manager is running in evaluation mode (expires in 90 days). |
Authorized |
Cisco EPN Manager has a valid Smart Account and is registered. All licenses requested by the product are authorized for use. |
Out of Compliance |
Cisco EPN Manager has exceeded the number of licenses that were purchased. (Specifically, the virtual account for the product instance has a shortage of one or more licenses types.) |
Evaluation Expired |
The evaluation period has expired and Cisco EPN Manager is in the unlicensed state. |
Authorization Expired |
Cisco EPN Manager did not successfully renew its license authorization prior to the authorization expiration date. |
Note | Cisco recommends that you convert to Cisco Smart Licensing. See Set Up Cisco Smart Licensing in Cisco EPN Manager. If you are using Smart Licensing and want to re-enable traditional licensing, see Disable Smart Licensing. |
Cisco EPN Manager checks traditional licenses every 4 hours and writes the status to the License log (/opt/CSCOlumos/logs/license.log). If a time-based license expires, any users that are in an active session will be redirected to the Licenses page, and new users are prevented from logging in. If an RTM license device count is exceeded, you should either:
See these topics for more information on traditional licenses:
To view the installed Cisco EPN Manager traditional licenses, choose . Cisco EPN Manager supports the licenses listed in Base License.
To install a new traditional license, the original license must reside on the server. Do not create copies of licenses. To purchase new traditional licenses, point your browser to www.cisco.com/go/license. Make sure you install licenses in the correct order. For example, you must always install the Base license first because it is required by the other licenses.
When you delete a license, all of that license’s information is removed from the server.
Caution | If you make a manual change to a license file, it will be considered corrupted and Cisco EPN Manager will not install it. If this happens, obtain a new license file. |
The only time you may have to move a license to another server is if you are using high availability, and a server fails. If you need to delete a license, see Add and Delete Traditional Licenses. To move the license:
From the Licensing dashboard, you can determine whether traditional or smart software licensing is enabled (indicated in the Active Licensing Mode field at the top of the dashboard) and view the number of licenses that are currently in use. You can set the licensing mode from the Smart Software Licensing page ( ).
To open this dashboard, do one of the following:
Choose
.Click the Licensing Dashboard link from the top-right corner of the Smart Software Licensing page.
The information displayed in the dashboard depends on the licensing mode that is enabled. If smart software licensing is currently enabled, the following dashlets are displayed:
License Summary Count area—Displays the number of licenses consumed and the compliance status for each license type. The number of licenses displayed is based on the current date.
License Summary dashlet—Displays a bar chart that graphs the number of licenses consumed for each license type during a particular time period. To view additional information, place your cursor over the chart.
Device Distribution for License dashlet—To view the device distribution chart for a particular license, click its link from the top of the chart displayed in the License Summary dashlet. To view additional information, place your cursor over the chart.
Note | The information displayed in the License Dashboard is refreshed daily after the SmartLicense job runs at 02:00 A.M. (its pre-configured run time). To view this job in the Job Dashboard, choose . |
If traditional licensing is currently enabled, the Licensing dashboard displays the Traditional Licensing dashlet. Specify whether you want to view information about Lifecyle or Assurance licenses by choosing the corresponding option from the License Type drop-down list. The dashlet updates, displaying information such as the device families with that license type, the number of tokens allocated to each device in those families, as well as the number of tokens that are not being used at the moment.
Cisco provides updates to the Cisco EPN Manager software periodically. These updates fall into the following three categories:
Add-ons—Provide new features, which can include GUI screens and functionality, to supplement the Cisco EPN Manager version you are using. This includes Cisco EPN Manager maintenance packs and maintenance pack point patches.
The update notifications that Cisco EPN Manager displays depends on the Notification Settings specified by your administration. See Enable or Disable Notifications About Software Updates . All software updates are packaged in .ubf files. A large update can contain individual smaller updates, from which you can choose what you want to install. When you install an update, Cisco EPN Manager does the following:
Verifies that the file publisher is Cisco Systems and the file has not been tampered with
Automatically installs any other updates that are required
If you have connectivity to Cisco.com, you can download install the updates directly from Cisco.com. If you do not have internet connectivity, copy the update from a server that has the necessary connectivity and install it from there.
Use one of these methods to check the Cisco EPN Manager product version.
#cat /opt/CSCOlumos/installedComponentsVersions.xml
To use the CLI, see Establish an SSH Session With the Cisco EPN Manager Server.
If you are not logged in to the web GUI, you can view a popup that lists the software updates by clicking View Installed Updates from the login page.
If you are logged in to the web GUI, you can view the software updates in two ways:
From the About page, by clicking the settings icon at the top right of the page and clicking About Cisco EPN Manager, then clicking View Installed Updates. (The View Installed Updates link is also available from the login page.)
By choosing
(this method provides the most detail).When you choose Cisco EPN Manager displays two tabs. The Updates tab . The Files tab contains information about
,By default, Cisco EPN Manager will display information about all available updates in the Software Update page. Because the list can be quite long, you may want to adjust what is displayed and the updates for which you are notified. You can also disable all notifications and reenable them later.
Step 1 | Configure the default Cisco.com credentials so that Cisco EPN Manager can get information about available updates. |
Step 2 | Configure your
software update notification settings.
|
Before installing any software, you should verify authenticity of the publisher by making sure the image is signed. This ensures that the image is from Cisco Systems and that it has not been tampered with.
Cisco EPN Manager software is provided in the following formats:UBF files that you can download and install using the Software Update web GUI feature
ISO or OVA images that are provided during major product releases and updates
You do not have to manually validate UBF packages that are downloaded using the Software Update feature. This is because Cisco EPN Manager automatically validates the UBF files during the Software Update installation process. If a file is not signed, Cisco EPN Manager generates an error message and will not install the UBF file. If this occurs, contact your Cisco representative.
You do need to manually validate ISO and OVA images. Use the following procedure to validate them before installation.
Step 1 | If you do not have openssl installed, download and install it (see http://www.openssl.org). | ||||
Step 2 | Place the following files in a temporary directory: | ||||
Step 3 | Move to the
temporary directory and run the following command as the Linux CLI root user
(see
Log In and Out as the Linux CLI root User):
openssl dgst -sha512 -verify cert-file -signature sig-file content-file Where: | ||||
Step 4 | If the result is Verified OK: | ||||
Step 5 | (OVA package
only) Verify that Cisco Systems is the publisher.
| ||||
Step 6 | Check the
certificate chain.
|
These steps explain how to download a software update from Cisco.com and then install it on the Cisco EPN Manager server.
If you are using high availability, see the information in Apply Patches to High Availability Servers.
Make sure you have an account on Cisco.com.
Step 1 | Back up your data. See Perform a Manual Backup. | ||
Step 2 | Download the
file to your local machine, then upload it from your local machine to the
Cisco EPN Manager
server.
| ||
Step 3 | Copy the file from your local machine to the Cisco EPN Manager server as described in Copy a File from a Client Machine to the Cisco EPN Manager Server. | ||
Step 4 | Log in to the Cisco EPN Manager web GUI as a user with Administrator privileges. | ||
Step 5 | Upload the file to the Cisco EPN Manager server. | ||
Step 6 | Select the
software update and click
Install, then click
Yes in the confirmation pop-up window.
Cisco EPN Manager will auto-restart and the web GUI will not be accessible for some time. (If it does not, restart it by following the procedure in Stop and Restart Cisco EPN Manager.) | ||
Step 7 | When the web GUI is accessible, log in and check the version on the Software Update page. |
Instruct all users to clear their browser cache before opening the Cisco EPN Manager web GUI.
Use the followiing SCP command to retrieve files from your client machine and copy them to the Cisco EPN Manager server's default local repository (/localdisk/defaultRepo). You should run this command as the Linux CLI root user (see Log In and Out as the Linux CLI root User).
scp clientUsername@clientIP:/fullpath-to-file /localdisk/defaultRepo
For example:
scp jsmith@123.456.789.101:/temp/myfile.tar.gz /localdisk/defaultRepo
Make sure SCP is enabled on your client machine, and the required ports are open (see the Cisco Evolved Programmable Network Manager Installation Guide).