www.cisco.com Open in urlscan Pro
2a02:26f0:3500:889::b33  Public Scan

URL: https://www.cisco.com/c/en/us/support/docs/security/email-security-virtual-appliance/118301-technote-esa-00.html
Submission: On May 06 via api from US — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

 * Skip to content
 * Skip to search
 * Skip to footer

 * Cisco.com Worldwide
 * Products and Services
 * Solutions
 * Support
 * Learn
 * Explore Cisco
 * How to Buy
 * Partners Home
 * Partner Program
 * Support
 * Tools
 * Find a Cisco Partner
 * Meet our Partners
 * Become a Cisco Partner

 * 
 * ...
 * Support
 * Product Support
 * Security
 * Cisco Secure Email Virtual Gateway
 * Troubleshooting TechNotes


IDENTIFY BEST PRACTICES FOR VESA, VWSA, OR VSMA VIRTUAL LICENSES

Save
Log in to Save Content

Translations

Download

Print


AVAILABLE LANGUAGES

 * Arabic - عربي
 * Brazil - Português
 * Canada - Français
 * China - 简体中文
 * China - 繁體中文 (臺灣)
 * Germany - Deutsch
 * Italy - Italiano
 * Japan - 日本語
 * Korea - 한국어
 * Latin America - Español
 * Netherlands - Nederlands


DOWNLOAD OPTIONS

 * 
   PDF (42.7 KB)
   View with Adobe Reader on a variety of devices
 * 
   ePub (85.8 KB)
   View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
 * 
   Mobi (Kindle) (74.5 KB)
   View on Kindle device or Kindle app on multiple devices

Updated:February 14, 2023
Document ID:118301
Bias-Free Language


BIAS-FREE LANGUAGE

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.


CONTENTS

Introduction
Prerequisites
Background Information
Best Practices for Cisco Secure Email Virtual Gateway, Secure Web Appliance
Virtual, or Secure Email and Web Manager Virtual Licenses
Obtain a Virtual License (VLN)
Create a Demo License for a Virtual Appliance
Share a Permanent Hardware License to a Virtual License
Load the Virtual License ontoYour Appliance
Verification
Related Information


INTRODUCTION

This document describes best practices for virtual licenses for Virtual Email
Security Appliance (vESA), Virtual Web Security Appliance (vWSA) or vSMA.


PREREQUISITES

 * You have a Cisco.com account tied to an active Cisco contract.
 * You have a fully licensed Cisco Email Security Appliance (ESA), Cisco Web
   Security Appliance (WSA), or Cisco Security Management Appliance (SMA)
   covered on an active Cisco contract. 
 * You have read and acknowledged the Cisco Content Security Virtual Appliance
   Installation Guide.
 * The vESA/vWSA/Virtual Security Managment Appliance (vSMA) has been installed
   into your virtual environment, the System Setup Wizard is completed, and you
   have issued the saveconfig command from the CLI on the virtual appliance.
 * At any time, if you have issues in regards to licensing, you can select Help
   from the License Registration Portal.


BACKGROUND INFORMATION

Various references can list the virtual ESA as VESA, vESA, or ESAV, and the
virtual WSA as VWSA, vWSA, or WSAV, or virtual SMA as VSMA, vSMA, and SMAV.  Be
sure to use these acronyms interchangeably, as needed.

If you have not downloaded the virtual appliance, you can do so from the
following:

 * Secure Email Virtual Gateway
 * Secure Web Appliance Virtual
 * Secure Email and Web Manager Virtual


BEST PRACTICES FOR CISCO SECURE EMAIL VIRTUAL GATEWAY, SECURE WEB APPLIANCE
VIRTUAL, OR SECURE EMAIL AND WEB MANAGER VIRTUAL LICENSES

Before you complete the configuration for your vESA/vWSA/vSMA, you are required
to request and install a virtual appliance license.


OBTAIN A VIRTUAL LICENSE (VLN)




A Virtual License Number (VLN) must be created from Cisco Global License
Operations (GLO).  You need to have your activation keys from your ESA, WSA or
SMA, and your Cisco.com account in order to complete this process. If you do not
already have a Cisco.com account, register for an account at Register for
Account

If you share a current license, you need to have your email address used for the
current device registration.  If not, you cannot request the Activation Code
listed in the steps below.  Any assistance with licensing must be handled
through GLO. (Phone: 1-800-553-2447, option 3, and request to have a case opened
for GLO/Licensing, or contact via email: licensing@cisco.com)

CREATE A DEMO LICENSE FOR A VIRTUAL APPLIANCE

 1.  Go to the Cisco License Registration Portal (LRP): Cisco Go License
 2.  Log in with your Cisco account ID.
 3.  Click Licenses.
 4.  From the Get Licenses drop-down, choose Demo and evaluation...
 5.  From the pop-up, choose the Product Family: Security Products and Product:
     Cisco Email/Web/Content Security Virtual Demo License.
 6.  You then select the Product for one of the following:
     * Cisco Email Security Appliance (ESA) Virtual Appliance 45-Day Demo
       License
     * Cisco Web Security Appliance (WSA) Virtual Appliance 45-Day Demo License
     * Cisco Content Security Management Appliance (SMA) Virtual Appliance
       45-Day Demo License
 7.  Click Next.
 8.  If you have set up Virtual Account for Smart Account, you can select your
     account from the drop-down.  If not, please continue.
 9.  For Demo license for... Virtual Appliance and validity date, please leave
     these at the default choice.
 10. For SN / Virtual Device Identifier, you can enter the serial of your
     current, fully licensed appliance, or leave it blank and click Next.
 11. Finally, review the Send To, End User fields and click the check box for
     the End-User-License-Agreement (EULA); click Add... to include additional
     recipients.
 12. Click Submit to complete the demo license request.
 13. Check the email address as entered in earlier steps, as the demo license is
     sent to that email address.

Note: Your virtual license file can be sent and received within three hours to
the email address as you have specified.

Note: The virtual license file is sent in XML format. 

SHARE A PERMANENT HARDWARE LICENSE TO A VIRTUAL LICENSE

 1.  Go to the Cisco LRP: Cisco Go License
 2.  Log in with your Cisco account ID.
 3.  Click Licenses.
 4.  From the Move Licenses drop-down, choose Share License...
 5.  Choose the Get Activation Codes option.
 6.  You are presented with a pop-up window. Choose IronPort Product - SW
     Bundles (if you have a current software bundle) or IronPort Product -
     TC (if you have individual products).
 7.  Enter a current ESA/WSA/SMA serial number in the Source Serial
     Number/Virtual Device Identifier field. If you have multiple ESAs, WSAs, or
     SMAs, choose one that has the same licenses that you want to be enabled on
     your virtual appliance.
 8.  For the Select Destination Appliance Type option,
     choose the Virtual button.
 9.  Leave the Target Serial Number/Virtual Device Identifier field BLANK.
 10. In the Send to field, enter the email address to which the activation code
     can be sent.
     
     * If you have previously stepped through the license request, you are
       presented with a current VLN(s), choose as needed.
 11. Click Request Code.
 12. Check the email address as entered in earlier steps.  An activation code
     is sent.  Once you receive the activation code, repeat steps #3 and #4
     (listed above). Once you reach step #5, choose the Use Activation
     Codes option.
 13. Paste in the provided activation code and click Next.
 14. Choose the Cisco ESA/WSA software SKUs that can be embedded on the Cisco
     virtual ESA/virtual WSA/virtual SMA license. Click Next.
 15. Enter the email address to which the license can be sent.
 16. Finally, click Get License.

Note: Your virtual license file can be sent and received within three hours to
the email address you have specified.

Note: The virtual license file is sent in XML format.  


LOAD THE VIRTUAL LICENSE ONTO YOUR APPLIANCE

 * The virtual license file once received can only be loaded from the CLI of the
   appliance that uses the command loadlicense, and then either Paste from
   CLI or Load from file. 
 * You need to enter CTRL-D once the license has been entered. 
 * After the successful load of the license file, you are prompted to accept a
   EULA. You need to enter Y in order to accept the EULA and complete the upload
   of the license onto the virtual appliance.

Note: It is recommended to load the XML file in Notepad++, or another similar
text editor that is capable of XML rendering. If a web browser is used to open
the XML file, extraneous dashes or blank spaces can be added which results in
this error – "Malformed license: Invalid XML, could not parse".  If you see this
error, please try again to upload the XML in an appropriate text editor.

Example output of Paste via CLI:

virtual_esa.local> loadlicense

1. Paste via CLI
2. Load from file
How would you like to load a license file?
[1]> 1

Paste the license file now.
Press CTRL-D on a blank line when done.

<?xml version="1.0"?>
<Envelope xmlns="urn:envelope">
  <data>
    <License>
      <info>
        <company>
          Cisco SWIFT
        </company>
        <vln>
          VLNESAXXYYZZ
        </vln>
        <issue>
          XXYYZZ79f15642c686424515c4XXYYZZ
        </issue>
        <license_version>
          1.0
        </license_version>
        <begin_date>
          Wed Jul 10 23:09:50 2013 GMT
        </begin_date>
        <end_date>
          Thu Jul 10 23:12:02 2014 GMT
        </end_date>
        <email>
          average_user@cisco.com
        </email>

<<<SNIP FOR BREVITY>>>

</Envelope>
^D
IMPORTANT: PLEASE READ THIS END USER LICENSE AGREEMENT CAREFULLY. IT IS
VERY IMPORTANT THAT YOU CHECK THAT YOU ARE PURCHASING CISCO SOFTWARE OR
EQUIPMENT FROM AN APPROVED SOURCE AND THAT YOU, OR THE ENTITY YOU
REPRESENT (COLLECTIVELY, THE "CUSTOMER") HAVE BEEN REGISTERED AS THE END
USER FOR THE PURPOSES OF THIS CISCO END USER LICENSE AGREEMENT.  IF YOU
ARE NOT REGISTERED AS THE END USER YOU HAVE NO LICENSE TO USE THE SOFTWARE
AND THE LIMITED WARRANTY IN THIS END USER LICENSE AGREEMENT DOES NOT
APPLY.  ASSUMING YOU HAVE PURCHASED FROM AN APPROVED SOURCE, DOWNLOADING,
INSTALLING OR Use CISCO OR CISCO-SUPPLIED SOFTWARE CONSTITUTES
ACCEPTANCE OF THIS AGREEMENT.

<<<SNIP FOR BREVITY>>>

Please refer to the Cisco Systems, Inc. End User License Agreement,
Privacy Statement and Service Description of Software Subscription Support
Services.

Do you accept the above license agreement? []> Y

Example output of Load from file:

virtual_esa.local> loadlicense

1. Paste via CLI
2. Load from file
How would you like to load a license file?
[1]> 2

Enter the name of the file in /configuration to import:
[license.xml]> license.xml

Note: If you choose to Load from file, you need to use File Transfer Protocol
(FTP) in order to place the license file onto the virtual appliance. This
can require configuration of the interface either from CLI with
the interfaceconfig command, or the GUI, Network > IP Interfaces. Ensure
that FTP is enabled on the interface required, and submit/commit all changes.

An example FTP from your localhost, with standard FTP commands, is shown here:

$ftp 172.16.6.165
Connected to 172.16.6.165.
220 ironport.example.com Cisco IronPort FTP server (V8.0.0) ready
Name (172.16.6.165:user): admin
331 Password required.
Password: <password>
230 Login successful.
Remote system type is UNIX.
Use binary mode to transfer files.
ftp> hash
Hash mark printing on (1024 bytes/hash mark).
ftp> bin
200 Type set to Binary.
ftp> cd /configuration
250 CWD command successful.
ftp> put license.xml
local: license.xml remote: license.xml
227 Entering Passive Mode (172,16,6,165,67,52)
150 Opening Binary connection for license.xml
######
226 Transfer Complete
6244 bytes sent in 00:00 (90.08 KiB/s)
ftp> quit
221 Goodbye.


VERIFICATION

At this point, the license file can be loaded onto your virtual appliance. You
can use the featurekey command in order to get the full display of the feature
keys that were tied to the license and that are now active.

Note: Feature keys are included as part of the license. The feature keys expire
at the same time as the license, even if the feature has not been activated.
Purchasing new feature keys requires you to download and install a new virtual
appliance license file. This is specified in the Cisco Content Security Virtual
Appliance Installation Guide.

You can also use the showlicense command and see the VLN number and license
validity dates:

)> showlicense

Virtual License
===============
vln VLNESA123456
begin_date Mon Jan 01 18:20:50 2014 GMT
end_date Wed Dec 31 18:20:49 2014 GMT
company CISCO
seats 25
serial EF7
email average_user@cisco.com
issue 4a0cf2fe83bb47cbbd84e0f359123456
license_version 1.1 


RELATED INFORMATION

 * Cisco Email Security Virtual Appliance - Support Page
 * Cisco Email Security Appliance - Support Page
 * Cisco Web Security Virtual Appliance - Support Page
 * Cisco Web Security Appliance - Support Page
 * Cisco Content Security Management Appliance - Support Page
 * Cisco Content Security Management Virtual Appliance - Support Page
 * Technical Support & Documentation - Cisco Systems


REVISION HISTORY

Revision Publish Date Comments
3.0
14-Feb-2023
Updated Title, Introduction, SEO, Style Requirements, Machine Translation,
Gerunds and Formatting to comply with current guidelines.
1.0
15-Aug-2014
Initial Release


CONTRIBUTED BY CISCO ENGINEERS

 * Dennis McCabe Jr
   Cisco Technical Leader
 * Robert Sherwin
   Cisco Technical Leader


WAS THIS DOCUMENT HELPFUL?

Yes No Feedback


CUSTOMERS ALSO VIEWED

 * Understand Smart Licensing Overview and Best Practices for Email and Web
   Security
 * Create Certificates Setup Guide for TLS on ESA
 * Upgrade Email Security Appliance (ESA) with GUI or CLI
 * How to Apply the Workaround for Cisco vESA/vSMA Failing Upgrade Due to Small
   Partition Size
 * Field Notice: FN - 72502 - Secure Web, Secure Management, and Secure Email
   Virtual Appliances Might Not Receive Updates After January 13, 2023 -
   Configuration Change Recommended
 * + Show 2 More


CONTACT CISCO

 * Open a Support Case
 * (Requires a Cisco Service Contract)




THIS DOCUMENT APPLIES TO THESE PRODUCTS

 * Secure Email Virtual Gateway
 * Secure Web Appliance Virtual



Cookies allow us to optimise your use of our website. We also use third-party
cookies for advertising and analytics. Please read our Privacy Statement and
Cookie Notice for more information.
Manage cookie settings Reject Accept



CONSENT MANAGER




 * YOUR PRIVACY


 * STRICTLY NECESSARY COOKIES


 * PERFORMANCE COOKIES


 * TARGETING COOKIES


 * FUNCTIONAL COOKIES

YOUR PRIVACY

When you visit any website, it may store or retrieve information on your
browser, mostly in the form of cookies. This information might be about you,
your preferences or your device and is mostly used to make the site work as you
expect it to. The information does not usually directly identify you, but it can
give you a more personalized web experience. Because we respect your right to
privacy, you can choose not to allow some types of cookies. Click on the
different category headings to find out more and change our default settings.
However, blocking some types of cookies may impact your experience of the site
and the services we are able to offer. Privacy Statement

STRICTLY NECESSARY COOKIES

Always Active

These cookies are necessary for the website to function and cannot be switched
off in our systems. They are usually only set in response to actions made by you
which amount to a request for services, such as setting your privacy
preferences, logging in or filling in forms.    You can set your browser to
block or alert you about these cookies, but some parts of the site will not then
work. These cookies do not store any personally identifiable information.

PERFORMANCE COOKIES

Performance Cookies


These cookies provide metrics related to the performance and usability of our
site. They are primarily focused on gathering information about how you interact
with our site, including: page load times, response times, error messages, and
allowing a replay of a visitor’s interactions with our site, which enables us to
review and analyze visitor behavior, helping to improve site usability and
functionality. These cookies also allow us to count visits and traffic sources
so we can measure and improve the performance of our site. They help us to know
which pages are the most and least popular and see how visitors move around the
site. If you do not allow these cookies we will not know when you have visited
our site and will not be able to monitor its performance.

TARGETING COOKIES

Targeting Cookies


These cookies may be set through our site by our advertising partners. They may
be used by those companies to build a profile of your interests and show you
relevant adverts on other sites.    They do not store directly personal
information, but are based on uniquely identifying your browser and internet
device. If you do not allow these cookies, you will experience less targeted
advertising.

FUNCTIONAL COOKIES

Functional Cookies


These cookies enable the website to provide enhanced functionality and
personalisation. They may be set by us or by third party providers whose
services we have added to our pages.    If you do not allow these cookies then
some or all of these services may not function properly.

Back Button


COOKIE LIST

Filter Button
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label

Clear
checkbox label label
Apply Cancel
Save Settings
Allow All