This document supports the version of each product listed and
supports all subsequent versions until the document is
replaced by a new edition. To check for more recent editions
of this document, see http://www.vmware.com/support/pubs.
EN-001281-00
Page 2
vShield Installation and Upgrade Guide
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates.
If you have comments about this documentation, submit your feedback to:
VMware is a registered trademark or trademark of VMware, Inc. in the United States and other jurisdictions. All other marks
and names mentioned herein may be trademarks of their respective companies.
VMware, Inc.
3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
2 VMware, Inc.
Page 3
Contents
About this Book5
Introduction to vShield7
1
vShield Components at a Glance 7
Deployment Scenarios 10
Preparing for Installation13
2
System Requirements 13
Deployment Considerations 14
Installing the vShield Manager19
3
Obtain the vShield Manager OVA File 19
Install the vShield Manager Virtual Appliance 19
Log In to the vShield Manager User Interface 20
Set up vShield Manager 20
Change the Password of the vShield Manager User Interface Default Account 22
Schedule a Backup of vShield Manager Data 22
Installing vShield Edge, vShield App, vShield Endpoint, and vShield Data
4
Security25
Running vShield Licensed Components in Evaluation Mode 25
Install vShield Component Licenses 26
Install vShield App 26
Installing vShield Edge 28
Installing vShield Endpoint 33
Install vShield Data Security 34
VMware, Inc.
Uninstalling vShield Components37
5
Uninstall a vShield App Virtual Appliance 37
Uninstall a vShield Edge 37
Uninstall a vShield Data Security Virtual Machine 38
Uninstall a vShield Endpoint Module 38
Upgrading vShield39
6
Upgrade vShield Manager 39
Upgrade vShield App 44
Upgrade vShield Edge 45
Upgrade vShield Endpoint 46
Upgrade vShield Data Security 46
3
Page 4
vShield Installation and Upgrade Guide
Troubleshooting Installation Issues49
7
vShield App Installation Fails 49
vShield Data Security Installation Fails 50
Index51
4 VMware, Inc.
Page 5
About this Book
This manual, the vShield Installation and Upgrade Guide, describes how to install and configure the
VMware®vShield™ system by using the vShield Manager user interface, the vSphere Client plug-in, and
command line interface (CLI). The information includes step-by-step configuration instructions, and
suggested best practices.
Intended Audience
This manual is intended for anyone who wants to install or use vShield in a VMware vCenter environment.
The information in this manual is written for experienced system administrators who are familiar with
virtual machine technology and virtual datacenter operations. This manual assumes familiarity with
VMware Infrastructure 5.x, including VMware ESX, vCenter Server, and the vSphere Client.
VMware Technical Publications Glossary
VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions
of terms as they are used in VMware technical documentation, go to
http://www.vmware.com/support/pubs.
Document Feedback
VMware, Inc.
VMware welcomes your suggestions for improving our documentation. If you have comments, send your
feedback to docfeedback@vmware.com.
5
Page 6
vShield Installation and Upgrade Guide
Technical Support and Education Resources
The following technical support resources are available to you. To access the current version of this book
and other books, go to http://www.vmware.com/support/pubs.
Online and Telephone
Support
Support Offerings
VMware Professional
Services
To use online support to submit technical support requests, view your
product and contract information, and register your products, go to
http://www.vmware.com/support.
Customers with appropriate support contracts should use telephone support
for the fastest response on priority 1 issues. Go to
http://www.vmware.com/support/phone_support.html.
To find out how VMware support offerings can help meet your business
needs, go to http://www.vmware.com/support/services.
VMware Education Services courses offer extensive hands-on labs, case
study examples, and course materials designed to be used as on-the-job
reference tools. Courses are available onsite, in the classroom, and live
online. For onsite pilot programs and implementation best practices,
VMware Consulting Services provides offerings to help you assess, plan,
build, and manage your virtual environment. To access information about
education classes, certification programs, and consulting services, go to
http://www.vmware.com/services.
6 VMware, Inc.
Page 7
Introduction to vShield1
This chapter introduces the VMware® vShield™ components you install.
This chapter includes the following topics:
“vShield Components at a Glance,” on page 7
n
“Deployment Scenarios,” on page 10
n
vShield Components at a Glance
VMware vShield is a suite of security virtual appliances built for VMware vCenter Server integration.
vShield is a critical security component for protecting virtualized datacenters from attacks and misuse, and
helping you achieve your compliance-mandated goals.
vShield includes virtual appliances and services essential for protecting virtual machines. vShield can be
configured through a web-based user interface, a vSphere Client plug-in, a command line interface (CLI),
and REST API.
vCenter Server includes vShield Manager. The following vShield packages each require a license:
vShield App
n
vShield App with Data Security
n
vShield Edge
n
vShield Endpoint
n
One vShield Manager manages a single vCenter Server environment and multiple vShield App, vShield
Edge, vShield Endpoint, and vShield Data Security instances.
vShield Manager
The vShield Manager is the centralized network management component of vShield, and is installed as a
virtual appliance on any ESX™ host in your vCenter Server environment. A vShield Manager can run on a
different ESX host from your vShield agents.
Using the vShield Manager user interface or vSphere Client plug-in, administrators install, configure, and
maintain vShield components. The vShield Manager user interface leverages the VMware Infrastructure
SDK to display a copy of the vSphere Client inventory panel, and includes the Hosts & Clusters and
Networks views.
VMware, Inc.
7
Page 8
vShield Installation and Upgrade Guide
vShield App
vShield App is a hypervisor-based firewall that protects applications in the virtual datacenter from network
based attacks. Organizations gain visibility and control over network communications between virtual
machines. You can create access control policies based on logical constructs such as VMware vCenter™
containers and vShield security groups—not just physical constructs such as IP addresses. In addition,
flexible IP addressing offers the ability to use the same IP address in multiple tenant zones to simplify
provisioning.
You should install vShield App on each ESX host within a cluster so that VMware vMotion operations work
and virtual machines remain protected as they migrate between ESX hosts. By default, a vShield App virtual
appliance cannot be moved by using vMotion.
The Flow Monitoring feature displays network activity between virtual machines at the application protocol
level. You can use this information to audit network traffic, define and refine firewall policies, and identify
threats to your network.
vShield Edge
vShield Edge provides network edge security and gateway services to isolate a virtualized network, or
virtual machines in a port group, vDS port group, or Cisco Nexus 1000V port group. You install a vShield
Edge at a datacenter level and can add up to ten internal or uplink interfaces. The vShield Edge connects
isolated, stub networks to shared (uplink) networks by providing common gateway services such as DHCP,
VPN, NAT, and Load Balancing. Common deployments of vShield Edge include in the DMZ, VPN
Extranets, and multi-tenant Cloud environments where the vShield Edge provides perimeter security for
Virtual Datacenters (VDCs).
Standard vShield Edge Services (Including Cloud Director)
Firewall
Network Address
Translation
Dynamic Host
Configuration Protocol
(DHCP)
Supported rules include IP 5-tuple configuration with IP and port ranges for
stateful inspection for all protocols.
Separate controls for Source and Destination IP addresses, as well as port
translation.
Configuration of IP pools, gateways, DNS servers, and search domains.
Advanced vShield Edge Services
Site-to-Site Virtual
Private Network (VPN)
SSL VPN-Plus
Load Balancing
High Availability
vShield Edge supports syslog export for all services to remote servers.
Uses standardized IPsec protocol settings to interoperate with all major VPN
vendors.
SSL VPN-Plus enables remote users to connect securely to private networks
behind a vShield Edge gateway.
Simple and dynamically configurable virtual IP addresses and server groups.
High availability ensures an active vShield Edge on the network in case the
primary vShield Edge virtual machine is unavailable.
8 VMware, Inc.
Page 9
Figure 1‑1. Multi-Interface Edge
vShield Edge
MPLS VPN
Internet
Interface 1
Interface 3
Interface 2
Interface 4
Interface 6
Interface 5
DMZ
network
Accounting
network
Marketing
network
Engineering
network
VPN
Load
Balancing
DNS
DHCP
availability
High
vShield Edge
Chapter 1 Introduction to vShield
vShield Endpoint
vShield Endpoint offloads antivirus and anti-malware agent processing to a dedicated secure virtual
appliance delivered by VMware partners. Since the secure virtual appliance (unlike a guest virtual machine)
doesn't go offline, it can continuously update antivirus signatures thereby giving uninterrupted protection
to the virtual machines on the host. Also, new virtual machines (or existing virtual machines that went
offline) are immediately protected with the most current antivirus signatures when they come online.
vShield Endpoint installs as a hypervisor module and security virtual appliance from a third-party antivirus
vendor (VMware partners) on an ESX host. The hypervisor scans guest virtual machines from the outside,
removing the need for agents in every virtual machine. This makes vShield Endpoint efficient in avoiding
resource bottlenecks while optimizing memory use.
VMware, Inc. 9
Page 10
!
Third-party service virtual appliance deployed
on each host to provide endpoint services
vShield Endpoint hypervisor module
deployed on each host
vShield Installation and Upgrade Guide
Figure 1‑2. vShield Endpoint Installed on an ESX Host
vShield Data Security
vShield Data Security provides visibility into sensitive data stored within your organization's virtualized
and cloud environments. Based on the violations reported by vShield Data Security, you can ensure that
sensitive data is adequately protected and assess compliance with regulations around the world.
Deployment Scenarios
Using vShield, you can build secure zones for a variety of virtual machine deployments. You can isolate
virtual machines based on specific applications, network segmentation, or custom compliance factors. Once
you determine your zoning policies, you can deploy vShield to enforce access rules to each of these zones.
Protecting the DMZ
The DMZ is a mixed trust zone. Clients enter from the Internet for Web and email services, while services
within the DMZ might require access to services inside the internal network.
You can place DMZ virtual machines in a port group and secure that port group with a vShield Edge.
vShield Edge provides access services such as firewall, NAT, and VPN, as well as load balancing to secure
DMZ services.
A common example of a DMZ service requiring an internal service is Microsoft Exchange. Microsoft
Outlook Web Access (OWA) commonly resides in the DMZ cluster, while the Microsoft Exchange back end
is in the internal cluster. On the internal cluster, you can create firewall rules to allow only Exchangedrelated requests from the DMZ, identifying specific source-to-destination parameters. From the DMZ
cluster, you can create rules to allow outside access to the DMZ only to specific destinations using HTTP,
FTP, or SMTP.
10 VMware, Inc.
Page 11
Chapter 1 Introduction to vShield
Isolating and Protecting Internal Networks
You can use a vShield Edge to isolate an internal network from the external network. A vShield Edge
provides perimeter firewall protection and edge services to secure virtual machines in a port group,
enabling communication to the external network through DHCP, NAT, and VPN.
Within the secured port group, you can install a vShield App instance on each ESX host that the vDS spans
to secure communication between virtual machines in the internal network.
If you utilize VLAN tags to segment traffic, you can use App Firewall to create smarter access policies.
Using App Firewall instead of a physical firewall allows you to collapse or mix trust zones in shared ESX
clusters. By doing so, you gain optimal utilization and consolidation from features such as DRS and HA,
instead of having separate, fragmented clusters. Management of the overall ESX deployment as a single
pool is less complex than having separately managed pools.
For example, you use VLANs to segment virtual machine zones based on logical, organizational, or network
boundaries. Leveraging the Virtual Infrastructure SDK, the vShield Manager inventory panel displays a
view of your VLAN networks under the Networks view. You can build access rules for each VLAN network
to isolate virtual machines and drop untagged traffic to these machines.
Protecting Virtual Machines in a Cluster
You can use vShield App to protect virtual machines in a cluster.
In Figure 1-3, vShield App instances are installed on each ESX host in a cluster. Virtual machines are
protected when moved via vMotion or DRS between ESX hosts in the cluster. Each vApp shares and
maintains state of all transmissions.
Figure 1‑3. vShield App Instances Installed on Each ESX Host in a Cluster
Common Deployments of vShield Edge
You can use a vShield Edge to isolate a stub network, using NAT to allow traffic in and out of the network.
If you deploy internal stub networks, you can use vShield Edge to secure communication between networks
by using LAN-to-LAN encryption via VPN tunnels.
vShield Edge can be deployed as a self-service application within VMware Cloud Director.
VMware, Inc. 11
Page 12
vShield Installation and Upgrade Guide
Common Deployments of vShield App
You can use vShield App to create security zones within a vDC. You can impose firewall policies on vCenter
containers or Security Groups, which are custom containers you can create by using the vShield Manager
user interface. Container-based policies enable you to create mixed trust zones clusters without requiring an
external physical firewall.
In a deployment that does not use vDCs, use a vShield App with the Security Groups feature to create trust
zones and enforce access policies.
Service Provider Admins can use vShield App to impose broad firewall policies across all guest virtual
machines in an internal network. For example, you can impose a firewall policy on the second vNIC of all
guest virtual machines that allows the virtual machines to connect to a storage server, but blocks the virtual
machines from addressing any other virtual machines.
12 VMware, Inc.
Page 13
Preparing for Installation2
This chapter provides an overview of the prerequisites for successful vShield installation.
This chapter includes the following topics:
“System Requirements,” on page 13
n
“Deployment Considerations,” on page 14
n
System Requirements
Before you install vShield in your vCenter Server environment, consider your network configuration and
resources. You can install one vShield Manager per vCenter Server, one vShield App or one vShield
Endpoint per ESX™ host, and multiple vShield Edge instances per datacenter.
Hardware
Table 2‑1. Hardware Requirements
ComponentMinimum
Memory
Disk Space
vCPU
vShield Manager: 8GB allocated, 3GB reserved
n
vShield App: 1GB allocated, 1 GB reserved
n
vShield Edge Compact: 256 MB, Large and Quad Large: 1 GB, X-Large: 8 GB
These are the minimum required versions of VMware products.
VMware vCenter Server 5.0 or later
n
For VXLAN virtual wires, you need vCenter Server 5.1 or later.
13
Page 14
vShield Installation and Upgrade Guide
VMware ESX 5.1 or later for each server
n
For VXLAN virtual wires, you need VMware ESX 5.1 or later.
VMware Tools
n
For vShield Endpoint and vShield Data Security, you must upgrade your virtual machines to hardware
version 7 or 8 and install VMware Tools 8.6.0 released with ESXi 5.0 Patch 3. For more information, see
“Install VMware Tools on the Guest Virtual Machines,” on page 34.
You must install VMware Tools on virtual machines that are to be protected by vShield App.
VMware vCloud Director 5.1 or later
n
Client and User Access
PC with the VMware vSphere Client
n
If you added ESX hosts by name to the vSphere inventory, ensure that DNS servers have been
n
configured on the vShield Manager and name resolution is working. Otherwise, vShield Manager
cannot resolve the IP addresses.
Permissions to add and power on virtual machines
n
Access to the datastore where you store virtual machine files, and the account permissions to copy files
n
to that datastore
Enable cookies on your Web browser to access the vShield Manager user interface
n
From vShield Manager, port 443 accessible from the ESX host, the vCenter Server, and the vShield
n
appliances to be deployed. This port is required to download the OVF file on the ESX host for
deployment.
Connect to the vShield Manager using one of the following supported Web browsers:
n
Internet Explorer 6.x and later
n
Mozilla Firefox 1.x and later
n
Safari 1.x or 2.x
n
Deployment Considerations
Consider the following recommendations and restrictions before you deploy vShield components.
Deployment Considerations for vShield
This topic describes deployment considerations for vShield components.
Preparing Virtual Machines for vShield Protection
You must determine how to protect your virtual machines with vShield. As a best practice, you should
prepare all ESX hosts within a DRS cluster for vShield App, vShield Endpoint, and vShield Data Security
depending on the vShield components you are using. You must also upgrade your virtual machines to
hardware version 7 or 8.
Consider the following questions:
14 VMware, Inc.
Page 15
Chapter 2 Preparing for Installation
How Are My Virtual Machines Grouped?
You might consider moving virtual machines to port groups on a vDS or a different ESX host to group
virtual machines by function, department, or other organizational need to improve security and ease
configuration of access rules. You can install vShield Edge at the perimeter of any port group to isolate
virtual machines from the external network. You can install a vShield App on an ESX host and configure
firewall policies per container resource to enforce rules based on the hierarchy of resources.
Are My Virtual Machines Still Protected if I vMotion Them to Another ESX Host?
Yes, if the hosts in a DRS cluster are prepared, you can migrate machines between hosts without weakening
the security posture. For information on preparing your ESX hosts, see “Install vShield App,” on page 26.
vShield Manager Uptime
The vShield Manager should be run on an ESX host that is not affected by downtime, such as frequent
reboots or maintenance mode operations. You can use HA or DRS to increase the resilience of the vShield
Manager. If the ESX host on which the vShield Manager resides is expected to require downtime, vMotion
the vShield Manager virtual appliance to another ESX host. Thus, more than one ESX host is recommended.
Communication Between vShield Components
The management interfaces of vShield components should be placed in a common network, such as the
vSphere management network. The vShield Manager requires connectivity to the vCenter Server, ESXi host,
vShield App and vShield Edge instances, vShield Endpoint module, and vShield Data Security virtual
machine. vShield components can communicate over routed connections as well as different LANs.
VMware recommends that you install vShield Manager on a dedicated management cluster separate from
the cluster(s) that vShield Manager manages. Each vShield Manager manages a single vCenter Server
environment.
If the vCenter Server or vCenter Server database virtual machines are on the ESX host on which you are
installing vShield App, migrate them to another host before installing vShield App.
Ensure that the following ports are open:
Port 443/TCP from, to, and among the ESX host, the vCenter Server, and vShield Data Security
n
UDP123 between vShield Manager and vShield App for time synchronization
n
443/TCP from the REST client to vShield Manager for using REST API calls
n
80/TCP and 443/TCP for using the vShield Manager user interface and initiating connection to the
n
vSphere SDK
22/TCP for communication between vShield Manager and vShield App and troubleshooting the CLI
n
Hardening Your vShield Virtual Machines
You can access the vShield Manager and other vShield components by using a web-based user interface,
command line interface, and REST API. vShield includes default login credentials for each of these access
options. After installation of each vShield virtual machine, you should harden access by changing the
default login credentials. Note that vShield Data Security does not include default login credentials.
vShield Manager User Interface
You access the vShield Manager user interface by opening a web browser window and navigating to the IP
address of the vShield Manager’s management port.
The default user account, admin, has global access to the vShield Manager. After initial login, you should
change the default password of the admin user account. See “Change the Password of the vShield Manager
User Interface Default Account,” on page 22.
VMware, Inc. 15
Page 16
vShield Installation and Upgrade Guide
Command Line Interface
You can access the vShield Manager, vShield App, and vShield Edge virtual appliances by using a
command line interface via vSphere Client console session. To access the vShield Endpoint virtual
appliance, refer to the instructions from the anti-virus solution provider. You cannot access the vShield Data
Security virtual machine by using the command line interface.
Each virtual appliance uses the same default username (admin) and password (default) combination as the
vShield Manager user interface. Entering Enabled mode also uses the password default.
For more on hardening the CLI, see the vShield Command Line Interface Reference .
REST Requests
All REST API requests require authentication with the vShield Manager.
Using Base 64 encoding, you identify a username-password combination in the following format:
username:password. You must use a vShield Manager user interface account (username and password)
with privileged access to perform requests. For more on authenticating REST API requests, see the vShieldAPI Programming Guide.
Deployment Considerations for vShield App
VMware recommends that you analyze your vCenter Server environment and determine whether your
want to protect the entire environment or certain clusters only.
If you decide to protect specific clusters, you must prepare the entire cluster and install vShield App on all
ESX hosts in those clusters. If you install vShield App only on some hosts in a cluster, there is a chance that
vMotion can move virtual machines from a protected to an unprotected host thus compromising the
security of your network.
Ensure that you install vShield App in your environment during a maintenance window. The total install
time may vary depending on your environment and the number of hosts in each cluster, but you must
complete installing vShield App on all desired clusters before resuming normal operations.
After installation, VMware recommends that you enable vSphere HA and set the cluster feature to VM andApplication Monitoring on the clusters where you installed vShield App. This feature monitors the vShield
App and triggers a restart if it fails, which minimizes the vShield App outage. For more information on this
feature, see vSphere Availability.
VMware recommends that you let vShield App run during normal operations and use the vShield App
Flow Monitoring tool for baseline knowledge of the traffic flowing in and out of your virtual network. You
can then add rules according to the needs of your network.
Enabling the SpoofGuard feature of vShield App allows you to authorize the IP addresses reported by
VMware Tools, and alter them if necessary to prevent spoofing. Depending on the SpoofGuard mode you
choose, vShield App either automatically trusts IP assignments on their first use or requires you to manually
approve IP assignments before use. However, be aware that the IP address of a virtual machine may change
when the DHCP server renews a lease or is rebooted. This means that you must approve the new or
renewed IP address if the SpoofGuard feature is enabled.
Becoming familiar with the flow monitoring and SpoofGuard features before installing vShield App will
enable you to configure vShield App in the most secure way possible. For more information on these
features, see the vShield Administration Guide.
16 VMware, Inc.
Page 17
Chapter 2 Preparing for Installation
Deployment Considerations for vShield Edge
Before installing vShield Edge, you must become familiar with your network topology. vShield Edge can
have multiple interfaces, but you must connect at least one internal interface to a portgroup or VXLAN
virtual wire before you can deploy the vShield Edge.
The uplink interface provides connectivity to the outside world. You must have created and configured a
port group or VXLAN virtual wire that has external connectivity. You must also have a port group with
virtual machines to which you can connect the internal interface. Determine the IP addresses and subnets to
be provided for these interfaces. Also think about the services that you should enable and configure after
installing vShield Edge. For more information on vShield Edge services, see the vShield Administration Guide.
After you install vShield Edge and before you configure vShield Edge services, virtual machines in that port
groups(s) may lose network connectivity. To avoid this issue, you may create a new port group, install and
configure vShield Edge on it, and then move virtual machines to the port group.
Be aware that the default vShield Edge firewall policy blocks all incoming traffic, so you must add allow
rules as required.
VMware, Inc. 17
Page 18
vShield Installation and Upgrade Guide
18 VMware, Inc.
Page 19
Installing the vShield Manager3
VMware vShield provides firewall protection, traffic analysis, and network perimeter services to protect
your vCenter Server virtual infrastructure. vShield virtual appliance installation has been automated for
most virtual datacenters.
The vShield Manager is the centralized management component of vShield. You use the vShield Manager to
monitor and push configurations to vShield App, vShield Endpoint, and vShield Edge instances. The
vShield Manager runs as a virtual appliance on an ESX host.
Installing the vShield Manager is a multistep process. You must perform all of the tasks that follow in
sequence to complete vShield Manager installation successfully.
To enhance your network security posture, you can obtain licenses for vShield App, vShield Endpoint, and
vShield Edge.
This chapter includes the following topics:
“Obtain the vShield Manager OVA File,” on page 19
n
“Install the vShield Manager Virtual Appliance,” on page 19
n
“Log In to the vShield Manager User Interface,” on page 20
n
“Set up vShield Manager,” on page 20
n
“Change the Password of the vShield Manager User Interface Default Account,” on page 22
n
“Schedule a Backup of vShield Manager Data,” on page 22
n
Obtain the vShield Manager OVA File
The vShield Manager virtual machine is packaged as an Open Virtualization Appliance (OVA) file, which
allows you to use the vSphere Client to import the vShield Manager into the datastore and virtual machine
inventory.
Install the vShield Manager Virtual Appliance
You can install the vShield Manager virtual machine on an ESX host in a cluster configured with DRS.
With vShield 5.0 and later, you can install the vShield Manager in a different vCenter than the one that the
vShield Manager will be interoperating with. A single vShield Manager serves a single vCenter Server
environment.
The vShield Manager virtual machine installation includes VMware Tools. Do not attempt to upgrade or
install VMware Tools on the vShield Manager.
VMware, Inc.
19
Page 20
vShield Installation and Upgrade Guide
Prerequisites
You must have been assigned the Enterprise Administrator or vShield Administrator role .
Procedure
1Log in to the vSphere Client.
2Create a port group to home the management interface of the vShield Manager.
The vShield Manager management interface, vCenter Server, and ESXi hosts must be reachable by all
future vShield Edge, vShield App, and vShield Endpoint instances.
3Select File > Deploy OVF Template.
4Click Browse to locate the folder on your PC that contains the vShield Manager OVA file.
5Complete the installation.
The vShield Manager is installed as a virtual machine in your inventory.
6Power on the vShield Manager virtual machine.
What to do next
The default CPU for vShield Manager 5.1 is 2 vCPU. For vShield Manager to work with vSphere Fault
Tolerance, you must set the CPU to 1 vCPU.
Log In to the vShield Manager User Interface
After you have installed and configured the vShield Manager virtual machine, log in to the vShield Manager
user interface.
Procedure
1Open a Web browser window and type the IP address assigned to the vShield Manager.
The vShield Manager user interface opens in a web browser window using SSL.
2Accept the security certificate.
NOTE You can use an SSL certificate for authentication. Refer to the vShield Administration Guide.
The vShield Manager login screen appears.
3Log in to the vShield Manager user interface by using the user name admin and the password default.
You should change the default password as one of your first tasks to prevent unauthorized use. See
“Change the Password of the vShield Manager User Interface Default Account,” on page 22.
4Click Log In.
Set up vShield Manager
Specify vCenter Server, DNS and NTP server, and Lookup server details.
NOTE The vShield Manager virtual machine does not appear as a resource in the inventory panel of the
vShield Manager user interface. The Settings & Reports object represents the vShield Manager virtual
machine in the inventory panel.
20 VMware, Inc.
Page 21
Chapter 3 Installing the vShield Manager
Prerequisites
You must have a vCenter Server user account with administrative access to synchronize vShield
n
Manager with the vCenter Server . If your vCenter password has non-Ascii characters, you must change
it before synchronizing the vShield Manager with the vCenter Server.
To use SSO on vShield Manager, you must have vCenter Server 5.1 or above and single sign on service
n
must be installed on the vCenter Server.
Procedure
1Log in to the vShield Manager.
2Click Settings & Reports from the vShield Manager inventory panel.
3Click the Configuration tab.
4The DNS Servers area displays the IP addresses of the DNS servers you specified when you configured
the network settings of the vShield Manager.
You can edit the servers if required.
5In NTP Server, click Edit and type the IP address of your NTP server.
The NTP server establishes a common network time. It is recommended that you use the NTP server
used by the SSO server so that the time on the vShield Manager server is in synch with the NTP server.
IMPORTANT You must reboot the vShield Manager after editing the NTP server details.
6In Lookup Service, click Edit and type the host name or IP address of the host that has the lookup
service.
7Change the port number if required.
The Lookup Service URL is displayed based on the specified host and port.
8Type the SSO user name and password.
This enables vShield Manager to register itself on the Security Token Service server.
9In vCenter Server, type the IP address or hostname of your vCenter Server.
10 Type your vSphere Client login user name.
11 Type the password associated with the user name.
12 To assign the Enterprise Administrator role to the user you have logged in as, select Assign vShield
Enterprise Administrator role to this user.
This role gives vShield operations and security permissions to the user.
13 To modify the plug-in script download location, select Modify plug-in script download location and
type the vShield Manager IP address and port number.
This may be required for NAT environments. By default, the vShield Manager address used is
vShield_Manager_IP:443.
14 Click Save.
15 (Optional) On a Windows server computer, perform the following steps to load the vShield Manager
inventory panel:
aOpen Internet Explorer.
bSelect Tools > Internet Options.
cIn the Internet Option window, select the Security tab.
dClick Trusted sites.
VMware, Inc. 21
Page 22
vShield Installation and Upgrade Guide
eClick the Sites button.
fType the IP address of the vShield Manager and click Add.
gClick Close.
hClick OK.
iClose Internet Explorer.
The vShield Manager connects to the vCenter Server, logs on, and utilizes the VMware Infrastructure SDK
to populate the vShield Manager inventory panel. The inventory panel is presented on the left side of the
screen. This resource tree should match your VMware Infrastructure inventory panel. The vShield Manager
does not appear in the vShield Manager inventory panel.
What to do next
Login to the vSphere Client, select an ESX host, and verify that vShield appears as a tab. You can then install
and configure vShield components from the vSphere Client.
Change the Password of the vShield Manager User Interface Default
Account
You can change the password of the admin account to harden access to your vShield Manager.
Procedure
1Log in to the vShield Manager user interface.
2Click Change Password on the top right corner of the window.
3In Old password, type default (the current password).
4Type a new password.
5Confirm the password by typing it a second time in the Retype Password field.
6Click OK to save your changes.
Schedule a Backup of vShield Manager Data
You can only schedule the parameters for one type of backup at any given time. You cannot schedule a
configuration-only backup and a complete data backup to run simultaneously.
Procedure
1Click Settings & Reports from the vShield Manager inventory panel.
2Click the Configuration tab.
3Click Backups.
4From the Scheduled Backups drop-down menu, select On.
5From the Backup Frequency drop-down menu, select Hourly, Daily, or Weekly.
The Day of Week, Hour of Day, and Minute drop-down menus are disabled based on the selected
frequency. For example, if you select Daily, the Day of Week drop-down menu is disabled as this field
is not applicable to a daily frequency.
6(Optional) Select the Exclude System Events check box if you do not want to back up system event
tables.
7(Optional) Select the Exclude Audit Log check box if you do not want to back up audit log tables.
8Type the Host IP Address of the system where the backup will be saved.
22 VMware, Inc.
Page 23
Chapter 3 Installing the vShield Manager
9(Optional) Type the Host Name of the backup system.
10 Type the User Name required to login to the backup system.
11 Type the Password associated with the user name for the backup system.
12 In the Backup Directory field, type the absolute path where backups will be stored.
13 Type a text string in Filename Prefix.
This text is prepended to each backup filename for easy recognition on the backup system. For example,
if you type ppdb, the resulting backup is named as ppdbHH_MM_SS_DayDDMonYYYY.
14 From the Transfer Protocol drop-down menu, select either SFTP or FTP, based on what the destination
supports.
15 Click Save Settings.
VMware, Inc. 23
Page 24
vShield Installation and Upgrade Guide
24 VMware, Inc.
Page 25
Installing vShield Edge, vShield App,
vShield Endpoint, and vShield Data
Security4
After the vShield Manager is installed, you can obtain licenses to activate the vShield App, vShield
Endpoint, vShield Edge, and vShield Data Security components. The vShield Manager OVA package
includes the drivers and files required to install these add-on components. A vShield App license allows you
to use the vShield Endpoint component as well.
vShield virtual appliances include VMware Tools. Do not attempt to alter or upgrade the VMware Tools
software on a vShield virtual appliance.
This chapter includes the following topics:
“Running vShield Licensed Components in Evaluation Mode,” on page 25
n
“Install vShield Component Licenses,” on page 26
n
“Install vShield App,” on page 26
n
“Installing vShield Edge,” on page 28
n
“Installing vShield Endpoint,” on page 33
n
“Install vShield Data Security,” on page 34
n
Running vShield Licensed Components in Evaluation Mode
Before purchasing and activating licenses for vShield Edge, vShield App, and vShield Endpoint, you can
install and run evaluation modes of the software. When run in evaluation mode, intended for demonstration
and evaluation purposes, your vShield Edge, vShield App, and vShield Endpoint are completely operational
immediately after installation, do not require any licensing configuration, and provide full functionality for
60 days from the time you first activate them.
When run in evaluation mode, vShield components can support a maximum allowed number of instances.
After the 60-day trial period expires, unless you obtain licenses for your software, you cannot use vShield.
For example, you cannot power on vShield App or vShield Edge virtual appliances or protect your virtual
machines.
To continue using the vShield App and vShield Edge functionality without interruptions or to restore the
features that become unavailable after the 60-day trial, you need to obtain and install license files that
activate the features appropriate for the vShield component you purchased.
VMware, Inc.
25
Page 26
vShield Installation and Upgrade Guide
Install vShield Component Licenses
You must install a CIS or vCloud Networking and Security (vCNS) license before installing vShield App
and vShield Edge. The vSphere license includes a license for vShield Endpoint. You can install these licenses
after vShield Manager installation is complete by using the vSphere Client.
Procedure
1From a vSphere Client host that is connected to a vCenter Server system, select Home > Licensing.
2From the Management tab, select Asset.
3Right-click a CIS or vCNS asset and select Change license key.
4Select Assign a new license key and click Enter Key.
5Enter the license key, enter an optional label for the key, and click OK.
6Click OK.
7Repeat these steps for each vShield component for which you have a license.
Install vShield App
You can install vShield App on an ESX host.
NOTE The network connection of a virtual machine is interrupted when you protect it with vShield App. If
vCenter Server is running on a virtual machine and it becomes disconnected from the network, the vShield
App installation process might halt without completing. VMware recommends that you place the vCenter
Server, vCenter Server database, and third party or internal service virtual machines that you do not want
protected in the Virtual Machines Exclusion List. For information on excluding virtual machines from
vShield App protection, see the vShield Administration Guide.
IMPORTANT If the vCenter Server or vCenter Server database virtual machines are on the ESX host on which
you are installing vShield App, migrate them to another host before installing vShield App.
Prerequisites
Verify that you have a unique IP address for the management (MGT) port of each vShield App virtual
n
appliance. Each IP address should be reachable from vShield Manager and sit on the Management
network used for vCenter and ESX host management interfaces. Using an incorrect IP address will
require you to uninstall and re-install vShield App on this host.
Local or network storage in which to place the vShield App.
n
Procedure
1Log in to the vSphere Client.
2Select an ESX host from the inventory tree.
3Click the vShield tab.
4Accept the security certificate.
5Click Install for the vShield App service.
26 VMware, Inc.
Page 27
Chapter 4 Installing vShield Edge, vShield App, vShield Endpoint, and vShield Data Security
6Under vShield App, provide the following information.
OptionDescription
Datastore
Management Port Group
IP Address
Netmask
Default Gateway
Select the datastore on which to store the vShield App virtual machine
files.
Select the port group to host the vShield App management interface. This
port group must be able to reach the vShield Manager’s port group.
Type the IP address to assign to the vShield App management interface.
IMPORTANT Ensure that you type the correct IP address. To change the IP
address after installing vShield App, you would need to uninstall vShield
App and reboot the ESX host.
Type the IP subnet mask associated with the assigned IP address.
Type the IP address of the default network gateway.
7Click Install.
You can follow the progress of the vShield App installation on the Recent Tasks pane of the vSphere
Client screen.
What to do next
Allow vShield App to run during normal operation and then examine the traffic going in and out of your
virtual network. Based on this information, configure firewall rules. Each vShield App inherits global
firewall rules set in the vShield Manager. The default firewall rule set allows all traffic to pass. You must
configure blocking rules to explicitly block traffic. To configure App Firewall rules, see the vShieldAdministration Guide.
NOTE If you have installed vShield App on a stateless ESX, you must follow the steps in “Install vShield
App on a Stateless ESX Host,” on page 27 before rebooting the host.
CAUTION Do not modify service virtual machines through the vSphere client. This may break
communication between vShield Manager and vShield App and compromise the security of your network.
Install vShield App on a Stateless ESX Host
If you installed vShield App on a stateless ESX host, you must perform the steps below before rebooting any
of the ESX hosts on which vShield App is installed.
Prerequisites
Install vShield App on the stateless ESX host.
n
Ensure that the firewall configuration changes done on the host by the VIB are complete.
n
aIn the vCenter client, select the stateless ESX host from the inventory panel.
bClick the Configuration tab.
cCheck that a DVFilter entry appears in the Incoming Connections under the Firewall panel. If no
DVFilter entry appears, click Refresh.
Create a host profile. For more information, see the vSphere Installation and Setup Guide.
n
Procedure
1Edit the host profile.
aIn the vCenter client, select Home > Management > Host Profiles.
bSelect the profile to edit.
VMware, Inc. 27
Page 28
vShield Installation and Upgrade Guide
cClick Edit Host Profile.
dSelect Networking Configuration > Host Port Group > vmservice-vmknic-pg > IP address
settings > How is IPv4 address determined.
eType the IP address as 169.254.1.1 and Subnet mask as 255.255.255.0.
fSelect Networking Configuration > Host Port Group > vmservice-vmknic-pg > Determine how
MAC address for vmknic should be decided.
gSelect User must explicitly choose the policy option.
2Save the host profile.
3In a web browser, type https://vsm-ip/bin/offline-bundles/VMware-vShield-fastpath-
esx5x-5.0.1-766127.zip and download the zip file.
4Use the host profile you created in Step 1 and the offline bundle you downloaded in Step 3 to update
the stateless ESX configuration.
Installing vShield Edge
You can install multiple vShield Edge virtual appliances in a datacenter. Each vShield Edge virtual
appliance can have a total of ten uplink and internal network interfaces. The internal interfaces connect to
secured port groups and act as the gateway for all protected virtual machines in the port group. The subnet
assigned to the internal interface can be RFC 1918 private space. Firewall rules and other vShield Edge
services are enforced on traffic between interfaces.
uplink interfaces of vShield Edge connect to uplink port groups that have access to a shared corporate
network or a service that provides access layer networking.
Multiple external IP addresses can be configured for load balancer, site-to-site VPN, and NAT services.
Overlapping IP addresses are not allowed for internal interfaces, and overlapping subnets are not allowed
for internal and uplink interfaces.
Prerequisites
You must have been assigned the Enterprise Administrator or vShield Administrator role .
Procedure
1Open the Add Edge Wizard on page 29
Open the Add Edge wizard to install and configure a vShield Edge instance.
2Name vShield Edge on page 29
vShield Edge requires a descriptive name that is unique across all vShield Edge virtual machines in a
single tenant. This name appears in your vCenter inventory.
3Specify the CLI Credentials on page 29
Edit the credentials to be used for logging in to the Command Line Interface (CLI).
4Add Appliances on page 30
You must add an appliance before you can deploy a vShield Edge. If you do not add an appliance
when you install vShield Edge, vShield Edge remains in an offline mode until you add an appliance.
5Add Internal and Uplink Interfaces on page 31
You can add up to ten internal and uplink interfaces to a vShield Edge virtual machine.
6Configure the Default Gateway on page 32
Provide the IP address for the vShield Edge default gateway.
28 VMware, Inc.
Page 29
Chapter 4 Installing vShield Edge, vShield App, vShield Endpoint, and vShield Data Security
7Configure Firewall Policy and High Availability on page 32
You can change the default firewall policy, which blocks all incoming traffic.
8Confirm Settings and Install the vShield Edge on page 33
Before you install the vShield Edge, review the settings you entered.
Open the Add Edge Wizard
Open the Add Edge wizard to install and configure a vShield Edge instance.
Procedure
1Log in to the vSphere Client.
2Select a datacenter resource from the inventory tree.
3Click the Network Virtualization tab.
4Click Edges.
5
Click the Add (
The Add Edge wizard appears.
) icon.
Name vShield Edge
vShield Edge requires a descriptive name that is unique across all vShield Edge virtual machines in a single
tenant. This name appears in your vCenter inventory.
Procedure
1Type a name for the vShield Edge virtual machine.
This name appears in your vCenter inventory. The name should be unique across all Edges within a
single tenant.
If you do not specify a name, vShield Manager creates a unique name for each vShield Edge.
2(Optional) Type a host name for the vShield Edge virtual machine.
This name appears in CLI. If you do not specify the hostame, the name you specified in Step 1 shows up
in CLI as well.
3(Optional) Type a description for this vShield Edge.
4(Optional) Type the tenant for this vShield Edge.
5(Optional) Select Enable HA to enable high availability (HA).
6Click Next.
Specify the CLI Credentials
Edit the credentials to be used for logging in to the Command Line Interface (CLI).
Procedure
1On the CLI Credentials page, specify the CLI credentials for your vShield Edge virtual machine.
OptionAction
CLI user name
CLI password
VMware, Inc. 29
Edit if required.
Edit tif required.
Page 30
vShield Installation and Upgrade Guide
2(Optional) Click Enable SSH access if required.
3Click Next.
The Edge Appliances page appears.
Add Appliances
You must add an appliance before you can deploy a vShield Edge. If you do not add an appliance when you
install vShield Edge, vShield Edge remains in an offline mode until you add an appliance.
Prerequisites
For high availability, verify that the resource pool has enough capacity for both HA virtual machines to be
deployed. A compact vShield Edge virtual machine requires 256 MB of memory, a large vShield Edge
virtual machine requires 1 GB of memory, and an X-Large vShield Edge virtual machine requires 8 GB of
memory. The datastore must have at least 512 MB disk space.
Procedure
1On the Edge Appliances page, select the size of the vShield Edge instance based on your system
resources.
The Large vShield Edge has more CPU, memory, and disk space than the Compact vShield Edge, and
supports a bigger number of concurrent SSL VPN-Plus users. The X-Large vShield Edge is suited for
environments which have Load Balancer with millions of concurrent sessions. The X-Large vShield
Edge does not support SSL VPN.
2Click Enable auto rule generation to add firewall, NAT, and routing routes to enable control traffic to
flow for these services..
If you do not select Enable auto rule generation, you must manually create firewall rules to add
firewall, NAT, and routing routes to allow control channel traffic for vShield Edge services such as
Load Balancing, VPN, etc.
NOTE Auto rule generation does not create rules for data-channel traffic.
3Click Enable AESNI to enable Intel® Advanced Encryption Standard New Instructions (Intel® AES-NI).
4
In Edge Appliances, click the Add (
) icon to add an appliance.
If you had selected Enable HA on the Name and Description page, you can add two appliances. If you
add a single appliance, vShield Edge replicates its configuration for the standby appliance ensures that
the two HA vShield Edge virtual machines are not on the same ESX host even after you use DRS and
vMotion (unless you manually vMontion them to the same host).
5In the Add Edge Appliance dialog box, select the cluster or resource pool and datastore for the
appliance.
6(Optional) Select the host on which the appliance is to be added.
7(Optional) Select the vCenter folder within which the appliance is to be added.
8Click Add.
9Click Next.
The Interfaces page appears.
30 VMware, Inc.
Page 31
Chapter 4 Installing vShield Edge, vShield App, vShield Endpoint, and vShield Data Security
Add Internal and Uplink Interfaces
You can add up to ten internal and uplink interfaces to a vShield Edge virtual machine.
Procedure
1
On the Interfaces page, click the Add (
2Select Internal or Uplink to indicate whether this is an internal or external interface.
You must add at least one internal interface for HA to work.
3Select the port group or VXLAN virtual wire to which this interface should be connected.
aClick Select next to the Connected To field.
bDpending on what you want to connect to the interface, click the Virtual Wire, Standard
Portgroup, or Distributed Portgroup tab.
cSelect the appropriate virtual wire or portgroup.
dClick Select.
4Select the connectivity status for the interface.
5
In Configure Subnets, click the Add () icon to add a subnet for the interface.
) icon and type a name for the interface.
An interface can have multiple non-overlapping subnets.
6
In Add Subnet, click the Add () icon to an IP address.
If you enter more than one IP address, you can select the Primary IP address. An interface can have one
primary and multiple secondary IP addresses. vShield Edge considers the Primary IP address as the
source address for locally generated traffic.
You must add an IP address to an interface before using it on any feature configuration.
7Type the subnet mask for the interface and click Save.
8(Optional) Type the MAC address for the interface. If HA is enabled, type two management IP
addresses in CIDR format.
Heartbeats of the two vShield Edge HA virtual machines are communicated through these
management IP addresses. The management IP addresses must be in the same L2/subnet and be able to
communicate with each other.
9Change the default MTU if required.
10 In Options, select the required options.
OptionDescription
Enable Proxy ARP
Send ICMP Redirect
Supports overlapping network forwarding between different interfaces.
Conveys routing information to hosts.
11 Type the fence parameters and click Add.
12 Repeat steps Step 1 through Step 11 to add additional interfaces.
13 Click Next.
The Default Gateway page appears.
VMware, Inc. 31
Page 32
vShield Installation and Upgrade Guide
Configure the Default Gateway
Provide the IP address for the vShield Edge default gateway.
Procedure
1On the Default Gateway page, select Configure Default Gateway.
2Select the interface that can communicate with the next hop or gateway IP address.
3Type the IP address for the default gateway.
4In MTU, the default MTU for the interface you selected in Step 2 is displayed. You can edit this value,
but it cannot be more than the configured MTU on the interface.
5Click Next.
The Firewall & HA page appears.
Configure Firewall Policy and High Availability
You can change the default firewall policy, which blocks all incoming traffic.
You must configure HA parameters for high availability to work on network configurations on
vShield Edge. vShield Edge supports two virtual machines for high availability, both of which are kept up
to date with user configurations. If a heartbeat failure occurs on the primary virtual machine, the secondary
virtual machine state is changed to active. Thus, one vShield Edge virtual machine is always active on the
network.
Procedure
1On the Firewall & HA page, select Configure Firewall default policy.
2Specify whether to accept or deny incoming traffic by default.
Any firewall rules you create override the default policy.
3Select whether to log incoming traffic.
If you create firewall rules that override the default policy, logging is determined by the rules you
created. Enabling default logging may generate too many logs and affect the performance of your
vShield Edge. Hence, it is recommended that you enable default logging only while troubleshooting or
debugging.
32 VMware, Inc.
Page 33
Chapter 4 Installing vShield Edge, vShield App, vShield Endpoint, and vShield Data Security
4If you selected Enable HA on the Name & Description page, complete the Configure HA parameters
section.
vShield Edge replicates the configuration of the primary appliance for the standby appliance and
ensures that the two HA vShield Edge virtual machines are not on the same ESX host even after you use
DRS and vMotion. Two virtual machines are deployed on vCenter in the same resource pool and
datastore as the appliance you configured. Local link IPs are assigned to HA virtual machines in the
vShield Edge HA so that they can communicate with each other. You can specify management IP
addresses to override the local links.
aSelect the internal interface for which to configure HA parameters.
b(Optional) Type the period in seconds within which, if the backup appliance does not receive a
heartbeat signal from the primary appliance, the primary appliance is considered inactive and the
back up appliance takes over.
The default interval is 6 seconds.
c(Optional) Type two management IP addresses in CIDR format to override the local link IPs
assigned to the HA virtual machines.
Ensure that the management IP addresses are not overlapping with any of the interface subnets.
5Click Next.
The Summary page appears.
Confirm Settings and Install the vShieldEdge
Before you install the vShield Edge, review the settings you entered.
Procedure
1On the Summary page, review the settings for the vShield Edge.
2Click Previous to modify the settings
3Click Finish to accept the settings and install the vShield Edge.
Installing vShield Endpoint
The installation instructions that follow assume that you have the following system:
A datacenter with supported versions of vCenter Server and ESXi installed on each host in the cluster.
n
For information on the required versions, see Chapter 2, “Preparing for Installation,” on page 13.
vShield Manager 5.1 installed and running.
n
Anti-virus solution management server installed and running.
n
vShield Endpoint Installation Workflow
After you prepare the ESX host for vShield Endpoint installation, install vShield Endpoint in these stages:
1Deploy and configure a security virtual machine (SVM) to each ESX host according to the instructions
from the anti-virus solution provider.
2Install the latest version of VMware Tools released for the version of ESX that you have on all virtual
machines to be protected.
The vShield Endpoint host component adds two firewall rules to the ESX host:
The vShield-Endpoint-Mux rule opens ports 48651 to port 48666 for communication between the host
n
component and partner security VMs.
VMware, Inc. 33
Page 34
vShield Installation and Upgrade Guide
The vShield-Endpoint-Mux-Partners rule may be used by partners to install a host component. It is
n
disabled by default.
Install VMware Tools on the Guest Virtual Machines
VMware Tools include the vShield Thin Agent that must be installed on each guest virtual machine to be
protected. Virtual machines with VMware Tools installed are automatically protected whenever they are
started up on an ESX host that has the security solution installed. That is, protected virtual machines retain
the security protection through shut downs and restarts, and even after a vMotion move to another ESX host
with the security solution installed.
Prerequisites
Make sure that the guest virtual machine has a supported version of Windows installed. The following
Windows operating systems are supported for vShield Endpoint 5.0:
Windows Vista (32 bit)
n
Windows 7 (32/64 bit)
n
Windows XP SP3 and above (32 bit)
n
Windows 2003 SP2 and above (32/64 bit)
n
Windows 2008 (32/64 bit)
n
Windows 2008 R2 (64 bit)
n
Procedure
1Select the type of installation for VMware Tools.
ESX Version of the HostAction
ESX 5.0 Patch 1 or later
ESX 4.1 Patch 3 or later
2in the Setup Type wizard, select one of the following options:
Complete.
n
Custom.
n
From the VMware Device Drivers list, select VMCI Driver, then select vShield Driver.
n
Install vShield Data Security
You can install vShield Data Security only after installing vShield Endpoint.
Prerequisites
Follow the installation instructions in Installing and Configuring VMware
Tools till the point you see the Setup Type wizard.
Follow the installation instructions in the Knowledge Base article
http://kb.vmware.com/kb/2008084 till the point you see the Setup Type
wizard.
Verify that vShield Endpoint has been installed on the host and guest virtual machines..
Procedure
1Log in to the vSphere Client.
2Select an ESX host from the inventory tree.
3Click the vShield tab.
4Click Install next to vShield Data Security.
34 VMware, Inc.
Page 35
Chapter 4 Installing vShield Edge, vShield App, vShield Endpoint, and vShield Data Security
5Select the vShield Data Security checkbox.
6Under vShield Data Security, enter the following information.
OptionDescription
Datastore
Management Port Group
Select the datastore on which to add the vShield Data Security service
virtual machine.
Select the port group to host the vShield Data Security’s management
interface. This port group must be able to reach the vShield Manager’s port
group.
7To configure a static IP, select the Configure static IP for management interface checkbox.
Enter the IP address, Netmask, and Default Gateway details.
NOTE If you do not select Configure static IP for management interface, an IP address is assigned
using Dynamic Host Configuration Protocol (DHCP).
8Click Install.
The vShield Data Security virtual machine is installed on the selected host.
VMware, Inc. 35
Page 36
vShield Installation and Upgrade Guide
36 VMware, Inc.
Page 37
Uninstalling vShield Components5
This chapter details the steps required to uninstall vShield components from your vCenter inventory.
This chapter includes the following topics:
“Uninstall a vShield App Virtual Appliance,” on page 37
n
“Uninstall a vShield Edge,” on page 37
n
“Uninstall a vShield Data Security Virtual Machine,” on page 38
n
“Uninstall a vShield Endpoint Module,” on page 38
n
Uninstall a vShield App Virtual Appliance
Uninstalling a vShield App removes the virtual appliance from the network and vCenter Server.
CAUTION Uninstalling a vShield App places the ESX host in maintenance mode. The ESX host reboots
during uninstallation. If any of the virtual machines that are running on the target ESX host cannot be
migrated to another ESX host, these virtual machines must be powered off or migrated manually before the
uninstallation can continue. If the vShield Manager is on the same ESX host, the vShield Manager must be
migrated prior to uninstalling the vShield App.
Procedure
1Log in to the vSphere Client.
2Select the ESX host from the inventory tree.
3Click the vShield tab.
4Click Uninstall for the vShield App service.
If you are uninstalling vShield App on a stateless ESX host, ignore the VIB uninstallation errors.
5If the ESX host was in maintenance mode before you started uninstalling vShield App, remove the
vShield App virtual machines manually after the automatic uninstallation is complete.
The instance is uninstalled.
Uninstall a vShield Edge
You can uninstall a vShield Edge by using the vSphere Client.
Prerequisites
You must have been assigned the Enterprise Administrator or vShield Administrator role .
VMware, Inc.
37
Page 38
vShield Installation and Upgrade Guide
Procedure
1Log in to the vSphere Client.
2Select a datacenter resource from the inventory tree.
3Click the Network Virtualization tab.
4Click Edges.
5
Click the Delete () icon.
Uninstall a vShield Data Security Virtual Machine
After you uninstall the vShield Data Security virtual machine, you must uninstall the virtual appliance
according to the instructions from the VMware partner.
Procedure
1Log in to the vSphere Client.
2Select an ESX host from the inventory tree.
3Click the vShield tab.
4Click Uninstall for the vShield Data Security service.
Uninstall a vShield Endpoint Module
Uninstalling a vShield Endpoint module removes a vShield Endpoint module from an ESX host. You must
perform these steps in the following order.
CAUTION If vShield Data Security is installed on the ESX host, you must uninstall it before uninstalling
vShield Endpoint.
Uninstall Products That Use vShield Endpoint
Before you uninstall a vShield Endpoint module from a host, you must uninstall all products that are using
vShield Endpoint from that host. Use the instructions from the solution provider.
Uninstall the vShield Endpoint Module from the vSphere Client
Uninstalling an vShield Endpoint module removes the vShield Endpoint Module from an ESX host.
Procedure
1Log in to the vSphere Client.
2Select an ESX host from the inventory tree.
3Click the vShield tab.
4Click Uninstall for the vShield Endpoint service.
38 VMware, Inc.
Page 39
Upgrading vShield6
To upgrade vShield, you must first upgrade the vShield Manager, then update the other components for
which you have a license.
This chapter includes the following topics:
“Upgrade vShield Manager,” on page 39
n
“Upgrade vShield App,” on page 44
n
“Upgrade vShield Edge,” on page 45
n
“Upgrade vShield Endpoint,” on page 46
n
“Upgrade vShield Data Security,” on page 46
n
Upgrade vShield Manager
You can upgrade vShield Manager to a new version only from the vShield Manager user interface. You can
upgrade vShield App and vShield Edge to a new version from the vShield Manager user interface or by
using REST APIs.
Prerequisites
Take a snapshot of vShield Manager so that you can revert to it in case the upgrade fails.
CAUTION Do not uninstall a deployed instance of vShield Manager appliance.
Upgrade vShield Manager from Version 5.0 to Version 5.1.2
vShield Manager version 5.1 and later needs a minimum of 2.5 GB disk space. You must run the
maintenance bundle to make disk space available for the upgraded vShield Manager.
Procedure
1Free Disk Space by Installing Maintenance Bundle on page 40
A minimum of 2.5 GB free disk space in the /common partition is required for the upgrade process. The
vShield maintenance bundle makes disk space available on the vShield Manager. It stops the vShield
Manager process and starts it again after the completion of the file system cleanup activity.
2Upgrade vShield Manager to Version 5.1 or Later on page 41
VMware, Inc.
39
Page 40
vShield Installation and Upgrade Guide
3Create Post-Upgrade Backup on page 42
Starting from version 5.1, vShield Manager requires an upgrade to its virtual hardware. This virtual
hardware upgrade is not automatically performed as part of the vShield upgrade process for vShield
Manager versions 5.0.x or below. Architectural changes for improved scalability, performance and
increased logging and reporting capabilities require an upgrade of vShield Manager's virtual
hardware. Some of these changes include 64-bit support, 2 vCPUs, 8 GB RAM, a larger virtual disk
along with other virtual hardware properties.
4Restore Post-Upgrade Backup on page 42
Restore the vShield Manager backup.
5Install 5.1.2a Maintenance Patch on page 43
If you are using vShield version 5.1.2, you must install the 5.1.2a patch.
Free Disk Space by Installing Maintenance Bundle
A minimum of 2.5 GB free disk space in the /common partition is required for the upgrade process. The
vShield maintenance bundle makes disk space available on the vShield Manager. It stops the vShield
Manager process and starts it again after the completion of the file system cleanup activity.
Prerequisites
NOTE Existing logs, flow monitoring data, and system event and audit logs on the vShield Manager
appliance are deleted as part of this procedure. You can retrieve the system event and audit logs using the
appropriate REST API call before applying the maintenance bundle. The tech support log bundle contains
log messages of this procedure.
Procedure
1Right-click the vShield Manager virtual machine and click Open Console to open the command line
interface (CLI) of the vShield Manager.
2Switch to enable mode.
3After logging in, type the show filesystems command.
You need at least 5% free disk space in the /common partition to install the maintenance bundle.
4Type the show manager log follow command. Keep this console open as you follow the rest of the
steps.
5Download the vShield maintenance bundle to a location to which vShield Manager can browse. The
name of the maintenance bundle file is something like VMware-vShield-Manager-upgrade-bundle-
maintenance-bundlebuildNumber.tar.gz.
6In the vShield Manager Inventory panel, click Settings & Reports.
7Click the Updates tab.
8Click Upload Settings.
9Click Browse and select the VMware-vShield-Manager-upgrade-bundle-maintenance-
bundlebuildNumber.tar.gz file.
10 Click Open.
11 Click Upload File.
12 Click Install to begin the upgrade process.
13 Click Confirm Install.
40 VMware, Inc.
Page 41
Chapter 6 Upgrading vShield
14 In the CLI, follow the output of the show manager log command. After you see the maintenance-fs-
cleanup: Filesystem cleanup successful message, log in to the vShield Manager user interface.
The upgrade process restarts the vShield Manager service, so you might lose connectivity to the vShield
Manager user interface. None of the other vShield components are restarted.
15 Log in to the CLI of the vShield Manager, switch to enable mode, and run the show filesystems
command to ensure there is at least 2.5 GB free space for the upgrade.
Upgrade vShield Manager to Version 5.1 or Later
Procedure
1Download the vShield upgrade bundle to a location to which vShield Manager can browse. The name
of the upgrade bundle file is something like VMware-vShield-Manager-upgrade_bundle-buildNumber.tar.gz.
2From the vShield Manager inventory panel, click Settings & Reports.
3Click the Updates tab.
4Click Upload Settings.
5Click Browse and select the VMware-vShield-Manager-upgrade_bundle-buildNumber.tar.gz file.
6Click Open.
7Click Upload Upgrade Bundle.
8Click Install to begin the upgrade process.
9Click Confirm Install. The upgrade process reboots vShield Manager, so you might lose connectivity to
the vShield Manager user interface. None of the other vShield components are rebooted.
10 After the reboot, log back in to the vShield Manager and click the Updates tab. The Installed Release
panel displays version 5.1.2 that you just installed.
vShield App rules from the previous release are upgraded as described below.
Firewall feature in prior versionResult of upgrade to version 5.1
Firewall rules allowed at datacenter,
cluster, and port group levels
Firewall rules supported raw IP and
MAC addresses as well as portprotocol and protocol-subtype
Firewall rules allowed at namespace level - datacenter, port group with
independent name space, and virtual wire levels
After upgrade, firewall rules from non-namespace contexts are moved to
corresponding datacenter. Migrated rules are merged with datacenter rules in
the following order:
datacenter high
n
cluster
n
Non-namespace port group or dvport group
n
datacenter low
n
datacenter default
n
Firewall rules support only IPsets, MACsets, and security groups
After upgrade, IPset, MACset, or service is internally created as appropriate. The
names of the created containers follow these naming conventions:
IPset/MACset: ip/macValue-contextName
n
Service: protocolName-portNumber-contextName or protocolName-subtypeName-
n
contextName
VMware, Inc. 41
Page 42
vShield Installation and Upgrade Guide
Firewall feature in prior versionResult of upgrade to version 5.1
Firewall rules included High and Low
precedence rules. Non-namespace
port group rules had None
precedence.
A single Spoofguard global setting
was applied across all datacenters in
inventory
In addition, all firewall histories and flows recorded prior to upgrade are deleted.
What to do next
Clear the browser cache on all clients that have accessed the previous version of the product. This action
clears the cached javascript or other files from that version that might have changed in the current version
Create Post-Upgrade Backup
Starting from version 5.1, vShield Manager requires an upgrade to its virtual hardware. This virtual
hardware upgrade is not automatically performed as part of the vShield upgrade process for vShield
Manager versions 5.0.x or below. Architectural changes for improved scalability, performance and increased
logging and reporting capabilities require an upgrade of vShield Manager's virtual hardware. Some of these
changes include 64-bit support, 2 vCPUs, 8 GB RAM, a larger virtual disk along with other virtual hardware
properties.
High and Low precedence rules not supported.
After upgrade, all non-default precedence rules are changed to None
precedence.
Spoofguard global settings are applied to each namespace. You can change
spoofguard settings on per namespace basis after upgrade.
Procedure
1From the vShield Manager Inventory panel, click Settings & Reports.
2Click the Configuration tab.
3Click Backups.
4Type the host IP address or name of the system where the backup is to be saved.
5Type the user name and password required to login to the backup system (ftp/sftp server).
6In the Backup Directory field, type the absolute path where backups will be stored.
7Type a text string in Filename Prefix. This text is prepended to each backup filename for easy
recognition on the backup system. For example, if you type ppdb, the resulting backup is named as
ppdbHH_MM_SS_DayDDMonYYYY.
8From the Transfer Protocol drop-down menu, select SFTP or FTP, based on what the destination
supports.
9Click Save Settings and then click Backup.
10 Click View Backups to ensure the backup was created.
Restore Post-Upgrade Backup
Restore the vShield Manager backup.
Procedure
1Power off the vShield Manager.
2Download the 5.1.2 vShield Manager .OVA installation package.
3Deploy a new vShield Manager into your vSphere inventory to replace the existing vShield Manager.
4Power on the new vShield Manager and go through the initial setup, giving it the same IP address as
the one that is currently powered off.
42 VMware, Inc.
Page 43
Chapter 6 Upgrading vShield
5Configure the vShield Manager Backups page to view the backups currently stored on the ftp/sftp
server.
6Identify the vShield Manager backup created earlier and click Restore.
Install 5.1.2a Maintenance Patch
If you are using vShield version 5.1.2, you must install the 5.1.2a patch.
Procedure
1Download the vShield 5.1.2a maintenance patch to a location to which vShield Manager can browse.
The name of the patch bundle file is something like VMware-vShield-Manager-upgrade-bundle-maintenance-bundlebuildNumber.tar.gz.
2From the vShield Manager Inventory panel, click Settings & Reports.
3Click the Updates tab.
4Click Upload Settings.
5Click Browse and select the file you had downloaded in Step 1.
6Click Open.
7Click Upload File.
8Click Install to begin the upgrade process.
9Click Confirm Install.
The upgrade process reboots vShield Manager, so you might lose connectivity to the vShield Manager
user interface. None of the other vShield components are rebooted.
Upgrade vShield Manager from Version 5.1 to 5.1.2
Procedure
1Download the vShield upgrade bundle to a location to which vShield Manager can browse. The name
of the upgrade bundle file is something like VMware-vShield-Manager-upgrade_bundle-buildNumber.tar.gz.
2From the vShield Manager inventory panel, click Settings & Reports.
3Click the Updates tab.
4Click Upload Settings.
5Click Browse and select the VMware-vShield-Manager-upgrade_bundle-buildNumber.tar.gz file.
6Click Open.
7Click Upload Upgrade Bundle.
8Click Install to begin the upgrade process.
9Click Confirm Install. The upgrade process reboots vShield Manager, so you might lose connectivity to
the vShield Manager user interface. None of the other vShield components are rebooted.
10 After the reboot, log back in to the vShield Manager and click the Updates tab. The Installed Release
panel displays version 5.1.2 that you just installed.
11 Download the vShield 5.1.2a maintenance patch to a location to which vShield Manager can browse.
The name of the patch bundle file is something like VMware-vShield-Manager-upgrade-bundle-
maintenance-bundlebuildNumber.tar.gz.
12 Follow Step 2 till Step 4.
VMware, Inc. 43
Page 44
vShield Installation and Upgrade Guide
13 Click Browse and select the file you had downloaded in Step 11
14 Follow Step 6 till Step 9.
Upgrade vShield Manager to Version 5.5
Prerequisites
You can upgrade to vShield Manager 5.5 only from version 5.1.2. If you have prior version of vShield
Manager in your environment, you must upgrade to vShield Manager version 5.1.2 before upgrading to
vShield Manager version 5.5.
Procedure
1Download the vShield upgrade bundle to a location to which vShield Manager can browse. The name
of the upgrade bundle file is something like VMware-vShield-Manager-upgrade_bundle-buildNumber.tar.gz.
2From the vShield Manager inventory panel, click Settings & Reports.
3Click the Updates tab.
4Click Upload Settings.
5Click Browse and select the VMware-vShield-Manager-upgrade_bundle-buildNumber.tar.gz file.
6Click Open.
7Click Upload Upgrade Bundle.
8Click Install to begin the upgrade process.
9Click Confirm Install. The upgrade process reboots vShield Manager, so you might lose connectivity to
the vShield Manager user interface. None of the other vShield components are rebooted.
10 After the reboot, log back in to the vShield Manager and click the Updates tab. The Installed Release
panel displays version 5.5 that you just installed.
Upgrade vShield App
Upgrade vShield App on each host in your datacenter.
Prerequisites
If you are using vShield App version 4.1, you must upgrade to version 5.0 or 5.0.1 before upgrading to
version 5.1 or later.
Procedure
1Log in to the vSphere Client.
2Select Inventory > Hosts and Clusters.
3Click the host on which you want to upgrade vShield App.
4Click the vShield tab.
The General tab displays each vShield component that is installed on the selected host and the available
release.
5Select Update next to vShield App.
6Select the vShield App checkbox.
44 VMware, Inc.
Page 45
7Click Install.
NOTE During vShield App upgrade, the ESXi host is placed into Maintenance Mode and rebooted.
Ensure that virtual machines on the ESXi host are migrated (using DRS or vMotion), or that they are
powered off to allow the host to be placed into Maintenance Mode.
What to do next
Inspect each upgraded rule to ensure it works as intended. For information on adding new firewall rules,
see the vShield Administration Guide.
Upgrade vShield Edge
Follow the upgrade procedure that corresponds to the existing vShield Edge version in your environment.
Upgrade vShield Edge from 5.0.x to 5.5
You must upgrade vShield Edge on each port group in your datacenter. You cannot upgrade vShield Edge if
the same backend IP address has been configured under different listeners with different ports.
vShield Edge 5.1 and later is not backward compatible and you cannot use 2.0 REST calls after the upgrade.
During the vShield Edge upgrade, there will be a brief network disruption for the networks that are being
served by the given vShield Edge instance.
Chapter 6 Upgrading vShield
Prerequisites
You must have been assigned the Enterprise Administrator or vShield Administrator role. If you have
vShield Edge 5.0.x, each 5.0.x vShield Edge instance on each portgroup in your datacenter must be
upgraded to 5.5.
Procedure
1Log in to the vSphere Client.
2Click the portgroup on which the vShield Edge is deployed.
3Click the vShield Edge tab.
4Click Upgrade.
5View the upgraded vShield Edge.
aSelect the datacenter corresponding to the port group on which you upgraded the vShield Edge.
bClick the Network Virtualization tab.
cClick Edges.
vShield Edge is upgraded to the compact size. A system event is generated to indicate the ID for each
upgraded vShield Edge instance.
What to do next
IMPORTANT Firewall rules from the previous release are upgraded with some modifications. Inspect each
upgraded rule to ensure it works as intended. For information on adding new firewall rules, see the vShieldAdministration Guide.
If a user's scope in a previous release was limited to a port group which had a vShield Edge installation, the
user is automatically granted access to that vShield Edge after the upgrade.
VMware, Inc. 45
Page 46
vShield Installation and Upgrade Guide
Upgrade vShield Edge from 5.1.x to 5.5
Procedure
1Log in to the vSphere Client.
2Click the datacenter for which vShield Edge instances are to be upgraded.
3Click the Network Visualization tab.
All existing vShield Edge instances are shown in the listings page. An arrow icon is shown for each
vShield Edge that must be updated.
4Click a vShield Edge and click Upgrade.
When the Edge is upgraded, the arrow icon no longer appears
What to do next
IMPORTANT Firewall rules from the previous release are upgraded with some modifications. Inspect each
upgraded rule to ensure it works as intended. For information on adding new firewall rules, see the vShieldAdministration Guide.
Upgrade vShield Endpoint
To upgrade vShield Endpoint from 5.0 to a later version, you must first upgrade vShield Manager, then
update vShield Endpoint on each host in your datacenter.
Procedure
1Log in to the vSphere Client.
2Select Inventory > Hosts and Clusters.
3Select the host on which you want to upgrade vShield Endpoint.
4Click the vShield tab.
The General tab displays each vShield component that is installed on the selected host and the available
version.
5Select Update next to vShield Endpoint.
6Select the vShield Endpoint check box.
7Click Install.
Upgrade vShield Data Security
Upgrade vShield Data Security on each host in your datacenter. It is recommended that you upgrade
vShield Endpoint before upgrading vShield Data Security.
Procedure
1Log in to the vSphere Client.
2Go to Inventory > Hosts and Clusters.
3Select the host on which you want to upgrade vShield Data Security.
The Summary tab displays each vShield component that is installed on the selected host and the
available release.
4Select Update next to vShield Data Security.
46 VMware, Inc.
Page 47
5Select the vShield Data Security checkbox.
6Click Install.
Chapter 6 Upgrading vShield
VMware, Inc. 47
Page 48
vShield Installation and Upgrade Guide
48 VMware, Inc.
Page 49
Troubleshooting Installation Issues7
This section describes installation issues.
This chapter includes the following topics:
“vShield App Installation Fails,” on page 49
n
“vShield Data Security Installation Fails,” on page 50
n
vShield App Installation Fails
Installing vShield App results in an error.
Problem
vShield App installation may fail due to a previous incomplete installation or problems during
uninstallation of a previous version.
Solution
1Start with an automated uninstall of vShield App. See Chapter 5, “Uninstalling vShield Components,”
on page 37.
2Verify that the required modules are loaded in the ESX host by logging in to an SSH client and typing
the following command:
VMware, Inc.
esx01# esxcfg-module -l | grep -i dvf
dvfilter 2 72
vmkapiv1_0_0_0_dvfilter_shim0 8
3If the required modules are not loaded, type the following commands to load them.