Gateway Operations Guide
Gateway Operations Guide
Release 1.02
Operations Guide
P/N 300-007-929
REV A01
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Copyright © 2005-2008 EMC Corporation. All rights reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is
subject to change without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO
REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS
PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable
software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their respective owners.
For the most up-to-date regulatory document for your product line, go to the Document/Whitepaper Library
on EMC Powerlink.
Preface
Introduction
ESRS Gateway architecture ............................................................. 18
Gateway server agent................................................................ 19
Gateway to EMC communication ........................................... 19
Responsibilities for the ESRS Gateway components ................... 23
Customer..................................................................................... 23
EMC Global Services ................................................................. 23
ESRS Gateway components............................................................. 24
Gateway server .......................................................................... 24
Policy Manager .......................................................................... 25
ESRS Gateway installation .............................................................. 29
High-availability installation ................................................... 29
Deployment Utility.................................................................... 29
Gateway Extract utility (GWExt)............................................. 30
Target device management....................................................... 31
PART 4 Appendixes
Appendix C Troubleshooting
Symptoms ........................................................................................ 194
Service behavior....................................................................... 194
OS and hardware failures....................................................... 194
Index
Title Page
1 Gateway architecture..................................................................................... 18
2 Heartbeat communication............................................................................. 20
3 Remote notification communication ........................................................... 21
4 Remote access communication..................................................................... 22
5 Policy Management settings......................................................................... 26
6 Pending request.............................................................................................. 27
7 Audit log sample ............................................................................................ 28
8 Default SMTP Properties............................................................................... 46
9 Default SMTP Message tab ........................................................................... 46
10 E-mail server specification ............................................................................ 47
11 Mail drop specification.................................................................................. 48
12 E-mail server test ............................................................................................ 49
13 Mail drop directory messages ...................................................................... 50
14 Sample e-mail.................................................................................................. 51
15 Windows Component Wizard ..................................................................... 57
16 Files Needed dialog box ................................................................................ 58
17 Inetpub directory............................................................................................ 59
18 Directory structure ......................................................................................... 60
19 My Computer > Manage ............................................................................... 60
20 Computer Management > Services and Applications .............................. 61
21 Rename FTP site ............................................................................................. 62
22 FTP Site IP address selection ........................................................................ 62
23 Allow anonymous connections checkbox cleared..................................... 62
24 IIS Manager data encryption warning ........................................................ 63
25 Messages tab ................................................................................................... 63
26 Inetpub path.................................................................................................... 64
27 Default SMTP Properties............................................................................... 65
28 Default SMTP Message Tab.......................................................................... 65
29 Email server specification ............................................................................. 66
30 Mail drop specification.................................................................................. 66
Title Page
1 Gateway server standard configuration requirements.............................. 40
2 GatewayCheck system requirements ........................................................... 77
3 GatewayCheck installed files ........................................................................ 78
4 GatewayCheck test failure resolution .......................................................... 94
5 Policy settings ................................................................................................ 120
6 Actions (Global group default set) ............................................................. 120
7 Access right descriptions.............................................................................. 124
8 Substitution parameters for notifications .................................................. 132
9 Policy Manager database files ..................................................................... 151
10 Backup/Restore scripts ................................................................................ 152
11 Keystore attributes ........................................................................................ 168
12 Actions defined by Gateway solution ........................................................ 176
13 Gateway default permissions ...................................................................... 179
14 Gateway Device default permissions......................................................... 180
15 Celerra default permissions......................................................................... 182
16 EMC Centera default permissions .............................................................. 183
17 CLARiiON default permissions .................................................................. 184
18 Connectrix default permissions .................................................................. 185
19 ControlCenter default permissions ............................................................ 186
20 EDL default permissions.............................................................................. 187
21 Invista default permissions.......................................................................... 188
22 Switch-Brocade-B default permissions ...................................................... 189
23 Switch-Cisco default permissions............................................................... 190
24 Symmetrix default permissions .................................................................. 191
Audience This guide is a part of the EMC Secure Remote Support Gateway
release 1.02 documentation set, and is intended for use by device
policy administrators.
Readers of this guide are expected to be familiar with the following
topics:
◆ The EMC Secure Remote Support Gateway system
◆ EMC storage products
Conventions used in EMC uses the following conventions for notes, cautions, warnings,
this guide and danger notices.
Note: A note presents information that is important, but not hazard-related.
! CAUTION
A caution contains information essential to avoid a hazard that will
or can cause minor personal or property damage if you ignore the
warning.
Where to get help EMC support, product and licensing information can be obtained as
follows.
Product information — For documentation, release notes, software
updates, or for information about EMC products, licensing, and
service, go to the EMC Powerlink website (registration required) at:
http://Powerlink.EMC.com
Your comments Your suggestions will help us continue to improve the accuracy,
organization, and overall quality of the user publications. Please send
your opinion of this guide to:
RemoteToolDocs@EMC.com
Introduction
Introduction 17
Introduction
EMC DRM
firewall application
servers
Policy Manager
EMC
Centera Connectrix Gateway Proxy server External EMC
(optional) firewall firewall
Symmetrix Public
Internet
(https)
Application
bridge servers
SB14
SB15
SB12
SB13
SB10
SB11
Security Web/access
SB8
SB9
SB6
SB7
Authority aervers
SB4
SB5
SB2
SB3
SB0
SB1
Celerra CLARiiON
Gateway environment
GEN-000818
Gateway server The Gateway server agent is an HTTP handler. The agent functions as
agent the communications broker between the Gateway-managed devices,
the Policy Manager, and the EMC® Device Relationship Manager
(DRM). All messages are encoded using standard XML and SOAP
application protocols. Agent message types include:
◆ Device state heartbeat polling
◆ Data file transfer
◆ Remote access session initiation
◆ User authentication requests
◆ Device management synchronization
The Gateway agent acts as a proxy, carrying information to and from
the Gateway-managed devices. To maximize remote support
availability, EMC configures the Gateway agent to employ built-in
failover to redundant EMC remote-support enterprise systems in the
event that access to the primary site is unavailable. The Gateway
agent can also queue session requests in the event of a temporary
local network failure.
Network traffic can be configured to route from the Gateway through
proxy servers to the Internet. Such configurations include support for
auto-configuration, HTTP, and SOCKS proxy standards. The agent
does not have its own user interface application. All agent actions are
logged to a local runtime file.
Gateway to EMC All communication between the customer’s site and EMC is initiated
communication by the Gateway server agent at the customer’s site. Using industry
standard Secure Sockets Layer (SSL) encryption over the Internet and
EMC-signed digital certificate authentication, the Gateway creates a
communication tunnel.
The Secure Remote Support Gateway uses industry-accepted
bilateral authentication for the EMC servers and the Gateway Agent.
Each Gateway has a unique digital certificate that is verified by EMC
whenever a Gateway makes a connection attempt. The Gateway then
verifies EMC's server certificate. Only when the mutual SSL
authentication passes and the client and server negotiate a shared
secret does the Gateway transmit messages to EMC, securing the
connection against spoofing and man-in-the-middle attacks.
The Secure Remote Support Gateway uses the SSL tunnel to EMC to
perform three different functions: Heartbeat polling, remote
notification and remote access. Each relies on the SSL tunnel, but
communication processes and protocols within the tunnel vary by
function. Each is discussed in the following sections.
Secure Remote
Support Gateway
Remote notification The Gateway also serves as a conduit for EMC products to send
remote notification event files to EMC. EMC hardware platforms use
remote notification for several different purposes. Errors, warning
conditions, health reports, configuration data, and script execution
statuses may be sent to EMC. Figure 3 on page 21 is an illustration of
the remote notification communication paths.
Secure Remote
Support Gateway
Remote access To establish a remote access session, the Secure Remote Support
Gateway uses asynchronous messaging to ensure that all
communication is initiated from the customer’s site. After being
properly authenticated at EMC, a support professional makes a
request to access a Gateway-managed device. The remote access
session request includes a unique identifier for the user, the serial
number of the target device, and the remote application he or she
wants to run on that device and optionally the Service Request being
used to generate the request. This request is queued at EMC until the
Gateway that manages the device in question heartbeats home.
In response to the Heartbeat message, the EMC DRM sends a special
status in the SOAP response. This response contains the request
information as well as an address and an access server session to
which the Gateway would connect. The Gateway uses its local
repository to determine the local IP address of the end device, checks
with the Policy Manager to see if the connection is permitted, and if
approved, establishes a separate SSL connection to the access servers
for the specific remote access session. This secure session allows IP
traffic from the EMC internal service person to be routed through the
Secure Remote
Support Gateway
Policy Manager Using the Policy Manager, you control the authorization
requirements for remote access connections, file transfers, service
notification processes, diagnostic script executions, and other
Gateway-related activities, as shown in Figure 5 on page 26. The
Policy Manager allows you to set authorization permissions for target
devices or groups of target devices being managed by the Gateway
system and provides these permissions to the Gateway system
during polling by the Gateway server, and records all requests and
actions in local log files. When a request arrives at the Gateway server
for remote device access, the access is controlled by the Gateway
enforcing the policy from the Policy Manager.
Policy Manager permissions can be assigned in a hierarchical system,
establishing policies based on model and product groups. If required,
you can override group-level permissions down to the individual
device level.
When you set an authorization rule to Ask for Approval, the Policy
Manager sends an email message to your designated address upon
each action request, per transaction. This email message contains the
action request itself and the user ID of the EMC Customer Service
representative requesting permission to perform the action. You use
the Policy Manager interface to accept or deny the requested action.
Figure 6 on page 27 provides an example.
Logging The Policy Manager logs all remote support events. Remote access
connections, diagnostic script executions, and support file transfer
operations are stored in the audit log files. The Policy Manager also
logs all authorization activity and policy changes. The audit log files
can be viewed through the Policy Manager interface. All log files are
controlled and managed by you to enable auditing of remote support
connections executed by EMC. Figure 7 on page 28 provides a sample
audit log.
Device control The Gateway solution proactively monitors, alerts, and notifies the
EMC Customer Support Center when the Gateway server or any
Gateway-managed device fails to communicate back to EMC
regularly. EMC alerts you of potential failures or issues that may
affect EMC's ability to provide timely support. As an EMC customer,
you are in complete control over which devices are included in your
Gateway device management system, and you can phase them in by
product line. EMC provides applications to assist you in automating
the addition of new devices to the Gateway management. All device
management operations are logged and must be performed by
authorized EMC Customer Service professionals using EMC-issued
RSA SecurID Authenticators.
Gateway Extract To configure a device for management, the EMC Customer Service
utility (GWExt) representative on site must know the following for each managed
device: serial number, EMC site identification number, product type,
and an IP address that can be used to access the device. The Gateway
Device Extract utility (GWExt.exe), when run on the EMC device,
automates the collection of this information and transports it to the
Gateway server. EMC supplies three versions of the GWExt utility
When running the GWExt utility, the GWExt utility first requests the
Gateway server IP address and EMC site identification number. It
then extracts the serial number and local IP address from the target,
creates a configuration file, and FTPs the file back to the Gateway
server.
The configuration files, for all devices that have used the GWext
utility, reside on the Gateway server until processed through the
Deployment Utility's Managed Devices option.
Target device Devices are added to the list of managed target devices (EMC storage
management products and select switches) in the Gateway system by using the
Deployment Utility.
from the Gateway server and is not translated (NAT'd). For example,
the local IP address of a device is 144.10.10.3, and is only on your
internal network. Also, you are using NAT (or a NAT device) that
maps the device IP (144.10.10.3) to IP 10.10.44.22 so that the device
can be reached from within your DMZ. In this case, EMC must use
the NAT IP address of 10.10.44.22 to reach the device, and in the
Deployment Utility the IP address field must be changed to
10.10.44.22.
The final portion of the deployment process requires a validation that
a device is successfully added to the configuration in the EMC DRM
system. The Deployment Utility adds the matched device to the
current managed device list and makes the device available for
remote access. If the serial number or Party ID for a newly integrated
device does not match the EMC Customer Service registered device
lists for your site, the Deployment Utility catalogues the device under
a UI tab labeled unresolved. This indicates that the device failed
registration, and it needs to be reconciled with the serial number of
the device on record with EMC Customer Service. Until full
reconciliation is achieved, the device is not accessible for remote
support by the Gateway. The Deployment Utility is also used to edit
the IP address of a device if it has been changed.
In the event you want to unmanage a device or otherwise no longer
require it to be accessible, it can be removed from the list of managed
devices by an authorized EMC Customer Service representative
through the device management menu within the Deployment
Utility. This menu selection sends a message to the EMC DRM system
to logically disassociate this serial number from your Gateway
system.
Digital Certificate During the site Gateway server installation, digital certificates are
Management (DCM) registered on the server. This procedure can only be performed by
EMC Customer Service professionals using EMC-issued RSA
SecurID Authenticators. All certificate usage is protected by unique
password encryption. Any message received by the Gateway server,
whether pre- or post-registration, requires entity-validation
authentication.
DCM automates Gateway digital certificate enrollment by taking
advantage of EMC's existing network authentication systems, which
use the RSA SecurID Authenticator and the EMC local certificate
authority (CA). Working with EMC systems and data sources, DCM
aids in programmatically generating and authenticating each
Device access control The Gateway solution achieves remote application access to a server
process running on an EMC storage device by using a strict IP and
application port-mapping process. You have complete control over
which ports and IP addresses are opened on your internal firewall to
allow connectivity. The remote access session connections are
initiated by an EMC Customer Service request at the EMC access
server and through a pull connection to the Gateway server. EMC
never initiates a connection to your Gateway server or network. Your
policies determine if and how a connection is established.
Device configuration Once your devices are configured for Gateway solution management,
access control it is imperative that any changes to the configuration of the managed
device are carefully controlled and monitored. For example, changing
the configured IP address in the Gateway system or changing the IP
EMC enterprise Several security features are incorporated into the EMC DRM system.
access control The Gateway infrastructure is isolated from the rest of EMC's internal
networks. EMC Customer Service professionals must be logged into
the EMC corporate network system to access the DRM system. Only
authorized EMC personnel can access the DRM system, and only
those employees that have authorization approval from EMC
Customer Service can use it.
In addition, only those EMC Customer Service professionals that are
approved to access your specific devices can initiate remote
connection sessions with those devices.
Pre-Installation Tasks
Preparation for
Standard Installation
Note: We define system drive as the drive where the operating system in
installed.
◆ Overview ............................................................................................. 38
◆ Internet Information Services (IIS) deployment ............................ 42
Overview
The primary task in preparation of the Gateway server prior to the
installation of the Gateway solution is preparing the Operating
System. This includes installing the Microsoft Internet Information
Services (IIS) on the system drive. Additional tasks discussed within
this chapter include setting up the FTP and SMTP servers on the
system drive.
Note: You must verify that Domain Policies have not inhibited the functions
necessary for the Gateway to function properly. In other words, verify that
services have not been removed or disabled by Domain Group Policies.
Note: Having the Windows Time Zone set to a setting other than the local
time zone may adversely affect remote support tool performance.
◆ Load .NET Framework versions 1.1 and 2.0. Both versions must
be loaded for complete functionality. Both versions may co-exist
on the same server without interfering with or overwriting each
other. Instructions are included in Section ”.NET Framework” on
page 41.
Overview 39
Preparation for Standard Installation
Server settings Prior to having Gateway software installed, you must configure its
summary server operating system with the settings shown in Table 1 on
page 40. The procedure to establish these IIS settings is provided in
“Internet Information Services (IIS) deployment” on page 42.
Note: The following settings describe the FTP services and directory structure required for Gateway server installation. Once the
server has been installed, the FTP or SMTP service may be disabled, but not both—however, the FTP directory structure must
remain in place.
.NET Framework
Two versions of Microsoft .NET Framework are required for full
functionality of the Gateway server and its utilities: 1.1 and 2.0. Both
version may co-exist on the same server without interfering with or
overwriting each other.
Version 2.0 Version 2.0 is required for the Gateway server application.
You must download and install the .NET Framework (version 2.0)
from the Microsoft website. Use Windows Update and select the
.NET Framework 2.0 package or navigate to the Microsoft .NET
Framework Version 2.0 at the Microsoft Download Center website:
-or-
.NET Framework 41
Preparation for Standard Installation
OnAlert user account Use this procedure to set up OnAlert user accounts:
setup
1. Right-click My Computer on the desktop, and select Manage
from the pop-up menu.
2. Double-click Local Users and Groups.
3. Right-click Users and select New User from the pop-up menu.
4. Enter OnAlert in the User Name field.
! IMPORTANT
The folders in the following list must be created on the same drive
where IIS is installed.
C:\Inetpub\ftproot\LocalUser
C:\Inetpub\ftproot\LocalUser\OnAlert
C:\Inetpub\ftproot\LocalUser\OnAlert\incoming
C:\Inetpub\ftproot\LocalUser\ESRSConfig
(Do not change the default TCP port 21.) Click Next.
8. Select Isolate users, and click Next.
9. Browse to C:\Inetpub\ftproot, click OK, then click Next.
10. Select the Read and Write checkboxes, and click Next.
11. Click Finish.
12. In the Internet Information Services (IIS) Manager, right-click on
the FTP site ESRS Gateway FTP and select Properties from the
pop-up menu.
13. Click Security Accounts and deselect Allow anonymous
connections.
14. At the alert, continue anyway?, click Yes.
15. Click Messages.
16. In the Welcome field, type a welcome message.
For example:
Welcome to the name_of_your_FTP_server FTP server
Configure and test You must set the e-mail message size to 15 MB:
e-mail
1. In the left pane of the Internet Information Services (IIS) Manager
window, right-click Default SMTP Virtual Server and select
Properties, as shown in Figure 8 on page 46.
telnet ip_address 25
vrfy onalert
252 2.1.5 Cannot VRFY user, but will take message for
<onalert@emc.com>
helo
mail from:esrs@emc.com
rcpt to:onalert@emc.com
data
subject:testemailserver<CR>
This is a test of the email server<CR>
.<CR>
250 2.6.0
<JERRYexICnDdNUbr6TU00000001@jerry.lab.pvt.dns> Queued
mail for delivery
Note: We define system drive as the drive where the operating system in
installed.
◆ Overview ............................................................................................. 54
◆ .NET Framework................................................................................ 56
◆ Post-installation configuration......................................................... 70
Overview
The primary task in preparation of the Gateway server prior to the
installation of the Gateway solution is preparing the Operating
System. This includes installing the Microsoft Internet Information
Services (IIS) on the same drive to be used for the OS and Gateway
software. Additional tasks discussed within this chapter include
setting up the FTP and SMTP servers on this drive.
◆ Load .NET Framework versions 1.1 and 2.0. Both versions must
be loaded for complete functionality. Both versions may co-exist
on the same server without interfering with or overwriting each
other. Instructions are included in Section ”.NET Framework” on
page 56.
Overview 55
Preparation for a Non-Standard Installation
.NET Framework
Two versions of Microsoft .NET Framework are required for full
functionality of the Gateway server and its utilities: 1.1 and 2.0. Both
version may co-exist on the same server without interfering with or
overwriting each other.
Version 2.0 Version 2.0 is required for the Gateway server application.
You must download and install the .NET Framework (version 2.0)
from the Microsoft website. Use Windows Update and select the
.NET Framework 2.0 package or navigate to the Microsoft .NET
Framework Version 2.0 at the Microsoft Download Center website:
-or-
17. Copy (DO NOT MOVE) the inetpub directory to the non-C: drive
used for the OS installation. In the example in Figure 17 on
page 59, this is drive E:.
! IMPORTANT
You must also keep the directory structure for the inetpub directory
on the C: drive. See Figure 18 on page 60
10. Click Yes in warning message dialog box (Figure 24 on page 63).
14. Under the Home Directory tab, point to the home directory
structure on the non-system drive ('E:', in this case. or
E:\Inetpub\ftproot\) (Figure 26 on page 64).
Configure and test You must set the email message size to 15 MB.
email
1. In the left pane of the Internet Information Services (IIS) Manager
window, right-click Default SMTP Virtual Server and select
Properties, as shown in Figure 27 on page 65.
telnet ip_address 25
vrfy onalert
252 2.1.5 Cannot VRFY user, but will take message for
<onalert@emc.com>
helo
mail from:esrs@emc.com
rcpt to:onalert@emc.com
data
subject:testemailserver<CR>
This is a test of the email server<CR>
.<CR>
250 2.6.0
<JERRYexICnDdNUbr6TU00000001@jerry.lab.pvt.dns> Queued
mail for delivery
Post-installation configuration
This section provides instructions for tasks following server software
installation.
Gateway server After the finishing the Gateway server software installation, complete
the instructions in the following sections (from Primus emc141688).
Edit registry When the system has been rebooted after installation:
Attempting stop...
Internet services successfully stopped
Attempting start...
Internet services successfully restarted
Note: There are multiple entries in the file. Verify and edit all paths as
necessary.
Post-installation configuration 71
Preparation for a Non-Standard Installation
Policy Manager After the Policy Manager server software installation is complete,
edit the FileUpload attributes of all Policies on the Policy Manager
Global group to reflect the correct paths of the file locations on the
Gateway server. We recommend that you first copy all applicable
policies and then make edits to one set, leaving the original policies
with the original locations. Figure 34 on page 72 shows edits that
must be made to the policies.
3. The edit parameters screen appears. In the File: field, enter the
correct drive and path for the directory listed in the Parameters
field, and click Add as shown in Figure 37 on page 73.
4. Check the path now listed with the original. If listed correctly,
click Finish, as shown in Figure 38 on page 73.
Post-installation configuration 73
Preparation for a Non-Standard Installation
GatewayCheck Utility
GatewayCheck Utility 75
GatewayCheck Utility
Overview
The EMC Secure Remote Support Gateway solution has specific
requirements for the hardware, software, and network configurations
of the customer-supplied Gateway and Policy Manager servers. If a
Gateway or Policy Manager server does not meet one or more of the
requirements (listed in Table 2 on page 77), various problems may
occur both during and after Gateway software installation.
Each time you run a new series of tests, the GatewayCheck utility
creates a new report file and stores all the test results in that file. You
can then use the GatewayCheck application (or Notepad or
WordPad) to view the report files for all the test series that you have
run on a server.
Note: You must install and run this application on every Gateway and Policy
Manager server, verifying that each server passes the required
GatewayCheck tests before your Gateway installation date.
Some ports may fail the connectivity test. This is due to the existence of
secondary connections, and does not effect the overall test result.
You will need to supply a copy of the test results to EMC Global Services
before the Gateway software installation is performed.
Item Requirement
Operating system Microsoft Windows Server 2003 SP1 or later
Microsoft .NET Framework 1.1
Storage 0.5 GB disk space available
Memory 512 MB RAM (1024 MB RAM preferred)
Minimum single 10/100 Ethernet adapter, preferred Gigabit
Ethernet adapters, optional additional NIC for data backups
Network connectivity to devices Network connections open between server and devices
Internet access Internet connection open on server
Installation
To install the GatewayCheck utility:
Note: For best results, you should create the GatewayCheck directory on
the drive where you intend to install the Gateway and Policy Manager
software on the server, but this is not a requirement.
Filename Description
GatewayCheck.exe Application
GatewayCheck.exe.config Application configuration file
TextMask.dll Custom edit control for text field validation
Operation
The GatewayCheck utility provides a suite of tests that you can run
on a candidate Gateway or Policy Manager server in order to verify
that the target server meets the hardware, software, and network
configuration requirements for successful installation of the Gateway
and Policy Manager software:
Operation 79
GatewayCheck Utility
! IMPORTANT
If you encounter a problem with the GatewayCheck application,
you must forward the contents of all three directories to your EMC
Global Services Representatives so that they can assist you in
solving the problem.
Entering customer You must register your customer site and contact information with
information the GatewayCheck application before you can select and run any
tests on your server. To enter your information:
2. Complete all text fields, as shown in Figure 41, and click OK.
The Test Selection screen appears, as shown in Figure 42 on
page 82.
Operation 81
GatewayCheck Utility
Selecting tests to be After you have entered your site and contact information in the
run Customer Information form, you can select the specific tests to be
performed during the test run. To do this:
1. From the main application menu, select Tests > EMC Secure
Remote Support Install Checks:
• If you did not yet enter your site and contact information, the
utility prompts you to do so. When you click OK from the
prompt, the Customer Information form appears, as shown in
Figure 41 on page 81. You must enter your customer
information before you can select and run any tests.
• If you have entered your customer site and contact
information, a new window appears, showing the Test
Selection screen with all test options selected by default, as
shown in Figure 42 on page 82.
The Test Selection screen lets you select options from any of the
following four test groups:
• Gateway Environment Tests — Verify that the Gateway
server hardware meets the minimum requirements and verify
that Microsoft Windows Server 2003 SP1 is installed on the
server.
• Policy Mgr Environment Tests — Verify that the Policy
Manager server hardware meets the minimum requirements
and verify that Microsoft Windows Server 2003 SP1 is installed
on the server.
• Network Connectivity Tests — Verify that all required
network connections have been configured properly, so that
communications are enabled between the Gateway server and
EMC and between the Gateway and Policy Manager servers.
• System Applications Tests — Verify that the Gateway server
has Microsoft IIS installed, has FTP and SMTP services
enabled and configured properly, has the required directory
structure in place on the installation root drive, has the
required user accounts configured properly, and has the
proper ports open for communication with each application
installed on each of its managed devices.
Different tests are designed to run on each type of server, as
follows:
• Co-Located Gateway and Policy Manager — You should run
all available tests. This is the default Test Selection screen
setting, as shown in Figure 42 on page 82.
Note: If you select at least one test option in each of the Gateway and
Policy Manager test groups, the GatewayCheck application assumes
that the Gateway and Policy Manager servers are to be co-located.
(GatewayCheck only tests the server on which it is installed.)
• Gateway Only — You should run all available tests except the
four tests for the Policy Manager.
• Policy Manager Only — You should run only the four tests in
the Policy Mgr Environment Tests group.
3. Using the checkboxes in the Test Selection screen shown in
Figure 42 on page 82, choose the tests you want to run on this
server. By default, all available test options are selected.
Operation 83
GatewayCheck Utility
Note: GatewayCheck runs the selected tests only after you click Run
Tests on the Test Results screen. “Executing the test run” on page 88
provides instructions for running the selected tests.
4. If you want to run the Free Disk Space test from the Gateway
Environment Tests group, perform the following steps:
a. Check the box next to Free Disk Space:
Note: If you do not highlight the drive letter, after step 5 on page 84,
you are asked to select the install drive letter even though the correct
letter is showing.
Setting test If you have selected any of the tests listed in step 5 on page 84, when
configuration you click Next on the Test Selection screen, the Test Configuration
parameters Parameters screen appears, as shown in Figure 43 on page 85.
Operation 85
GatewayCheck Utility
To set the parameters for the tests you selected, enter the information
required to perform the selected tests, as follows:
Note: If you wish to change the information in any text field on this screen,
you must use the Backspace key to delete the existing information and then
re-enter the correct information. You cannot highlight and overwrite existing
text, and you cannot click to insert new text in an existing entry.
Note: If the password field is not filled in, you receive warning message. You
may continue with the installation.
Operation 87
GatewayCheck Utility
Executing the test Once you have selected the tests you want to run and configured the
run parameters for those tests if necessary, the Test Results screen
appears, as shown in Figure 44 on page 88.
Note: If you wish to change the information in any text field on the Test
Configuration Parameters screen, you must use the Backspace key to delete
the existing information and then re-enter the correct information. You
cannot highlight and overwrite existing text, and you cannot click to insert
new text in an existing entry.
To use the Test Results screen to execute the test run and view results:
3. When the tests are complete, the basic status of each test (Passed
or Failed) appears in the Summary Test Results pane, and the
detailed results of each test appear in the Detailed Test Notes
pane. Figure 45 on page 90 shows some sample test results.
Operation 89
GatewayCheck Utility
Viewing test results This section describes how to view test results.
Test Results log files When the test names and results appear in the Test Results screen as
shown in Figure 45 on page 90, you can use the Test Results screen to
view each test result in detail. You can also use a text editor such as
Notepad to view test results from the file system.
1. From the menu bar, select View > Gateway Test Logs.
The Test Results Logs navigation window appears, as shown in
Figure 46 on page 91.
2. In the Files of type: drop-down list box, select Log files (*.log).
Operation 91
GatewayCheck Utility
The Test Results Logs window displays the log files for every
GatewayCheck test series that you have completed on this server.
3. Select the log file for the test results you want to view and click
Open.
The Test Results Logs window closes, and the contents of the log
file that you selected appear in the main GatewayCheck
application window, as shown in Figure 47 on page 92.
Saving Test Results When you have finished viewing all of your log files in the main
and exiting the application window, you can do any of the following:
application
◆ Close the log file, using the File > Close menu option, and use the
main application window to start another test run or view
another file.
◆ Save the log file in the current display window to a new filename,
using the File > Save As menu option to open a standard
Windows Save As dialog box.
◆ Exit the application, using the File > Exit menu option or the X
button in the upper-right corner of the window to close the
application window.
Operation 93
GatewayCheck Utility
Note: The EMC Registration Authority Connect and EMC Secure Remote
Support Connect tests can be performed using either the HTTPS protocol or a
simple TCP/IP connection to the EMC application servers.
Required: Gateway server must pass both TCP/IP connection tests to proceed
with Gateway software installation.
EMC Registration Authority Connect Required: Gateway server can connect to EMC servers over TCP port 443.
EMC Registration Authority Connect HTTPS HTTPS tests may fail for any of several reasons — for example, time-out and
proxy configuration / authorization errors. You can test connections by using a
local web browser to open the URLs provided in the detailed test results.
EMC Secure Remote Support Connect Required: Gateway server can connect to EMC servers over TCP port 443.
EMC Secure Remote Support Connect HTTPS HTTPS tests may fail for any of several reasons — for example, time-out and
proxy configuration / authorization errors. You can test connections by using a
local web browser to open the URLs provided in the detailed test results.
Note: If EMC has not yet installed the Gateway software, this test has a Failed
status. However, the detailed test results state that the failure is a warning, and
identify the drive on which EMC should install the Gateway software.
Device Application Port Connection Test Required: Internal firewall rules must be updated to allow communication between
the Gateway server and each of its managed devices, using the required ports for
each remote support application, as specified in Site Planning Guide.
Note: GatewayCheck tests the required port connections only for the devices and
applications that you specify in the Test Configuration Parameters screen shown
in Figure 43 on page 85. You should test the port connections for every
application on every device that you want to manage through the Gateway
system.
Note: For devices not yet on the network, this test has a Failed status. For those
devices, you should manually check the firewall rules to ensure that
communication is allowed between the Gateway server and each device, using
the required ports for each remote support application, as specified in Site
Planning Guide.
Version information
You can use the main GatewayCheck menu shown in Figure 40 on
page 80 to get version and copyright information.
Policy Management
◆ Installation......................................................................................... 100
◆ Startup/shutdown ........................................................................... 101
◆ Modifying the login banner............................................................ 103
◆ Creating Policy Manager user accounts ....................................... 104
◆ LDAP authentication ....................................................................... 112
Installation
EMC Customer Service performs all installations of the Policy
Manager software on a server that you provide and maintain at your
site.
Note: The Policy Manager uses Apache Tomcat 5.0.x. Only Tomcat operations
that are relevant to Policy Manager use are discussed here. For complete
documentation on Apache Tomcat, refer to http://tomcat.apache.org
100 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Administration
Startup/shutdown
Upon Policy Manager server startup, its web server automatically
starts as a Windows service.
You can manually start or stop the Policy Manager from the Windows
Services item, as described here:
1. Open the Control Panel in Windows.
2. Open Administrative Tools.
3. Open Services.
4. Select EMC Secure Remote Service Policy Manager as shown in
step 48 on page 101.
Startup/shutdown 101
Policy Manager Administration
102 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Administration
About users You have the option of using your own Lightweight Directory Access
Protocol (LDAP) authentication by following the procedure in
“LDAP authentication” on page 112. The default authentication
scheme is an Apache Tomcat file realm. This realm controls local user
access to web server administration and Policy Manager application
user interface pages.
Tomcat user With the Tomcat scheme, you administer the Policy Manager through
authentication a web interface.
To configure the Tomcat web server for use with the Policy Manager
software, you must specify users at two access levels, represented by
two roles, APMAdmin and APMUsers:
◆ APMAdmin — System administrators: log in to the Tomcat web
server; configure server settings; add, configure, and delete user
accounts; and add, configure, and delete roles and user groups;
log in to the Policy Manager application; set permissions for all
policies, devices, and device groups defined in the Policy
Manager; define, configure, and delete policies, devices, and
device groups; and view all Audit Log messages, approve remote
access requests.
◆ APMUsers — Policy administrators: log in to the Policy Manager
application; set permissions for all policies, devices, and device
groups defined in the Policy Manager; define, configure, and
delete policies, devices, and device groups; and view all Audit
Log messages, approve remote access requests.
Passwords for Policy Manager accounts are stored encrypted.
104 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Administration
Tomcat user The Tomcat web server, installed as a component of the Policy
account planning Manager, is installed with predefined roles and a predefined
administrator user account.
These predefined settings include:
◆ Roles: APMAdmin and APMUsers
Note: You may also see additional listed roles: admin, manager, role1,
tomcat. The only groups used by the Policy Manager are APMAdmin
and APMUsers.
Before you configure the Tomcat web server for the Policy Manager,
you should record the following information for later entry into the
Tomcat Web Server Administration Tool’s user interface:
◆ Full names of all new Policy Manager and Tomcat users
◆ Username and password to be assigned to each new user account
◆ Roles to be assigned to each new user account
◆ New password for default admin account
Logging into the Once you have recorded the information mentioned in the previous
Tomcat server section, you can make configuration changes to the Tomcat and
Policy Manager applications.
Note: You must restart the Policy Manager service after creating a user
account.
If you open the web browser on the Policy Manager server itself,
type:
http://localhost:port_number/admin/
for example:
http://localhost:8090/admin/
The Tomcat Web Server Administration Tool login page appears.
2. Type the username admin and the password EMCPMAdm7n.
The Tomcat Web Server Administration Tool home page appears,
with the navigation tree in the left-hand pane and a blank
dimmed screen in the right-hand pane, as shown in Figure 51 on
page 107.
106 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Administration
3. Delete the default password, and carefully type the new admin
user account password (that you chose earlier), and click Save.
108 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Administration
Note: The Username and Password entries are case-sensitive. Do not use
reserved UNIX or Windows characters for passwords or usernames.
5. Scroll down until you can see the entire Role Name column in the
Create New User Properties screen, and use the checkboxes to
select the roles that you want to assign to the new user. For a
particular user, you should select either or both of APMAdmin
and APMUsers, as described in “About users” on page 104.
Note: Two roles are predefined in the Tomcat default configuration: role1
and tomcat. These are not used in Policy Manager.
Note: For APMAdmin roles to be able to add, delete, or modify users the
must also be assigned the admin role.
6. Click Save.
The Users List screen reappears, with the user account you have
just created included in the list.
7. Repeat step 3 on page 108 through step 6 on page 109 for every
new user account.
8. Click Commit Changes as shown in Figure 56 on page 110.
110 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Administration
! IMPORTANT
For changes to take effect, restart the Policy Manager service as
described in “Startup/shutdown” on page 101.
LDAP authentication
If you want to use your current domain accounts to manage access to
the Policy Manager, thereby not having to use a shared account or
configuring duplicate accounts in Policy Manager, you have the
option to use your standard LDAP instead of the default Tomcat user
list. For complete documentation on LDAP versions supported by
Tomcat, refer to
http://tomcat.apache.org
Note: Customers are required to work with their own internal Security Team
for LDAP configuration. Please be advised it is a very complex configuration.
EMC is not responsible for the LDAP Policy Manager configuration.
Note: Only a system administrator that with a high level of knowledge about
LDAP should make the changes detailed in this procedure.
112 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Administration
Note: Before editing the server.xml file, make copies of server.xml and
tomcat-users.xml.
114 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
6
Policy Manager
Configuration and
Operation
This chapter presents the main policy management interface for the
Policy Manager. Remote user access and activity is initially specified,
and then managed while the Gateway is operational, for particular
devices and groups of devices:
Setting policy
If you are unfamiliar with the Policy Manager interface, follow the
tour outlined in these subsections:
◆ “Policy settings” on page 118
◆ “Access rights” on page 124
◆ “Notifications” on page 128
Log in to home Once your Policy Manager system administrator has assigned you a
page username and password, you can log into the Policy Manager
application as follows:
1. Open a web browser, and type the Policy Manager server’s IP
address or domain name and the port number that the Tomcat
web server uses (8090 or the alternate port number designated at
installation) in the URL shown here:
http://DomName_or_IPAddr:PortNumber/actions/index
for example:
http://server1.customer.com:8090/actions/index
If you open the web browser on the Policy Manager server itself,
you can type:
http://localhost:port_number/actions/index
for example:
http://localhost:8090/actions/index
116 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Policy settings This section describes the global policy settings, group hierarchies,
and device type settings.
118 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
There are six fields that represent the policy record for a each
permission. A permission is an action with defined parameters. The
permission also has an access right setting that tells you whether it is
allowed for that group. Table 5 on page 120 provided an explanation
and example of the policy settings.
120 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Group hierarchy The Global group is the top-level parent providing default settings.
page
There is a group for each device type at the level lower than Global,
such as CLARiiON® and Symmetrix, with its own set of rules. Global
permissions and access rights are inherited by device type groups:
Select the Explore Device Groups link at upper right of the page.
This brings up the page shown in Figure 63 on page 121. It shows the
hierarchy of preset groups as well as the devices registered with the
Policy Manager. Examine the structure of the groups you see.
Group hierarchy: Each policy group is designated by a line item that links to further
Preset groups information for each group. Your Policy Manager installation
includes a default set of second-level groups:
• Celerra
• EMC Centera®
• CLARiiON
• Connectrix®
• EMC ControlCenter®
• EDL
• Invista®
• Switch-Brocade-B
• Switch-Cisco
• Symmetrix
Note: You cannot alter these group names. EDM™ may also appear among
the EMC products displayed, but is not supported in Gateway release
1.02.xx.
The following groups are also found under the Name column:
ESRS Gateway
ESRS_Site_ID_ …
…
Gateway Device
ESRS_DEVICE_Site_ID_ …
The ESRS Gateway group represents the Gateway server, and
contains policy you may want to edit as you would with the EMC
product devices.
Note: The Gateway Device group should not be edited. It is used only to
support internal processing of connect home operations.
From the top level, the default structure of policy settings groups
reflects Device Types (EMC product families) and particular Devices:
Global [the sole top-level group]
Device Type [group named by product name]
Device [group named by product serial number]
To see the policy settings for a particular group, locate the group in
the hierarchy and click on its name to open the corresponding policy
settings page.
122 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Device type If you select Celerra from the group hierarchy, you see policy settings
settings page for Celerra, which are also the default settings for specific Celerra
devices (the next lower level).
Settings for the Celerra group are identical to those for the Global
group except that there are several additional Remote Application
actions. (See example in Figure 64 on page 123.) When an EMC
product (in this case Celerra) registers with the Policy Manager, its
policy settings are initially supplied from the default set of
permissions from the device (Celerra) template.
Among other things, this permission set identifies particular
applications for which EMC Customer Service needs access. For
example, if EMC Customer Support needs to work on a Celerra
problem, a support engineer needs to remotely access these Celerra
applications:
◆ CelerraMgr
◆ Telnet
◆ CLIviaSSH
Although other applications are denied access, those specific
applications are set at Always Allow.
Device From the group hierarchy, select the group for a particular (Celerra)
settings page device. It is represented below the device type name by a serial
number — for example, ML2805000499.
You now see policy settings for that device only. Some may be
inherited from the Global settings, some from the Celerra settings,
and some may be specific to that device.
Access rights Policy settings are embodied in access rights. Each permission has an
access right specifying whether it can be executed.
Identify default The policy for each new device registering with the Policy Manager is
settings inherited from the device type. Device type policy is preset by EMC,
but can be edited.
Policy for a particular group consists of a set of permissions
(action-parameter combination), each with an associated access right.
For a particular permission, one of three allowed access right options
is set:
◆ Always Allow
◆ Ask for Approval
◆ Never Allow
These options are fully described in Table 7 on page 124.
Name Description
Always Allow The Agent can execute these permissions without asking for approval or sending the action information to
Policy Manager (the Agent does log an entry in the Policy Manager Audit log). To see which actions of
Always allow rights were performed on a device, refer to the device’s log file.
Ask for Approval The Agent forwards the action and its parameters to Policy Manager for approval. When Policy Manager
receives the action, it sends an email to the address specified for the device’s policy and then stores the
action request in the Pending Requests queue. The action request remain shown in the Pending Request
page until it is approve or denied, or it times out. (If timed out, the action is denied and needs to be
requested again, if desired, and a message is logged to the Policy Manager Audit Log.)
If approved or denied, the action request is removed from the Pending Requests page. A message
regarding the approval or denial is logged to the Policy Manager Audit Log. Policy Manager sends its
response (accept or deny) to the Gateway server. If the action request was approved, the device processes
the action.
Never Allow The Agent does not execute these permissions and sends information for these requests to Policy
Manager only when Never Allow actions are requested from the Gateway server. To see which
device-initiated actions of Never Allow rights were denied on a device, refer to the device’s log file.
124 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Access right settings This section describes parent/child permissions and settings.
Set access rights Set (or reset) an access right by choosing from the list box menu
provided for the particular permission, as shown in Figure 65 on
page 125 for Default package permission.
You can set all access rights for a group to a single value by using the
checkbox Set All Permissions at the bottom left side of the page. For
example, Set All Permissions: Never Allow can be used in
emergencies to block all requests.
If an access right is locked in a parent group, then for any child group
this right appears as uneditable text (no list box menu) and cannot be
reset. The first three access rights listed in Figure 68 on page 125 are
locked by a parent group.
Note: The Reset to Parent’s Policy option does not appear in any device
model (Connectrix, EMC Centera, and so on) policy settings page, where its
use would not be practical.
126 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Missing devices If a device is offline or not connected to the Gateway server, it may be
enforcing an outdated policy. This could mean that the device is
allowing actions that should be set to Never Allow or Ask for
Permission, or denying actions that it should be allowing.
To determine if a device is offline to the Gateway server, use the View
and remove missing devices page. Any devices shown in this page
have missed their last contact (ping) with the Gateway and are now
considered offline. See examples in Figure 70 on page 127.
Before removing a device from the Policy Manager, make sure that
you know the true status of the device:
◆ Any devices you remove should also be undeployed by EMC
Global Services.
◆ If you accidentally remove a device still in production, it will
reregister when placed back online.
◆ Any devices on the missing list that have an unknown status
need to be investigated. Contact EMC Global services for
assistance.
Notifications If an access right is set to Ask for Approval, when an EMC support
engineer requests a session. The Gateway server sends an action
request to the Policy Manager for approval. The Policy Manager then
sends an email notification to the individual or group alias specified in
the notification configuration.
Setting notifications Notifications are specified for each device group. Each notification is
sent with a message based on that group’s standard form. Any
permission requested for a particular group thus uses the same
notification form that is sent to the same person.
The Global group notification message template is set during
installation.
128 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
= Overwritten content
= Inherited content
The group notification form opens for editing (the form may
display as blank—you may have to copy contents from the global
notification if you want to use the same addresses, subject, and
body text). The notification fields and settings for the Global
group are shown in Figure 73 on page 130. The full default Body
is shown in Figure 74 on page 131.
130 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Hello,
Your current authorization policy manager rules require your approval for
the following EMC support action:
Date: <$TMST>
Action: <$ACTN>
Description: <$ACTD>
Device Model:<$A_MN>
Device Serial Number:<$A_SN>
EMC Username:<$USRN>
Please click the URL link listed below to approve or deny this request.
http://000.000.000.000:8090/actions/request/show_requests Link to
access
This email was automatically generated by the EMC Secure Remote Support authorization
Policy Manager in response to the following permission settings: page
Model : <$A_MN>
Permission Name: <$PR_N>
Permission Description: <$PR_D>
Permission Detail Setting : <$PRDT>
Please note that details of the action request can be viewed in the Policy
Manager Audit Log web pages. Please use your browser to log into the
Policy Manager server to approve or deny this request.
Thank You,
EMC Customer Service
Tag Description
<$A_MN> Gateway server model number
<$A_SN> Gateway server serial number
<$A_GN> Gateway server associated group name
<$A_GD> Gateway server associated group description
<$ACTN> Action name
<$ACTD> Action description
<$PR_N> Permission name
<$PR_D> Permission description
<$PRDT> Permission details (parameter names and values)
<$SMSG> SOAP message
<$TMST> Timestamp when action was forwarded from Gateway server
<$USRN> Username
132 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
About requests If using the Ask for Approval policy when a Gateway-managed
device needs approval to perform a requested action, it sends a
request to the Gateway. The Gateway sends a message to the Policy
Manager that it needs to get its approval (if the action is a request from
the Gateway server), and then waits for the Policy Manager’s
response.
When the Policy Manager receives the request, it sends an email
notification, such as the message in Figure 74 on page 131, to the
individual defined for that device’s policy (or device group’s policy),
and then queues it for approval.
If the responsible individual does not accept the request within the
period specified for that permission, the Policy Manager removes the
action from the Pending Request queue and posts an entry to its
Audit Log (see example message in Figure 77 on page 139). The
device is sent a denied request due to time-out message. When a
timeout occurs, a new request may be submitted.
Pending requests are shown in the Policy Manager’s Pending
Requests tab, View all pending single or container1 requests for
<selected> group. This is a list of all pending requests for a group. In
this page you can accept or deny a single action request or a container
of pending action requests or all actions shown.
Accept/deny This section provides details on how to accept or deny requests for
pending requests the Ask for Approval setting. Figure 75 on page 135 shows the details
for the following steps:
View request details View details, and accept or deny pending request
You can view more information for a single permission before
accepting or denying it. You cannot view more information on a
container, which can contain multiple permissions. Click the name of
the permission from the Name column in the View Pending Requests
page, as shown in Figure 75 on page 135.
134 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
The View Request Details page appears showing further details about
the action, including the time the action request was received by the
Gateway server. This detail page is shown in Figure 75 on page 135.
Pending time-out When a request is made for a permission with an access right set to
Ask for Approval, if an email reply is not received within the
time-out period, the request expires. The Pending Time-out setting is
an action parameter (Permissions of the same action have the same
Pending Time-out). As part of the action configuration, you can
specify a length of time (minutes) for a permission request to be
granted.
Note: Changing the setting at a device level changes the global policy setting
for all devices. Use with caution.
Note: Recognize that if EMC is attempting a remote connection and you have
your remote access settings set to Ask for Approval, but no one responds to
the email within the time-out period (five minutes by default), the request is
denied. This may prevent service on your devices from occurring within a
reasonable time.
136 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
About log Logs contain user interaction activity records for the Gateway server
messages and Policy Manager.
The View audit log entries for Global group page shows audit log
entries generated during the current rollover period. Logs from
previous rollover periods (and logs larger than 1000 lines) are
viewable within the file system using a text editor such as Notepad.
Audit log entries are stored to the server running the Policy Manager;
by default, under the apm/audit directory. Each day a file is created
and all audit log messages generated by the Policy Manager for that
day are saved to the file. By default, the daily files are created with
the following syntax:
ESRS_Audit_yyyy_mm_dd.txt
where yyyy is the current four-digit year, mm is the current month,
and dd is the current day.
Note: There are no limits on how large these files can grow or how many files
are stored on disk, so make sure to keep track of disk use and space, and
archive the files as needed.
Failure to maintain sufficient free disk space will result in the Policy Manager
failing to function and corruption of the Policy Manager Database.
Audit Log To view the Audit log, click Audit Log tab. The View audit log entries
for Global group page appears, as shown in Figure 76 on page 138.
138 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Log scope examples To see Audit Logs for only certain groups, you can select logs for:
◆ any group
-and-
◆ group (only) -or- group + all child groups
Note: Callhome activities are only shown on the Gateway instance of the
Policy Manager.
You see that the Group Name column on the left, now shows only
Symmetrix entries, while the link you selected now toggled to
Show all audit log entries for the selected group and subgroups.
(Click that link if you want to return to the all-Symmetrix view.)
See the lower right of two screens in Figure 78 on page 141.
140 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Policy Manager Configuration and Operation
Note: If you leave the audit log to enter another tab such as Policy or
Configuration and later return to the audit log tab, you see the previous log
view.
Sources Activities from the following sources are recorded in the audit log:
Gateway:
◆ Gateway registers with the Policy Manager,
◆ Gateway sends a request to perform an action with a permission
access right of for example.
◆ Gateway performs an action defined for a permission access right
of Always. The message sent to the Policy Manager Audit Log
includes the name of the user who performed the action, the
action performed, and the success or failure of executing the
action.
◆ Gateway denies an action defined for a permission access right of
Never Allow. The message sent to the Policy Manager audit log
includes username of the person who attempted the action,
information about the rejected action (specific to the type of
action), and the policy permission that caused the action to be
rejected.
◆ Gateway sends a Remote Session Disconnect message.
Policy Manager:
All activity.
142 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
PART 3
Gateway Maintenance
Server Maintenance
EMC advises that you take advantage of the best practice of backing
up data on the Gateway and Policy Manager servers. It is your
responsibility to perform backups and ensure that the servers can be
restored through the use of the backup data. Either image backup or
data file backup is satisfactory. Topics in this chapter include:
◆ Power sequences .............................................................................. 146
◆ Time Zone settings ........................................................................... 147
◆ Service preparation .......................................................................... 148
◆ Policy Manager database management ........................................ 151
◆ Backup guidelines and procedures ............................................... 155
◆ Restoration methods........................................................................ 158
Power sequences
EMC's customers routinely perform maintenance tasks that include
powering down and powering up their data centers based on
scheduled timeframes. While these powerdown/powerup sequences
are defined by the customers' internal processes, the presence of the
EMC Secure Remote Support Gateway in customer environments can
affect the sequence in which powerdown/powerup actions are
carried out.
! IMPORTANT
Improper shutdown procedures generate service requests. Be sure
to notify your EMC Customer Engineer of any shutdown plans to
avoid necessary service calls.
! IMPORTANT
EMC recommends that the EMC Secure Remote Support Gateway
server(s) and Policy Manager servers be the last devices powered
down and the first devices powered up after maintenance is
complete, to allow support level access to the EMC end devices at
all stages in the power up/down sequence.
146 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
Note: When changing the time zone on existing server installations, you
must reboot the Gateway server after changing the setting.
Service preparation
This section describes steps that need to be taken prior to performing
maintenance procedures on the Gateway and Policy Manager
servers.
Gateway server Follow the procedures in this section before performing maintenance
on the Gateway server.
! IMPORTANT
If the Gateway disk becomes full, the Gateway server will fail to
function properly for callhome messages, and possibly for support
connections. If the problem is severe enough the server OS ceases
to function.
148 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
Policy Manager Follow the procedures in this section before performing maintenance
server on the Policy Manager server.
! IMPORTANT
If the system runs out of disk space for log files, the Policy
Manager database will become corrupted, needing to be
reinstalled.
To maintian flat audit logs and conserve disk space, compress audit
logs an copy them to a repository. Audit logs typically compress by
greater the 85%.
150 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
Component files The data for each database consists of five files in the same directory
apm. The endings are *.properties, *.script, *.data, *.backup, and *.log.
All these files are essential and thus should never be deleted or
allowed to get corrupted.
These files are identified in Table 9 on page 151.
File Description
apm.backup Zipped backup of the last known consistent state of the data file
apm.data Data for cached tables
apm.log Recent changes within the database
apm.properties General settings for the database
apm.scripts Definition of tables and other database objects, plus data for
noncached tables
Mode The default mode for the hsqldb is the In_Process mode (Standalone
Mode).
Backup The five component files of the database are backed up together.
There are three scripts in hsqldb\lib:
◆ apmbackup.vbs
◆ apmrestore.vbs
◆ schbackup.bat
Description for the scripts are given in Table 10 on page 152.
File Description
apmbackup.vbs Backs up the [install_drive]:\EMC\Policy Manager\hsqldb\apm
folder. This must be installed in
[install_drive]:\EMC\Policy Manager\hsqldb\lib.
This script runs every day at 5:00 A.M., copying the apm folder to
[install_drive]:\EMC\Policy Manager\hsqldb\backup.
It maintains 31 days history of the apm database.
apmrestore.vbs Simple GUI script to help restore the desired backup image to
[install_drive]:\EMC\Policy Manager\hsqldb\apm.
This script must be installed in
[install_drive]:\EMC\Policy Manager\hsqldb\lib.
You must stop the Policy Manager service before you do a
database restore.
The original[install drive]:\EMC\Policy Manager\hsqldb\apm
is moved to
[install_drive]:\EMC\Policy Manager\hsqldb\apm_dateoftherestore
schbackup.bat Batch file to add the schedule command apmbackup.vbs to run
every day at 5:00 A.M.
152 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
154 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
Server image Image backup is the preferred method for backing up a Gateway or
backup Policy Manager server and data.
Set up the Policy Manager database for daily (or other periodic)
automated database backup: If your EMC Customer Engineer has
not done so already, perform the procedure outlined in “Policy
Manager database automated backup” on page 156.
Note that the Policy Manager database includes Audit Log files as
well as configuration settings.
Policy Manager If on the Pre-Site Checklist you had indicated that you wanted to set
database up Gateway’s automated Policy Manager database backup, this
automated backup feature is ready to use.
Whether or not you have preset the automated backup, you may
examine and possibly customize the script provided with your Policy
Manager and activate it with the Windows Task Scheduler.
To configure and activate your backup tasks:
1. Check whether there is a backup task already scheduled by first,
in Windows, opening Start > Settings > Control Panel >
Scheduled Tasks.
a. If the automated backup has been activated by your EMC
Customer Engineer, you find the scheduled task Policy
Manager Database Backup listed. In this case your backup
has been configured and activated—you are done.
b. However, if you are unsure of the location of the backup path,
or if you want to change that path, you can also perform step 2
and then exit.
c. If there is no existing backup task, you first edit the backup
script to specify the backup path, and then schedule the
backup task—continue with the next step.
156 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
Note: Unless you edit the script file to provide a pathname, the backup is
created in the root directory of the Policy Manager application.
Note: There are three instances of the text backup in this script file,
indicating (by default) the relative location of the backup directory.
Restoration methods
Restoration procedures differ based on the method of backup you are
using.
158 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
160 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Server Maintenance
Note: Audits occurring after the date of the restore date are not displayed in
the audit history of the Policy Manager web interface. Any new audits are
appended to the database as they occur. Even though the audits are not
displayed in the web interface, they are viewable through the file system,
located in the <install_drive>:\EMC\Policy Manager\Audit directory.
! IMPORTANT
If you need to restore a Policy Manager, start with a clean
installation only if you have an recent database backup on a
separate drive. Reinstall only the same software release version as
that of the database backup.
! IMPORTANT
If the Gateway disk becomes full, the Gateway server will fail to
function properly for callhome messages, and possibly for support
connections. If the problem is severe enough the server OS ceases
to function.
162 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
PART 4
Appendixes
<Service name="Tomcat-Standalone">
......
<Connector port="8090"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" redirectPort=”8443” acceptCount="100"
debug=”0” connectionTimeout=”20000”
disableUploadTimeout=”true”/>
......
</Service name="Tomcat-Standalone">
166 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
SSL communication between the Gateway and Policy Manager
5. Locate and delete all the text between and including the
<!-SSL and --> tags in the section inside the
<Service name="Tomcat-Standalone"> element as shown in bold
text.
<Service name="Tomcat-Standalone">
......
......
<!-- SSL
<Connector port="8443"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" disableUploadTimeout="true"
acceptCount="100" debug="0" connectionTimeout=”20000”
scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS"
keystoreFile="c:/apm/.keystore" keystorePass="password"/>
-->
</Service name="Tomcat-Standalone">
<Service name="Tomcat-Standalone">
......
......
<!-- Define a SSL HTTP/1.1 Connector on port 8443 -->
<Connector port="8443" maxHttpHeaderSize="8192"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" disableUploadTimeout="true"
acceptCount="100" debug=”0” connectionTimeout=”20000”
scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS" keystorePass="PMStorePass1234"
keystoreFile="C:/EMC/Policy Manager/Tomcat5/bin/PMIdentityStore.jks"/>
......
......
</Service name="Tomcat-Standalone">
Table 11 on page 168 lists the values and definitions for keystore.
Attribute Description
keystoreFile Add this attribute if the keystore file you
created is not in the default location Tomcat
uses (a file named .keystore in the user home
directory under which Tomcat is running).
You can specify an absolute pathname, or a
relative pathname that is resolved against
the $CATALINA_BASE environment
variable.
keystorePass Add this element if you used a keystore (and
Certificate) password other than the default
keystore password (changeit).
keystoreType Add this element if using a keystore type
other than JKS.
keyAlias Add this element if your have more than one
key in the KeyStore. If the element is not
present the first key read in the KeyStore is
used.
168 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
SSL communication between the Gateway and Policy Manager
Enabling the Policy Manager application to use SSL for all communications
Use the following procedure for enabling the Policy Manager to use
SSL for all communications:
1. Locate the
<install_root>\EMC\Policy Manager\Tomcat5\webapps\
applications\apm\WEB-INF\web.xml file.
2. Create a copy of the web.xml file and rename it web.xml.bak.
3. Replace the web.xml file with the file attached to this document
(see pane at bottom of window), or manually edit the existing file
as shown in the following steps.
4. Open web.xml file using a text editor such as Notepad.
5. Find the <security-constraint> with any web-resource-name and
modify a portion of it to include the <user-data-constraint>
element as shown in bold text.
<web-app>
......
......
<security-constraint>
<web-resource-collection>
<web-resource-name>anything</web-resource-name>
......
</web-resource-collection>
......
<user-data-constraint>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
......
</security-constraint>
......
</web-app>
170 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
SSL communication between the Gateway and Policy Manager
Gateway configuration
This section describes the steps for making changes to Gateway
configuration to support SSL communication:
1. Locate the
<install_root>\EMC\ EMC\Gateway\ xgAPMProxy.xml file.
2. Create a copy of the xgAPMProxy.xml file and rename it
xgAPMProxy.xml.bak.
3. Open the xgAPMProxy.xml file using a text editor such as
Notepad.
4. Add the following <Encryption> element inside the
<APMProxyConfig> element as shown in bold text.
<APMProxyConfig>
......
......
<Encryption>
<Bits>128</Bits>
<Validate>false</Validate>
</Encryption>
</APMProxyConfig>
Note: The value of the Bits element denotes the strength (in bits) of the SSL
certificate used in the Policy Manager.
5. Change the value of the <Port> element from the default value of
8090 to 8443 (or to the value which is chosen for SSL port) as
shown in bold text.
<APMProxyConfig>
......
......
<Port>8443</Port >
</APMProxyConfig>
6. Save the file with the updated configuration and restart the
Gateway service.
7. Launch the EMC Secure Remote Support Deployment Utility
from Start > Programs > ESRS > Deployment Utility.
8. Connect to the Gateway for which the configuration is modified.
12. Click Deploy on the top level menu to update the changes to the
Gateway.
172 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
SSL communication between the Gateway and Policy Manager
<web-app>
......
......
<security-constraint>
<web-resource-collection>
<web-resource-name>Message Servlet</web-resource-name>
<url-pattern>/message</url-pattern>
</web-resource-collection>
<user-data-constraint>
<transport-guarantee>SSL_ENABLE-NONE</transport-guarantee>
</user-data-constraint>
</security-constraint>
</web-app>
5. Save the file with the updated configuration and restart the
Gateway service.
174 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
B
Invisible Body Tag
Actions
Table 12 on page 176 provides descriptions for the available Actions
used in the Gateway solution.
Although a number of Actions are defined by the Gateway solution,
only a subset are currently used. You see all Actions defined for a
particular Group when you examine that Group’s policy settings.
(For example, see Figure 62 on page 119.)
In Table 12 on page 176 through Table 24 on page 191, Actions and
Permissions defined, but not currently used, are shown dimmed.
! IMPORTANT
Change only the Access Rights for group or device Remote
Application actions.
Register Script Gateway Determines whether or not the Agent can register a script on the device as requested, or
Device needs to receive approval for the permission first. Permission parameters: name of the script
only to register.
Run Script Gateway Determines whether or not the Agent can run a script, or needs to receive approval for the
Device permission first. Permission parameters: name of the script to run.
only
Schedule a Script Gateway Determines whether or not the Agent can schedule a script for operation on the device as
Device requested, or needs to receive approval for the permission first. This action has no specific
only parameters.
Set Data Item All except Controls whether or not the Agent can write values to its data items as requested, or needs to
Values Gateway receive approval for the permission first. This action has no specific parameters.
Device
176 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
Package Gateway Determines whether or not the Agent accepts a package, or needs to receive approval for the
Device permission first. Permission parameters: Name and version number of the package to execute
only on the device. All contents of a package are included in the permission. (Packages are
(Can be handled differently than other permissions; check with EMC Customer Service.)
modified)
Data Item Values All except Determines whether or not the Agent can send data item values, or needs to receive approval
Gateway for the permission first. (This does not affect data item values sent as the result of a Write
Device Data Item action, configured in a logic schema.) For this release, only one permission can be
set for all data items, meaning all data items are included in the action.
File Download Gateway Determines whether or not the Agent can accept files downloaded to it from the DRM, or
Device needs to receive approval for the permission first. Permission parameters: Fully-qualified path
only of the file(s) to download to the device. The name(s) of the file(s) and path(s) may be explicit
(Can be (for example, “c:\error.log” or include wildcards (for example, “c:\*.log” or “c:\*.*”).
modified)
File Upload Gateway Determines whether or not the Agent can upload files to the DRM (whether an DRM-based
Device request or Agent-initiated process), or needs to receive approval for the permission first.
only Permission parameters: Fully-qualified path of the file(s) to upload to the DRM. The pathname
on the device can be explicit or relative (which the Agent interprets to be the root of the Agent
installation). File names can be explicit (for example, “error.log” or include wildcards (for
example, “*.log” or “*.*”). Gateway defines File Upload permissions for connect home device
configuration, FTP, and SMTP.
Restart Agent Gateway Determines whether or not the Agent can restart itself as requested, or needs to receive
Device approval for the permission first. This action has no specific parameters.
only
(Can be
modified)
Remote A different Determines whether the Agent can start a remote application session as requested, or needs
Application set of to receive approval for the permission first. Although applications are in general denied
instances access,permissions for specific applications are set at “Always Allow.” Permission Parameters:
is used by name of the remote application interface.
each
device
model
177
Default Policy Values
Default permissions
The following tables identify the permission and access right settings
provided with the default Policy Manager installation:
◆ Table 13 on page 179 provides descriptions for the available
permissions for the Gateway group, as well as the default access
right values.
◆ Table 14 on page 180 provide descriptions for the available
permissions for the Gateway Device server group, as well as the
default access right values.
◆ Tables 18 through 23, page 185 though page 190, provide
descriptions for the available permissions for the various EMC
models or device types supported, as well as the default access
right values.
When a new device registers with the Gateway for the Policy
Manager, it copies the default settings for its particular device type.
! IMPORTANT
Change only the Access Rights for group or device Remote
Application actions.
178 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
179
Default Policy Values
180 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
181
Default Policy Values
182 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
183
Default Policy Values
184 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
185
Default Policy Values
186 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
187
Default Policy Values
188 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
189
Default Policy Values
190 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Default Policy Values
191
Default Policy Values
192 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
C
Invisible Body Tag
Troubleshooting
Troubleshooting 193
Troubleshooting
Symptoms
Use the symptoms of a problem to narrow down the troubleshooting
procedures.
Service does not If the Gateway or Policy Manager service is down and fails to
start up manually start up from the Services window, it is likely from one of
these causes:
◆ Missing (inadvertently deleted or moved) files:
1. Examine the server log file to confirm missing-file errors.
2. Attempt restoration from image backup, or possibly
reinstallation if image backup is not available. See
“Restoration methods” on page 158 .
◆ Virus damage (corrupted files):
1. Run virus checker program to confirm presence of virus, and
if so, attempt virus checker repair.
2. If virus repair is not possible, you may be able to attempt a
reinstallation, as described in “Restoration methods” on
page 158.
OS and hardware If the server failure is clearly occurring at a more basic level than the
failures Gateway or Policy Manager service, you may want to perform a
reinstallation, as described in “Restoration methods” on page 158.
194 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Index
Symbols D
.NET Framework 38, 54, 77 DCM 32
denying requests 134
Deployment Utility 29
A
device access control 33
accepting requests 134
device configuration access control 33
access requests 133
device management 19, 31
access rights 124
digital certificate 19
setting 125
Digital Certificate Management 32
APMAdmin 104
APMUsers 104
Approval email notifications E
changing settings 128 email
architecture 18 configuring 45, 64
audit log 137 testing 64
global 138 EMC access control 34
parameters 138 EMC responsibilites 23
sources 142 ESRSConfig user account 43
authenitcation
LDAP 112
F
file transfer 19
B FileUpload attributes 72
backup FTP
configuring 156 server setup 44
preparation 149
procedure 155
G
restoration 155
Gateway
acrhitecture 18
C components 24
customer responsibilities 23 Deployment Utility 29
Device Extract Utility 30
device management 31
high-availability 29
EMC Secure Remote Support Gateway Release 1.02 Operations Guide 195
Index
server agent 19 N
Gateway server installation 37 non-standard installation 53
GatewayCheck notifications
configuring 85 default 132
failure resolution 94 setting 128
installation 78
logs 90
operation 79 O
registering 81 OnAlert 42
saving results 93 operating system 38, 54
starting 79 OS 38, 54
GatewayCheck utility 75 OS failure 194
GWExt 30
P
H Password
hardware failure 194 APMAdmin 105
heartbeat 19, 20 APMUsers 105
high availablility 24 proxy server 86
password
ESRSConfig 40
I OnAlert 40
Identiry Keystore File 166 Permissions
IIS 39, 55 match parent 126
Internet Information Services 57 parent vs child 126
set all to single value 126
J Policy Maanger
JNDI realm 113 restsart service 101
Policy Manager
device control 28
K installation 100
keystore attributes 168 introduction 25
logging 27
L maintenance 147
LDAP authentication 112 permissions 25
ldap.jar 112 rules 26
Lock shutdown 101
checkbox 126 startup 101
same permission in child’s policy 126 stopping/restarting service 111
unlock a locked permission 126 user accounts 104
policy settings
default settings 124
M global 118
maildrop 47 preset groups 122
Microsoft IIS 39, 55 power sequences 146
preparing a server 37
196 EMC Secure Remote Support Gateway Release 1.02 Operations Guide
Index
R startup 101
registry editing 70 stop service 111
remote access 21 syncronization 25
remote notification 20
requests 133 T
accepting/denying 134 time zone 38, 54, 147
requirement time-out 135
Internet access 77 Tomcat 166
memory 77
network connectivity 77
operating system 77 U
storage 77 user account
restart service 101, 111 configuration 106, 108
restoration 158 planning 105
user account folders 43
user accounts 104
S user authentication 19
server agent 19 username
server installation 37 Policy Manager 105, 116
server settings 40
service restart 101
Setting Notifications 128 V
shutdown 101 version number 117
SMTP VMotion 24
server setup 45 VMware support 24
SSL communication
disabling 173 W
enabling 166 Windows Server 2003 38, 54
standard installation 37
EMC Secure Remote Support Gateway Release 1.02 Operations Guide 197
Index
198 EMC Secure Remote Support Gateway Release 1.02 Operations Guide