Cisco Content Security Virtual Appliance Installation Guide: Last Updated: September 24, 2020
Cisco Content Security Virtual Appliance Installation Guide: Last Updated: September 24, 2020
Contents
• About Cisco Content Security Virtual Appliances, page 1
• System Requirements, page 7
• Prepare the Content Security Image and Files, page 12
• Deploy on Microsoft Hyper-V, page 14
• If DHCP Is Disabled, Set Up the Appliance on the Network (Microsoft Hyper-V), page 15
• Deploy on KVM, page 15
• Deploy on VMWare ESXi, page 19
• If DHCP Is Disabled, Set Up the Appliance on the Network (VMware vSphere), page 22
• Amazon Web Services (AWS) EC2 Deployments, page 22
• Managing Your Cisco Content Security Virtual Appliance, page 25
• Troubleshooting and Support, page 27
• Additional Information, page 30
Recommended Processor
Product AsyncOS Release Model Disk Size RAM Cores
Cisco Email Security AsyncOS 13.0 C000V (For 200 GB 4 GB 1
Virtual Appliance and later evaluation and
demonstration
AsyncOS 12.0 only)
and later
C100V 200 GB 6 GB 2
AsyncOS 11.0
C300V 500 GB 8 GB 4
and later
C600V 500 GB 8 GB 8
AsyncOS 10.0.1
and later
Note Except as explicitly stated in the AsyncOS documentation, modifications to the ESXi
configurations defined in the OVF are not supported.
Cisco Content Security virtual appliance OVF images have been pre-configured with the values in the
following table.
Processor
Product Model Disk Space Memory Cores
Cisco Email Security Virtual Appliance C000V 200 GB 4 GB 1
(For evaluation and
demonstration only)
C100V 200 GB 6 GB 2
C300V 500 GB 8 GB 4
C600V 500 GB 8 GB 8
Processor
Product Model Disk Space Memory Cores
Cisco Content Security Management Virtual M000V 250 GB 4 GB 1
Appliance
(For evaluation and
demonstration only)
M100V 250 GB 6 GB 2
M300V 1024 GB 8 GB 4
M600V 2032 GB 8 GB 8
AsyncOS version requirements are described in Supported VMWare ESXi Hypervisors, page 10.
System Requirements
• Microsoft Hyper-V Deployments, page 8
• KVM Deployments, page 8
• VMWare ESXi Deployments, page 10
KVM Deployments
The following are the qualified environments for KVM deployments. All deployments use thin
provisioning for disk storage.
Version Info:
• Linux: 3.10.0-123.13.2.el7.x86_64
• libvirt/QEMU:
Compiled against library: libvirt 1.1.1
Using library: libvirt 1.1.1
Using API: QEMU 1.1.1
Running hypervisor: QEMU 1.5.3
Hardware:
• Supported on: UCS C Series 220 and 240 M3 and later
• Redhat 7.0 certified UCS Platforms:
https://catalog.redhat.com/hardware/servers/search?p=1&c_version=Red%20Hat%20Enterprise%
20Linux%207&c_catalog_vendor=Cisco
Ubuntu Server
Host OS:
• Ubuntu Server 14.04.1 LTS (latest update)
Version Info:
• Linux: 3.13.0-43-generic
• Virsh/QEMU
Compiled against library: libvirt 1.2.2
Using library: libvirt 1.2.2
Using API: QEMU 1.2.2
Running hypervisor: QEMU 2.0.0
Hardware:
• Supported on: UCS C Series 220 and 240 M3 and later
• Ubuntu 14.04 Certified UCS Platform:
https://certification.ubuntu.com/server/models?query=&vendors=Cisco+UCS&release=14.04+LTS
KVM Drivers
Supported KVM drivers:
• CDROM: IDE CDROM
• Network: E1000, Virtio
• Disk: VirtIO
KVM Packages
Required/related KVM packages to be installed on the host:
• qemu-kvm
• qemu-img
• libvirt
• libvirt-python
• libvirt-client
• virt-manager (requires X-windows)
• virt-install
Other VMware hypervisors are supported on a “Best Effort” basis: Cisco will try to help you, but it may
not be possible to reproduce all problems, and Cisco cannot guarantee a solution.
Note Except as explicitly stated in the documentation, Cisco does not support the alteration of the Cisco
Content Security virtual appliance’s hardware configuration, such as removing IP interfaces or changing
the appliance’s CPU cores or RAM size. The appliance may send alerts if such changes are made.
Note VMWare ESXi 6.7 deployment is supported on Cisco UCS M4 and M5 chassis servers with AsyncOS
11.8.1-023 and later (for Web Security appliances).
Step 1 Go to the Cisco Download Software page for your virtual appliance:
• For email security:
https://software.cisco.com/download/release.html?mdfid=284900944&flowid=41782&softwareid
=282975113&release=9.1.0&relind=AVAILABLE&rellifecycle=ED&reltype=latest
• For web security:
https://software.cisco.com/download/release.html?mdfid=284806698&flowid=41610&softwareid
=282975114&release=10.1.0&relind=AVAILABLE&rellifecycle=&reltype=latest
• For content security management:
https://software.cisco.com/download/release.html?mdfid=286283259&flowid=72402&softwareid
=286283388&release=9.0&relind=AVAILABLE&rellifecycle=GD&reltype=latest
Step 2 In the left navigation pane, select an AsyncOS version.
Step 3 Click Download for the virtual appliance model image you want to download.
Step 4 Save the image to your local machine.
Related Topics
• Deploy on Microsoft Hyper-V, page 14
• Deploy on KVM, page 15
• Deploy on VMWare ESXi, page 19
What To Do Next
When you deploy the AsyncOS.QCOW image, you will attach the ISO as a virtual CD-ROM drive to the
virtual machine instance.
After startup, you can check the status log on your Cisco virtual appliance. Error messages related to this
functionality include the keyword zero. You must log into the appliance, and use the tail command
from the CLI. For more information, see the “Web Security Appliance CLI Commands” topic in the
“Command Line Interface” chapter in the user guide.
Related Topics
• Deploy on KVM, page 15
Note The following are the limitations for virtual Web Security appliances (with FreeBSD 10.x) deployed on
Microsoft Hyper-V generation 1 platform:
• It is not possible to modify the virtual appliance interfaces using the etherconfig CLI command.
• The ifconfig CLI command displays the virtual appliance interface status as Unknown or Simplex
even though it runs on Duplex mode.
However, there is no impact on the performance of the appliance due to the above limitations.
Note If you cloned the virtual security appliance image, perform the following steps for each image.
Note The Management port obtains its IP address from your DHCP server. If the appliance cannot
reach a DHCP server, it will use 192.168.42.42 by default.
Note The hostname does not update until after you have completed the setup wizard.
Deploy on KVM
Action More Information
Step 1 Ensure that your equipment and See System Requirements, page 7 and the documentation for the
software meet all system products and tools that you will use.
requirements.
Step 2 Review the Release Notes for your Release Notes are available from the locations in Additional
AsyncOS release. Information, page 30.
Step 3 Set up the UCS server, host OS, See the documentation for the products and tools you will use.
and KVM.
Step 4 Download the virtual content See Download the Cisco Content Security Virtual Appliance
security appliance image. Image, page 12.
Step 5 Ensure that the Cisco image is See Ensure Virtual Appliance Image Compatibility With Your
compatible with your deployment. KVM Deployment, page 16
Step 6 (Optional) Prepare an ISO file that See Prepare the License and Configuration Files to Load at
includes the license and Startup (KVM Deployments), page 13.
configuration files to
automatically load at startup.
Step 7 Determine the amount of RAM See Supported Virtual Appliance Models and AsyncOS Releases
and the number of CPU cores to for KVM Deployments, page 3.
allocate to your virtual appliance
model.
See Supported Virtual Appliance Models and AsyncOS Releases for KVM Deployments, page 3.
Step 10 Select Forward.
Step 11 Select the Customize check box.
Step 12 Select Finish.
Step 13 Configure the disk drive:
a. In the left pane, select the drive.
b. Under Advanced options, select options:
• Disk bus:Virtio.
• Storage format: qcow2
c. Select Apply.
Step 14 Configure the network device for the management interface:
a. In the left pane, select a NIC.
b. Select options:
• Source Device: Your management vlan
• Device model: virtIO
• Source mode: VEPA.
c. Select Apply.
Step 15 Configure network devices for four additional interfaces (WSA only):
Repeat the previous set of substeps for each interface you will use.
Step 16 If you prepared an ISO image with the license and configuration files to be loaded at startup:
Attach the ISO as a virtual CD-ROM drive to the Virtual Machine instance.
Step 17 Select Begin Installation.
Related Topics
• Deploy on KVM, page 15
Procedure
Step 1 Create the storage pool where your virtual appliance will reside:
v i r s h po o l - d ef i n e - a s - - n a me v m- p o o l - - t y p e d i r - - t a r g e t / h ome / u s er n a me / v m- p o ol
v i r s h po o l - s t a r t v m- p oo l
Step 2 Copy the virtual appliance image to your storage pool:
c d / h o me / y u s er n a me / v m- p o o l
t a r x v f ~ / a s y n c o s - 8 - 6 - 0 - 0 0 7 - S1 0 0 V. q c o w2 . t a r . g z
Step 3 Install the virtual appliance:
v i r t - i ns t al l \
- - v i r t - t y pe kv m \
- - o s - t y p e =u n i x \
- - o s - v ar i an t =f r e e b s d 8 \
- - n ame ws a- e xa mpl e \ (This name should be unique)
- - r am 6 1 4 4 \ (Use the value appropriate to your virtual appliance model)
- - v cpu s 2 \ (Use the value appropriate to your virtual appliance model)
- - n o r e bo o t \
- - i mp o r t \
- - di s k
p a t h = / ho me/ u s e r n a me / v m- p oo l / a s y n c o s - 8 - 6 - 0 - 0 0 7 - S1 0 0 V. q c o w2 , f o r ma t = q c o w2 , b u s = v i r t i o \
- - d i s k p a t h = / h o me / u s e r n a me / v m- p o o l / ws a . i s o , b u s = i d e , d e v i c e= c d r o m \ (If you created an ISO
with the license and configuration file to load at startup)
- - n e t wor k t y pe = d i r e c t , s o ur c e = e n p 6 s 0 . 4 8 3 , s o u r c e _ mo d e = v e p a , mod e l = v i r t i o \
- - n e t wor k t y pe = d i r e c t , s o ur c e = e n p 6 s 0 . 4 8 4 , s o u r c e _ mo d e = v e p a , mod e l = v i r t i o \
- - n e t wor k t y pe = d i r e c t , s o ur c e = e n p 6 s 0 . 4 8 5 , s o u r c e _ mo d e= v e p a , mo d e l = v i r t i o \
- - n e t wo r k t y p e = d i r e c t , s o u r c e = en p 6 s 0 . 4 8 6 , s o u r c e _ mo d e = v ep a , mo d e l = v i r t i o \
- - n e t wo r k t y p e = d i r e c t , s o u r c e = e n p 6 s 0 . 4 8 7 , s ou r c e _ mo d e = v e p a , mod e l = v i r t i o
Step 4 Start the virtual appliance:
v i r s h s t a r t ws a - e x a mp l e
Related Topics
• Deploy on KVM, page 15
Step 1 On the host OS, find the ma c v t a p interface associated with the interface with which the multicast traffic
will be associated.
Step 2 Set the ma cv t ap interface to use promiscuous mode:
E n t e r on t h e h o s t : i f co n f i g ma c v t a p X p r o mi s c
Related Topics
• Deploy on KVM, page 15
4. (Optional) Clone the image if you want to run (Optional) Clone the Virtual Appliance, page 19.
multiple virtual appliances on your network.
5. Prevent intermittent connectivity issues. Disable unused network interface cards (NICs) on
the virtual machine.
6. Configure synchronization on the virtual machine Important! Prevent Random Failures, page 21
to avoid random failures on your Cisco Content
Security virtual appliance.
7. If DHCP is disabled, set up the appliance on your If DHCP Is Disabled, Set Up the Appliance on the
network. Network (VMware vSphere), page 22
8. Install the license file. Install the Virtual Appliance License File,
page 22.
9. Log into the web UI of your appliance and • For instructions on accessing and configuring
configure the appliance software as you would do the appliance, including gathering required
for a physical appliance. information, see the online help or user guide
For example, you can: for your AsyncOS release, available from the
relevant location in Additional Information,
• Run the System Setup Wizard page 30.
• Upload a configuration file • To migrate settings from a physical appliance,
• Manually configure features and see the release notes for your AsyncOS
functionality. release.
Feature keys are not activated until you enable the
respective features.
10. Configure the appliance to send alerts when See the online help or user guide for your
license expiration nears. AsyncOS release, available from the relevant
location in Additional Information, page 30.
• You must shut down the virtual appliance before cloning it.
• If you want to clone a virtual appliance that is already in use, see Clone a Virtual Appliance Already
in Use, page 24 for more information.
For instructions on cloning a virtual machine, see VMWare’s technical documentation at
http://www.vmware.com/support/ws55/doc/ws_clone.html.
Related Topics
• Deploy on Microsoft Hyper-V, page 14
• Deploy on KVM, page 15
• Deploy on VMWare ESXi, page 19
Step 1 Unzip the .zip file for the virtual appliance in its own directory; e.g., C: \ v ESA\ C1 0 0 V or : \ v WSA\ S3 0 0 V.
Note Except as explicitly stated in the AsyncOS documentation, modifications to the ESXi
configurations defined in the OVF are not supported.
Note Do not take backup (snapshot) of the virtual appliance using VMware or any other third-party tools, or
restore a virtual appliance from a snapshot. Alternatively, you can take backup of the configuration using
the System Administration > Configuration File menu in the user interface or using the s a v ec o n f i g
CLI command. You can then load it on another spawned virtual appliance.
Related Topics
• Deploy on Microsoft Hyper-V, page 14
• Deploy on KVM, page 15
• Deploy on VMWare ESXi, page 19
Caution It is important that you do not shutdown or restart the virtual appliances using vSphere client or web
client unless advised to do so by Cisco Technical Support. Cisco recommends that you use the shutdown
or reboot command from the CLI, or the Shutdown/Reboot option that is listed in the system
administration tab of the appliance GUI. If you power cycle the appliance (or experience power outage
to the virtual infrastructure), it may lead to lost messages, database corruption, or lost logging data. The
failure to unmount the file system cleanly damages the file system, resulting the system in a broken state.
Virtual machines have inherent timing quirks that you must address in order to avoid random failures on
your Cisco Content Security virtual appliance. To prevent these issues, enable exact time stamp counter
synchronization on your virtual machine.
Step 1 In the vSphere Client, select a virtual appliance from the list of machines.
Step 2 Log in to the CLI, and type the command s hu t d o wn to power off the virtual appliance.
Step 3 Right-click the appliance and select Edit Settings.
Step 4 Click the Options tab and select Advanced > General.
Step 5 Click Configuration Parameters.
Step 6 Edit or add the following parameters:
monitor_control.disable_tsc_offsetting=TRUE
monitor_control.disable_rdtscopt_bt=TRUE
timeTracker.forceMonotonicTTAT=TRUE
Step 7 Close the settings window and run appliance.
Related Topics
• Deploy on Microsoft Hyper-V, page 14
• Deploy on KVM, page 15
• Deploy on VMWare ESXi, page 19
Note If you cloned the virtual security appliance image, perform the following steps for each image.
Step 2 Write down the IP address of the virtual appliance’s Management port.
Note The Management port obtains its IP address from your DHCP server. If the appliance cannot
reach a DHCP server, it will use 192.168.42.42 by default.
Note The hostname does not update until after you have completed the setup wizard.
Related Topics
• Deploy on Microsoft Hyper-V, page 14
• Deploy on KVM, page 15
• Deploy on VMWare ESXi, page 19
Note If you cloned the virtual security appliance image, perform the following steps for each image.
Procedure
Step 1 Using SSH or telnet in a terminal application, log into the appliance’s CLI as the admin/ironport user.
Note You cannot paste the contents of the license file into the CLI using the vSphere client console.
What to Do Next
For Microsoft Hyper-V deployments:
• Return to Deploy on Microsoft Hyper-V, page 14.
For KVM deployments:
• Return to Deploy on KVM, page 15.
For ESXi deployments:
• For more information on the Management interface’s IP address, see Deploy on VMWare ESXi,
page 19.
• If you cloned the virtual security appliance image, repeat the procedure in this topic for each image.
• See remaining setup steps in Deploy on VMWare ESXi, page 19.
IP Address
When the virtual appliance is first powered on, the Management port gets an IP address from your DHCP
host. If the virtual appliance is unable to obtain an IP address from a DHCP server, it will use
192.168.42.42 as the Management interface’s IP address. The CLI displays the Management interface’s
IP address when you run the System Setup Wizard on the virtual appliance.
Note You cannot open a Technical Support tunnel before installing the virtual appliance license. Information
about Technical Support tunnels is in the User Guide for your AsyncOS release.
The Cisco Content Security virtual appliance requires an additional license to run the virtual appliance
on a host. You can use this license for multiple, cloned virtual appliances. Licenses are
hypervisor-independent.
For AsyncOS for Web Security 8.5 and later, AsyncOS for Email Security 8.5.x and later, and AsyncOS
for Security Management 8.4 and later:
• Feature keys for individual features can have different expiration dates.
• After the virtual appliance license expires, the appliance will continue to serve as a web proxy (Web
Security appliance), deliver mail (Email Security appliance), or automatically handle quarantined
messages (Security Management appliance) without security services for 180 days. Security
services are not updated during this period. On the Content Security Management appliance,
administrators and end users cannot manage quarantines, but the management appliance continues
to accept quarantined messages from managed Email Security appliances, and scheduled deletion
of quarantined messages will occur.
For AsyncOS for Email Security 8.0 and AsyncOS for Web Security 7.7.5 and 8.0:
• Feature keys are included as part of the virtual appliance license. The feature keys expire at the same
time as the license, even if the feature has not been activated. Purchasing new feature keys will
require downloading and installing a new virtual appliance license file.
• Because feature keys are included in the virtual appliance license, there are no evaluation licenses
for AsyncOS features.
Note For information about the impact of reverting the AsyncOS version, see the online help or user guide for
your AsyncOS release.
Related Topics
• Install the Virtual Appliance License File, page 22
Force Reset, Power Off, and Reset Options Are Not Fully Supported
The following actions are the equivalent of pulling the plug on a hardware appliance and are not
supported, especially during AsyncOS startup:
– In KVM, the Force Reset option.
– In VMWare, the Power Off and Reset options.
Supported
on Virtual
Command SMA? Information
loadlicense Yes This command allows you to install a license for your virtual appliance.
You cannot run System Setup Wizard on the virtual appliance without
installing a license using this command first.
etherconfig — The Pairing option is not included on virtual appliances.
version — This command will return all the information about the virtual appliance
except for the UDI, RAID, and BMC information.
resetconfig — Running this command leaves the virtual appliance license and the feature
keys on the appliance.
revert — Beginning with AsyncOS 8.5 for Email Security: Behavior is described in
the System Administration chapter in the online help and user guide for
your appliance.
reload — Running this command removes the virtual appliance license and all the
feature keys on the appliance. This command is available only for the Web
Security appliance.
diagnostic — The following diagnostic > raid submenu options will not return
information:
1. Run disk verify
2. Monitor tasks in progress
3. Display disk verify verdict
This command is only available for the Email Security appliance.
showlicense Yes View license details.
For virtual Email and Web security appliances, additional information is
available via the featurekey command.
Random Failures
Problem Random failures occur that have no obvious cause.
Solution See Important! Prevent Random Failures, page 21
Note To get support for virtual appliances, call Cisco TAC and have your Virtual License Number (VLN)
number ready.
If you file a support case for a Cisco content security virtual appliance, you must provide your contract
number and your Product Identifier code (PID).
You can identify your PID based on the software licenses running on your virtual appliance, by
referencing your purchase order, or from the following lists:
• Product Identifier Codes (PIDs) for Virtual Email Security Appliances, page 29
• Product Identifier Codes (PIDs) for Virtual Web Security Appliances, page 29
• Product Identifier Codes (PIDs) for Virtual Content Security Management Appliances, page 30
Product Identifier Codes (PIDs) for Virtual Content Security Management Appliances
Cisco TAC
Contact information for Cisco TAC, including phone numbers:
http://www.cisco.com/en/US/support/tsd_cisco_worldwide_contacts.html
Additional Information
For more information, including information about support options, see the Release Notes and User
Guide or online help for your AsyncOS release.
Related Topics
• Deploy on Microsoft Hyper-V, page 14
• Deploy on KVM, page 15
• Deploy on VMWare ESXi, page 19
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of
Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The
use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any
examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only.
Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.