Wyse™ Rapport® Management Software
Wyse™ Rapport® Management Software
Quick-Start Guide
Issue: 092104
ii
Copyright Notice
© 2004, Wyse Technology Inc. All rights reserved.
This manual and the software and firmware described in it are copyrighted. You may not
reproduce, transmit, transcribe, store in a retrieval system, or translate into any language
or computer language, in any form or by any means, electronic, mechanical, magnetic,
optical, chemical, manual or otherwise, any part of this publication without express written
permission.
Trademarks
Wyse, WY, and WyseWorks are registered trademarks, and the Wyse logo, Winterm logo,
Wyse, Winterm, Wyse Expedian, and Alcatraz are trademarks of Wyse Technology Inc.
Rapport is a registered trademark of Rapport Technologies Inc., a division of Wyse
Technology.
ICA is a registered trademark and MetaFrame is a trademark of Citrix Systems Inc.
Microsoft, Windows, Windows CE, Windows NT, Windows XP, and Windows Terminal
Server are registered trademarks of Microsoft Corporation.
All other products are trademarks and/or registered trademarks of their respective
companies.
Specifications subject to change without notice.
Ordering Information
For availability, pricing, and ordering information in the United States and Canada, call
1-800-GET-WYSE (1-800-438-9973) or visit us at [Link] In all other
countries, contact your sales representative.
883833-01 Rev. A
September 2004
Wyse Technology Inc.
3471 North First Street
San Jose, CA 95134-1801
Contents
About Rapport Software 1
Related Online Resources Available at Wyse 1
Setting Up Your Environment to Use Rapport Software 2
System Requirements 2
Third-Party Software Requirements 2
About the Desktop Engine 3
About MS SQL Server 3
Port Requirements 4
Port Requirements for HTTP 5
Installing Rapport Management Software 6
About the Rapport Installation Wizard 6
New Installation 6
Upgrade Installation 6
Installation Types 7
Typical Installation 7
Custom Installation 8
Configuring Rapport Software 9
Database Configuration Wizard 9
Discovering Devices 11
Managing Devices 12
Enabling Device Security (Enterprise-Only Feature) 12
Web Agents 12
Creating Software Packages 12
Scripts 13
About Groups and Views 14
Groups 14
Views 15
Default Device Configuration (Enterprise-Only Feature) 15
Adding Rapport Users 15
About the Sale Key (License) 16
Activating the Rapport Sale Key (License) 16
List of Figures
1 Example of a script 14
2 Pick a User dialog box 15
3 New Rapport user 16
4 Results pane 17
5 Licensing Wizard 17
List of Tables
1 Minimum system requirements 2
2 Port requirements 4
3 Typical installation options 7
iv
System Requirements
Any one of the following operating systems is required:
• Windows 2000 Professional (SP3 or higher)
• Windows 2000 Server (SP3 or higher)
• Windows 2000 Advanced Server (SP3 or higher)
• Windows XP Professional
Ensure that your system has the minimum system requirements shown in Table 1:
Note
The actual free space required depends on the number and size of the
packages you register as well as the number of devices you will be managing
(the Rapport Database size). This minimum space assumes the Rapport
Database and packages consume 500 MB.
(SQL) and non-relational sources. These components include Microsoft ActiveX Data
Objects (ADO), OLE DB, and Open Database Connectivity (ODBC).
Note
Although Rapport Management Software requires MDAC 2.7, it is
recommended to use MDAC 2.8. Rapport Management Software 4.4 installs
MDAC 2.8 if it is not already present.
Note
By default, Rapport software installs MSDE 2000. To use an SQL Server
2000 Personal Edition or an SQL Server 2000 Developer Edition, you must
perform a Custom installation (for custom installation procedures, refer to
“Custom Installation” on page 8).
4
Port Requirements
To perform their full range of management functions, Rapport components require certain
ports to remain open on your servers, routers, and switches. Table 2 lists the ports
Rapport software uses and describes the respective communication protocols and their
function.
Rapport
Component Protocol Port Function
Rapport
Component Protocol Port Function
Note
Typically, port 80 is designated as the HTTP port. However, if port 80 (or the
designated HTTP port) is closed, Rapport software will be unable to push
updates or quick commands to devices.
6
New Installation
If you launch the Rapport installation wizard on a system without Rapport components, the
wizard detects this and automatically helps you to perform a new installation.
Upgrade Installation
If you launch the Rapport installation wizard on a system with Rapport components, the
wizard detects these components and automatically helps you to perform an upgrade
installation. In an upgrade case however, you can still choose to install the Rapport
software over an existing installation of Rapport software.
Note
Rapport software version 4.4 upgrades all previous 4.x versions of Rapport
software. It does not upgrade 3.x versions of Rapport software.
7
Installation Types
The two types of installations are Typical and Custom.
Note
Custom installations options may differ depending on the Sale Key (license)
used.
Typical Installation
In a Typical installation, the Rapport installation wizard selects the most common
installation options.
Note
A Typical installation selects the most common installation options regardless
of the Sale Key entered. All components are installed on a single server
using the default options.
Table 3 summarizes the Typical installation options for each of the Rapport components.
Standard Services The wizard installs Standard Services (which requires SNMP
to be installed).
Rapport User The wizard installs the Rapport User Interface, an MMC
Interface snap-in.
Caution
It is highly recommended that you DO NOT install Rapport software on any
server which is currently dedicated to other tasks (such as a Domain
Controller, Backup Controller, Mail Server, Production Web Server, DHCP
Server, MSMQ Server, Application Server, and so on). It is highly
recommended that Rapport software be installed on a server that is
dedicated to Rapport services.
8
Custom Installation
In a Custom installation, the Rapport installation wizard allows you to select configuration
options other than the default options. When performing a Custom installation of Rapport
software, be sure to perform the installation of the components in the order described in
“Installing Rapport Management Software” on page 6.
Note
An Enterprise Sale Key allows the components to be installed on one to five
servers in any combination if the Database is installed first, and the Software
Repository is installed second.
Table 4 summarizes the Custom installation options for each of the Rapport components.
Rapport Database You can select an existing instance of SQL Server 2000 or
allow the wizard to install an instance of MSDE 2000 as the
database. If the wizard does not detect an instance of SQL
Server 2000, installation of MSDE 2000 is the only option
available.
Software Repository You can select an existing FTP service or allow the wizard to
reconfigure Microsoft's Internet Information Services (IIS) FTP
service.
If you are using an existing FTP service, the wizard prompts
you for an IP address, username, and password (Workgroup
licenses allow local IP addresses only). The wizard attempts to
connect to the FTP service to ensure connectivity and read/
write permissions. The Rapport software verifies an existing
connection. It does not configure FTP.
If you are using IIS FTP, the wizard creates a local Rapport
user and assigns the user read/write permissions to FTP.
Standard Services The wizard installs Standard Services (which requires SNMP
to be installed).
Rapport User The wizard installs the Rapport User Interface, an MMC
Interface snap-in.
Caution
It is highly recommended that you DO NOT install Rapport software on any
server which is currently dedicated to other tasks (such as a Domain
Controller, Backup Controller, Mail Server, Production Web Server, DHCP
Server, MSMQ Server, Application Server, and so on). It is highly
9
Note
Be aware of the following:
• Web Services, Standard Service, and User Interface require MDAC 2.8.
• If your network has multiple subnets, consider deploying a copy of the Rapport
Software Repository on each subnet. A Software Repository on each subnet allows
you to store large device applications and image files locally. When you distribute
upgrades to one or more devices on a subnet from a local repository, you reduce
network traffic.
• Rapport software uses SQL authentication. Since there is not an SQL-only mode,
Rapport software utilizes Mixed Mode authentication. Be aware that if you are using
an existing SQL Server that was installed using Windows authentication mode only,
the Rapport Database user will be unable to log-in to the SQL database, and the
installation will fail.
for Rapport software to start working with the devices on your network. After completing
the wizard, you can start discovering and managing devices with Rapport software.
Use the guidelines in Table 5 to complete the Database Configuration Wizard.
User Use the Add a New User command button Completing this dialog
Configuration and enter information to set up users and box allows you to set
assign them permissions. up and administer
Rapport users. After
Note: Completing this dialog box at this time completing this dialog
is optional (you can add and configure box, the Subnet
Rapport users at any time). Information dialog box
is displayed.
Subnet Use the Add a New Subnet command button Completing this dialog
Information and enter information to allow the Rapport box allows the Rapport
Database to keep track of the devices in a software to obtain
given subnet. subnet specifications
so it can begin to
Note: Completing this dialog box at this time discover devices. After
is optional (you can add and configure completing this dialog
subnets at any time). However, until you add a box, the Wizard
subnet, Rapport software cannot discover Completion dialog box
devices. is displayed.
Discovering Devices
Device discovery is the process by which Rapport software becomes aware of the devices
on your network and stores information about them in the Rapport Database. After
Rapport software stores device information in its database, you can use the full range of
Rapport functions to manage your devices.
Table 6 describes the two methods Rapport software uses for discovering the devices on
your network.
Dynamic Discovery Once the Web Agent on any device is aware of the location of
(Web Agent the Rapport Web Service (see Linking Devices with the Rapport
check-in) Web Service, in the Rapport Help File), the Web Agent
checks-in periodically with the Rapport Web Service. This form
of check-in is based on pull communications because the Web
Agent initiates communications. At check-in time, the Web
Agent provides the Rapport Web Service with a set of device
information, such as:
• Device Name
• Hardware information (platform, flash size, memory, CPU,
asset number, serial number, and so on)
• Network Information (WINS, DNS, IP address, Domain
Name, subnet, and so on)
• Image Number
• Software inventory (application names and versions)
• Rapport Web Agent version
Note: You can control the parameter for check-in frequency
through the Device Manager Preferences.
Managing Devices
This section provides important information about managing your devices.
Web Agents
The Web Agent is a service that runs on managed devices and communicates with the
Rapport Web Server. The Web Agent listens for and processes commands from the Web
Server and periodically checks-in to the server to report its status.
Element Description
Rapport A Rapport script file contains a Version header and a Script section. The
Script File header contains the information about the software package. This
(.rsp file) information includes the minimum storage size of the intended devices, the
category under which the package is stored, the intended operating
system, and so on. The script section contains script commands that are
executed sequentially to make changes on the device (for example, file or
registry changes).
Package The package folder contains all the necessary files for the package to be
folder deployed and executed on the intended devices. Be aware that a package
folder always accompanies a software package, even if there are no files
in the folder. For example, a package that retrieves device registry data
can consist of an .rsp file and an empty package folder.
Note
Be aware of the following:
• With the exception of the .rsp file extension, the .rsp file and the folder are named
identically.
• When a package is registered into the Rapport software, the Script File (.rsp) is
stored in the database and the package folder is stored in the Master Software
Repository. These files can be synchronized from the Master Software Repository
to remote software repositories on demand.
• To create custom software packages, contact your Sales Representative.
Scripts
Scripts (see Figure 1) are part of a Rapport software package. Software packages consist
of a folder containing files that are sent to a device and a script containing commands to
be processed by the Web Agent. Rapport Scripting Language consists of two command
sets that are used with either Web Agents or SNMP devices (see Rapport Scripting
Language, in the Rapport Help File). The Rapport Scripting Language is a scripting
language used to perform basic tasks such as copying files and modifying the registry of
the devices that the Rapport software manages. The Rapport scripting language is not a
programming language because it does not support looping, branching, and the use of
subroutines. However, it does contain a small command set to allow it to perform a variety
of routine functions.
14
Groups
Rapport software uses the following three methods to assign devices to groups (in the first
two methods, Rapport software performs the device assignment without your direct
intervention):
• System values of each device
When discovering a device, Rapport software examines the system values of the
device (platform, vendor ID, OS, and so on). Rapport software then groups the newly
discovered devices into the corresponding pre-defined group types automatically.
• Custom Group Type and Group associated with a subnet (Enterprise-Only
Feature)
When you define a subnet, Rapport software allows you to specify whether the devices
in the subnet should be automatically assigned with a specific group type and group.
To accomplish device assignment by subnet, you must create group types and groups
prior to assigning the subnet (see Creating Device Views, in the Rapport Help File).
• Manual assignment
After you have created a Device View and assigned devices to the groups, you can
drag-and-drop a device from one custom group within the View to another custom
group. For example, if a Device View groups devices by department within buildings,
you can easily drag-and-drop a device from the Engineering department in building
Exodus I to the Marketing department in the same building or in another building (see
Moving Devices Across User-Defined Groups, in the Rapport Help File).
15
Views
Views are built on Group Types arranged in a user-assigned hierarchy. You can build
views based on the six built-in group types (OS, Platform, Image number, Subnet,
Location, and Contact), on user-created Custom Group Types, or on any combination of
built-in and user-created Groups.
2. Select the name of the user you want to add as a Rapport user and click Add.
The user name will be displayed in the Add Name text box.
16
3. Click OK.
The Rapport user name will be displayed in the results pane as shown in Figure 3.
Note
A new Rapport user has no permissions. To assign permissions to a user,
refer to Editing User Permissions in the Rapport Help File.
Note
If your Rapport Server does not have an internet connection, go to the
following URL to activate your Rapport License:
[Link]
1. Expand Configuration Manager in the Rapport MMC Snap-in Tree panel and select
Licensing.
The results pane (see Figure 4) shows your Unactivated Sale Key(s).
17
2. Right-click an Unactivated Sale Key from the list and select Activate.
The Licensing Wizard dialog box is displayed as shown in Figure 5.
Note
You can copy-and-paste the Sale Key and Unactivated Key from the Key
Information area into the online Rapport licensing form.