VDS 6.2.0 DSM InstallConfig Guide v2 PDF
VDS 6.2.0 DSM InstallConfig Guide v2 PDF
D o c u m e ntat i o n v 2
M a rc h 2 6 , 2 0 1 9
Vormetric Data Security Platform
Installation and Configuration Guide
v6.2.0
Contents
...................................
.....
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Documentation Version History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Sales and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Connect to the V6000 appliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Access the DSM Command Line Interface (CLI) . . . . . . . . . . . . . . . . . . . . 45
Configure network settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configure a bonded NIC device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Enable DHCP on bond0 interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configure NTP, time zone, date, time . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configure the hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Generate the DSM Certificate Authority . . . . . . . . . . . . . . . . . . . . . . . . . 52
Add more CLI administrators (optional) . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring IPMI for the V6000 (optional) . . . . . . . . . . . . . . . . . . . . . . . 53
Verify web access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Upload a license file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Full Disk Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
nShield Connect Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
High Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
System and Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Configuring nShield Connect HSM with DSM . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Configure nShield Connect appliance and associated RFS . . . . . . . . . . . 57
Add DSM as an nShield Connect client . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Add the nShield Connect HSM to the DSM . . . . . . . . . . . . . . . . . . . . . . . 57
Configuring High Availability for network HSM-enabled DSM . . . . . . . . . . . . 58
Managing network HSM-enabled DSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Backing up and Restoring network HSM-enabled DSM . . . . . . . . . . . . . . . . . . 60
Updating a network HSM-enabled DSM Security World . . . . . . . . . . . . . . . . . 61
High Availability (HA) Configuration for V6000 hardware appliance . . . . . . . . . . . . 61
KVM Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
virt-manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
virsh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Deploying on a Xen Hypervisor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
virt-manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
virsh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
High Availability (HA) Configuration for Virtual Appliances . . . . . . . . . . . . . . . . . . . 95
A Specifications, Racking, and Cabling for the V6000 and V6100 . . . . . . . . . . 111
Hardware Appliance Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Control Panel LEDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
DSM Hardware Appliance Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Space, Network, and Power Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Physical dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
C IPMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
IPMI Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Configuring and Accessing IPMI on the DSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Configuring IPMI on the DSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Configuring IPMI Network Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Configuring Date and Time Settings with NTP Enabled . . . . . . . . . . . . . . . . . . 143
Configuring Date and Time Settings with NTP Disabled . . . . . . . . . . . . . . . . . 143
Configuring Users Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Configuring IPMI GUI Port Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Configuring Fan Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Remote Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Console Redirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Power Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Using Active Directory with IPMI GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Configuring AD groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Configuring the AD Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Configuring LDAP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Configuring LDAP Settings on IPMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Maintenance Firmware Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Server Health . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Best Practices after IPMI is Configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Replace the default certificate with a Web Server Certificate . . . . . . . . . . . . 151
Change the port through which you access IPMI . . . . . . . . . . . . . . . . . . . . . . . 152
Change the IPMI password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Creating IPMI users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
To create an IPMI user: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Configuring Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Configure SMTP (optional - for e-mail alerts) . . . . . . . . . . . . . . . . . . . . . 155
6 Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Ports to Configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
IPMI Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
8 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Loss of Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Is the Management Console accessible? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Check whether Agent communication ports are open from the UI . . . . . . . . 173
Reset DSM Appliance and Remove All Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Reset Original Security World with Original ACS Quorum . . . . . . . . . . . . . . . . 174
Create New Security World with New ACS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Chassis Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Indicator Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Boot-Up Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Boot-up Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Preface
.....................................................................
The Install and Configuration Guide describes how to install and configure the hardware and
virtual appliances, including the V6100 DSM with Hardware Security Module (HSM). This
document is intended for system administrators who install the DSM and connect it to a
network.
Documentation Changes
6.0.2 v4 03/01/2018 This release introduces support for DSM key attributes to be propagated to
VAE and support for a DSM AWS image.
6.0.3 v1 07/06/2018 GA release of v6.0.3 This release introduces support for nShield Connect
Integration, Automatic registration of LDT/Docker hosts, Bring Your Own
Encryption Keys (BYOK). Provides the ability to create non-KMIP domains
with a DSM KMIP license installed, Additional REST APIs, and Thales
branding on GUI, CLI, and documentation.
6.1.0 v1 09/07/2018 GA release of V6000 and virtual appliances can now be HMS-enabled by
connecting them to an nShield Connect appliance. DSM is now available in
the Azure marketplace.
6.2.0 v1 3/12/2019 GA release; HA is now active/active, new CLI commands, new API calls
expanded KMIP features. This guide contains new troubleshooting and
IPMI information.
ASSUMPTIONS
This documentation assumes that you have knowledge of your computer network as well as
network configuration concepts. For the hardware appliance, you’ll also need access to the
data center where your DSM hardware appliance will be racked and cabled.
For more information about what’s new in this release, refer to the DSM 6.0.2 Release Notes.
Refer to the DSM Administrators Guide for how to administer your DSM Appliance and to the
various agent guides for information about Vormetric Data Security Agents.
.....
The Data Security Manager (DSM) is the central component in the Vormetric Data Security
Platform (VDS Platform). The DSM provides centralized management of data security policies
and encryption keys that enable corporations to secure their data in physical as well as virtual
environments. With the DSM you can:
• Define security policies to encrypt files and directories and control access to that encrypted
data
• Create, store and manage DSM encryption keys, efficiently
• Provide centralized key management for third-party platforms, and securely store X.509
certificates, symmetric keys, and asymmetric keys
• Provide strong separation of duties, ensuring one administrator does not have complete
control over data security policies, encryption keys, and DSM administration
• Create administrative domains for different business units or different customers to share the
DSMs protection but, with complete separation of administrators and the data they control
• Provide continuous availability by clustering DSMs to ensure access to DSM policies and keys
• Provide flexible administration via a web-based management console, command line
interface (CLI), and application programming interfaces (API) including REST and SOAP.
This guide describes how to install and configure the DSM V6100 and V6000 hardware
appliances, and the DSM virtual appliance.
This chapter contains the following sections:
• “DSM Overview”
• “DSM Deployment”
DSM Overview
.....................................................................
The DSM is available as either a hardware appliance with a Hardware Security Module (model
V6100), a hardware appliance (model V6000), or a virtual appliance.
The DSM stores data security policies, encryption keys, and audit logs in a a virtual or hardened
appliance that is physically separated from the VTE Agents. Security teams can enforce strong
separation of duties over management of the system by requiring the assignment of key and
policy management to more than one data security administrator so that no one person has
complete control over the security of data.
Figure 1: DSM V6000 Appliance without HSM (rear view)
No HSM
HSM
The DSM integrates key management, data security policy management, and event log
collection into a centrally managed platform that provides high availability and scalability to
thousands of Vormetric Transparent Encryption (VTE) Agents. This enables data security
administrators to manage standards-based encryption across Linux, UNIX, and Windows
operating systems in both centralized and geographically distributed environments. The DSM
supports IPv4 and IPv6 addresses.
IPMI
The V6000 and V6100 DSM hardware appliances support the Intelligent Platform Management
Interface (IPMI). IPMI is a computer interface specification for autonomous computer
subsystems. It provides remote access to the V6000 and V6100 hardware appliances. It allows
administrators to remotely monitor appliance health (temperature, power consumption,
physical drive status, chassis intrusion), perform remote cold boots (power off and power on),
and access the DSM CLI from a remote location. IPMI is not supported by the DSM virtual
appliance or hardware appliances earlier than V6000/V6100.
As of this release, IPv6 addresses are supported on DSM hardware appliances. However IPv6
addresses cannot be configured via the IPMI CLI. To configure an IPv6 address using IPMI, you
must access the IPMI management console UI.
Although not necessary for DSM maintenance and operation, some administrators may find the
IPMI features useful. IPMI activation and best practices are described in “IPMI” on page 139.
DSM Deployment
.....................................................................
The Data Security Manager (DSM) enables centralized management of data security policies
and key management, simplifying training, deployment and operations.
A VTE environment consists of a DSM and one or more VTE Agents residing on your protected
hosts. A protected host contains the data to be protected, and can be on-site, in the cloud, or a
hybrid of both. The VTE Agents communicate with the DSM and implement security policies on
their protected host systems.
Communication between agents and the DSM is encrypted and secure. DSM Administrators
establish access and manage encryption policies through a web-based management console,
command line interface (CLI), and application programming interfaces (API) including REST and
SOAP.
VTE achieves security with complete transparency to end users with little impact to application
performance. It requires no changes to your existing infrastructure and supports separation of
duties between data owners, system administrators, and security administrators. See Figure 3:
“The DSM in a VTE Environment”.
Figure 3: The DSM in a VTE Environment
.....
The DSM V6100 appliance comes with a Hardware Security Module (HSM). The HSM
safeguards and manages DSM objects (example: certificates and keys) with strong
authentication and crypto-processing. This chapter describes how to set up and configure the
V6100 hardware appliance.
In a V6100 high availability (HA) environment, all systems must be V6100s, they cannot be
combined with any other appliance type or version of DSM. As of the v6.0.2 release, the DSM
supports full disk encryption for enhanced security, and dynamic IP addressing via DHCP.
Figure 4: V6100 DSM hardware appliance
Front
Back
• Eliminates the need for administrators to be physically present in the lab to administer the
DSM
• Eliminates the need for physical mode switch changes for HSM administration
• Enables administrators to present smart cards remotely from a PC or laptop
• Enables operational simplicity and efficiency
Requirements
Remote HSM Administration only applies to the V6100 appliances that have DSM software v6.0
or later installed. Remote administration needs to be turned on from the CLI before you can
begin to use it.
To use the remote HSM administration feature, the following are required:
• A remote card reader or trusted verification device (TVD) and smart cards set. These must be
ordered separately, contact your Thales Sales representative for more information.
• V6100 appliance with DSM software (v6.0 or later)
• Client system (e.g. laptop, PC outside the data center) on which to install the remote
administration software and connect the TVD.
See “Enable remote administration” on page 25 for details.
NOTE: If you choose not to enable remote HSM administration, you can continue to use the
original card reader and card set that came with your DSM V6100 appliance.
Security World
A Security World is a logical security grouping of a DSM appliance and its associated objects and
the Administrative Card Set (ACS) that is used to create and manage that appliance and its
associated objects. In the case of a high availability deployment, all the DSM appliances and
their associated objects in the cluster, are members of the same Security World.
The ACS is required to access a DSM, and in an HA environment, the same ACS is required to
access the HA DSM nodes. The ACS creates the Security World to which the DSM belongs. In an
HA deployment, all DSMs in the same cluster belong to the same Security World and require
the same ACS to carry out administrative functions, for example, adding new DSMs to a cluster.
Each card set consists of a number of smart cards, N, of which a smaller number, K, is required
to authorize an action. That required number K is known as the quorum.
ACS
The ACS is created when the initial DSM is configured. If this is an HA cluster, than the initial
DSM is designated as node 1. During ACS creation, you must choose the total number of smart
cards contained in your ACS (minimum is two, recommended is at least three, maximum is 64).
This number is called N. You must then choose a smaller number of cards from this set of N,
which are required to authorize an administrative action. This required number is called K, and
is known as the quorum.
For example, if you have a single DSM, you can choose to have 6 cards in your ACS (N=6), and 4
cards to authorize an administrative action (K=4).
Before configuring your DSM, decide both N and K. Remember that in a distributed HA
environment, you may want K cards at each geographic location so you don’t have to ship cards
to the different location to perform an administrative task. However, you may also want to have
K+1 cards in case one card goes bad or is unavailable.
The ACS is created during primary DSM configuration. While generating the certificate, you are
prompted to insert a smart card into the reader and to provide an optional passphrase for each
card. If a passphrase is specified, it will be required for subsequent card usage. That is, not only
will the card holder have to provide the smart card, but also the passphrase required for that
card. Repeat this procedure for each card in your ACS (N number of times). On completion of
the ACS creation, distribute the cards to the appropriate card holders.
ACS Guidelines
Once you create your ACS, you can never change N and K. You can create a replacement ACS,
but N and K remain the same. Use these guidelines to carefully select the card set.
• The ACS is crucial: an unusable card set will prevent you from performing administrative
operations that require the ACS.
• The ACS for the DSM(s) in a standalone or HA environment is created when HA node 1 is
configured. You must define N and K before you set up HA node 1, and you must decide
whether or not to use pass phrases for each card in the ACS.
• You can only create an ACS on the initial HA node. It cannot be created on any other HA node.
All nodes in a DSM cluster share the same Security World.
• Do not create an ACS where K is equal to N because an error on one card would render the
whole card set unusable.
• Certain administrative tasks on a DSM require only a quorum (K) of smart cards. If you are
creating a distributed HA environment, you’ll probably want enough smart cards to access
each of the distributed DSMs in your environment plus maybe one extra in case one of the
cards goes bad.
For example, if you have four distributed DSMs and the quorum, K, is two, you will need at
least three smart cards at each DSM location. This means, that the total number of smart
cards, N, must be at least twelve.
• Choose the optimal K to N ratio for your situation. You cannot change the K or N of your ACS
after initial creation.
• A higher K to N ratio provides greater security, but less convenience. For example if you
choose K to be nine and N to be ten, nine cards must be available to perform an
administrative task on any DSM in the system, and you will have one extra in case one of
those nine are not available. On the other hand, making sure those nine cards are available
can provide more logistical problems.
• A lower K to N ratio provides slightly less security, but more convenience. For example, if
you have one local HA node and three geographically distributed HA nodes, and you choose
K to be three and N to be sixteen, then you could distribute four cards to each DSM location
and only three of those cards need to be available.
You should choose enough smart cards to support all of your DSMs, plus a backup card in
case one of the cards gets damaged, or is unavailable. However, a higher N increases the
risk of others gathering enough cards to access the DSM. You want K to be high enough to
provide a level of security that you are comfortable with, but not so high as to be logistically
difficult.
• In some cases, it is desirable to make K greater than half the value of N (for example, if N is
seven, to make K to be four). Such a policy makes it harder for a potential attacker to obtain
enough cards to access the DSMs. Choose values of K and N that are appropriate to your
situation.
• Smart cards have a unique identification number, it can be very useful to document the ID
number of each card, which ACS group that card belongs to, the security officer a card belongs
to, the passphrase, and any additional information you consider useful for your situation.
• Pass phrases are optional for each card. An ACS can have some cards with pass phrases and
some with no pass phrase. Pass phrases can be different for each card.
• Create a security policy to manage the card set and to keep it well protected. No single person
should have access to more than one card (separation of duties).
DHCP support is available for all the DSM interfaces; eth0 (enabled by default), eth1, and
bond0. The DSM DHCP implementation configures the interface IP address, subnet mask,
router (default gateway), DNS server, and the search domain. It does not configure a host
name, an NTP server, or Time Zone for the DSM appliance, these have to be manually
configured via the CLI.
You can choose to turn off dynamic IP addressing and use static IP addressing instead, see
“Configuring DSM via Static IP Addressing”. DHCP is managed via the CLI, the DHCP CLI
commands are available in the Network category of commands and are described in detail in
the DSM Administrators Guide.
The DSM appliance eth0 interface is now DHCP-enabled by default. This section describes
how to configure the DSM appliance with DHCP enabled. You must have a DHCP Server
properly configured to ensure that the DSM appliance gets the correct IP address.
After accepting the license agreement and changing the CLI administrators password, you need
to set the host name and configure an NTP server. The following sections describe the
procedures to configure the DSM using DHCP:
6. “Enable DHCP on bond0 interface:” on page 23, if you choose to use this feature
7. “Generate DSM Certificate Authority and create ACS” on page 25
8. “Configuring High Availability for V6100” on page 37
9. “Add more CLI administrators (optional)” on page 29
If you do not want to want to use DHCP, it can be turned off via the CLI and you can assign a
static IP addresses to the DSM interfaces. The DHCP CLI commands are available in the Network
category commands sub-menu and are described in detail in the CLI chapter of the DSM
Administrators Guide.
To turn off DHCP do the following and then proceed with the procedures described below,
“Configure appliance with static IP addressing enabled”.
Log on to the CLI console with the CLI administrator credentials and enter the Network
category of commands, and turn off DHCP on the eth0 interface;
0001:network$ ip dhcp release <interface> version 4
Example
0001:network$ ip dhcp release eth0 version 4
System Response
WARNING: Changing network ip address may disconnect your session and will
require the server software to be restarted.
Continue? (yes|no)[no]:yes
DHCP operations may take some time, please wait....
SUCCESS: Please restart server software to pick up the changes.
0002:network$
The following sections below describe how to configure the DSM appliance using static IP
addressing:
Assumptions
• Data center conditions meet the appliance racking, networking, and power requirements.
• The IP address, routing configuration and DNS addresses for the DSM allow connectivity to all
servers where Vormetric Encryption Agents are installed.
Use this table to collect the information you need for the installation.
Table 2: Installation Checklist
REQUIREMENT VALUE
Hardware Requirements
Network Information
Certificate Information
Pre-configuration tasks
You must do one of the following on each DSM, since entries in the host file are not
replicated across DSMs.
• Modify the host file on the protected hosts: Enter the DSM host names and matching IP
addresses in the /etc/hosts file on the protected host. You must do this on EACH
protected host making sure to add an entry for all DSM nodes (if using HA).
• Use IP addresses: You may use IP addresses or the FQDN to identify the host
simultaneously. In other words, they don't all have to use an IP address or FQDN.
Configuration tasks
To configure the DSM you need to access the DSM CLI through a terminal connection in the
back of the DSM hardware appliance. Figure 5 shows the various DSM appliance ports.
Figure 5: V6100 appliance ports
After connecting your laptop to the DSM, use the DSM Command Line Interface (CLI) to
configure the DSM (see the first few steps in “Configure network settings” on page 18). CLI
commands are grouped into the following categories or submenus. Enter “?” on the CLI
command line to lists the categories:
0036:dsm$ ?
network Networking configuration
system System configuration
hsm HSM configuration
maintenance System maintenance utilities
ha HA configuration
ipmi IPMI configuration
user User configuration
exit Exit
To enter a submenu, enter a name or just the first few letters of the name. To display the
commands for that submenu, enter a ‘?’. For example, the submenu maintenance is used to
provide maintenance utilities:
0037:dsm$ maintenance
0038:maintenance$ ?
config Save/load configuration file
showver Show the installed VTS version
delver Delete unused firmware version
ntpdate Set ntp services
date Set system date
time Set system time
gmttimezone Set system time zone
diag OS diagnostics
Every command has a usage and example input. Type the command without a value:
0039:maintenance$ ntpdate
usage: ntpdate {sync | add SERVER_ADDRESS | delete SERVER_ADDRESS | on |
off | show }
0040:maintenance$ date
month=Mar day=17 year=2015
Show system date SUCCESS
0041:maintenance$ time
hour=11 min=11 sec=36 zone=PDT
Show system time SUCCESS
0042:maintenance$ gmttimezone
usage: gmttimezone {list|show|set ZONE_NAME}
0043:maintenance$ diag
usage: diag [log [ list | view LOG_FILE_NAME] | vmstat | diskusage |
hardware | osversion | uptime ]
0044:maintenance$
You must enter a submenu to execute the commands in that submenu. For example, the
reboot command is in the system submenu, you would type system and press enter to enter
the system submenu, then type reboot to execute the reboot command. To return to the main
menu when finished, type up.
A complete description of all the DSM CLI commands can be found in the DSM Administrators
Guide.
NOTE: The eth0 interface is DHCP enabled by default. See “Configuring DSM through
DHCP”for more information, and for instructions on how to switch to static addressing if
desired.
Thales recommends that you retain the default eth1 IP address configuration in the event that
you need a recovery option to access the DSM appliance.
Example
0002:network$ ip address init 192.168.10.4/16 dev eth1
IPv6 example
0002:network$ ip address init fa01::3:15:130/64 dev eth1
NOTE: If you are connected through ETH0, you will be disconnected at this step. Reconnect on
the new IP address.
3. (Optional) If you have configured ETH0, you can also configure an IP address for ETH1 if you want
to communicate with agents on a different subnet for example, or if you want to access the
Management Console from a different subnet. To configure an IP address for ETH1, type:
0003:network$ ip address init <eth1 IP address>/<subnet mask (e.g., 16
or 24)> dev eth1
Example IPv4
0003:network$ ip address init 192.168.10.3/16 dev eth1
Example IPv6
0003:network$ ip address init fa01::3:15:130/64 dev eth1
System Response
WARNING: Changing the network ip address requires server software to be
restarted.
Continue? (yes|no) [no]:
Type ‘yes’ to continue with the IP address configuration.
4. Configure the IP address for the default gateway. Type:
0004:network$ ip route add default table main.table dev [eth0 or eth1]
via <IP address for the default gateway>
Example
0004:network$ ip route add default table main.table dev eth0 via
192.168.1.5
IPv6 example
0004:network$ ip route default table main.table dev eth0 via
fa01::3:15:120
5. Verify the interface settings. Type:
7. If you are using DNS, set the primary DNS server for the DSM. Type:
0007:network$ dns dns1 <ip address for dns server 1>
8. If you have a second or third DNS server, set them for the DSM. Type:
0008:network$ dns dns2 <ip address for dns server 2>
NOTE: In order to use the bonded NICs feature, you must ensure that your switch is configured
to use Link Aggregation Control Protocol (LACP).
DSM physical appliances have two physical NICs called eth0 and eth1. Only two NICs eth0
and eth1 are supported. Any additional physical/virtual NICs are ignored.
The NIC bonding setting is system specific. If it is to be used for all nodes in a cluster, it must be
enabled on all nodes individually.
If configured, this interface supersedes the eth0 and eth1 interface configurations and must
be used to access the appliance.
1. Access the DSM CLI and login with your credentials. If this is the first time you are logging in,
then you will be required to accept the license agreement and change the default password, see
“Configure network settings”.
2. Navigate to the network commands menu, type:
$ network
The output of this command displays the physical link settings on the system. You can use it to
verify any changes to the physical link settings:
Example:
Device State MTU Mediatype Speed
eth0 UP 1500 copper auto
eth1 UP 1500 copper auto
or
0003:network$ ip address flush bond0
Routes that are associated with this bonded NIC device will also be deleted.
Bonding driver modes
The modes specify bonding policies. Some options for certain modes are configurable (the
transmit hash policy for bonding modes 2 and 4, and the updelay for bonding mode
6), while the others take the default values for those modes, except for the miimon setting.
The transmit hash policy for bonding modes 2 and 4, is used for slave selection in these modes.
To set the transmit hash policy for mode 2 or 4, use the ip link set command, for example;
0004:network$ ip link set bond0 mode 2 xmithashpolicy layer2+3
To view the changes, use the ip link show command;
Device State MTU Mediatype Speed
eth0 UP 1500 copper auto
eth1 UP 1500 copper auto
The miimon setting specifies the MII link monitoring frequency in milliseconds, which
determines how often the link state of each slave is inspected for link failures. The miimon
setting has a value of 100 instead of the default value of 0.
• To see the supported Bonding driver modes, see Table 15, “Bonding Driver Modes,” on
page 171.
6. Set the country and city where the DSM resides. Type:
0005:maintenance$ gmttimezone set <country/city>
7. Set the date. (If you used ntpdate synch, this step is not necessary.) Type:
0006:maintenance$ date <mm/dd/yyyy>
8. Set the time. (If you used ntpdate synch, this step is not necessary.) Type:
0007:maintenance$ time <hh:mm:ss>
Where hh is 00 to 23.
9. Verify your settings. Type:
0008:maintenance$ time
0008:maintenance$ date
3. Set the hostname. You must enter the fully qualified domain name for the DSM. Type:
0003:system$ setinfo hostname <FQDN>
Example
0003:system& setinfo hostname dsm.company.com
NOTE: The default host name in the output is your. name.here. Also, it must be lowercase.
Before you can use the TVD and smart cards to generate the certificate authority, you need to
enable remote administration.
1. Navigate to the hsm menu and check the remote administration status. Type:
$ hsm
0001:hsm$ remoteadmin show
On completion of the preliminary configuration, you must now generate the DSM certificate
authority which requires the ACS. Read “ACS Guidelines” on page 8 before going through the
procedures in this section.
Prerequisites
Move the mode switch on the back panel of the appliance to the Operational (O) position.
Warning! The switch must remain in the Operational (O) position at all times when
using either local or remote administration.
1. Install the client software on the laptop or PC. Instructions for how to install the TVD client
software are available in the CD and guide that came with your TVD. The software must be
installed on all laptops and PCs participating in the ACS creation. Refer to the TVD release notes
for supported operating systems.
2. Connect the TVD to your laptop or PC.
3. Determine the total number of smart cards, N, you require for your Administrator Card Set
(ACS).
4. Determine the quorum (K) i.e., the number of cards required to perform an administrative
operation.
5. Document the ACS group for each card as well as the security officer to which a card belongs.
You can also add the passphrase and any additional information you consider useful for your
situation.
The following steps display the DSM CLI commands and output when you create the certificate
authority and ACS.
4. A warning message is displayed informing you that all agent and peer node certificates will need
to be resigned after the new certificate authority is created and that the DSM software will be
restarted, type ‘yes’ to generate the certificate.
WARNING: All Agents and Peer node certificates will need to be re-signed
after CA and server certificate regenerated, and the security server
software will be restarted automatically!
Continue? (yes|no)[no]:yes
5. The following message is displayed. Read it, enter the required information to generate the CA,
and ensure the DSM host name is correct, press enter:
This computer may have multiple IP addresses. All the agents will have to
connect to Security Server using same IP.
Enter the host name of this computer. This will be used by Agents to talk
to this Security Server.
This Security Server host name[<hostname>.com]:
Please enter the following information for key and certificate
generation.
What is the name of your organizational unit? []:Engineering
What is the name of your organization? []:Vormetric, Inc.
What is the name of your City or Locality? []:San Jose
What is the name of your State or Province? []:California
What is your two-letter country code? [US]:
Regenerating the CA and server certificates now...
6. You will now create your ACS.
!
Caution: Do not set the number of cards to use in the ACS to more than the number
of cards in your possession. See “ACS Guidelines” for details.
7. You will be prompted to enter the total number of cards to use in the ACS, (N), and the minimum
number of cards required to perform an administrative task (K).
Enter the total number of cards (N) you would like to use in your
Administrator Card Set (ACS).
Note: To create a Security World that meets the requirements of Common
Criteria this value should be at least 3.
This value must be at least 2 and no higher than 64: 2
!
Caution: You must not lose this passphrase or your cards will be unusable.
The hash value above, is the same hash value that will be displayed when you create an HA
node. You can compare the hash values to verify a successful creation.
!
Caution: Do NOT remove the card from the smart card reader until the server
private key is generated.
9. You can now remove the smart card from the reader.
Creating and signing the server certificates...
done
CA and Server certificates have been generated successfully.
JBoss vault keystore password have been completed successfully.
You may now start the Security Server
Stopping Security Server
Stopping data store
Starting data store
Starting Security Server
SUCCESS: The CA and security certificates are re-generated and the
Security Server software is restarted.
After configuring your appliance, you need to access the DSM Management Console from a
browser, to administer the DSM.
Open a browser and confirm access over HTTPS to either the DSM hostname (if configured in
DNS) or the IP address defined in “Configure network settings” on page 18. Example URL:
https://dsm.vormetric.com
If this doesn't work because, for example, port 443 was blocked by a firewall, specify port 8445.
Example:
https://dsm.vormetric.com:8445
The default user name and password to log on to the DSM the for first time are; admin and
admin123. You will be prompted to reset the password. The password criteria are:
• Does not have repeating characters
• Uses at least 1 upper and 1 lower case character
• Uses at least 1 special character
The DSM Management Console has a help icon (?) located on the right-hand side of the title
bar, which is located under the menu bar, on each page of the Web UI. Click the icon for help
with tasks on a specific page.
user
2. For each administrator you want to add, type:
add <administrator name>
3. When prompted, enter a password. The password criteria are:
• Does not have repeating characters
• Uses at least 1 upper- and 1 lower-case character
• Uses at least 1 special character
4. Return to the main menu, type:
up
To maintain the security of the encrypted root file system, a DSM System administrator can set
a passphrase that will be required at boot time to unlock the system. Setting a boot passphrase
is not required. Users who prefer an unattended boot, can continue to use the DSM without a
passphrase. However in the interest of better security, we recommend that you set a boot
passphrase.
Once a boot passphrase is set, it is required each time the system boots. The passphrase is set
via the CLI and is available under the ‘System’ category of commands in the security sub-menu,
refer to the CLI chapter of the DSM Administrators Guide for details about usage.
If you plan to create a high availability cluster, we recommend, that you set a passphrase on
each node in the cluster, in order to maintain a consistent level of security.
To set a passphrase the following are required:
• An RSA key pair with a minimum length of 2048 bits. The public key of the pair is used to
encrypt the passphrase. The private key is required to decrypt the passphrase for recovery, in
the event that it is lost.
• Console access to the DSM appliance, either direct or remotely via IPMI. After setting the
passphrase, the DSM will reboot and any network connections will no longer work. Upon
reboot, a prompt will appear on the console, and the system will wait for the correct boot
passphrase to be entered.
See “Configuring IPMI on the DSM” for how to set up the IPMI. If using a virtual appliance, you
can connect to the DSM via the console available from the virtualization application in use.
1. Log on to the console, and enter the System category of commands and type security
boot-passphrase set at the prompt;
0001:system$ security boot-passphrase set
2. You will be prompted for an RSA public key with a minimum length of 2048 bits. Copy and paste
the contents of your public key file at the prompt, then press Enter again to end with an empty
line.
An RSA public key with minimum length of 2048 bits is required for boot
passphrase recovery. Please enter one now, ending with an empty line:
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwYIf0Z04nzne9j78BY7m
Q9kMTgh8YErtklECnVVhxExob/UvAWOvSBcGDVgixpeMCywWVh8OgTIbj751PVfa
TI8/C+gP4Rd6cdtO7fGzsYsAZxN9OCssRQlCJfCe6y6fNep3dDOh1noTFyFNTqOy
c3WW0gAlJ9ILPwn6uxVRgtXPgLnFfP9zNieyWmHTLw6He8BZAAYkWbESMgnA5BoJ
mcxdpv/i/8ZODTMMo/6Ji4oYpQPa8i9Ex7qTZinl5hxjIjC8eIcUOMNdAhvslNzs
T6FZPJ2BEYBU6TAQpxDPLwPAQIEw1x/NzcYUUfgaP1pZIAdhWFJUZkx4FqmEA5od
MwIDAQAB
-----END PUBLIC KEY-----
3. You are prompted to enter a passphrase, which must conform to the configured password policy.
After you enter the passphrase, a message is displayed, warning you that you will need access to
the console, either directly or via IPMI, so that you can enter the boot passphrase when
prompted. If the console is available, type ‘yes’ to continue.
Enter new boot passphrase:
Enter new boot passphrase again:
WARNING: After setting the new boot passphrase, the system will
be rebooted automatically and the new passphrase must be entered
on the console. If you do not have direct or IPMI access to the
console, then choose 'no' to cancel. DSM will not boot up until
a correct boot passphrase is entered.
Continue? (yes|no)[no]: yes
!
Caution: Save this encrypted passphrase as it is required each time the DSM reboots.
In the event that you forget the passphrase and lose the encrypted passphrase
and/or the RSA private key, your DSM will be unrecoverable.
4. You will be reminded to set a boot passphrase on each of the designated DSM HA nodes as well.
A message confirming that a boot passphrase has been set is displayed and the system will
reboot.
NOTE: run this command on every server node in the cluster to
keep them at a uniform security level.
SUCCESS: custom boot passphrase has been set.
DSM server is rebooting...
5. Open the IPMI Java console (or if using a virtual machine, the console from the virtualization
application). During the reboot you will be prompted to enter the boot passphrase. The system
will continue to reprint the prompt until the correct value is entered.
Please enter passphrase for disk <disk_name> (DSM_ROOT)!
6. Enter the passphrase, the system startup messages will continue to scroll until the system is
ready and the log in prompt is displayed. Now you can log into your system as before.
Welcome to the Vormetric Data Security Manager on
<dsm_server_name>.com
<dsm_server_name> login: cliadmin
Password:
SUCCESS
The following passphrase recovery files are available:
0. 201710031407
2. Enter the number of the file to display contents, the encrypted passphrase and the public key
used to encrypt it. An example of the command you can use to decrypt the passphrase is also
displayed.
Type the number of a file to view the contents, or 'q' to quit: 0
Encrypted passphrase (base64 encoded):
fqWOGbKe4x6R3vmWtBMFvoAauaEpOnQ9OGLmFW9eZhFbv+w1+u0LPgIGYx9e5AT
5nPnPD2GAyMWM
H8GOvuJvht7UzBodMA07DHNMpyMnOEsy6Nz+ouWsMWhHen5JFNMXKWM9TYQ9/yr
1D2cFuBsppFLV
W/2McKIYuBqgeaOefzL2jr8vyyFudq6TGgTjRJe1edLDCqTJbcK100o036U0vyn
EsvMucps1sq0k
Lpes6Zp1ud5usWngn2J2X6PrlAugHp4nMMDIRLQBgzX95x7Fb7VLebcb/eIGn39
KJaPU9sxEiFwl
xh/f6azXhHpjahwjirzfpZl0300VFYT0P9o5xg==
!
Caution: Copy and paste functionality is not available from the IPMI Java console,
you will have to manually copy the contents of the encrypted passphrase file and
save it. That file needs to be accessible, along with the private key so that you can
run the command to decrypt the passphrase.
We recommend you save the encrypted passphrase ahead of time from the CLI so
you don't have to manually transcribe it from the boot menu. See “Full Disk
Encryption” on page 30.
3. Enter the passphrase when prompted to do so on the IPMI Java console to unlock the system
and boot up the DSM.
Configuring IPMI
.....................................................................
The Intelligent Platform Management Interface (IPMI) is a computer interface specification for
autonomous computer subsystems. IPMI provides remote DSM access to users from different
locations. It allows a system administrator to monitor system health and manage computer
events from a remote location. IPMI is not supported by the DSM virtual appliance.
The IPMI Java console is recommended when setting a boot passphrase for the DSM.
Although not necessary for DSM maintenance and operation, some administrators may find the
IPMI features useful. See “IPMI” on page 139, for IPMI best practices in a DSM environment.
The DSM appliance has a dedicated IPMI Ethernet port that is pre-configured with the IP
address, 192.168.10.10. The DSM IPMI Ethernet port is separate from the other two DSM
Ethernet ports, see Figure 7: “IPMI Ethernet port” below.
Figure 7: IPMI Ethernet port
This section describes how to configure IPMI and access the IPMI management console.
IPMI Ports
To see which ports can be configured for IPMI on the V6000/V6100 DSM hardware appliance,
see Table 14, “IPMI Ports,” on page 170.
NOTE: If the HTTP and HTTPS ports are both enabled for IPMI, IPv6 will not work for HTTPS. The
workaround is to either disable HTTP or use IPv4 rather than IPv6.
4. Set the IPMI net mask using the command mask set <net mask>, type;
0013:ipmi$ mask set <net mask>
5. Enable the KVM port using the command port enable kvm. The KVM port is required for
remote Java console support. At the prompt, type;
0014:ipmi$ port enable kvm
6. Open a browser session and point the browser to the URL that contains the IPMI IP address you
just configured; https://<IPMI IP address>. You will see the IPMI login screen, see Figure 8 below.
The default login credentials are as follows; Username: ADMIN and password: ADMIN.
7. Navigate to Remote Control > Console Redirection and click Launch Console. Download and run
the resulting .jnlp file to open a Java console for your DSM. This Java console provides access
to the DSM CLI.
8. Log on to the CLI using the default CLI administrator credentials; Username; cliadmin, password:
cliadmin123. You will be prompted to change the CLI administrator password. After that you will
be prompted to change the IPMI GUI login password as well.
The new password must be at least 8 characters long, must contain at least one upper case
letter, one special character, and one number.
9. Configure the network settings, see “Configure network settings” on page 18 and then generate
the CSR, see.“Generate DSM Certificate Authority and create ACS” on page 25.
.....
This chapter describes how to set up a newly purchased or replacement Vormetric V6000 DSM
hardware appliance. At the end of this process, your DSM hardware appliance will be
connected to the network and ready to support protected hosts.
Figure 9: V6000 DSM hardware appliance
Front
Back
Overview
.....................................................................
As of DSM v6.0.3, the V6000 and virtual appliances can be network HSM-enabled by
connecting them to an nShield Connect HSMs. This feature enables the DSM appliance to
utilize an nShield Connect HSM to create and protect the DSM master key. For more about this
feature see, “nShield Connect Integration” below.
The DSM appliance eth0 interface is now DHCP-enabled by default. This section describes
how to configure the DSM appliance with DHCP enabled. You must have a DHCP Server
properly configured to ensure that the DSM appliance gets the correct IP address.
DHCP support is available for all the DSM interfaces; eth0 (enabled by default), eth1, and
bond0. The DSM DHCP implementation configures the interface IP address, subnet mask,
router (default gateway), DNS server, and the search domain. It does not configure a host
name, an NTP server, or Time Zone for the DSM appliance, these have to be manually
configured via the CLI. You can choose to turn off dynamic IP addressing and use static IP
addressing instead, see “Configuring the DSM via Static IP Addressing”. DHCP is managed via
the CLI, the DHCP CLI commands are available in the Network category of commands and are
described in detail in the DSM Administrators Guide.
After accepting the license agreement and changing the CLI administrators password, you need
to set the host name and configure an NTP server. The steps are as follows:
• Assemble configuration information using the “DSM Installation Checklist”.
• “Specify host name resolution method”, if required
• “Configure DSM ports”, if applicable
• “Configure the hostname”
• “Configure NTP, time zone, date, time”
• “Enable DHCP on bond0 interface” if you choose to use this feature
• “Generate the DSM Certificate Authority” after you configure the hostname and NTP server
• Open a browser, after generating the CA, to access the DSM Management Console see, “Verify
web access”
• “Upload a license file”
If you do not want to want to use DHCP, it can be turned off via the CLI and you can assign a
static IP addresses to the DSM interfaces. The DHCP CLI commands are available in the Network
category commands sub-menu and are described in detail in the CLI chapter of the DSM
Administrators Guide.
To turn off DHCP do the following and then proceed with the configuration as described in the
sections below:
Log on to the CLI console with the CLI administrator credentials and enter the Network
category of commands, and turn off DHCP on the eth0 interface;
$ network
0001:network$ ip dhcp release <interface> version 4
Example
$ network
0001:network$ ip dhcp release eth0 version 4
System Response
WARNING: Changing network ip address may disconnect your session and will
require the server software to be restarted.
Continue? (yes|no)[no]:yes
DHCP operations may take some time, please wait....
SUCCESS: Please restart server software to pick up the changes.
0002:network$
After you release DHCP on an interface, all network configuration information is lost, you need
to configure the gateway, and DNS information again. Do the following to configure the
appliance with static IP addressing:
• “Specify host name resolution method”, if required
• “Configure DSM ports”, if applicable
• “Configure network settings”
• “Configure a bonded NIC device”, if you choose to use this feature
• “Configure NTP, time zone, date, time”
• “Configure the hostname”
• “Generate the DSM Certificate Authority”
• Open a browser, after generating the CA, to access the DSM Management Console see,“Verify
web access”
• “Upload a license file”
Assumptions
• Data center conditions meet the appliance racking, networking, and power requirements.
• The IP address, routing configuration and DNS addresses for the DSM allow connectivity to all
servers where Vormetric Encryption Agents are installed.
• The IP address, routing configuration and DNS addresses for the DSM allow connectivity to all
servers where Vormetric Encryption Agents are installed.
Use this table to collect the information you need for the installation.
Table 3: Installation Checklist
REQUIREMENT VALUE
Software requirements
Hardware Requirements
Network Information
Certificate Information
a. DSM DHCP support enables configuration of the appliance IP address, net mask, gateway, and search domain. It does not configure an
appliance host name, or an NTP server
Pre-configuration tasks
You must do one of the following on each DSM, since entries in the host file are not
replicated across DSMs.
• Modify the host file on the protected hosts: Enter the DSM host names and matching IP
addresses in the /etc/hosts file on the protected host. You must do this on EACH protected
host making sure to add an entry for all DSM nodes (if using HA).
• Use IP addresses: You may use IP addresses or the FQDN to identify the host
simultaneously. In other words, they don't all have to use an IP address or FQDN.
Configuration Tasks
0001:dsm$ main
0038:maintenance$ ?
showver Show the installed VTS version
ntpdate Set ntp services
date Set system date
time Set system time
gmttimezone Set system time zone
diag OS diagnostics
up Return to previous menu
exit Exit
Every command has usage and example input. Type the command without a value:
0039:maintenance$ ntpdate
usage: ntpdate {sync | add SERVER_ADDRESS | delete SERVER_ADDRESS | on |
off | show }
0040:maintenance$ date
month=Mar day=17 year=2015
Show system date SUCCESS
0041:maintenance$ time
hour=11 min=11 sec=36 zone=PDT
Show system time SUCCESS
0042:maintenance$ gmttimezone
usage: gmttimezone {list|show|set ZONE_NAME}
0043:maintenance$ diag
usage: diag [log [ list | view LOG_FILE_NAME] | vmstat | diskusage |
hardware | osversion | uptime ]
0044:maintenance$
You must enter the submenu to execute the submenu commands. For example, the
reboot command is in the system submenu, so you would enter system, then
enter reboot. To return to the main level when finished, enter up.
A complete description of the DSM CLI commands can be found in the Administrators Guide.
2. Manually set the IP address for the laptop to 192.168.10.2 (or higher) with a default mask of
255.255.255.0
3. SSH to 192.168.10.1
4. Log in with the default login and password:
Login: cliadmin
Password: cliadmin123
5. The Vormetric license agreement is displayed, type ‘y’ to accept and press Enter.
6. When prompted, type in a new password and press Enter. Reconfirm your password.
NOTE: The eth0 interface DHCP enabled by default. See “Configuring the DSM via DHCP” for
details, and for instructions to switch to static addressing if desired.
We recommend that you retain the default eth1 IP address configuration in the event that you
need a recovery option to access the DSM appliance.
Type:
0002:network$ ip address init <DSM IP address>/<subnet mask (e.g. 16 or
24)> dev eth0/eth1
Example
0002:network$ ip address init 192.168.10.2/16 dev eth1
IPv6 example: ip address init fa01::3:15:130/64 dev eth1
NOTE: If you are connected via ETH0, you will be disconnected at this step. Reconnect on the
new IP address.
9. (Optional) If you have configured ETH0, you can also configure an IP address for ETH1 if you want
to communicate with agents on a different subnet for example, or if you want to access the
Management Console from a different subnet. To configure an IP address for ETH1, type:
0002:network$ ip address init <eth1 IP address>/<subnet mask (e.g., 16
or 24)> dev eth1
Example:
0002:network$ ip address init 192.168.10.3/16 dev eth1
IPv6 example:
0003:network$ ip address init fa01::3:15:130/64 dev eth1
The following warning is displayed:
WARNING: Changing the network ip address requires server software to be
restarted.
Continue? (yes|no) [no]:
Type yes to continue with the IP address configuration.
10. Add the IP address for the default gateway. Type:
0004:network$ ip route add default table main.table dev [eth0 or eth1]
via <IP address for the default gateway>
Example
0005:network$ ip route add default table main.table dev eth0 via
192.168.1.5
IPv6 example:
0006:network$ ip route default table main.table dev eth0 via
fa01::3:15:120
11. Verify the interface settings. Type:
0006:network$ ip address show
13. If you are using DNS, set the primary DNS server for the DSM. Type:
0008:network$ dns dns1 <ip address for dns server 1>
14. If you have a second or third DNS server, set them for the DSM. Type:
0009:network$ dns dns2 <ip address for dns server 2>
NOTE: In order to use the bonded NICs feature, you must ensure that your switch is configured
to use Link Aggregation Control Protocol (LACP).
The DSM physical appliances have two physical NICs called eth0 and eth1. Only two NICs
eth0 and eth1 are supported. Any additional physical/virtual NICs are ignored.
The NIC bonding setting is system specific. If it is to be used for all nodes in a cluster, it must be
enabled in all nodes individually.
1. Access the DSM CLI and login with your login credentials. If this is the first time you are logging
in, then you will be required to accept the license agreement and change the default password.
2. Navigate to the network commands menu;
0001:dsm$ network
3. Enable the bonded NIC, type:
0002:network$ ip address init <ip_address>/<subnet_mask> dev bond0
Example: ip address init 1.2.3.4/16 dev bond0
In the event that a bonded NIC is being configured after the initial configuration, or after the
DSM has been upgraded, if you want to reuse an IP address that was originally assigned to
eth0 or eth1, then you must delete that address from eth0 or eth1 first, and then reassign it
to the bond0 device.
4. Add a default gateway for the bond0 device;
0001: ip route add default table main.table dev bond0 via
<gateway_ip_address>
Example: ip route add default table main.table dev bond0 via 1.2.7.8
If a bond0 interface is configured after setting up the eth0 and/or eth1 interfaces, and it is
configured with an IP address that is on the same subnet as a default gateway, that gateway
configuration continues to apply. However, if you configure bond0 with an IP address on a
different subnet, you will have to reconfigure the default gateway.
1. You can change the bonding driver mode based on your requirements. There are seven modes
available from 0-6. See “Bonding driver modes” for more information. Note however, that only
the default options are available with each of the modes and these options cannot be changed.
When the mode option is specified the speed option cannot be specified (i.e. the options mode
and speed are mutually exclusive). In other words, bond0 does not take the speed option and
both eth0 and eth1 don't take the mode option. However, the MTU and up/down options can
still be used for the bond0 device.
or
0003:network$ ip address flush bond0
Routes that are associated with this bonded NIC device will also be deleted.
Bonding driver modes
The modes specify the bonding policies. The following modes are supported (seeTable 15,
“Bonding Driver Modes,” on page 171 below), but none of the options for the modes are
configurable and take the default values for those modes, except for the miimon setting. The
miimon setting specifies the MII link monitoring frequency in milliseconds, which determines
how often the link state of each slave is inspected for link failures. The miimon setting has a
value of 100 instead of the default value of 0.
• To see the supported Bonding driver modes, see Table 15, “Bonding Driver Modes,” on
page 171.
6. Set the country and city where the DSM resides. Type:
gmttimezone set <country/city>
7. Set the date. (If you used ntpdate synch, this step is not necessary.) Type:
date <mm/dd/yyyy>
8. Set the time. (If you used ntpdate synch, this step is not necessary.) Type:
time <hh:mm:ss>
Where hh is 00 to 23.
9. Verify your settings. Type:
time
date
Example:
0003:system& setinfo hostname dsm.company.com
NOTE: The default host name in the output is your. name.here. Also, it must be lowercase.
2. A warning is displayed, informing you that all agents and peer node certificates will need to be
re-signed after the CA and server certificate have been regenerated, and the DSM server
software will be restarted. Type ‘yes’ to continue, the default is ‘no’.
3. Enter the FQDN of this DSM, the name displayed in ‘This Security Server host name [FQDN of the
DSM], should be correct, if you entered the host name information in the previous sections
correctly. Press Enter to accept the name.
4. Next, enter the information required to generate the certificate. Answer the prompts:
a. What is the name of your organizational unit? []:
b. What is the name of your organization? []:
c. What is the name of your City or Locality? []:
d. What is the name of your State or Province? []:
e. What is your two-letter country code? [US]:
5. Once the certificate is signed, return to the main menu. Type:
up
Deployment
The figure below shows an example of a network HSM-enabled DSM HA cluster deployment.
The DSM could be virtual appliances on-premise or in the cloud, or V6000 appliances on-
premise. The nShield Connect HSMs are clustered for fault tolerance—if one of them fails, the
Security World is still available to the DSMs via the failover Connect appliance.
The nShield Connect HSMs use the Security World paradigm to provide a secure environment
for all HSM and key management operations. The nShield Connect HSM has its own Security
World, and the DSM (or DSM high availability cluster) joins that Security World. For more about
the Security World paradigm, see, “Security World” on page 7.
When a DSM appliance joins the nShield Connect HSM Security World, that DSM appliance is
network HSM-enabled and functions similarly to a V6100 appliance—with important
differences in how backups are restored, see “Backing up and Restoring network HSM-enabled
DSM”.
New CLI commands have been added to the HSM category of commands to enable and manage
this feature. Refer to the CLI chapter of the DSM Administrators Guide for a detailed description
of the new commands.
High Availability
A DSM high availability (HA) cluster must consist of homogeneous appliance types. For
example, if you plan to create an HA cluster for a network HSM-enabled DSM, then all nodes in
the cluster must be network HSM-enabled appliances. As this feature is supported on both
V6000 and virtual DSMs, an HA cluster for a network HSM-enabled DSM may consist of both
V6000 and virtual DSMs, as long as they are all network HSM-enabled.
Network HSM-enabled DSMs cannot be clustered with V6100 appliances—the V6100 creates
its own Security World, whereas a network HSM-enabled DSM belongs to the nShield Connect
Security World, and since all nodes in a cluster have to belong to the same Security World, the
V6100 and network HSM-enabled DSM appliances cannot be combined.
When creating a cluster, Thales recommends that you configure at least two or more nShield
Connect HSMs for fault tolerance. Refer to the nShield Connect HSM documentation for
information about configuring additional nShield Connect HSMs.
Each DSM node in a network HSM-enabled DSM cluster can be configured with one or more
nShield Connect HSMs for fault tolerance, provided they all belong to the same Security World.
See “Configuring High Availability for network HSM-enabled DSM” for more about network
HSM-enabled DSM high availability clusters.
• DSM V6000 or virtual appliances with 6.0.3 or higher, of the DSM firmware. This feature is
only supported on v6.0.3 or higher of the DSM firmware, you must upgrade your system to
this version to enable this feature. See the “Upgrade and Migration” on page 97 for details
about upgrading your system.
• At least one nShield Connect HSM and its corresponding remote file system (RFS) deployed on
the network. The nShield HSM must belong to a Security World. If there are more than one
nShield Connect HSMs in the deployment, they must all belong to the same Security World for
the DSM to connect to them. Thales recommends that you add another nShield Connect HSM
to the Security World for fault tolerance.
NOTE: Client licenses are required for each nShield Connect HSM that is configured for the
DSMs—the number of client licenses required per nShield Connect HSM is equal to the number
of DSMs used.
• The nShield Connect HSM used to enable this feature can be either of the following; nShield
Connect+, or nShield Connect XC. For more information about configuring the nShield
Connect HSM and RFS, refer to the relevant nShield Connect HSM user documentation.
• Port 9004 must be opened on the network path between the DSMs and the nShield Connect
HSM(s) to enable communication between the DSMs, the nShield Connect HSM(s) and its
associated RFS.
NOTE: If the nShield Connect Security World is FIPS 140-2 level 3 compliant, only one card from
the associated ACS is required for this step. The card is only required for the first HSM device to
be added to the DSM, it is not required for any subsequent nShield Connect HSMs that are
added.
1. Navigate to the HSM category of commands, type the following at the prompt:
0000:dsm$ hsm
0001:hsm$
2. Use the connect add command to add the nShield Connect HSM to the DSM. Type the following
command at the prompt,
0001:hsm$ connect add <nShield_Connect_IP_Address>
<RFS_IP_Address>
where,
<nShield_Connect_IP_Address> is the IP address of the nShield Connect HSM and
<RFS_IP_Address> is the IP address of the computer that has the RFS installed.
For example,
0001: hsm$ connect add 1.2.3.18 1.2.3.4
3. A warning displays, informing you that once this DSM is converted to a network HSM-enabled
appliance, it cannot be rolled back. Type ‘yes’ to continue.
The DSM is restarted if the operation is successful.
4. Follow the prompts to add the nShield Connect HSM to the DSM.
5. To view the nShield Connect HSM that has been added run the connect show command.
6. If there are more nShield HSMs in the same Security World you can add them now using the
connect add command.
7. The About page of the DSM Web UI also displays the nShield Connect HSMs that have been
configured.
Figure 12: Configured HSM devices on DSM Web UI About page
When configuring high availability (HA) for network HSM-enabled DSMs, Thales recommends
the following:
• Configure at least two nShield Connect HSMs in the Security World for fault tolerance. This
means in the event one of the appliances is not reachable for some reason, the Security World
is still available.
NOTE: Client licenses will be required for each nShield Connect appliance that is configured for
the DSMs—the number of client licenses required per Connect appliance will be equal to the
number of DSMs connected to the nShield appliance.
• Each network HSM-enabled DSM node in the HA cluster must be connected to at least two of
the nShield Connect HSMs in the Security World. This ensures that if one of the nShield
Connect is not reachable for some reason, the DSM nodes can still access the Security World
of via the second nShield Connect.
A network HSM-enabled DSM HA cluster can be configured in one of two ways:
The first way is to configure DSMs as standalone nodes and enable network HSMs for each of
them in the same Security World. That is, all the DSMs must be configured with nShield
Connect HSM(s) that are part of the same Security World. You can now create a network HSM-
enabled DSM cluster in the same way as for any other DSM cluster
The high-level steps for to configure a network HSM-enabled DSM HA cluster in this way are:
1. Configure two nShield Connect HSMs and the associated RFS.
2. Configure the DSMs that are to be part of the HA cluster.
3. Add the DSMs individually to the nShield Connect Security World to make each DSM network
HSM-enabled. This means you must run the connect add command on each of the DSMs to add
them to that Security World.
4. Add both nShield Connect HSMs to each of the DSMs.
Steps 1 to 4 are described here “Configuring nShield Connect HSM with DSM”, do this for each
DSM server that is to be part of the HA cluster.
5. Configure HA per the standard procedure described here, “Configuring HA for V6000 and Virtual
Appliances” on page 144.
0001:hsm$
0001:hdm$ connect add
3. To view the available nShield Connect appliances, type the following at the prompt:
4. 0002:hsm$ connect show
5. If you want to remove the existing nShield Connect, type the following at the prompt:
0003:hsm$ connect delete
A network HSM-enabled DSM is backed up in the same way as any other DSM appliance. You
should also take a backup of the RFS when you backup the DSM and keep the two backup files
together. The RFS backup is done separately as part of the nShield Connect administration,
refer to the nShield Connect user documentation for details and procedures.
If the backup is to be restored to the same DSM appliance, then the nShield RFS backup is not
required.
If the backup is to be restored on a another network HSM-enabled DSM in another Security
World, you will need to restore the RFS first and then the DSM backup. The associated ACS will
also be required.
The high-level steps to backup a network HSM-enabled DSM and restore the backup to another
DSM in another Security World are as follows:
1. Backup the network HSM-enabled DSM. The backup procedure for a network HSM-enabled DSM
or cluster is the same as for any other DSM deployment. Refer to the DSM Administrators Guide
chapter, “Backing Up and Restoring the DSM”.
2. Backup the nShield Connect RFS. Refer to the nShield user documentation for the procedure.
3. Restore the Security World data on the nShield Connect device connected to the new network
HSM-enabled DSM that belongs to another Security World.
4. Run the connect secworldupdate command on the DSM to update the Security World.
5. Restore the network HSM-enabled DSM backup. The restore procedure for a network HSM-
enabled DSM or cluster is the same as for any other DSM deployment. Refer to the DSM
Administrators Guide chapter, “Backing Up and Restoring the DSM”.
A backup of a network HSM-enabled DSM can be restored as follows:
• On the same DSM appliance
• On another DSM appliance in the same Security World
• On a DSM V6100 appliance—to restore a network HSM-enabled DSM backup to a
V6100appliance, ACS of the nShield Connect device that was configured with the network
HSM-enabled DSM is required. Refer to the DSM Administrators Guide chapter, “Backing Up
and Restoring the DSM” for a detailed description of the procedure.
Additionally, you can restore the following types of backups to a network HSM-enabled DSM:
• A backup of a non-HSM DSM (V6000 or virtual DSM)
Domain level backups can be restored as follows:
• A domain backup from a network HSM-enabled DSM to a domain on a non network HSM-
enabled DSM (V6000 or virtual appliance) and vice versa
• A domain backup from a network HSM-enabled DSM to a domain on a V6100 appliance and
vice versa
In the event that the nShield Connect Security World changes, the network HSM-enabled
DSM’s Security World must be synchronized with the new one. A Security World change may be
triggered for various reasons, for example the ACS has been replaced.
To update the Security World on the network HSM-enabled DSM:
1. Open a CLI session on the DSM, if this is a high availability cluster, do this on all the nodes in the
cluster.
2. Navigate to the HSM submenu:
0000:dsm$ hsm
0001:hsm$
3. Type the following at the prompt:
0001:hsm$ secworldupdate
SUCCESS: Security World data on this DSM node updated
0002:hsm$
You can view the DSM audit logs, accessed via Log >Logs from the DSM Web UI, to see the
Security World update event.
.....
The DSM virtual appliance is available as an OVA file, Azure VHD, AWS AMI, and KVM image.
The OVA is available as a standard image, and a fastboot image with Open VM Tools (OVT) bun-
dled in for Cloud Service Providers. OVT is the open source implementation of VMware Tools,
and consists of a suite of virtualization utilities that improves the functionality, administration,
and management of virtual machines within a VMware environment.
This section describes how to deploy the various virtual images.
This chapter contains the following sections:
• “Overview” on page 63
• “Configuring a Virtual Appliance” on page 65
• “Full Disk Encryption” on page 81
• “nShield Connect Integration” on page 81
• “DSM Installation on bare metal using IBM SoftLayer” on page 81
• “DSM Installation on Hyper-V” on page 84
• “Deploying a DSM Azure Image” on page 86
• “Deploying a DSM AWS image” on page 90
• “KVM Deployment” on page 92
• “Deploying on a Xen Hypervisor” on page 94
• “High Availability (HA) Configuration for Virtual Appliances” on page 95
Overview
.....................................................................
DSM supports full disk encryption for enhanced security, and dynamic IP addressing via DHCP.
The full disk encryption feature is only available on a fresh installation of v6.0.2 or later.
DHCP is enabled by default on the eth0 interface on a fresh v6.0.2 and above installation but,
must be enabled manually, if a DSM appliance is upgraded to v6.0.2 and later versions. See
“Upgrading the DSM” on page 99 for details about upgrading the DSM appliance.
As of this release, DSM v6.1, the V6000 and virtual appliances can be HSM-enabled by
connecting them to an nShield Connect appliance. The Network HSM support feature enables
DSMs that do not have a built-in hardware security module (HSM) —DSM V6000 hardware
appliance and the virtual appliance—to utilize an nShield Connect HSM appliance to store the
DSM master key. See “nShield Connect Integration” on page 54 in Chapter 3, for details about
this feature. The appliance can be HSM-enabled after it has been configured.
After enabling the HSM, you will have the DSM virtual appliance setup as shown in Figure 13.
Figure 13: Virtual DSM Architecture
Assumptions
Number of Agents
Number of CPUs 2 4 4 6
a. The disk size change was introduced in v5.3.1, however you can still use “thin” provision to minimize
storage utilization.
The DSM eth0 interface is now DHCP-enabled by default. This section describes how to
configure the DSM appliance with DHCP enabled. You must have a DHCP Server properly
configured to ensure that the DSM appliance gets the correct IP address.
DHCP support is available for all the DSM interfaces; eth0 (enabled by default), eth1, and
bond0. The DSM DHCP implementation configures the interface IP address, subnet mask,
router (default gateway), DNS server, and the search domain. It does not configure a host
name, an NTP server, or Time Zone for the DSM appliance, these have to be manually
configured via the CLI. You can choose to turn off dynamic IP addressing and use static IP
addressing instead, see “Configuring DSM using Static IP Addressing”. DHCP is managed via the
CLI, the DHCP CLI commands are available in the Network category of commands and are
described in detail in the DSM Administrators Guide.
After accepting the license agreement and changing the CLI administrators password, you need
to set the host name and configure an NTP server. The steps are as follows:
1. Assemble configuration information using the “Virtual DSM Installation Checklist”.
2. Set up the virtual appliance, see “Virtual Appliance Setup”
3. “Specify host name resolution method”
4. “Configure Ports”, if applicable
5. “Configure NTP, time zone, date, time”
If you do not want to want to use DHCP, it can be turned off via the CLI and you can assign a
static IP addresses to the DSM interfaces. The DHCP CLI commands are available in the Network
category commands sub-menu and are described in detail in the CLI chapter of the DSM
Administrators Guide.
To turn off DHCP do the following and then proceed with the configuration as described in the
sections below:
Log on to the CLI console with the CLI administrator credentials and enter the Network
category of commands, and turn off DHCP on the eth0 interface;
$ network
0001:network$ ip dhcp release <interface> version 4
Example
$ network
0001:network$ ip dhcp release eth0 version 4
WARNING: Changing network ip address may disconnect your session and will
require the server software to be restarted.
Continue? (yes|no)[no]:yes
DHCP operations may take some time, please wait....
SUCCESS: Please restart server software to pick up the changes.
0002:network$
After you release DHCP on an interface, all network configuration information is lost, you need
to configure the gateway, and DNS information again. Do the following to configure the
appliance with static IP addressing:
1. Assemble configuration information using the “Virtual DSM Installation Checklist”.
2. Setup the virtual appliance, see “Virtual Appliance Setup”
3. “Specify host name resolution method”
4. “Configure Ports”, if applicable
5. “Configure network settings”
6. “Configure a bonded NIC device”, if you choose to use this feature
7. “Configure NTP, time zone, date, time”
Use this table to collect the information you need for the installation.
Table 5: Installation Checklist
REQUIREMENT VALUE
Software Requirements
OVA, ISO, KVM image depending on requirement
Refer to “Assumptions” for details
Virtualization software
Network Information
Certificate Information
Pre-Configuration tasks
This section details the installation and pre-configuration tasks required for DSM. It consists of
the following tasks:
• “Specify host name resolution method” on page 68
• “Configure Ports” on page 69
• “Access the Command Line Interface (CLI)” on page 69
• If you do NOT use a DNS server to resolve host names, do the following on all of the DSMs and
all of the protected hosts:
• Modify the host file on the DSM: To use names like serverx.domain.com, enter the host
names and matching IP addresses in the /etc/hosts file using the host command under the
network menu. For example:
0011:network$ host add <hostname> 192.168.1.1
SUCCESS: add host
0012:network$ host show
name=localhost1.localdomain1 ip=::1
name=<host name>.<domain name>.com ip=192.168.10.8
name=<host name> ip=192.168.1.1
SUCCESS: show host
You must do one of the following on each DSM, since entries in the host file are not
replicated across DSMs.
• Modify the host file on the protected hosts: Enter the DSM host names and matching IP
addresses in the /etc/hosts file on the protected host. You must do this on EACH protected
host making sure to add an entry for all DSM nodes (if using HA).
• Use IP addresses: You may use IP addresses or the FQDN to identify the host
simultaneously. In other words, they don't all have to use an IP address or FQDN.
Configure Ports
If a DSM must communicate with a device behind a firewall, you must open various ports in the
firewall as shown in the following figures.
• To see the ports to configure, see Table 13, “Ports to Configure,” on page 169
0001:vormetric$ main
0038:maintenance$ ?
showver Show the installed VTS version
ntpdate Set ntp services
date Set system date
time Set system time
gmttimezone Set system time zone
diag OS diagnostics
up Return to previous menu
exit Exit
Every command has usage and example input. Type the command without a value:
0039:maintenance$ ntpdate
usage: ntpdate {sync | add SERVER_ADDRESS | delete SERVER_ADDRESS | on |
off | show }
0040:maintenance$ date
month=Mar day=17 year=2015
Show system date SUCCESS
0041:maintenance$ time
hour=11 min=11 sec=36 zone=PDT
Show system time SUCCESS
0042:maintenance$ gmttimezone
usage: gmttimezone {list|show|set ZONE_NAME}
0043:maintenance$ diag
usage: diag [log [ list | view LOG_FILE_NAME] | vmstat | diskusage |
hardware | osversion | uptime ]
You must enter the submenu to execute the submenu commands. For example, the reboot
command is in the system submenu, so you would enter system, then enter reboot. To return
to the main level when finished, enter up.
A complete description of the DSM CLI commands can be found in the Administrators Guide.
NOTE: The DSM virtual appliance OVA file hardware version has been upgraded to version 9.
The version 9 hardware is supported on ESXi version 5.5 or later.
The installation procedure for the fastboot DSM virtual appliance and the fastboot DSM virtual
appliance for CSPs, is the same as the standard DSM virtual appliance. See “Disk Re-encryption
for DSM Fastboot Image” for a description of further configuration requirements for the
fastboot image.
Warning! All systems created from a fastboot OVA template utilize the same master
key for their encrypted disks. This is a security issue, as anyone with access to the
OVA could potentially decrypt the disk for any system created from that OVA
template. You will be prompted to re-encrypt the disk when the virtual DSM comes
up after deployment, we recommend that you continue with this procedure in the
interests of security. See “Disk Re-encryption for DSM Fastboot Image” for details.
10. At the message Completed Successfully, click Close. The main screen of the vSphere Client
appears.
11. If you haven’t chosen to power on the virtual DSM (see step 7 above) after deploying the
template, then in the left pane, select the Virtual Appliance you just created, and click the green
Power On icon in the tool bar, or right-click the VM and select Power > Power On.
NOTE: It takes about a half hour to provision the VM and build the DSM.
12. To watch the output as the installation progresses, click the Console tab and click inside the
console window.
The DSM eth0 interface is DHCP enabled by default. For DHCP to work properly you must have
a DHCP Server configured to ensure that the DSM gets the correct IP address and other
configuration information. However, you will still need to configure the hostname and an NTP
server or time zone for the virtual appliance see the following sections; “Configure the
hostname” and “Configure NTP, time zone, date, time” for a detailed description of the
procedures.
If you want to use static IP addressing for the virtual DSM, see “Configuring DSM using Static IP
Addressing”.
1. Once the virtual DSM has been created from the fastboot OVA template, you will be prompted to
log into the virtual appliance. As this is the first log in, use the default log in credentials:
Login: cliadmin
Password: cliadmin123
4. The license agreement is displayed, type ‘y’ to accept and press ‘Enter’.
5. When prompted, type in a new password and press ‘Enter’.
The DSM root filesystem is encrypted for enhanced security. A DSM System administrator can
set a passphrase at boot time to unlock the system.
NOTE: Setting a boot passphrase is not required. Users who prefer an unattended boot, can
continue to use the DSM without a passphrase. However in the interest of better security, we
recommend that you set a boot passphrase. See “Set boot passphrase” on page 30 for details.
2. The license agreement is displayed, type ‘y’ to accept and press Enter.
3. When prompted, type in a new password and press Enter. Reconfirm your password.
NOTE: The eth0 interface is DHCP enabled by default. See “Configuring DSM using DHCP” for
more information, and for instructions on how to switch to static addressing if desired.
We recommend that you retain the default eth1 IP address configuration in the event that you
need a recovery option to access the DSM.
Type:
0001:network$ ip address init <DSM IP address>/<subnet mask (e.g. 16 or
24)> dev eth0/eth1
NOTE: If you are connected via eth0, you will be disconnected at this step. Reconnect on the
new IP address.
6. (Optional) If you have configured eth0, you can also configure an IP address for eth1 if you
want to communicate with agents on a different subnet for example, or if you want to access the
Management Console from a different subnet. To configure an IP address for eth1, type:
0001:network$ ip address init <eth1 IP address>/<subnet mask (e.g., 16 or
24)> dev eth1
IPv6 Example: ip route default table main.table dev eth0 via fa01::3:15:120
8. Verify interface settings, type:
ip address show
10. If you are using DNS, set the primary DNS server for the DSM. Type:
dns dns1 <ip address for dns server 1>
11. If you have a second or third DNS server, set them for the DSM. Type:
dns dns2 <ip address for dns server 2>
NOTE: In order to use the bonded NICs feature, you must ensure that your switch is configured
to use Link Aggregation Control Protocol (LACP).
The DSM physical appliances have two physical NICs called eth0 and eth1. Only two NICs
eth0 and eth1 are supported. If using a virtual appliance, you must configure at least two
NICs and define them as eth0 and eth1 in order to enable the bond0 device type. Any
additional physical/virtual NICs are ignored. For virtual DSMs where only one network
connector is configured for a virtual machine, the bond0 interface cannot be enabled—the
network interface itself can be up but, no IP address can be assigned to it.
The NIC bonding setting is system specific. If it is to be used for all nodes in a cluster, it must be
enabled in all nodes individually.
1. Access the DSM CLI and login with your login credentials. If this is the first time you are logging
in, then you will be required to accept the license agreement and change the default password.
2. Navigate to the network commands menu;
$ network
0001:network$
3. Enable the bonded NIC;
0001:network$ ip address init <ip_address>/<subnet_mask> dev bond0
Example: ip route add default table main.table dev bond0 via 1.2.7.8
If a bond0 interface is configured after setting up the eth0 and/or eth1 interfaces, and it is
configured with an IP address that is on the same subnet as a default gateway, that gateway
configuration continues to apply. However, if you configure bond0 with an IP address on a
different subnet, you will have to reconfigure the default gateway.
5. You can change the bonding driver mode based on your requirements. There are seven modes
available from 0-6. See “Bonding driver modes” for more information. Note however, that only
the default options are available with each of the modes and these options cannot be changed.
When the mode option is specified the speed option cannot be specified (i.e. the options mode
and speed are mutually exclusive). In other words, bond0 does not take the speed option and
both eth0 and eth1 don't take the mode option. However, the MTU and up/down options can
still be used for the bond0 device.
To set or change the mode type:
0002:network$ ip link set bond0 mode <mode>
Example: ip link set bond0 mode 2
To see what mode is currently in use type:
0002: network$ ip link show bond0
6. To disable or break up a bonded NIC type, you can use either the delete or flush command.
Delete will only delete a specific IP address (multiple can be assigned) and flush will clear all
assigned IP addresses.
0003:network$ ip address delete <ip_address>/<subnet_mask> dev bond0
or
0003:network$ ip address flush bond0
Routes that are associated with this bonded NIC device will also be deleted.
Bonding driver modes
The modes specify the bonding policies. The following modes are supported (see Table below),
but none of the options for the modes are configurable and take the default values for those
modes, except for the miimon setting. The miimon setting specifies the MII link monitoring
frequency in milliseconds, which determines how often the link state of each slave is inspected
for link failures. The miimon setting has a value of 100 instead of the default value of 0.
• To see the supported Bonding driver modes, see Table 15, “Bonding Driver Modes,” on
page 171.
6. Set the country and city where the DSM resides. Type
gmttimezone set <country/city>
7. Set the date. (If you used ntpdate synch, this step is not necessary.) Type
date <mm/dd/yyyy>
8. Set the time. (If you used ntpdate synch, this step is not necessary.) Type
time <hh:mm:ss>
Where hh is 00 to 23.
9. Verify your settings. Type
time
date
3 Set the hostname. You must enter the fully qualified domain name for the DSM. Type:
0003:system$ setinfo hostname <FQHN>
Example:
0003:system& setinfo hostname dsm.company.com
2. A warning is displayed, informing you that all agents and peer node certificates will need to be
re-signed after the CA and server certificate have been regenerated, and the DSM server
software will be restarted. Type ‘yes’ to continue, the default is ‘no’.
3. Enter the FQDN of this DSM, the name displayed in ‘This Security Server host name [FQDN of the
DSM]’, should be correct if you entered the host name information in the previous sections
correctly. Press Enter to accept the name.
4. Next, enter the information required to generate the certificate. Answer the prompts:
a. What is the name of your organizational unit? []:
b. What is the name of your organization? []:
c. What is the name of your City or Locality? []:
d. What is the name of your State or Province? []:
e. What is your two-letter country code? [US]:
5. Once the certificate is signed, return to the main menu. Type
up
This process assumes that you have a SoftLayer account with SoftLayer NAS storage, and have
set up your bare metal system.
1. Enable SoftLayer VPN access using SSL.
Open a local secure shell session (SSH) and connect to your bare metal system using the public IP
address and root password. The public IP address is available under the Configuration tab for
your device. The root user password is available under the Password tab. Use the secure copy
(scp) command to copy the DSM ISO image to your bare metal system.
2. Open an SSH, log into your bare metal system as root and follow the instructions to mount NAS
in SoftLayer.
3. Copy the DSM ISO image to the mounted NAS directory.
4. Log into the SoftLayer portal and enable VPN access and set your VPN password.
If you receive a message saying “cannot find kickstart file”, type cdrom1 at the boot prompt
when you see the Thales banner. The installation will proceed as normal.
As of v6.0.2 the DSM eth0 interface has DHCP enabled by default. If you have a DHCP server
configured, your virtual appliance will obtain an IP address from that server. See “Configuring
DSM using DHCP”, for more information about DHCP for DSM. If you want to assign a static IP
address to your virtual DSM device, see “Configuring DSM using Static IP Addressing”, for how
to disable DHCP. Follow the procedure below to assign a static IP address for your virtual DSM
device.
1. Gather the required system information from the Device menu option. You need the following
information for network port 0 (private network) and port 1 (public network):
• Hostname
• IP address
• Subnet mask
• Gateway address
Once you have this information, you need to log into the DSM CLI to configure the virtual device.
2. Open an SSH and log into the CLI via the public IP address of your bare metal system using
cliadmin as the user name. For example: ssh cliadmin@<public IP address>
The default cliadmin user password is cliadmin123. You will be prompted to change the default
password.
Type network at the prompt to enter the network category command menu and follow the steps
below. Note that the IP addresses are used as examples:
• Delete the default IP Address, type:
0001:vormetric$ network
0002:network$ ip address delete 192.168.10.1/16 dev eth0
• Add private IP Address, type:
0002:network$ ip address add 10.114.160.214/26 dev eth0
• Add public IP Address, type:
0002:network$ ip address add 169.53.182.122/28 dev eth1
• Add default public gateway, type:
0002:network$ ip route add default table main.table via 169.53.182.113
• Add default private gateway, type:
0002:network$ ip route add 10.0.0.0/8 table main.table via
10.114.160.193
• Clear DNS, type:
NOTE: SoftLayer does not allow reverse lookup of hostname in Softlayer unless you have your
domain name. If you want to use DNS for name resolution in Softlayer, you can either register
your own domain or setup a DNS server within Softlayer.
See“Generate the Certificate Authority” on page 79, to complete the DSM configuration.
4. On the Specify Name and Location page, specify the name of the virtual machine and where you
want to store it.
5. On the Generation for the Machine page, select “Generation 1” for the virtual machine.
6. On the Memory page, specify a minimum of 4GB memory to run the guest operating system for
the virtual machine.
We recommend that you disable the Use Dynamic Memory for this virtual machine option,
which is enabled by default. This is to prevent memory over commits.
7. On the Networking page, connect the network adapter to an existing virtual switch to establish
network connectivity at this point. A second (optional) switch can be added later if desired.
If you want to use a remote image server to install an operating system on your test virtual
machine, select the external network.
8. On the Connect Virtual Hard Disk page, select Create a virtual hard disk. Specify a size for the
virtual hard disk based on the number of agents you plan to install.
Refer to Table 4, “Hardware requirements for Virtual Machine,” on page 64, for the virtual
machine hardware requirements.
9. On the Installation Options page, select the following option to install the operating system:
Install an operating system from a boot CD/DVD-ROM. Click Browse to navigate to the DSM ISO
file location and select the file. Click Next.
10. Review your selections and click Finish.
NOTE: Make sure the hard drive is set as first in the boot order, before you power on your
virtual machine.
11. Connect to the virtual machine console, and power on the machine to build the DSM.
NOTE: The installation takes approximately 30 minutes. It runs in the background. Once the
DSM is ready, you see a login prompt.
12. Once the DSM has been built, see “Configuring a Virtual Appliance” for details about how to
configure the DSM.
NOTE: Azure does not support Operations Management Suite (OMS). To avoid installation of
the OMS Agent, do not use any of the Azure platform monitoring services facilitated by the
OMS Agent.
Requirements
NOTE: For upgrades and fresh installations of DSM 6.2.0, if you are using HA, you must open
port 5432 in your firewall to allow communication between DSM HA nodes. For Azure and AWS
platforms, you will need to add this port to your security groups. You can now close port 50000
as it is no longer used.
Deployment Procedure
To ensure the proper deployment of a DSM Azure image, Thales recommends the configuration
parameters described below:
1. Log on to the Azure portal with your credentials.
2. From the Dashboard, click Create a Resource on the upper left corner of the Azure portal.
3. In the search field, type: Thales.
4. Select the latest version of Vormetric Data Security Manager from Thales eSecurity.
5. After reading the online material, click Create.
6. Enter the following details for the virtual machine:
• Virtual machine name.
• Select HDD as the VM disk type.
• In the User name field, type cliadmin. This is the default user available on the DSM during
initial start up.
• For Authentication Type, select Password. You cannot use this password when the DSM
initially launches. You will need to use the default user credentials to log on for the first time,
see “Virtual Appliance Configuration” for more information.
• For Subscription, Pay-As-You-Go is the default option.
• If you plan to create a new resource group, select Create New and enter a name for the group.
If you have an existing resource group that fits your requirements, select Use Existing and
select that group from the drop-down list. Refer to the Azure documentation for more
information about resource groups.
• Choose a location to host the virtual machine.
7. Click OK.
8. Select a size for the virtual machine. If you plan to use the DSM in a production environment,
refer to “Virtual machine hardware requirements” and select a size for your VM.
• Minimum requirements: 2 virtual CPUs, 8GB RAM and 250GB hard disk size
• Recommended size: 4 CPU/14GB RAM
9. In the Settings section, enter the following details:
• For High Availability, set to None.
• For Storage, click Yes for Use managed disks.
• For Network, if you selected an existing resource group, then the virtual network will be
selected by default from that resource group.
To create a new virtual network, click the arrow, enter a name and accept the default settings.
• Accept the default settings for Subnet.
• For Public IP address, select Assignment: Static.
• For Network security group, accept the default settings and enter a name for the group. You
can select an existing group if you know that it applies to your requirements.
• For Auto-shutdown, select Off.
• For Monitoring, in Boot diagnostics and Guest OS diagnostics, accept the default settings.
• For Diagnostics storage account, you can choose to create an account or select an existing
account if it fits your requirements.
• For managed Service identity, click Yes to control access to the storage account.
10. Click OK. Review the Summary and click Create to start the virtual machine deployment.
2. Click the name of the virtual DSM. A summary of the instance is displayed in the top panel.
3. Under DSN name , click Configure.
4. Enter a name for the host in the DNS name label field.
NOTE: Although this field is tagged optional, it is required for the virtual DSM to complete the
configuration.
5. Click Save.
Return to the Dashboard > Overview page. Under DNS name, you now see the FQDN for this
instance—the hostname and the complete domain hierarchy.
6. Copy the FQDN to a location that you can access from the DSM CLI.
7. SSH to the DSM CLI. The first time you log on to the DSM CLI, you must log in with the default
user name and password:
Login: cliadmin
Password: cliadmin123
8. A message asks "Do you want to re-encrypt the disk now? (yes|no)[no]:". Click yes if you plan to
use this disk for anything other than a quick evaluation.
9. Accept the license agreement and then type in a new password when prompted.
10. Navigate to the System menu, type:
0001:vormetric$ system
11. Enter the FQDN that you copied to the clipboard to set the hostname, type:
0002:system$ setinfo hostname <FQDN>
Example:
0002:system$ setinfo hostname mycompany.vdsm.westus.cloudapp.azure.com
Generating the CA
After configuring a hostname, you must generate the DSM certificate authority.
1. Generate a certificate authority for the virtual DSM instance, type:
0003:system$ security genca
A warning displays, informing you that all agents and peer node certificates will need to be re-
signed after the CA and server certificate have been regenerated, and the DSM server software
will be restarted. Type ‘yes’ to continue, the default is ‘no’.
2. Enter the FQDN of this DSM. The name displayed in ‘This Security Server host name [FQDN of
the DSM]’, should be correct. Press Enter to accept the name, or enter the FQDN that you copied
to the clipboard.
3. Enter the information required to generate the certificate. Answer the prompts:
• What is the name of your organizational unit? []:
• What is the name of your organization? []:
• What is the name of your City or Locality? []:
• What is the name of your State or Province? []:
• What is your two-letter country code? [US]:
4. Once the certificate is signed, you can access the virtual DSM through the web-based GUI. Open
a browser and confirm access over HTTPS to the DSM hostname. Example URL:
https://dsm.vormetric.com
If this does not work because, for example, port 443 was blocked by a firewall, specify port 8445.
Example URL: https://dsm.vormetric.com:8445.
The default user name and password to log on to the DSM the for first time are: admin and
admin123. You will be prompted to reset the password.
Azure blocks outbound and inbound ICMP (Internet Control Message Protocol), by default, at
the Azure load balancer. This prevents any targeted Ping/ICMP DDoS flood attacks. Therefore,
you cannot ping the Azure VMs from outside Azure.
Internally, you can ping from an Azure VM to another Azure VM that is on the same internal
network with the current DSM version.
Enabling Ping
You need to enable ping in order for legacy Vormetric products to be able to register to the
DSM. You can enable ping in the Azure CLI.
Configuring an HA Cluster
See “Configuring HA for V6x00 and Virtual Appliances” on page 128 for procedures to configure
high availability.
Requirements
NOTE: For upgrades and fresh installations of DSM 6.2.0, if you are using HA, you must open
port 5432 in your firewall to allow communication between DSM HA nodes. For Azure and AWS
platforms, you will need to add this port to your security groups. You can now close port 50000
as it is no longer used.
Installing DSM
The DSM AMI is visible on the EC2 Dashboard under Images > AMIs.
1. Select the DSM AMI and click Launch at the top of the page, or right-click the AMI file and select
Launch from the pull-down menu.
2. Select the instance type and click Next.
If you plan to use the DSM in a production environment, the minimum requirements are:
• 2 virtual CPUs
• 8GB RAM
• 250GB hard disk size
Refer to “Virtual machine hardware requirements” for details.
3. Select the number of DSM instances to create. Default is 1.
• If setting up a high availability (HA) configuration in the same region, enter the total number
of nodes (up to a maximum of eight) to launch them simultaneously. If you want to use
different regions you will need to change your region and repeat these steps.
Refer to the HA chapter in this guide for more information about configuring and managing a
DSM HA cluster.
4. Configure the instance details by selecting the following network requirements, (refer to the
Amazon documentation for help):
• Network
Select an existing VPC or create a new one.
• Subnet
Select an existing subnet or create a new one.
• Auto-assign Public IP
If you change Use subnet setting to Disable, this means that no IP address is assigned. You can
set the IP address later by clicking Elastic IPs and allocating an IP address for the DSM
instance.
• Termination protection
We recommend that you enable this setting to avoid accidentally terminating a DSM instance.
5. Click Next. The Add Storage page displays.
6. Accept the default size of 250GB, or increase it per your requirements. Click Next.
7. Click Add Tags.
8. In the Key field, type: Name.
9. In the Value field, enter a name for the DSM instance. Click Next.
10. If you already have an existing and correctly configured DSM security group, select that security
group.
Alternatively, on the Configure Security Group page, configure the appropriate ports:
• To see the ports to configure, see Table 13, “Ports to Configure,” on page 169.
11. Click Review and Launch.
12. Review the summary of the settings you selected and then click Launch.
You are prompted to select an existing key pair, or create a new one.
After you’ve launched the DSM instance, you need to allocate an Elastic IP address and
associate it with the DSM instance.
1. Click Allocate New Address, select EIP used in VPC and Yes, Allocate.
You can also associate an existing IP address that is not in use elsewhere.
2. Select this new address, and click Associate Address.
NOTE: Deploying the DSM AMI may take some time to complete. Some of the status checks on
the dashboard may display as failed. This is no cause for concern. The status will change to
passed once the deployment completes.
Configuring HA
To set up an HA cluster in multiple regions, copy the DSM AMI to the regions where you want to
locate the other nodes:
1. Navigate to Images > AMIs.
2. Select or right-click on the AMI and choose Copy AMI. A dialog box displays with the following
options:
• Destination region
• Name
• Description
3. Select the region to which to copy the AMI.
The name and descriptions are pre-populated but you can change them as per your
requirements.
4. You must manually add an entry for every other node in the HA cluster to /etc/hosts.
Note that the hosts file will already contain an entry for the DSM from which you are working. To
add the host information to the /etc/hosts file, in the CLI menu, switch to the network
submenu and type:
0001:network$ host add <HOST_NAME> <IP_ADDRESS>
Example:
0001:network$ host add dsmHA1.compute.amazonaws.com 192.68.10.1
KVM Deployment
.....................................................................
This section describes how to deploy a KVM image using the virt-manager desktop interface
and using the virsh command line tool. If you choose to deploy the KVM image using virsh, you
must also download the provided XML file.
virt-manager
virsh
1. Edit the XML file and change the virtual machine name and description to your requirements.
The name of the XML file and the virtual machine must be the same. Rename the XML file as
necessary.
2. In the XML file, change the path to the location where you saved the .qcow2 file. You must
change it to the absolute path.
3. Change name of the bridge devices (there are two NICs) to match existing bridge(s) or create a
bridge "br0" to match.
4. Change the UUID for the virtual machine, as well as the MAC addresses for the two NICs as
necessary.
5. To start the virtual machine, type the following command at the prompt;
# virsh create <xml_filename>
Example:
vncviewer localhost:0
virt-manager
NOTE: The virtual machine installation process can take up to 40+ minutes to complete.
virsh
The virsh instructions are the same for Xen deployment as they are for KVM deployment. See
“virsh” on page 93.
.....
This chapter describes how to upgrade your DSM software version to the latest DSM version. It
describes how to migrate from older (V5800) hardware appliances to the new V6x00 hardware
appliances. It also describes how to enable Remote HSM Management for the V6100 appliance.
Warning! Thales strongly recommends that you backup your DSM configuration
before upgrading or migrating to a new version. An upgrade cannot be rolled back.
The only way to go back to a previous version is to restore a backup of the DSM
configuration that was made before the upgrade, to the version of the software in
use before the upgrade.
Overview
.....................................................................
The software on a DSM appliance can always be upgraded to the next immediate release
version. In some cases upgrades to higher version while skipping intermediate releases is also
possible.
In a scenario that involves a platform change, it is called a migration. A migration is when you
upgrade the DSM hardware appliance to a new V6x00 appliances.
Both upgrades and migrations are described in the sections below, including upgrades and
migrations when using DSM with KMIP.
NOTE: The DSM hostname must match one of the hostnames on the HA server list page. If a
mismatch is found, the migration is aborted and an audit message is logged. For a successful
migration, prior to the next upgrade attempt, you must run the security gencert command
(0001:system$ security gencert) on the DSM CLI and enter the DSM’s hostname exactly
as shown in the audit log.
The procedures to upgrade a standalone DSM are described in “Upgrading a Single Node
Deployment”, and to upgrade an HA deployment, follow the procedure described here,
“Migrating from V5 appliances to V6x00 appliances”.
NOTE: If you are upgrading from an earlier version of DSM v5.3 or v5.3.1 with KMIP data,
contact Thales e-Security Support.
V5 hardware appliance (no HSM) with DSM version 6.0 installed. Yes
a. You can migrate from a V5800 with HSM appliance to a V6100 appliance, see “Migrating from V5
appliances to V6x00 appliances”
NOTE: As of release v6.0.3 the DSM supports nShield Connect integration to make the DSM
V6000 or virtual DSM a network HSM-enabled DSM. See, “nShield Connect Integration” on
page 54 for details.
Where <dsm server name> is the FQDN of the DSM that is being backed up.
15. Save the backup to a secure location.
Enable DHCP
You can now choose to enable DHCP on the appliance:
Log on to the CLI console and navigate to the Network category of commands and enable DHCP.
Example:
0004:network$ ip dhcp enable bond0 version 4
WARNING: Changing network ip address may disconnect your session
and will require the server software to be restarted.
Continue? (yes|no)[no]:yes
DHCP operations may take some time, please wait....
SUCCESS: Please restart server software to pick up the changes.
0005:network$
To configure a bond0 interface using DHCP, enable DHCP on that interface. The bond0
interface inherits the IP address that was dynamically assigned to the eth0 interface when the
DSM was initially deployed.
Upgrading an HA Cluster
platform change is called a migration. A V5800 appliance without HSM can be upgraded to DSM
v6.0 or later, follow the procedure described here, “Upgrading the DSM”.
The high-level steps to migrate from a V5800 hardware appliances to V6x00 hardware
appliances are described here:
1. Backup your DSM configuration to ensure you have a copy of the latest configuration before
starting the migration. You will need a wrapper key to create the backup, create one if you have
not already done so. Make sure you export the wrapper key or wrapper key shares used to
create the backup. The wrapper key is required to restore the backup. See “Backup current DSM
configuration” for detailed procedures.
2. Turn off the old hardware appliance and take it off the network. You must turn off the old DSM
hardware appliance and remove it from the network, before you restore the DSM to the new
hardware appliance, otherwise any registered agents will try and communicate with both the
old DSM and the new DSM and cause conflicts in your system.
3. Configure the V6x00 appliance as described in the DSM Installation and Configuration Guide.
4. Assign the new V6x00 appliance with the same IP address and the FQDN of the primary V5
appliance from which you are migrating.
5. Run the security genca CLI command on the new appliance.
6. Import the wrapper key shares to the new V6x00 appliance.
7. Restore the backed up DSM configuration to the new V6x00 appliance.
Restore backup
1. Log on to the Management Console as an administrator of type System Administrator or All.
a. Import the wrapper keys used to create the backup. Select System > Wrapper Keys from the
menu bar.
b. Select Import from the Operation pull-down menu and click Add.
c. If you have created key shares from the wrapper key, get the key shares from the custodians
and paste a key share value into the Key Share text field and click Ok. Repeat this for each
administrator selected as a key custodian, if you have chosen to have more than one
custodian for the wrapper key shares. A key share must be imported for at least as many as
were specified by the Minimum Number of Custodians value when the wrapper key was
exported.
Click Apply to finish importing the wrapper key.
d. Restore the backup file. Select System > Backup and Restore from the menu bar. Select the
Restore tab.
e. Click Browse to locate and select the backup file to restore. Click Ok. The restored file uploads
and the DSM disconnects from the Management Console.
f. Log back in to the Management Console as an administrator of type Security or All. Verify that
the configuration is restored correctly.
Once restore procedure is complete, log in to the DSM and verify that the KMIP keys and secret
data are available.
NOTE: The V5800 with HSM appliance does not support the v6 release of the DSM software.
The procedure to migrate to the new V6x00 appliances is the same as described above.
If you choose to use the remote administration feature, after upgrading to DSM software v6.0,
the following are required:
• Trusted verification device (TVD) and card set. Contact your Thales Sales representative for
more information.
• Obtain a KLF2 warrant.
• Replace the old card set with the new card set, see below for detailed procedure. Should you
choose to, you can continue to use the existing card reader along with the remote
administration TVD and card set.
Obtain a warrant
Once you have received your TVD and card set, obtain a warrant from Thales Support.
1. Move the mode switch on the back panel of the appliance to the Operational (O) position.
IMPORTANT: The switch must remain in the Operational (O) position at all times after
upgrading to version 6.0.1 of the software.
0001:vormetric$ hsm
to enter the hsm sub-menu.
3. The remoteadmin show command will display the status of this feature, type
0001:hsm$ remoteadmin show
If the feature is not turned on, you will see the following output on the CLI;
HSM warrant needs to be upgraded to KLF2 for remote administration
HSM remote administration is disabled
SUCCESS: remoteadmin command ran successfully
0001:hsm$
4. Next you need to enable remote administration, type;
0001:hsm$ remoteadmin on
HSM warrant needs to be upgraded to KLF2 for remote administration
The warrant in this HSM needs to be upgraded for remote administration
to work.
If you’ve already received the signed warrant from Vormetric support,
enter the content of the warrant file (copy and paste) and end with a
blank line. If not, please send an email to Vormetric support
([email protected]) with the following information to request a
warrant upgrade:
ESN: B0FF-8213-3E55
Content of the CSR file /opt/nfast/kmdata/warrants/csr_B0EG-8218-3F55:
0a00000014000000210e59ed694e5d0fe1aa8e31a654b795dfe60d5414000000f135b1
e84d5269b30ca5c1328bc7a2505c03bf09dc0000000400000000900000020020000200
00000f000000423045462d383231382d3345353500000d0000002249d39dc0294ac1ec
58b1c9a2f336c8159bcc3c2e0000000600000000000000440000000507b04338782583
2949dce4295499615903b32b9acbe88c8a9535762c9b6d0debced6e381149b6ab4a84a
1d42a0d24f7eec6b6d1a9bc1802c6bc6e1b4c4e03dac01000044000000ebff58428d7e
25a5c5992fe5d5d04b1a8ca2eed62116b8c516c715e7036fd28364592587c66c36551a
25da1df37073f4001d6325d5f6877ab4ebc2f805ffd54ebf000000bb000000
Enter the contents of the warrant file (copy and paste) followed by a
blank line or just press Enter to abort.
Copy and paste the contents, including the ESN and the content of the CSR file and email it to
Support ([email protected]). You will receive the signed warrant within 24 hours.
5. Copy the contents of the warrant file you received at the prompt;
KLF2 Warrant for B0FF-8213-3E55
6E4369706865722D6865782D4B4C463257617272616E74000000039E93374B57
41524E2D31B2375061796C6F6164C5EFB33B44656C65676174654B6579943545
43445341365075626C6963384E4953545035323192F4C542014450694D476864
B5B6D5EB57ABC19CDE258232029F59988B5DF7A5326D1FD780344F9ED8E2AF34
AAB987F18163B5A1205C68D2563B2602AB01633E90BB51CB1E05F4C54201D46C
0D3D17BDEC2584930DC77011E3A734098018681A5886BDEAFA952894B5E08F2D
8E625F2C3BAF1088008F1FD20A4F3A17F0B905400A1000376DA3C124AFC7D137
5369674D656368923545434453419235454D53413136534841353132C4165761
7272616E744365727469666963617465547970653A44656C65676174696F6E39
5369676E6174757265C5840021CDF6DEE1FBEB059B7A09C22FFCA50D6BD26AC4
8B1AFB7CB37A9022165589EBB1F3579C80BEDACCBC0930521EA7BD6566C8B2C8
92944533EAE39AE15F4614B28A00E7B0093E043FDF38776159DA1ABD5C5602EE
799DA9D3951022F8D4289E7D8F0A7D55D58BDF01649AD0CA20F6477DBE9B5A78
69BCFE4E665F8EA9F0536A99A016D7B2375061796C6F6164D5016FB6C416456C
656374726F6E696353657269616C4E756D6265722E423045462D383231382D33
453535C414506879736963616C53657269616C4E756D6265722933362D4A3332
38383939417070726F76616C73919437464950533134300203C4114D756C7469
43686970456D626564646564C41657617272616E744365727469666963617465
54797065C41D4669656C64557067726164654D6F64756C65496E666F726D6174
696F6E374B4C463270756294354543445341365075626C6963384E4953545035
323192F4C54201AC3DE0C4B4E1C66B2C80C19B1A6D6BEC7E4FD2A0421D4AA8B4
6A9B1481E3D6CEEB0D6D9B2C7635958A8CE8CB9A2BB3035961995429E4DC4929
8325783843B00705F4C541BF4ED5FF05F8C2EBB47A87F6D525631D00F47370F3
1DDA251A55366CC68725596483D26F03E715C716C5B81621D6EEA28C1A4BD0D5
E52F99C5A5257E8D4258FEEB384B4C46326D656368923545434453419235454D
53413136534841353132395369676E6174757265C584001A5B42B33DA5444F63
6ED39EF37FF086CCC7DE9512F676C30A469B8167E1534EB08F86913ADE3EBEAC
BF4A34E79B6BAF6BB1D1EE16413D37BDFF58CE6F7B122EE2003A92CFF4548B77
4AF280F0354A96F2668CBD1A0217322D40C239E5F39FEC142E25952594626338
99D8890E95A0FB23BA94DA8AA44118AA8ED804770D236F299C26C4387975F3A3
CDB62276BA301BC4DC112E246A4F000000000000000000000000000000000000
After enabling remote administration, you need to replace the old card set with the new card
set. Replacing the ACS does not recreate a copy of the old ACS, but creates a completely new
ACS to access the security world (the primary and failover DSMs) that replaces the old ACS.
NOTE: You may also want to run a replace ACS procedure if you lose a card from the smart card
set, or if a card is compromised, or corrupted.
If you have a DSM backup created using the old card set, you should retain that old card set in
case you want to restore the backup, in which case, do not erase the old card set when
prompted during the replaceacs procedure.
IMPORTANT: You can only replace the old ACS, you cannot change K or N during this procedure.
1. Start an SSH client session from the laptop or PC to the V6100 appliance, and log in using your
CLI administrator credentials.
2. To replace your ACS, insert one card from the quorum of the old card set into the old card reader,
and at the prompt type replaceacs and follow the instructions;
0002:vormetric$ hsm
0002:hsm$ hsm replaceacs
Before you start to replace ACS, you must ensure that you have enough
blank cards to create a complete new AC.
If you start the procedure without enough cards, you will have to
cancel the procedure part way through.
Have a quorum of cards from the current ACS ready. Please wait...
Insert ACS to authorize ACS replacement:
Module 1: 0 of 1 card read
Module 1 slot 0: empty
Module 1 slot 2: empty
.
.
.
Module 1 slot 17: empty
Module 1 completed.
!
Caution: Make a note of this passphrase, if you lose it the card will be unusable.
10. Remove the written card and insert the next card that is part of the quorum.
11. Enter a passphrase if using one and make a note of it.
12. Once you’ve completed writing the cards, you will be prompted to erase the old cards. If you
plan on keeping the old set, do not erase them.
The new cards can be used with the old card reader, however, the old cards cannot be read with
the new TVD.
NOTE: Remote administration is also available for DSM V6000 or virtual appliances that nShield
Connect integration enabled, however this needs to be configured on the nShield Connect
device. Refer to the nShield Connect documentation for more information about enabling
remote administration.
.....
This chapter provides the V6000/V6100 hardware appliance specifications and installation
instructions. It contains the following sections:
• “Hardware Appliance Diagrams” on page 111
• “DSM Hardware Appliance Specifications” on page 114
• “Space, Network, and Power Requirements” on page 115
• “Appliance Rack Mount Safety Instructions” on page 116
• “Rack Mounting the Appliance” on page 117
• “Rack Mounting Instructions” on page 119
• “Installing and Connecting Cables” on page 125
Warning! The DSM appliance is covered with three FIPS tamper evident stickers.
Removing or damaging the stickers voids FIPS compliance and the equipment
warranty.
Figure 2: Vormetric DSM hardware appliance with FIPS tamper evident stickers
Figure 3: Rear view of V6100 DSM with HSM (V6000 has no HSM)
Power Power HSM mode
module 2 module 1 IPMI port ETH1 port switch
Serial port ETH0 port
HSM
Card Reader port
The control panel located on the front of the SC813M chassis has five LEDs. These LEDs provide
you with critical information related to different parts of the system. This section explains what
each LED indicates when illuminated and any corrective action you may need to take.
HDD with 9
FIPS Tamper
Evident Sticker 8
7 6 5 4 3 2 1
Number Description
1 Power Button: Used to apply or remove power from the power supply to the server system.
Turning off system power with this button removes the main power but keeps standby power
supplied to the system. Therefore, you must unplug system before servicing.
3 Power LED: Indicates power is being supplied to the system's power supply units. This
LED should normally be illuminated when the system is operating.
4 HDD: Indicates IDE channel activity. SAS/SATA drive and/or DVD-ROM drive
activity when flashing.
Status Description
Blinking red (0.25Hz) Power failure, check for a non-operational power supply.
Solid blue Local UID has been activated. Use this function to locate the server in a rack mount
environment.
Blinking blue (300 msec) Remote UID is on. Use this function to identify the server from a remote location.
Specification Description
Memory 16GB
Serial Ports 1
Ethernet 2 x 1GB
IPMI 1 x 100Mb
Specification Description
External connectors
Power requirements
The table below lists the required environmental conditions for the DSM.
Table 4: Environmental conditions for the DSM
Condition Range
Inspect the box the chassis was shipped in and note any damage. If the chassis itself shows
damage, file a damage claim with the carrier.
Decide on a suitable location for the rack unit that will hold your chassis. Choose a clean, dust-
free, well ventilated area. Avoid areas where heat, electrical noise and electromagnetic fields
are generated. Placed near a grounded power outlet.
The box your chassis was shipped in includes two sets of rail assemblies, two rail mounting
brackets, and the mounting screws needed to install the system into the rack. Read this section
before beginning the installation procedure.
Rack precautions
• Ensure that the leveling jacks on the bottom of the rack are fully extended to the floor with
the full weight of the rack resting on them.
• In single rack installation, stabilizers should be attached to the rack.
• In multiple rack installations, the racks should be coupled together.
• Always make sure the rack is stable before extending a component from the rack.
• You should extend only one component at a time - extending two or more simultaneously may
cause instability.
• Determine the placement of each component in the rack before you install the rails.
• Install the heaviest server components on the bottom of the rack first, and then work up.
• Use a regulating uninterruptible power supply (UPS) to protect the server from power surges,
voltage spikes and to keep your system operating in case of a power failure.
• Allow the hot plug hard drives and power supply modules to cool before touching them.
• Always keep the rack's front door and all panels and components on the servers closed when
not servicing to maintain proper cooling.
!
Caution: To prevent bodily injury when mounting or servicing this unit in a rack, you
must take special precautions to ensure that the system remains stable. The
following guidelines are provided to ensure your safety:
• This unit should be mounted at the bottom of the rack if it is the only unit in the
rack.
• When mounting this unit in a partially filled rack, load the rack from the bottom to
the top with the heaviest component at the bottom of the rack.
• If the rack is provided with stabilizing devices, install the stabilizers before
mounting or servicing the unit in the rack.
NOTE: This rail will fit a rack between 26" and 33.5" deep.
The chassis package includes two rack rail assemblies in the rack mounting kit. Each assembly
consists of two sections: an inner fixed chassis rail that secures directly to the server chassis
and an outer fixed rack rail that secures directly to the rack itself.
Locking tabs
Both chassis rails have a locking tab. The tabs lock the server into place when installed and
pushed fully into the rack. These tabs also lock the server in place when fully extended from the
rack. This prevents the server from coming completely out of the rack when you pull it out for
servicing.
Figure 6: Identifying the Sections of the Rack Rails (right side rail shown)
The inner rails are pre-attached and do not interfere with normal use of the chassis if you
decide not to use a server rack. Attach the inner rail extension to stabilize the chassis within the
rack. If you are not using a rack, you do not have to install the inner rail extensions.
Warning! Do not pick up the server by the front handles. They are designed to pull
the system from a rack only.
NOTE: Figures are for illustrative purposes only. Always install servers into racks from the
bottom up.
!
Caution: The rack stabilizing mechanism must be in place, or the rack must be bolted
to the floor before you slide the unit out for servicing. Failure to stabilize the rack
can cause the rack to tip over.
NOTE: Figures are for illustrative purposes only. Always install servers into racks from the
bottom up.
Connect each power module to an independent, 100-240V, 47-63Hz, 12V 6A power source.
Always shut down the system before removing power to ensure that all files and processes are
properly closed. The DSM appliance is started and shut down through the Vormetric Command
Line Interface (CLI) with the shutdown command.
The serial console is connected to the system through the serial port in the back of the DSM
Appliance. This is a DB-9 RS-232 connector. (See Figure 5 on page 16.)
The serial console port provides a direct connection to the DSM hardware appliance. By
default, the serial console interface is always accessible and it can always be relied on to
communicate with the DSM. Communication with the appliance is done through the DSM CLI
after making a terminal connection. The serial console is used to configure the appliance
Ethernet interfaces during initial setup. After the network is configured, a CLI administrator can
log on to the appliance using an SSH connection, and complete the configuration process.
To log on using the CLI:
1. Configure your console connection using the following parameters:
• Terminal Type: VT100
• Baud Rate: 9600
• Parity: None
• Data bits: 8
• Stop bits: 1
2. Connect the system serial console port and the DSM Appliance serial console port.
3. The pin-out of the DSM Appliance serial console port is:
1 DCD 6 DSR
2 RXD 7 RTS
3 TXD 8 CTS
4 DTR1 9 RI
5 Gnd
Two RJ-45 10/100/1000 Mb Ethernet connections, eth0 and eth1, are provided on the rear
panel of the V6000/V6100 DSM hardware appliance (see Figure 5 on page 16). The eth0
interface comes pre-configured from the factory. The eth1 interface is not configured and is
disabled by default.
You can access the DSM appliance immediately after bootup via a Secure Shell Protocol (SSH)
connection. The default IP address of the eth0 network interface is:
eth0: 192.168.10.1
If you want to connect to the DSM via Ethernet, manually set the IP address for the laptop to
192.168.10.2 (or higher) with a default mask of 255.255.255.0. Otherwise, use the serial
console interface to configure the DSM network. We recommended that you use the serial
console interface to perform initial network configuration because, if you are logged onto the
appliance through the Ethernet interface, the connection will drop when you change the
Ethernet interface IP address.
.....
This chapter describes how to set up High Availability (HA) for V6x00 hardware and virtual
appliances. Refer to the High Availability chapter in the DSM Administrators Guide for details
about managing an HA deployment.
This appendix contains the following sections:
• “HA Overview”
• “Supported HA Deployments”
• “Configuring HA for V6x00 and Virtual Appliances”
• “Configuring High Availability for Network HSM-enabled Nodes”
• “Upgrading an HA Cluster”
HA Overview
.....................................................................
To configure High Availability (HA) for DSMs, you need administrators of type: DSM System
Administrator or All as well as someone with DSM CLI privileges. A DSM HA configuration
consists of two or more DSM HA nodes.
As of DSM v6.2.0, HA is now configured as Active-Active. This means that there is no longer a
primary or a failover node. All nodes are peers. When one node fails, the other nodes continue
operating normally. When the failed node is working properly again, it synchronizes with the
other HA nodes.
Supported HA Deployments
.....................................................................
You must have at least two DSM HA nodes installed on the same network to create an HA
cluster. The maximum number of nodes allowed in an HA cluster is eight.
To ensure reliable operation, the appliances in an HA cluster must run the same version of the
DSM software and have the same hardware configurations.
V6100
A DSM high availability (HA) cluster for a V6100 must consist of only v6100 appliances. You
cannot mix it with other DSM appliances (V6000 or virtual DSM).
Prerequisites
Refer to “Configure network settings”, for how to configure a DSM V6100 or virtual appliance.
Before you set up your HA cluster, do the following:
1. Specify a hostname resolution method, see “Specify host name resolution method”.
You can map a host name to an IP address using a Domain Name Server (DNS). DNS is the
preferred method of host name resolution.
You can modify the hosts file on the HA node:
a. Log in to the CLI menu.
b. Type: network
c. Type: host add <hostname> <IP address>
You can also identify a host using only the IP address.
• If you use DNS to resolve host names, use the FQDN for the host names.
• Both forward and reverse address resolution is required for nodes in a cluster.
• FQDN name must be lowercase
2. Open all required ports. To see the ports to configure, see Table 13, “Ports to Configure,” on
page 169.
NOTE: For upgrades and fresh installations of DSM 6.2.0, if you are using HA, you must open
port 5432 in your firewall to allow communication between DSM HA nodes. For Azure and AWS
platforms, you will need to add this port to your security groups. You can now close port 50000
as it is no longer used.
3. Perform a ‘ping’ operation on all of the DSMs to ensure that network communication is working
between the DSM HA nodes.
Network Latency
If the network latency between the HA nodes exceeds 100ms, you may experience delays in HA
replication, especially if you have many policies, or you have large policies that contain many
resource sets, user sets, etc.
Another factor in network latency is the Policy Version History setting (System > General
Preferences > System > Maximum Number of Saved Policy History). Each time changes are
made to a policy, a new version of that policy is created. This setting determines how many
previous versions of the policy will be kept. The more versions that are kept, the longer the
delay because it increases the time required to replicate policy data to the cluster nodes. See
Table 4, “General Preferences System tab attribute values and use,” on page 25 for details
about this setting. We recommend changing this value to 0 or 5 from the default of 10 if you
experience network latency.
To configure HA for the V6100 hardware appliance, you need the following:
• Two V6100 appliances installed and configured.
• A trusted verification device (TVD) connected to a laptop or PC that is connected to the V6100
appliance.
• A quorum of activated smart cards to perform administrative actions and their pass phrases.
See “Administrator Card Set (ACS)” for more about the ACS.
1. Install and configure your DSM as described in previous chapters of this guide.
NOTE: The license must be installed on the DSM designated as HA node 1 before you can
configure the other HA nodes.
2. On HA node 1 (the Initial Server), log on to the Management Console as an administrator of type
System, or All.
3. Click High Availability in the menu bar. The High Availability Servers window opens.
4. Click Add. The Add High Availability Server window opens.
5. In the Server Name field, enter the host name or FQDN of a DSM node.
6. Click Ok. The DSM node is listed in the High Availability Servers window. It is designated as ‘Not
Configured’.
Figure 11: Node added but not configured/joined to the cluster
NOTE: You can also add nodes in the CLI. See the High Availability Category section in the CLI
chapter in the DSM Admin guide.
System Response:
WARNING: This server node is about to join an HA cluster.
Please make sure the HA cluster is running and has this server node in
its HA node list.
This may take several minutes.
NOTE: Sometimes, when DSM nodes are spread far apart geographically, or are in a cloud
environment, the Join function takes so long that the ssh session times out and terminates
automatically before the Join can finish. If the Join function fails, type: join longwait to
make the join command proceed in a 'longwait mode' (as opposed to the 'normalwait' mode).
The difference between the two modes is the duration that it waits for the node replication
status state to be set to 'ready.' Longwait waits for approximately twice as long as the
normalwait mode.
10. Click the High Availability tab. In the row for the HA node 2, the Synchronization status should
contain a green circle and the Configured column should contain a check.
NOTE: Client licenses are required for each nShield Connect appliance that is configured for the
HA Cluster—the number of client licenses required per Connect appliance is equal to the
number of DSM HA nodes connected to the nShield appliance.
You can configure a network HSM-enabled DSM HA cluster in one of two ways:
The first method is to configure all of the DSMs as standalone nodes and enable network HSMs
for each of them in the same Security World. You can now create a network HSM-enabled DSM
cluster in the same manner as for any other DSM cluster.
The high-level steps to configure a network HSM-enabled DSM HA cluster following this
method are:
1. Configure two nShield Connect appliances and the associated RFS.
2. Configure the HA cluster.
3. Add the DSM individually to the nShield Connect Security World to make each DSM network
HSM-enabled. This means you must run the connect add command on each DSM to add them
to that Security World.
Refer to the nShield user documentation for a description of how to configure and deploy the
nShield Connect device and the associated RFS.
4. Add both nShield Connect appliances to each of the DSMs as follows:
a. Add the nShield Connect appliance to the DSM. Open a CLI session on the DSM appliance that
is a client of the nShield Connect appliance.
NOTE: If the nShield Connect Security World is FIPS 140-2 level 3 compliant, only one card from
the associated ACS is required for this step. The card is only required for the first Connect
device to be added to the DSM, it is not required for any subsequent nShield Connect
appliances that are added.
b. Navigate to the HSM category of commands, type the following at the prompt:
0000:dsm$ hsm
0001:hsm$
c. Use the connect add command to add the nShield Connect to the DSM. Type the following
command at the prompt,
0001:hsm$ connect add <nShield_Connect_IP_Address> <RFS_IP_Address>
A warning displays, informing you that once this DSM appliance is converted to a network
HSM-enabled appliance, it cannot be rolled back.
d. Type yes to continue. The DSM is restarted if the operation is successful.
e. Follow the prompts to add the nShield Connect appliance to the DSM.
f. To view the nShield Connect that has been added, type:
0002: hsm$ connect show
g. If there are more nShield appliances in the same Security World, you can add them now using
the connect add command.
NOTE: The About page of the DSM Web UI also displays the nShield Connect devices that have
been configured.
NOTE: Once a DSM is network HSM-enabled, it must be connected to at least one nShield
Connect appliance. If you remove an nShield appliance from a Security World, you must make
sure that any DSM appliances that were connected to it, are now connected to another nShield
appliance belonging to that same Security World.
In this case, if more than one nShield appliance is available in the Security World, a DSM
Administrator could choose to use any of the available nShield appliances after the DSM has
joined the cluster.
See “Configuring High Availability for Network HSM-enabled Nodes” on page 133.
See the VDS Administrators Guide for instructions on other HA functions such as:
• Assigning Hosts to the DSM in an HA cluster
• Pushing Configuration Changes to Hosts
• Reassigning Hosts to Another DSM in the HA Cluster
• Displaying the High Availability Configuration
• Recovering from incomplete node synchronizations
Upgrading an HA Cluster
.....................................................................
When upgrading the nodes in an HA cluster, you must break the cluster by removing a node
from the cluster, running the HA cleanup function and then upgrading that node
independently. After upgrading all of the HA nodes:
• Add them back into the HA cluster
• Join them to the HA cluster
• Register VTE Agents to the nodes
Prerequisite
• Backup your current DSM configuration, as described above, “Backup current DSM
configuration” on page 100.
Breaking up the HA cluster involves removing the nodes from the HA cluster. On HA node 1, the
initial node, log in to the CLI menu as CLI Admin.
1. Switch to the HA menu, type:
0001:dsm$ ha
Example
0002:dsm$ remove HAnode3.i.vormetric.com
System Response:
WARNING: This command is going to remove one server node from
the HA cluster.
This may take several minutes.
Continue? (yes|no)[no]:yes
SUCCESS: Removed server node HAnode3.i.vormetric.com from the
HA cluster.
3. Repeat the previous step for all of the nodes in the HA cluster.
4. After removing the nodes, log on to one of the other nodes, (not the initial one) as CLI Admin
and switch to the HA menu.
0001:dsm$ ha
System Response:
WARNING: This command cleans up HA configuration data of, and
restarts, this server.
This may take several minutes.
Continue? (yes|no)[no]:
6. Type yes to continue.
SUCCESS: cleanup
7. Repeat the cleanup process for every node that you removed from the HA cluster.
In the GUI, upgrade the initial node to the latest version of the software.
1. Select System > Software Upgrade. The Upgrade Software window opens.
2. If two software images are present, click Delete Idle Version to delete the one which is not in
use.
3. Click Browse/Choose File and select the upgrade file that was provided to you.
4. Click Open, and then click Upgrade to start the upgrade. Follow the directions on the screen.
5. Refresh your browser to view the login screen after the upgrade completes.
6. For HSMs like a V6100, repeat these steps to upgrade each of the other nodes in the HA cluster.
NOTE: If you plan to enable nShield Connect integration on a DSM V6000 or virtual DSM HA
cluster see, “Configuring High Availability for network HSM-enabled DSM” on page 58.
The initial node is the only node that needs to be upgraded. This ensures that all of the content
of the node: policies, admins, domains, keys, reports, logs, etc. will be saved. However, an
upgrade is unnecessary for the other nodes in the cluster, because all of the content of the
initial node will be copied over from the initial node when all of the nodes in the HA cluster
synchronize. Therefore, to optimize upgrading the virtual DSMs for the additional nodes in the
HA cluster:
1. Upgrade the initial node to DSM v4.0.0.0.
2. On each additional node, perform a fresh installation of DSM v4.0.0.0. In other words, use the
OVA file for the installation, not the upgrade tar file.
3. Once the software upgrade/installation on each of the nodes is complete, add the nodes to the
cluster and join the HA cluster. See “Adding DSM Nodes to an HA Cluster” on page 130 and “Join
a Node to an HA Cluster” on page 130 for more information.
.....
The Intelligent Platform Management Interface (IPMI) provides browser-based remote access
to the V6000 and V6100 hardware appliances. It allows administrators to remotely monitor
appliance health (temperature, power consumption, physical drive status, chassis intrusion,
and others), perform cold boots (power-off and power-on), and access the DSM CLI.
NOTE: IPMI is not supported by the DSM virtual appliance or hardware appliances earlier than
V6000/V6100.
IPMI Overview
.....................................................................
IPMI offers useful features, but it also introduces some security issues. Following these
recommended best practices will reduce the probability of these security issues occurring.
• IPMI requires a browser with Java 7 or higher. Enable Java Network Launch Protocol (JNLP)
and Java content in the browser to use the keyboard-video-mouse (KVM) for the remote
console. In Windows, you also must install Java JRE.
• Disable IPMI services if not needed. Disconnect the IPMI port at the back of the DSM
hardware appliance from the network, or execute the DSM CLI command ipmi disable.
• Deploy IPMI in a secure private network behind a firewall, restricting inbound and outbound
traffic to/from IPMI.
• Do not share the IPMI port with the other two DSM Ethernet ports. The Vormetric factory
default sets the IPMI LAN interface to Dedicated (you can check the status in the IPMI GUI
under Network Link Status).
The following section describes how to configure IPMI and access the IPMI management
console.
Before you can use IPMI to configure your DSM V6000/V6100 appliance, you need to configure
an IP address, and enable the KVM port for remote Java console support.
NOTE: You must install the latest version of Java JRE to use the KVM feature.
If you want to configure the IPMI Ethernet port IP address to use an IPv6 address, you must do
this through the IPMI GUI—you cannot configure the IPMI Ethernet port IP address through the
CLI.
NOTE: If the HTTP and HTTPS ports are both enabled for IPMI, IPv6 will not work for HTTPS. The
workaround is to either disable HTTP or use IPv4 instead of IPv6.
0011:vormetric$ ipmi
0012:ipmi$
4. Set the IPMI net mask using the command mask set <net mask>, type:
0013:ipmi$ mask set <net mask>
5. Enable the KVM port using the command port enable kvm. The KVM port is required for
remote Java console support. At the prompt, type:
0014:ipmi$ port enable kvm
6. Open a browser session and point the browser to the URL that contains the IPMI IP address you
just configured; https://<IPMI IP address>.
You will see the IPMI login screen, see Figure 13: “IPMI Login screen” below.
Figure 13: IPMI Login screen
NOTE: The first time that you log on to a DSM, the software makes you change your password.
1. Navigate to Remote Control > Console Redirection and click Launch Console. Download and run
the resulting .jnlp file to open a Java console for your DSM. This Java console provides access
to the DSM CLI.
2. Log on to the CLI using the default CLI administrator credentials:
• Username: cliadmin
• Password: cliadmin123
You will be prompted to change the CLI administrator password. After that you will be prompted
to change the IPMI GUI login password as well. The new password must be:
• At least 8 characters long
• Contain at least one upper case letter
• Contain at least one special character
• Contain at least one number
3. Configure the network settings, see “Configure network settings” on page 18 and then generate
the CSR, see.“Generate DSM Certificate Authority and create ACS” on page 25.
4. If you plan on setting the IP address manually using the IPv4 or IPV6 format, enter appropriate
information into the available fields.
5. Select Enable to enable Virtual LAN support, and enter the VLAN ID in the field.
6. The Lan Interface allows you to select the port used for IPMI out-of-band communication.
• The default setting is dedicated, which allows IPMI to be connected from either the shared
LAN port (LAN1/0) or the dedicated IPMI LAN port. Precedence is given to the dedicated LAN
port over the shared LAN port.
• Select Dedicate for IPMI to connect through the IPMI Dedicated LAN port at all time.
• Select Share for IPMI to connect through the first LAN port (port 0 or port1) on the board.
NOTE: Thales recommends that you use a dedicated port for IPMI.
7. The RMCP (Remote Mail Checking Protocol) Port allows the user to select the desired RMCP
port. The default port is 623.
8. The Network Link Status displays the status, speed, and duplex type for the dedicated and
shared network links. Select an appropriate link.
9. Click Save to save the Network settings.
This feature allows you to configure the time/date settings for the host server and the agent.
You can either set the date and time manually or use the NTP server to set date and time.
Follow the instructions below to set date and time using the NTP server:
1. In the Configuration submenu, select Date and Time to set the date and time settings.
2. Select NTP Enable to use NTP settings.
3. Select a time zone.
Time zone is enabled when NTP Enable is selected. The options are UTC -12:00 hr. to +12:00 hr.
4. Enter the IP address for the primary NTP server.
5. Enter the IP address for the secondary NTP server.
6. Select the daylight saving time (DST) option for the time to automatically adjust during DST.
7. Click Refresh to display the current date/time.
8. Click Save to save the entries.
This Users page displays information on the current users. You can add, delete or modify user
information. In this section, you assign Network Privileges based on a role: User, Operator or
Administrator. The following table describes the access for each role for each function.
Table 5: Privileges
c. Confirm password
d. Network Privileges
5. To modify the information or the status of a user, select a user and then click Modify User.
6. To delete a user from the network, select a user from the users list and then click Delete User.
NOTE: The User ID #1 (Anonymous) is reserved and cannot be modified or deleted. The User ID
#2 (ADMIN) cannot be deleted. You can only modify the name and password.
You can configure the following ports for IPMI on the V6000/V6100 DSM hardware appliance.
To access:
• Click Configuration > Port to display the Port Settings page.
To configure port settings:
1. Click Configuration > Port.
2. Enter the desired web port number.
3. Enter the Web SSL port number.
4. Enter the desired IKVM port number.
5. Virtual Media Port: Enter the desired virtual media port number.
6. After configuring the port settings, click Save to save the settings.
Remote Control
.....................................................................
Remote control allows you to carry out activities and perform operations on a remote server
through remote access, such as accessing the DSM CLI. There are three options for remote
control.
• Console Redirection: It opens the Java console so that you can access the CLI to configure
settings.
• Power Control: Displays and executes the power options of the remote system, including the
following:
• Reset Server
• Power Off Server-Immediately
• Power Off Server-Orderly Shutdown
• Power On Server
• Power Cycle Server
Warning! Using reset server, power cycle server and power off server -immediate on
a DSM that is running, may risk damaging the file system. Thales recommends only
using power off server - orderly shutdown.
• Launch SOL: Launches SOL (Serial Over LAN) console and allows you to view status messages.
Console Redirection
Allows you to launch console redirection through the IKVM (keyboard, video/ monitor, mouse)
support.
1. Click Remote Control > Console Redirection.
2. Click Launch Console.
3. Download and run the resulting .jnlp file to launch the Java console. A screen displays to indicate
that Java is launching.
4. When the warning screen displays, click Continue to launch the remote console.
Power Control
This feature allows you to check the power state and perform remote power control.
Warning! Using reset server, power cycle server and power off server -immediate on
a DSM that is running, may risk damaging the file system. Thales recommends only
using power off server - orderly shutdown.
NOTE: Power cycling the DSM through IPMI is not the same as an actual power cycle. Standby
power is still available.
Configuring AD groups
IPMI uses groups in Active Directory (AD) to differentiate privilege levels. Before you can
configure LDAP, you must create new groups on the AD server for each privilege level and then
assign users to those groups. IPMI contains four levels of privilege.
1. Create groups on the AD server, for example, one for Administrators and one for Operators.
2. Add appropriate users to each group to which you want to grant access.
1. Log into the IPMI GUI and click Configuration > Active Directory.
2. Click on the here link at the top of the page to enable the Active Directory server.
3. Enter your AD server settings:
• Port
• User Domain Name
• Time Out
• Domain Controller Server Address1
4. Click Save to save the settings.
You are redirected back to the main AD settings page.
5. In the table, select row 1 and click Add Role Group.
6. In the Role Group Name field, enter the name of the AD group that was configured on the AD
server for Administrator level privilege.
7. For the Role Group Domain field, enter the domain defined on the AD server.
8. Set the privilege level for users in this AD group from the pull-down menu.
9. Click Add to save the changes and you will be re-directed to the main AD Settings page.
10. Repeat steps 5-9 for all other roles/groups needed.
1. On the LDAP server, create an OU (organizational unit) that you will use for LDAP.
2. Create users in that OU that have a permission attribute "H=<number>" where the number can
be from 1-4 and the permission levels are as follows:
• 4 = Administrator
• 3 = Operator
• 2 = User
• 1= Callback
NOTE: Once the server is in the firmware update mode, the device will be reset, and the server
will reboot, even if you cancel firmware updating.
NOTE: If you uncheck Preserve Configuration and Preserve SDR, the option restores the
factory default settings.
7. Click Start Update to begin uploading the selected firmware to the host server.
Warning! To properly update your firmware, do not interrupt the process until the
process is completed. Once it is completed, the system will automatically reboot, and
you will need to login to the server again.
Server Health
.....................................................................
To view sensor readings and event logs:
• Click Server Health.
The following options are available for Server Health:
• Sensor Readings: View sensor information
• Event Log: Access event logs. Choose a category from the pull-down menu to filter the events;
sort them by clicking on a column header.
• Power Consumption: Displays Power consumption information, including maximum,
minimum and average power consumption in last hour, day and week.
• Storage Monitoring: Displays physical and logical storage.
Replace the default IPMI certificate to make your system more secure. To replace the certificate
you need to upload an RSA2048 private key and the associated SHA256 certificate using the
IPMI GUI.
1. Create a CSR and a 2048-bit RSA private key for the IPMI certificate using Openssl. Type:
openssl req -new -newkey rsa:2048 -nodes -out
<hostName>.<domain>.com_rsa.csr -keyout <hostName>_rsa_2048.key -subj
"/C=<country>/ST=<state>/L=<locality>/O=<organization>/OU=<organization_unit
>/CN=<FQDN>/emailAddress=<email_address>"
Example:
openssl req -new -newkey rsa:2048 -nodes -out
sys99999.sys5backup.com_rsa.csr -keyout sys99999.sys5backup.com_rsa_2048.key
-subj "/C=US/ST=California/L=San Jose/O=Thales E-Security,
Inc./OU=ThalesQA/CN=sys99999.sys5backup.com/
[email protected]"
2. Get the CSR signed by a 3rd party with SHA-256 signature algorithm The following example is
from CACert.org:
4. Click Choose File and import the signed leaf cert. and private key into IPMI.
5. After IPMI reboots, browse to the IPMI using the hostname that matches the certificate and look
for the “green lock” in the URL field. When you see it, it means that the new certificate and key
are now installed.
NOTE: You may need to import the CA root certificate into your keystore.
By default, you can only access the IPMI management console through HTTPS. The default port
for HTTPS is 443. Changing the default port from 443 will present an obstacle to potential
hackers. If you change the https port, for example to 59841, you will have to add it to the IPMI
URL. For example, instead of accessing IPMI using https://10.3.45.45 you will have to use
https://10.3.45.45:59841
1. In the IPMI management console, click Configuration > Port.
2. Change the Web SSL port from 443 and click Save. You will lose connectivity to the IPMI console
when you change the port number. Enter the URL to log in again with the new port number as;
https://<IP address or host name>:<Port number>
Example: https://1.2.3.4:59841
3. Navigate to Remote Control > Console Redirection and click Launch Console.
4. Save the file and then double-click the .jnlp file to launch the remote Java console.
Use a complex password for IPMI. The new password must be at least 8 characters long, must
contain at least one upper case letter, one special character, and one number. To change IPMI
user passwords:
1. In the IPMI management console, click Users in the left column.
2. Highlight the user whose password will change, and click Modify User.
3. Click Change Password, enter Password and Confirm Password, then click Modify.
You can create IPMI users by using the IPMI GUI or by using the DSM CLI ipmi user add
command. Thales recommends using the DSM CLI ipmi user add command.
In this example there is only on administrator, the default. The IPMI user ID is 2, and the IPMI
user name is ADMIN, and the privilege level is Administrator. Using the DSM CLI you can use any
of the unused user IDs from 3 to 8. In this example, we’ll use User ID 3.
2. Choose a user name and privilege level for the administrator you are about to create. This can be
of type Administrator, Operator or User. Each type has varying levels of privilege (see table
below). The Administrator has full view and change control of all IPMI features. The Operator has
change control of most IPMI features and viewing privileges of the rest. The User has the fewest
privileges. Don’t give Administrator privileges to all IPMI users. Create user types appropriate for
each user.
Function User Operator Administrator
3. Run the user add command to create the user. user add has the following syntax:
Configuring Alerts
You can configure IPMI to send alert notifications about hardware events on the DSM
appliance. To receive email alerts you will need to configure your SMTP server in the IPMI GUI.
You can also configure SNMP trap alerts, to be sent to an SNMP manager.
This IP Access Control table allows you to add, modify and delete an IP Access rule, an IP
Address/Mask setting, or an IP access policy. To modify a setting:
1. Click Configuration > IP Access Control.
2. Select the Enable IP Access Control settings to change the settings.
3. Select an item in the IP Access Control list and click Add/Modify to display the Add Rule page.
4. Enter an IP Address/Mask:
This column displays IP Address/Mask settings and allows you to grant access to a specific IP
address or a range of IP addresses.
For example, if you wanted to specify a range of IP addresses from 192.168.0.1 to 192.168.0.126,
you would enter 192.168.0.1/25.
5. From the policy dropdown menu, select Accept to allow access for the IP address(es) entered
above. Select Drop to deny access.
NOTE: The Number of Access Rules displays the maximum number of IP Access rules you can
set for the system.
NOTE: If the IP access control is set incorrectly you may accidentally lock yourself out of IPMI. If
this happens, use the DSM CLI IPMI command; reset factorydefault.
If you want to reset your IPMI configuration to the factory defaults, use the DSM CLI command
ipmi reset factorydefault. DO NOT use the IPMI management console to reset IPMI to
factory settings. The command ipmi reset factorydefault is optimized for security, and
the IPMI management console factory reset is not. The command ipmi reset
factorydefault is more secure because it:
• Only allows access to the IPMI IP address through https.
• Disables the Dynamic Host Configuration Protocol (DHCP) so you can set the IPMI to use a
static IP address. A static IP allows administrators to create firewall rules and monitor usage of
this system.
• Sets IPMI LAN interface to Dedicated so that the IPMI must run in a dedicated IPMI-only LAN.
• Resets the IP address to the default 192.168.10.10. Username is reset to default (UserID:
ADMIN Password: ADMIN).
cold boots (power-off and power-on), and access the DSM CLI. IPMI is not supported by the
DSM virtual appliance or hardware appliances earlier than V6000/V6100.
Table 6: DSM CLI IPMI category commands
ip Set, delete, or show ip address of machine using IPMI.
user Add, show, or delete user. Also change password and privilege level.
clearint Clear chassis intrusion. If chassis cover is open, a chassis intrusion toggle is
set that shows up in the IMPI GUI sensor reading, CLI maintenance
diagnostic, and DSM log. This command resets the toggle.
selftest Triggers a test called the IPMI Baseboard Management Controller (BMC)
self-test. Use this if you suspect the IPMI controller is not working. The
BMC chip runs even when the rest of the system is down.
ip
ip set
Set the IPMI IP address. Setting the IP address automatically sets the mask to 16-bit mask.
Syntax
ip set ip_address
Example
The following example sets the IPMI network interface IP address.
0001:vormetric$ ipmi
0002:ipmi$ ip set 10.3.99.77
IP=10.3.99.77
SUCCESS: ip set
ip delete
Delete the IPMI IP address. This sets the IP to 0.0.0.0.
Syntax
ip delete
Example
The following example deletes the IPMI network interface IP address.
0002:ipmi$ ip delete
IP=0.0.0.0
SUCCESS: ip delete
ip show
Show the IPMI IP address.
Syntax
ip show
Example
The following example shows the IPMI network interface IP address.
0002:ipmi$ ip show
IP=0.0.0.0
MAC=00:25:90:F7:12:52
SUCCESS: ip show
mask
The mask command sets, deletes or shows the subnet mask for the IP address. The mask
command includes the following elements:
Table 8: DSM CLI IPMI category mask command elements
set Sets the subnet mask for the IP address.
mask set
Set the subnet mask for the IP address.
Syntax
mask set subnet_mask
Example
0001:vormetric$ ipmi
0002:ipmi$ mask set 255.255.0.0
Subnet Mask=255.255.0.0
SUCCESS: subnet mask set
mask delete
Set the subnet mask for the IP address to 0.0.0.0..
Syntax
mask delete
Example
0002:ipmi$ mask delete
Subnet Mask=0.0.0.0
SUCCESS: subnet mask delete
mask show
Show the subnet mask for the IPMI IP address.
Syntax
mask show
Example
0002:ipmi$ mask show
Subnet Mask=255.255.0.0
SUCCESS: subnet mask show
gateway
The gateway command sets the IPMI gateway. The gateway command includes the following
elements:
Table 9: DSM CLI IPMI category gateway command elements
set Sets the IPMI gateway.
gateway set
Use the gateway set command to set the IPMI IPMI gateway.
Syntax
gateway set ip_address
Example
0001:vormetric$ ipmi
0002:ipmi$ gateway set 10.10.79.254
Gateway=10.10.79.254
SUCCESS: gateway set
gateway delete
Use the gateway delete command to delete the IPMI gateway.
Syntax
gateway delete
Example
0002:ipmi$ gateway delete
Gateway=0.0.0.0
SUCCESS: gateway delete
gateway show
Use the gateway show command to show the IPMI gateway.
Syntax
gateway show
Example
0003:ipmi$ gateway show
Gateway=0.0.0.0
SUCCESS: gateway show
dhcp
Enable or disable Dynamic Host Configuration Protocol (DHCP). Forces the IPMI IP address to be
static. By default it’s off.
Syntax
dhcp show| dhcp enable| dhcp disable
Example
dhcp enable
SUCCESS: dhcp on
disable
The disable command disables the IP, and mask, setting them both to 0.0.0.0.
Syntax
disable
Example
0001:vormetric$ ipmi
0002:ipmi$ disable
Do you want to disable IPMI network? Access to IPMI will not be
available afterwards. (yes|no)[no]:yes
SUCCESS: Disable IPMI network
port
Enable, disable, or check the status of the IPMI port. The default ports are https=443,
keyboard/video/mouse (kvm)=5900, vmedia=623, web=80. IPMI users can change the port
numbers but the service will still get enabled or disabled with the same command.
Table 10: DSM CLI IPMI category port command elements
enable Enable IPMI port.
enable
Enable IPMI port.
Syntax
port enable [https | kvm | vmedia |web]
Example
0001:dsm$ ipmi
0002:ipmi$ port enable https
SUCCESS: Enable ipmi https web port
disable
Disable IPMI port.
Syntax
port disable [https | kvm | vmedia |web]
Example
0002:ipmi$ port disable https
SUCCESS: Disable ipmi https web port
• To see which ports can be configured for IPMI on the V6000/V6100 DSM hardware appliance,
see Table 14, “IPMI Ports,” on page 170.
status
Check the status or IPMI ports.
Syntax
port status [https | kvm | vmedia |web]
Example
0003:ipmi$ port status https
IPMI https web port is enabled
SUCCESS: port status https
user
The user command adds, shows, or deletes users. Also changes user password and privilege
level. See “Creating IPMI users” on page 153 for more details. The user command includes the
following elements:
Table 11: DSM CLI IPMI category user command elements
add Add an IPMI user.
user add
Add an IPMI user. After using this command, you will have created a user with no password. Use
the user password command to add a password.
Syntax
user add userID User_name privilege_level
Where,
user password
Change or add IPMI user’s password. The password constraints are as follows; 8 characters
minimum, 20 characters maximum. At least one capital letter, one number, and one special
character are also required.
Syntax
user password userID
Example
0002:ipmi$ user password 3
Enter new password:
Enter password again:
SUCCESS: user password modified
user delete
Delete user.
Syntax
user delete userID
Example
0003:ipmi$ user delete 4
user show
Use user show to show the IPMI users.
Syntax
user show
Example
0003:ipmi$ user show
User ID | User Name | Privilege Level | Enable
------- | ----------- | --------------- | ------
user level
Change IPMI user’s privilege. Don't assign administrative privileges to all users. Assign operator
or user privilege instead.
Syntax
user level userID privilege_level
Example
user level 3 3
SUCCESS: user privilege level modified
clearint
Clear chassis intrusion. When someone opens the chassis cover of the DSM, chassis intrusion
will get flagged. When the cover is put back, run clearint to clear it.
Syntax
clearint
Example
clearint
SUCCESS: Clear chassis intrusion flag
psinfo
Show power supply information. If only one power module is plugged in, the output will display
only one module.
Syntax
psinfo
Example
0001:ipmi$ psinfo
[SlaveAddress = 78h] [Module 1]
Item | Value
---- | -----
Status | [STATUS OK](00h)
AC Input Voltage | 116.5 V
AC Input Current | 0.34 A
reset
The reset command resets the IPMI configuration or resets the IPMI BMC controller. The reset
command includes the following elements:
Table 12: IPMI category reset command elements
factorydefault Reset IPMI configuration to factory default.
factorydefault
Wipe out IPMI configuration and return to IPMI factory default: ip=192.168.10.10,
mask=255.255.0.0, gateway=0.0.0.0. ADMIN will be the only user left with default password
ADMIN. All others users are deleted. Also disables DHCP and sets the IPMI to a dedicated non-
share port.
Syntax
reset factorydefault
Example
reset factorydefault
System Response
Do you want to load IPMI factory default? It takes about 100
seconds to load.
Warning: IPMI IP address will reset to default 192.168.10.10
and IPMI users will get deleted. (yes|no)[no]:
reset bmc
Reset IPMI controller. When you want to do a reboot on the IPMI BMC controller chip because the IPMI
is failing to respond, or a self-test failed, use this command to reset IPMI chip.
Syntax
reset bmc
Example
reset bmc
System Response
Do you want to reset IPMI controller? It takes about 100 seconds
to reset. (yes|no)[no]:
BMC cold reset successfully completed!
SUCCESS: Reset IPMI hardware
selftest
version
.....
This section describes all of the ports that you must configure for your appliance.
Ports to Configure
.....................................................................
The following table lists the communication direction and purpose of each port you must open.
161 TCP/UDP SNMP Manager → DSM SNMP queries from an external manager
443 TCP Browser → DSM Redirects to either port 8445 or 8448 depending on the
DSM↔ DSM security mode. (8445 is used in compatible & RSA modes;
8448 is used in Suite B mode, for secure communication
Agent → DSM between DSMs in an HA cluster and for LDT registration.)
5696 TCP KMIP client → DSM Allows communication between the KMIP client and
primary DSM
7025 TCP/UDP DSM ↔ DSM Uses SNMP to get HA node response time.
8080 TCP Agent → DSM Port 8080 is no longer used for registration, but you can
DSM ↔ DSM manually close/open this legacy port for new deployment,
for backward compatibility if you use previous versions of
the agent and need to register to 8080. Default is on (open).
Syntax
0001:system$ security legacyregistration
[ on | off | show ]
8443 TCP Agent → DSM Fallback RSA TCP/IP port through which the agent
communicates with the DSM, in case 8446 is blocked. The
agent establishes a secure connection to the DSM, through
certificate exchange, using this port.
8444 TCP Agent → DSM Fallback RSA port via which the Agent log messages are
uploaded to DSM, in case 8447 is blocked.
8445 TCP Browser → DSM Management Console, VMSSC, and fall back for HA
DSM ↔ DSM (fall back) communication in case port 8448 is dropped.
8446 TCP Agent → DSM Configuration Exchange using Elliptic Curve Cryptography
(Suite B)
8447 TCP Agent → DSM Agent uploads log messages to DSM using Elliptic Curve
Cryptography (ECC)
8448 TCP Browser → DSM GUI Management during enhanced security using Elliptic
DSM ↔ DSM Curve Cryptography (Suite B). Also for secure
communication between DSMs in an HA cluster. Also used
Agent → DSM for communication between host with LDT host and DSM
during Agent registration.
9004 TCP DSM↔ network HSM DSM communication with nShield Connect and its
associated RFS
9005 TCP DSM↔ remote admin Used by Remote Administration Service process to accept
connections from the Remote Administration Client.
IPMI Ports
.....................................................................
The following table lists all of the IPMI ports that you can configure.
Communication
Port Protocol Purpose
Direction
80 TCP Browser → IPMI This port is disabled by default, for security reasons, and
should not be used.
443 TCP Browser → IPMI This port is enabled by default. It is used for the IPMI GUI. If
you change the port through which you access IPMI through
your browser (“Change the port through which you
access IPMI” on page 152).
5900 TCP Browser → DSM This port is disabled by default. It is used for remote KVM
(Keyboard Video Mouse) management. It should be disabled
when not in use for security reasons.
623 UDP Browser → DSM This port is disabled by default. Enable only if you want to
attach virtual media. It should be disabled when not in use for
security reasons.
.....
This section describes all of the supported Bonding Driver modes.
.....
This section describes some troubleshooting procedures for your appliance.
It contains the following sections:
• “Loss of Connection” on page 173
• “Reset DSM Appliance and Remove All Data” on page 174
• “Chassis Issues” on page 179
• “Indicator Definitions” on page 180
• “Boot-Up Messages” on page 180
Loss of Connection
.....................................................................
If you have created GuardPoints and for some reason the appliance cannot be reached, the
GuardPoints will continue to function with no issues. However, if the system is rebooted, the
agent cannot access its configuration from the appliance and the GuardPoints cannot use the
encryption key to encrypt or decrypt data, unless you are using a cached-on-host key. Challenge
and response and manual passwords are good way to provide business continuity in these
situations.
1. Try to open a web browser with the correct address to the appliance (example:
https://192.168.10.11:8445 or 8448 for Suite B mode).
2. Check if the appliance is a trusted site in your web browser’s Security Options.
1. Use the Network Diagnostic checkport tool in the Management Console (or CLI) to check those
ports.
2. Refer to the DSM Installation and Configuration guide for information about ports that need to
be configured.
!
Caution: If you choose to create a new Security World, we strongly recommend that
you use a new set of cards (ACS) to create the new Security World. If you reuse the
original ACS to create the new Security World, the cards will be overwritten. Any
backups created with that original ACS will be unrecoverable.
To reset the current DSM installation to its initial unconfigured state—network configuration
remains intact—and retrieve the original security world, do the following;
1. Log on to the DSM CLI console using the CLI Administrator credentials.
2. To enter the maintenance menu, type:
$ maintenance
System Response
Reset configuration will wipe out all the configuration data and
set the configuration data to the manufacture default. System
will reboot automatically.
Continue? (yes|no)[no]:yes
config reset SUCCESS. You can reboot the Security Server now or
it will reboot automatically in 60 seconds.
0002:maintenance$
You will need to generate the DSM certificate authority (CA) again. This will require a quorum
from the original ACS used to create the Security World. Wait until the system has rebooted
and the vormetric$ prompt is displayed, then run the security genca command.
System Response
WARNING: All Agents and Peer node certificates will need to be
re-signed after CA and server certificate regenerated, and the
security server software will be restarted automatically!
Continue? (yes|no)[no]:yes
4. The following message displays. Read it, enter the required information to generate the CA, and
ensure the DSM host name is correct, press enter:
This node may have multiple IP addresses. All the agents will
have to connect to Security Server using same IP.
Enter the host name of this node. This will be used by Agents to
talk to this Security Server.
This Security Server host name[mycompany.com]:
Please enter the following information for key and certificate
generation.
What is the name of your organizational unit? []:
What is the name of your organization? []:
What is the name of your City or Locality? []:
What is the name of your State or Province? []:
What is your two-letter country code? [US]:
Regenerating the CA and server certificates now...
5. A message displays informing you that a Security World exists and provides you with the option
to reuse it. This is the Security World in place when the config reset command was run.
Type yes to reuse the existing Security World. Keep the quorum of cards from the ACS used to
create this original Security World available as these will be required for the next few steps.
Follow the instructions on the screen:
There is an existing Security World.
Would you like to reuse it? (yes|no)[no]: yes
Please provide a quorum of cards from the ACS of the existing
Security World.
15:47:02 WARNING: Module #1: preemptively erasing module to see
its slots!
Indoctrinating Module:
Module 1: 0 cards of 1 read
Module 1 slot 0: empty
Module 1 slot 2: empty
Module 1 slot 3: empty
Card reading complete.
security world loaded on 1 module; hknso =
3546197a6456c5e3bfb28d7facd063072b7a8f52
Do NOT remove the smart card from the reader yet.
Creating CA keys and signer certificates...
done.
Generating server private key...
done.
You may now remove the smart card from the reader.
Creating and signing the server certificates...
done.
CA and Server certificates have been generated successfully.
JBoss vault keystore password have been completed successfully.
Self test in progress: passed
SUCCESS: The CA and security certificates are re-generated and
the Security Server software is restarted.
To reset the current DSM installation to its initial unconfigured state—network configuration
remains intact—and create a new Security World, do the following;
1. Log on to the DSM CLI console using the CLI Administrator credentials.
2. Enter the maintenance category of commands
0001:dsm $ maintenance
Reset configuration will wipe out all the configuration data and
set the configuration data to the manufacture default. System
will reboot automatically.
Continue? (yes|no)[no]:yes
Config reset SUCCESS. You can reboot the Security Server now or
it will reboot automatically in 60 seconds.
4. You will need to generate the DSM certificate authority (CA) again. This will require a quorum
from the original ACS used to create the Security World.
5. Wait until the system has rebooted. Type up at the prompt to return to the main menu.
6. Type system to access the System category sub-menu.
7. To generate the CA, type:
0004:system$ security genca
System Response
WARNING: All Agents and Peer node certificates will need to be
re-signed after CA and server certificate regenerated, and the
security server software will be restarted automatically!
Continue? (yes|no)[no]:yes
8. Read the message and enter the required information to generate the CA. Ensure the DSM host
name is correct, press Enter:
9. A message displays informing you that a Security World exists and provides you the option to
reuse it. This is the Security World in place at the when the config reset command was run.
Type no to destroy the old Security World and create a new Security World. Have the new set of
cards available for this step. For information about the ACS and best practices, refer to the
Administrative Card Set section in chapter 1 of the DSM Installation and Configuration Guide.
Follow the instructions on the screen.
There is an existing Security World.
Would you like to reuse it? (yes|no)[no]: no
Enter the total number of cards (N) you would like to use in your
Administrator Card Set (ACS).
Note: The system can handle at most 64 cards but you should not
enter more than the number of available cards in your possession
currently.
This value must be at least 2 and no higher than 64: 2
Enter the number of cards (K) required to authorize an action.
This number K is known as the quorum.
Note: The value for K must be less than N. Creating card sets in
which K is equal to N is not allowed because an error on one card
would render the whole card set unusable.
This value must be at least 1 and less than 2: 1
17:10:29 WARNING: Module #1: preemptively erasing module to see
its slots!
Create Security World:
Module 1: 0 cards of 2 written
Module 1 slot 0: empty
Module 1 slot 2: empty
Module 1 slot 3: empty
Module 1 slot 4: empty
Module 1 slot 5: empty
.
.
.
Module 1 slot 2:- no passphrase specified - overwriting card
Module 1: 1 card of 2 written
Module 1 slot 2: remove already-written card #1
Module 1 slot 2: empty
Module 1 slot 2: unknown card
Module 1 slot 2:- no passphrase specified - overwriting card
Card writing complete.
security world generated on module #0; hknso =
781eb7d9ae3abad631bfc4c7487279eadbcef4a8
Do NOT remove the smart card from the reader yet.
Creating CA keys and signer certificates...
done.
!
Caution: Restoring a backup of the previous configuration will restore the old
Security World and the new one just created will be destroyed.
Chassis Issues
.....................................................................
If the Chassis intrusion message indicates that the unit’s lid is open, try the following
solutions:
In the CLI, try to clear the chassis intrusion:
1. Log on to the CLI menu for the DSM.
2. Change to the IPMI menu, type:
$ IPMI
4. If you are logged into the system with root access and you are not in the CLI menu, type:
# /usr/sbin/sdt -r "chassis intrusion”
Indicator Definitions
.....................................................................
Table 16: HSM Status Led Indicators
LED Status Description
Off Power off
On, blinks occasionally Operational mode
Flashes two short pulses, followed by a short pause Initialization mode
Flashes two long pulses, followed by a pause Maintenance mode
Flashes SOS, the Morse code distress code (three short pulses, Error mode: For example, the Morse codes for
three long pulses, three short pulses). After flashing SOS, the temperature error is as followed.
status LED flashes an error code in Morse code
3 Fast Flashes
3 Slow Fashes
3 Fast Flashes
1 Medium Flash
Boot-Up Messages
.....................................................................
• If the following message is observed during boot-up, it means the following.
i8042: No controller found
This message is not an error and can be safely ignored. It is normal during boot up. This occurs
because the DSM does not have a PS/2 keyboard attached. This is not a hardware failure so DOES
NOT require an RMA.
“Some configured disks have been removed from your system, or are no
longer accessible. Please check your cables and also ensure that all
disks are present.
Contact Technical Support if you see this message and arrange a RMA.
Boot-up Issues
If the DSM has boot-up issues, capture the boot-up logs through the IMPI port and provide
them to the Thales technical support team.
Once the IPMI has been configured on the DSM, there is a feature for recording the boot-up
sequence for troubleshooting.
1. Make sure that the iKVM port is enabled.
You can enable iKVM either through the CLI command or through the IPMI GUI.
2. Open the remote control and you will see the iKVM console.
3. There is a Record option to record the virtual screen. The recording length is limited but you can
select low video resolution, like 800x600, to increase recording time length. This is very useful
for troubleshooting boot failures.
admin administrator
The default DSM administrator created when you install the DSM. Admin has DSM System Administrator
privileges and cannot be deleted.
Administrative Domain
(domains). A protected host or group of protected hosts on which an DSM administrator can perform security
tasks such as setting policies. Only DSM administrators assigned to a domain can perform security tasks on the
protected hosts in that domain. The type of VTE tasks that can be performed depends on the type of
administrator. See also “local domain”.
administrator
See “DSM Administrator and types”.
Agent utilities
A set of utilities installed with the VTE agents and run on protected hosts. These utilities provide a variety of
useful functions such as gathering protected host and agent configuration data, registering agents on the
DSM, and encrypting data on the protected host.
appliance
The DSM server. Often referred to as a DSM hardware appliance, which is a hardened DSM server provided by
Vormetric, or as a DSM virtual appliance, which is the software version of the DSM to be deployed by the
customers as a virtual machine.
authentication
A process that establishes the origin of information, or determines the legitimacy of an entity's identity.
authorization
Access privileges granted to an entity that convey an “official” sanction to perform a security function or
activity.
block devices
Devices that move data in and out by buffering in the form of blocks for each input/output operation.
catch-all rule
The last policy rule that applies to any GuardPoint access attempt that did not fit any of the other rules in the
policy.
certification authority or CA
A trusted third party that issues digital certificates that allow a person, computer, or organization to exchange
information over the Internet using the public key infrastructure. A digital certificate provides identifying
information, cannot be forged, and can be verified because it was issued by an official trusted agency. The
certificate contains the name of the certificate holder, a serial number, expiration dates, a copy of the
certificate holder's public key (used for encrypting messages and digital signatures) and the digital signature of
the certificate-issuing authority (CA) so that a recipient can verify that the certificate is real. This allows others
to rely upon signatures or assertions made by the private key that corresponds to the public key that is
certified. The CA must be trusted by both the owner of the certificate and the party relying upon the
certificate.
challenge-response
When a protected host is disconnected from the DSM, the GuardPoint data is not accessible to users.
Challenge-response is a password-based procedure that allows users to gain access to their GuardPoint data
during disconnection. Users run a utility, vmsec challenge, a seemingly random string (the challenge) is
displayed. The user calls this in to their DSM Security administrator. The administrator returns a counter-string
(the response) that the host user must enter to decrypt guarded data.
Character device
See “raw device.”
ciphertext
Data in its encrypted form. Ciphertext is the result of encryption performed on plaintext using an algorithm,
called a cipher.
cleartext or plaintext
Data in its unencrypted form.
cryptographic algorithm
A computational procedure that takes variable inputs, including a cryptographic key, and produces ciphertext
output. Also called a cipher. Examples of cryptographic algorithms include AES, ARIA, and DES.
cryptographic key
See “encryption key.”
cryptographic signature
See “signing files.”
dataxform
A utility to encrypt data in a directory. Short for “data transform.”
DB2
A relational model database server developed by IBM.
Decryption
The process of changing ciphertext into plaintext using a cryptographic algorithm and key.
Digital signature
A cryptographic transformation of data that provides the services of origin authentication, data integrity, and
signer non-repudiation.
domains
See administrative domains.
Domain Administrator
The second-level DSM administrator created by a DSM System Administrator. The DSM Domain Administrator
creates and assigns DSM Security Administrators to domains and assigns them their security “roles”. See “DSM
Administrator and types”.
DSM
See “Data Security Manager (DSM).”
DSM System Administrator - Creates/removes other DSM administrators of any type, changes their
passwords, creates/removes, domains, assigns a Domain Administrator to each domain. Cannot do any
security procedures in any domain.
Domain Administrator - Adds/removes DSM Security Administrators to domains, and assign roles to each
one. Cannot remove domains and cannot do any of the domain security roles.
Security Administrator - Performs the data protection work specified by their roles. Different roles enable
them to create policies, configure hosts, audit data usage patterns, apply GuardPoints, and so on.
Domain and Security Administrator - Can do the tasks of DSM Domain and Security Administrators.
All - Can do the tasks of all three of the DSM administrative types
DSM CLI
A command line interface executed on the DSM to configure the DSM network and perform other system-
level tasks. See the DSM Command Line Interface documentation
DSM database
A database associated with the DMS containing the names of protected hosts, policies, GuardPoints, settings,
and so on.
EKM
See “Extensible Key Management (EKM).”
Encryption
The process of changing plaintext into ciphertext using a cryptographic algorithm and key.
encryption agent
See Vormetric Transparent Encryption agent.
encryption key
A piece of information used in conjunction with a cryptographic algorithm that transforms plaintext into
ciphertext, or vice versa during decryption. Can also be used to encrypt digital signatures or encryption keys
themselves. An entity with knowledge of the key can reproduce or reverse the operation, while an entity
without knowledge of the key cannot. Any VDS policy that encrypts GuardPoint data requires an encryption
key.
failover DSM
A secondary DSM that assumes the policy and key management load when a protected host cannot connect to
the primary DSM or when a protected host is specifically assigned to the failover DSM. A failover DSM is
almost identical to the primary DSM, having the same keys, policies, protected hosts, and so on.
FF1
See “Format Preserving Encryption (FPE)”.
FF3
See “Format Preserving Encryption (FPE)”.
file signing
See signing files.
FKEK
See “File Key Encryption Key (FKEK)”
FQDN
Fully qualified domain name. A domain name that specifies its exact location in the tree hierarchy of the
Domain Name Server (DNS). For example: example.vormetric.com.
GPFS
General Parallel File System is a high-performance shared-disk clustered file system developed by IBM.
GuardPoint
A location in the file system hierarchy, usually a directory, where everything underneath has a Vormetric data
protection policy applied to it. The File System Agent intercepts any attempt to access anything in the
GuardPoint and uses policies obtained from the DSM to grant or deny the access attempt. Usually, depending
on the policies, data copied into a GuardPoint is encrypted, and only authorized users can decrypt and use that
GuardPoint data.
host locks
Two Management Console options, FS Agent Locked and System Locked, that are used to protect the File
System Agent and certain system files. File System Agent protection includes preventing some changes to the
File System Agent installation directory and preventing the unauthorized termination of File System Agent
processes.
host password
This is not a regular login or user password. This is the password entered by a host system user to unlock a
GuardPoint when there is no DSM connection. This password decrypts cached keys when the DSM is not
accessible. The host must also be configured with Cached on Host keys. See “challenge-response”.
After enough data is collected, the DSM Security Administrator can modify the initial test policy into an
operational policy.
Key Agent
A Vormetric agent that provides an API library supporting a subset of the PKCS#11 standard for key
management and cryptographic operations. It is required for the following products: Vormetric Key
Management (VKM), Vormetric Tokenization, Vormetric Application Encryption (VAE), Vormetric Cloud
Encryption Gateway (VCEG). Sometimes called the VAE Agent.
key group
A key group is a collection of asymmetric keys that are applied as a single unit to a policy.
key management
The management of cryptographic keys and other related security objects (for example, passwords) during
their entire life cycle, including their generation, storage, establishment, entry and output, and destruction.
key template
A template that lets you quickly add agent keys or third-party vault keys by specifying a template with
predefined attributes. You can define specific attributes in a template, then you can call up the template to
add a key with those attributes.
key shares
When data is backed up or exported from VTE (for example, symmetric keys or DSM database backups), they
can be encrypted in a wrapper key needed to restore the exported data on the new machine. Wrapper keys
can be split and distributed to multiple individuals. Each split piece of the wrapper key is called a key share.
Decrypting the data requires that some specified number of the individuals that received key shares
contribute their key share to decrypt the data.
key wrapping
A class of symmetric encryption algorithms designed to encapsulate (encrypt) cryptographic key material. The
key wrap algorithms are intended for applications such as protecting keys while in untrusted storage or
transmitting keys over untrusted communications networks. Wrapper keys can be broken up into key shares,
which are pieces of a wrapper key. Key shares are divided amongst two or more custodians such that each
custodian must contribute their key share in order to assemble a complete wrapper key.
Key Vault
A Vormetric product that provides passive key vaulting. It securely stores symmetric and asymmetric
encryption keys from any application and tracks key expiration dates.
KMIP
Key Management Interoperability Protocol. A protocol for communication between enterprise key
management systems and encryption systems. A KMIP-enabled device or client software can communicate
with the DSM to manage encrypted keys.
Learn Mode
A DSM operational mode in which all actions that would have been denied are instead permitted. This permits
a policy to be tested without actually denying access to resources. In the Learn Mode, all GuardPoint access
attempts that would have been denied are instead permitted. These GuardPoint accesses are logged to assist
in tuning and troubleshooting policies.
local domain
A DSM domain in which DSM administration is restricted to Domain Administrators or Security Administrators
assigned to that domain. To access a local domain in the Management Console, a DSM administrator must
specify their local domain upon login.
Management Console
The graphical user interface (GUI) to the DSM.
MEK
See Master encryption key.
multi-factor authentication
An authentication algorithm that requires at least two of the three following authentication factors:
1) something the user knows (for example, password); 2) something the user has (example: RSA SecurID); and
3) something the user is (example: fingerprint). VTE implements an optional form of multi-factor
authentication for Management Console users by requiring DSM administrators to enter the token code
displayed on an RSA SecurID, along with the administrator name each time the administrator logs on to the
Management Console.
multitenancy
A VTE feature that enables the creation of multiple local domains within a single DSM. A local domain is a DSM
domain in which DSM administration is restricted to Domain Administrators or Security Administrators
assigned to that domain. This allows Cloud Service Providers to provide their customers with VTE
administrative domains over which the customer has total control of data security. No other administrators,
including CSP administrators, have access to VTE security in a local domain.
offline policy
Policies for Database Backup Agents. Online policies are for the File System Agent.
one-way communication
A VTE feature for an environment where the DSM cannot establish a connection to the agent, but the agent
can establish a connection to the DSM. For example, the protected host is behind a NAT so protected host
ports are not directly visible from the DSM, or the protected host is behind a firewall that prohibits incoming
connections, or the protected host does not have a fixed IP address as in the cloud. When an agent is
registered with one-way communication, changes made for that protected host on the DSM are not pushed to
the protected host, rather as the protected host polls the DSM it will retrieve the change.
online policies
Policies for the File System Agent. Offline policies are for Database Backup Agents.
policy
A set of security access and encryption rules that specify who can access which files with what executable
during what times, and whether or not those files are encrypted. Policies are created by DSM Security
Administrators, stored in the DSM, and implemented on protected hosts by a File system Agent. See “rule (for
policies)”.
policy tuning
The process of creating a simple Learn Mode policy that allows any protected host user to access a
GuardPoint; to examine who accesses the GuardPoint, what executables they use, and what actions they
require; and to modify the policy such that it allows the right people, using the right executable, performing
the right action to do their job, and prevent anyone else from inappropriate access.
process set
A list of processes that can be used by the users in a user set associated with a policy rule.
protected host
A host on which a VTE Agent is installed to protect that host’s data.
raw device
A type of block device that performs input/output operations without caching or buffering. This results in
more direct access.
register host
The process of enabling communication between a protected host and the DSM. Registration happens during
agent installation. Before registration can happen, the host must be added to the DSM database.
rekeying
The process of changing the encryption keys used to encrypt data. Changing keys enhances data security and
is a requirement to maintain compliance with some data security guidelines and regulations. Also called key
rotation.
roles
A set of Management Console permissions assigned to DSM Security Administrators by DSM Domain
Administrators. There are five roles: Audit (can generate and view logging data for file accesses), key (can
create, edit, and delete keys), Policy (can create, edit, and delete policies), Host (can configure, modify, and
delete protected hosts and protected host groups), and Challenge & Response (can generate a temporary
password to give to a protected host user to decrypt cached encryption keys when connection to the DSM is
broken).
RSA SecurID
A hardware authentication token that is assigned to a computer user and that generates an authentication
code at fixed intervals (usually 60 seconds). In addition to entering a static password, Management Console
administrators can be required to input an 8-digit number that is provided by an external electronic device or
software.
secfs
1) The File System Agent initialization script. 2) An acronym for Vormetric Secure File System agent. It
generally refers to the kernel module that handles policies (locks, protected host settings, logging preferences)
and keys, and enforces data security protection.
secvm
A proprietary device driver that supports GuardPoint protection to raw devices. secvm is inserted in between
the device driver and the device itself.
Security Administrator
The third-level DSM administrator who does most of data protection work like creating policies, configuring
protected hosts, auditing data usage patterns, applying GuardPoints and other duties. The privileges of each
Security Administrator is specified by the roles assigned to them by the Domain Administrator. See roles. See
“DSM Administrator and types”.
Security Server
See “DSM”.
separation of duties
A method of increasing data security by creating customized DSM administrator roles for individual DSM
administrators such that no one administrator has complete access to all encryption keys in all domains of all
files.
signing files
File signing is a method that VTE uses to check the integrity of executables and applications before they are
allowed to access GuardPoint data. If file signing is initiated in the Management Console, the File System
Agent calculates the cryptographic signatures of the executables that are eligible to access GuardPoint data. A
tampered executable, such as a Trojan application, malicious code, or rogue process, with a missing or
mismatched signature, is denied access. Also called cryptographic signatures.
Suite B mode
A set of publicly available cryptographic algorithms approved by the United States National Security Agency
(NSA). These algorithms enhance security by adding up to 384-bit encryption to the communication between
the Web browser and the DSM, the DSM and Agent, and between DSMs in HA environments.
Symmetric-key algorithm
Cryptographic algorithms that use the same cryptographic keys for both encryption of plaintext and
decryption of ciphertext. The keys, in practice, represent a shared secret between two or more parties that
can be used to maintain a private information link. This requirement that both parties have access to the
secret key is one of the main drawbacks of symmetric key encryption, in comparison to public-key encryption.
user set
A named list of users on which a policy rule applies.
VAE Agent
See “Key Agent”.
vmd
Acronym for Vormetric Daemon, vmd is a process that supports communication between the DSM and kernel
module.
Gateway (VCEG), Vormetric Tokenization Server (VTS), Vormetric Key Management (VKM), and Vormetric
Protection for Teradata Database—are based.
Vormetric Vault
A virtual vault to store 3rd-party encryption keys, certificates and other security objects.
VTE Agent
Vormetric agents that are installed on protected hosts to implement data protection. See “File System Agent”.
wrapper keys
See “key wrapping”.
WSDL
Web Services Description Language.