Axeda Platform. Axeda Desktop Server. User s Guide

Transcription

1 Axeda Platform Axeda Desktop Server User s Guide Version 6.1 June 2010

2 Copyright Axeda Corporation. All rights reserved. Axeda Corporation 25 Forbes Boulevard, Suite 3 Foxborough, MA USA (508) Axeda ServiceLink and Axeda Platform software and services ( Axeda Products ) and Questra IDM software ( IDM Software ) are protected by contract law, copyright laws, and international treaties. Axeda Products and IDM Software are supplied under license and/or services contracts with Axeda s customers and only users authorized under the applicable contract are permitted to access and use the Axeda Products and IDM Software. Unauthorized use and distribution may result in civil and criminal penalties. Use, duplication, or disclosure of Axeda software by the U.S. government is subject to FAR and which state that Government shall acquire only the technical data and the rights in that data customarily provided to the public with a commercial item or process and commercial computer software or commercial computer software documentation shall be acquired by the Government under licenses customarily provided to the public to the extent such licenses are consistent with Federal law. The information in this manual is subject to change without notice and does not represent a commitment on the part of Axeda Corporation. This manual and the accompanying Axeda products are copyrighted by Axeda Corporation and contain proprietary and confidential information of Axeda Corporation. All rights are reserved. Any reproduction and/or distribution without the prior written consent from Axeda Corporation is strictly prohibited, except as permitted under the contract between your company and Axeda Corporation. Please refer to the contract for details. "Axeda" is a registered trademark and the "Axeda" logo is a trademark of Axeda Corporation. Questra is a registered trademark of Axeda Corporation. Axeda ServiceLink, Safe Access, Firewall-Friendly, and Maximum Support are trademarks or service marks of Axeda Corporation. Questra IDM Application Suite, Questra RemoteService, Questra SmartMonitor, Questra SoftwareDirector, Questra SoftwareCourier, Questra TotalAccess, A2B, and Asset-to-Business are trademarks of Axeda Corporation. This program is based on UltraVNC Win32 Server This program is licensed under the GNU General Public License Version 2, June Copyright Ultr@VNC Team For more Information and links please visit: Copyright Ultr@VNC Team Copyright Sam - esvnc Copyright Rudi D. V. - VdaccVNC Copyright Const. Kaplinsky - TightVNC Copyright 2002 RealVNC Ltd. RealVNC Copyright 2002 VNC QuickDesk Copyright Tridia Corporation - TridiaVNC Copyright AT&&T Laboratories Cambridge/Olivetti Research Ltd. VNC Copyright Info-ZIP Copyright Markus Franz Xaver Johannes Oberhumer - Mini LZO library Document Number: DesktopServer/UserGuide/6.1/0610

3 GNU GENERAL PUBLIC LICENSE Information GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place - Suite 330, Boston, MA , USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow.

4 GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

5 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

6 It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS

7 Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) 19yy <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WAR- RANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA , USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.

8 Table of Contents Chapter 1 Using This Guide About This Guide Audience Contents Getting Help Supported Platforms Documentation Feedback Chapter 2 Introducing Axeda Desktop Server Overview Auditing by the Axeda Gateway and Axeda Connector Agents Security Features Desktop Server security Encryption Axeda Policy Server and Desktop Server Runtime security and control of the connection Desktop sharing through Axeda Service Remote Sessions module Axeda Gateway and Desktop Server Quick Launch Timeout periods Example of using Desktop Viewer through Axeda Service Support for multiple languages Chapter 3 Installing and Configuring Axeda Desktop Server 3-1 Installing Desktop Server on Windows To install Axeda Desktop Server Installing Desktop Server in Silent Mode Post-installation requirements TOC i

9 Configuring Desktop Server for Windows Setting the Server password To set a Server password (and any other properties in the dialog boxes) Editing the initialization file To edit the initialization file Configuring power management for Windows To enable Wake on LAN or Wake on WIreless LAN Installing Desktop Server on Linux To install Axeda Desktop Server Configuring and Starting Desktop Server on Linux Configuring an Image for Remote Monitors To configure Desktop Server to display an image when remote monitor is blanked To display the image during service Changing Default Settings To ensure port availability To edit the Axeda Desktop Server initialization file Upgrading Desktop Server Uninstalling the existing Desktop Server Installing the new Desktop Server Performing post-installation tasks Restarting Desktop Server To start the Axeda Desktop Server on Linux platforms Upgrading Axeda Desktop Viewer Upgrading Quick Launch To upgrade Quick Launch Chapter 4 Activities at the Axeda Desktop Server Overview of activities Accessing the Desktop Server menu Managing Desktop Viewer sessions To close all remote sessions from the Desktop Server computer To list all remote sessions from the Axeda Desktop Server computer To stop a single Desktop Viewer session To chat with a Desktop Viewer user from the Desktop Server machine Managing the service (Windows) To register Desktop Server as a service using a custom name To install the service from the menu To uninstall (unregister) the service To stop the service To restart the service on Windows TOC ii

10 Managing Desktop Server (Linux) Mouse cursor shape not passed to Desktop Viewer Troubleshooting Enabling debug logging Windows not updating properly When the taskbar icon is disabled CPU Usage higher in non-admin mode Closing Desktop Server To shut down Desktop Server Problems on Microsoft Windows systems Audit messages for Chat sessions Audit messages for File Transfer activities File Transfer Timeout and KeepAlive Interval Appendix A Running Desktop Server on UNIX/Linux...A-1 Running Desktop Server across X11 user sessions... A-2 Running Desktop Server in the display manager... A-2 Running Desktop Server in the user session... A-3 To start Desktop Server automatically in GNOME:... A-3 To start Desktop Server automatically in KDE:... A-3 TOC iii

11 Chapter 1 Using This Guide About this chapter This chapter contains the following major sections: About This Guide explains the intended audience of this guide and summarizes the contents of each chapter contained in this guide. Getting Help explains where to find answers to your questions about Axeda Desktop Server, aside from this guide. Supported Platforms explains how to obtain the supported platform information for Axeda Desktop Server. Documentation Feedback explains how you can help us improve Axeda documentation. About this chapter 1-1

12 About This Guide This section describes the intended audience for this guide and presents a summary of the contents of this guide. Audience This guide assumes that readers are familiar with Axeda Platform, Axeda Builder, and the Axeda Gateway and Axeda Connector Agents. It also assumes readers are familiar with the operating system on which they will install and run Axeda Desktop Server. Contents This guide describes the features that Axeda Desktop Server provides. It then explains how to install, configure, run, and use the server. In addition to this chapter, this guide contains the following chapters: Chapter 2, Introducing Axeda Desktop Server, describes the two main components of Axeda Desktop, Axeda Desktop Server and Axeda Desktop Viewer. Chapter 3, Installing and Configuring Axeda Desktop Server, provides instructions for installing the Axeda Desktop software and for configuring and starting Axeda Desktop Server. This chapter also provides instructions for upgrading Desktop Server, Desktop Viewer, and Quick Launch. This chapter provides instructions for running the installer in silent mode. Chapter 4, Activities at the Axeda Desktop Server, explains additional activities you can perform using Axeda Desktop Server. Appendix A, Running Desktop Server on UNIX/Linux, explains how you can run Axeda Desktop Server on UNIX-based machines across X11 user sessions. About This Guide 1-2

13 Getting Help If you still have questions after reading the documentation for your Axeda product, you can contact Axeda at for help or more information. Supported Platforms This document does not provide information about the supported platforms for Axeda Desktop Server. To obtain this information, contact Axeda at Documentation Feedback As part of our ongoing efforts to produce effective documentation, Axeda asks that you send us any comments, additions or corrections for the documentation. Your feedback is very important to us and we will use it to improve our products and services. Please send your comments to Thank you for your help. Getting Help 1-3

14 Chapter 2 Introducing Axeda Desktop Server About this chapter This chapter introduces Axeda Desktop, and its two components, Axeda Desktop Server and Axeda Desktop Viewer in the following sections: Overview introduces Axeda Desktop and its two main components, Axeda Desktop Server and Axeda Desktop Viewer. Security Features describes the security features of Axeda Desktop. Desktop sharing through Axeda Service briefly describes how users can connect to remote desktops through the Axeda Service application. About this chapter 2-1

15 Overview Axeda Desktop is a desktop sharing program that enables users to view and operate remote assets. It makes a remote computer s user interface (screen area) available for viewing and use by someone at another computer. For example, IT department technicians can help computer users experiencing problems in another building by asking the users to share their desktops. When a desktop is shared, the IT technician can operate the computer to troubleshoot the problem, without ever going to the other building. As another example, a support technician responsible for maintaining multiple remote assets can view the desktop of a remote computer configured to provide an interface to those assets, even if there is no user at the remote computer to initiate the sharing. When a computer desktop is shared, the operator viewing the remote desktop can do anything that the local operator can do, such as viewing messages and starting applications. Axeda Desktop is comprised of two components, Axeda Desktop Viewer and Axeda Desktop Server. The Axeda Desktop Viewer application is the client application that lets you view the desktop of a computer that is running the server component, Axeda Desktop Server. You can share the desktops through a direct network connection on your network or through the Axeda Service application. Once the desktop of the computer running Axeda Desktop Server is shared to the computer running Axeda Desktop Viewer, the operator can view and operate the remote desktop, including uploading log files, downloading software patches, starting applications, viewing configurations, and more. Axeda Desktop supports large file uploads, where large refers to files larger than 2GB. Support technicians can also open Chat sessions with remote operators to assist in troubleshooting a problem or in performing routine maintenance. Remote operators can also initiate Chat sessions with support technicians. The Axeda Global Access Server provides a secure Web server through which the Desktop Server and Viewer computers can communicate. Both computers may be hidden from the Internet through firewalls and proxy servers; however, as long as they can both browse to the Axeda Enterprise server, they can share a session. Because the Axeda Enterprise server is Firewall-Friendly, IT departments do not need to assign external IP addresses, reconfigure firewalls, or install direct telephone lines. The Axeda Enterprise server authenticates users and manages sessions to make administration centralized and easy. Auditing by the Axeda Gateway and Axeda Connector Agents Axeda Desktop Server sends audit messages to the Axeda Gateway or Axeda Connector Agent, which forwards them to the Enterprise server. When a remote session is started, the Agent connects to Axeda Desktop Server, listening on port Desktop Server writes audit messages to this port. Using this method, the Agent can associate each remote session established with Desktop Server with the corresponding Enterprise session. Note: Auditing of file transfers requires release 5.2 or later of the Axeda Enterprise server. When users transfer a directory, all files and sub-directories are transferred; however, only the directory name appears in the audit message. Overview 2-2

16 Security Features This section describes security features for desktop sessions. A Desktop Server machine is typically hidden behind a firewall and cannot be addressed directly. In addition, the organization that owns the machines or assets may require authentication for remote sessions through their RADIUS authentication server. The Axeda Deployment Utility enables Service Technicians to configure the Axeda Gateway and Axeda Connector Agents running on the assets to support the on-site RADIUS server. Once the Agents are configured this way, a Desktop Viewer operator must provide authentication credentials (user name and password) for the RADIUS server as well as for the Axeda ServiceLink Applications and the Desktop Server before a remote session can begin. Desktop Server security The Desktop Server provides ways to limit access to the asset or computer through its properties. These properties let you specify a variety of options, including: The type of incoming connections to accept Authentication requirements Actions remote users can take, such as file transfers Whether to prompt a local user to accept an incoming request for a session What to do if a local user does not respond in the timeout period What to do with multi-viewer connections What to do when the last remote user disconnects For complete information about configuring properties for Desktop Server, refer to Chapter 3, Installing and Configuring Axeda Desktop Server. Authentication The Desktop Server application should be configured with at least the Server password for desktop sharing (also requires a change to a property in the Desktop Server initialization file). If a Server password is configured, the Desktop Viewer operator must know and type that password to share the desktop of that Desktop Server computer. The Desktop Server can also be configured to require a password for View Only users and to require MS Logon, with a user name, password, and domain. Encryption During sessions shared through the Axeda Service application, all data passed between the Desktop Viewer and Desktop Server computers is confidential and made secure with AES (Advanced Encryption Standard) data encryption. Security Features 2-3

17 Axeda Policy Server and Desktop Server If a Desktop Server computer has an Axeda Gateway or Axeda Connector Agent installed (which is required for sessions initiated through Axeda Service), and the agent is configured with Axeda Policy Server support, then the Desktop Server asset is subject to any Axeda Policy Server settings. For example, desktop sharing may not be allowed for that asset. Runtime security and control of the connection An operator at a Desktop Server computer can cancel any active connections or sessions at any time. Also, the Admin properties for the Desktop Server application allow you to prevent more than one connection at a time and to limit the actions of both the local user and a remote user during the shared session to view-only. You can also prevent loss of access to the asset by preventing remote users from shutting down the Desktop Server. If desired, you can configure the Desktop Server to lock the workstation or log off the current user when the last Desktop Viewer client disconnects. Desktop sharing through Axeda Service The Axeda Service application provides an Asset dashboard for every asset that is either manually configured in the Axeda Platform database or that registers itself with the Axeda Enterprise server. On the Asset dashboard, you can view information about and sent in by the asset. If, for example, alarms have been generated by the Axeda Gateway or Axeda Connector Agent running on the asset, you may want to troubleshoot the asset by establishing a Remote Desktop session with the asset. The Asset dashboard provides a Remote Sessions module, from which you can start a Remote Desktop session and download the latest version of the Desktop Viewer application. Note: The Agent project must be configured for Desktop sessions (on port 5920 for the Windows version or 5820 for the Java version) for the Desktop session to be available on the Asset dashboard. Remote Sessions module When starting up, an Axeda Gateway or Axeda Connector Agent includes the list of the remote sessions configured in its project when it registers with the Enterprise server. Once the Agent registers with the Enterprise server, the Remote Sessions module on the Asset dashboard displays the names of these remote sessions. For Remote Desktop sessions, the name is always Desktop. In general, the module shows the session most recently used at the top of the list. If you do not see the session you want to start, you can click View all to display the complete list of remote sessions registered for this asset (Remote Sessions page). Desktop sharing through Axeda Service 2-4

18 When a remote session is active, the Remote Sessions module displays the login name of the user who started or currently owns the session. If the login name is longer than the module space allows, you can point to the partial name to see the entire login name in a tool tip. In addition, an End link appears next to an active remote session. To close the session, click the End link. When prompted to confirm the action, click OK to end the session. Depending on how often the Agent contacts the Enterprise server, it may take a minute or so (check the ping rate shown for the asset on the dashboard) for the Agent to receive the message to End the session and respond; to refresh the dashboard page, click the name of the asset. The Remote Sessions module and the Remote Sessions page both provide access to the Quick Launch feature for Remote Desktop sessions. In addition, they provide a Download Viewer link that will download the viewer application that is appropriate for the asset. Axeda Gateway and Desktop Server If you are running Axeda Gateway on a gateway asset, you can install Desktop Server on that asset and on the assets that Gateway is monitoring. With just Desktop Server running on the managed assets, you can run remote desktop sessions on them as well as on the gateway asset. Note: Keep in mind that you can use Desktop Viewer to connect to Desktop Server only through Axeda Service; you cannot use it to connect through Axeda Access. If you have assets that are running Access Remote, you can create Access Viewer sessions either through Axeda Access or Axeda Service. For the Enterprise server to launch the correct viewer application, the Axeda Gateway and Axeda Connector Agents report the server application and version of the server application running on the asset for which the remote session is requested. When a request for a remote session is sent to the agent for a session of type Desktop, the Agent queries the desktop server on port 8331 and passes the information to the Enterprise server. The information includes the name of the server application, its version number, an rfc flag, the operating system, and the interface name specified in Applications.xml. The rfc flag indicates which versions of the viewer and server are compatible. Once the remote session is established, audit information is passed using port Desktop sharing through Axeda Service 2-5

19 Quick Launch The Quick Launch feature makes it easy to start a Remote Desktop or Remote Application session from the Asset dashboard. As long as you are accessing the Axeda Service application from a Windows or Linux computer, you can take advantage of Quick Launch to start Axeda Desktop Viewer to share the desktop of a remote asset or to start an application on the asset. When necessary, the system can also download the appropriate version of Desktop Viewer to your client computer. If you already have a copy of Desktop Viewer, the system checks that your version is correct for the Desktop Server running on the asset. If not, the system downloads the correct version. Important!After upgrading Desktop Server to a new release, you must also update the Axeda Platform database so that Quick Launch will have the information about the new version and download the appropriate viewer for the new version of Desktop Server. Refer to the section, "Post-installation requirements" on page 3-9, for details. A system administrator must configure the Desktop or Application type of session for the model of the asset to launch automatically, using the Model Remote Interfaces page of the Axeda Configuration application. Otherwise, the system does not automatically start Desktop Viewer or the configured application. The rest of this section focuses on how Quick Launch applies to Desktop Viewer. Configuring Quick Launch Configuring Quick Launch is a multi-step process that system administrators perform. The main steps are to copy the viewer application files to the appropriate directory on the Enterprise server, configure the properties for downloading the viewer applications, and then configure the Desktop remote interface for each model in the Axeda Configuration application. The Axeda Enterprise Server Installation and Maintenance Guide explains how to perform these steps in the chapter on configuring applications. Using Quick Launch To use Quick Launch for a Desktop session, first navigate to the Asset dashboard for the asset that you want to access. From the Remote Sessions module of the Asset dashboard, click the Desktop link. The system sends your request for a Desktop session to the asset and starts the Application Bridge applet. When the asset next contacts the Enterprise server, the remote session is started. Desktop sharing through Axeda Service 2-6

20 The system determines the correct viewer for the desktop server that is running on the asset. For you to use Desktop Viewer, the asset must be running Desktop Server. If Desktop Viewer is not already on your computer, the system determines which version of Desktop Viewer to download for your operating system and the version of Desktop Server. The system then downloads the viewer to your computer. As long as it is configured to do so, the system also launches Desktop Viewer automatically. Refer to "Example of using Desktop Viewer through Axeda Service" on page 2-7 for a complete picture of establishing a Desktop session. Note: The connection options that you select when launching Desktop Viewer through Quick Launch are saved in your Windows user account folder, in C:\Documents and Settings\<your user account>\application Data\AxedaDesktopViewer\options.vnc. When you are ready to end the session, you can close Desktop Viewer and then click End in the Remote Sessions module. If Quick Launch is configured to stop Desktop Viewer once you click End, then you can simply click End Sessions in the Remote Session window or End in the Remote Sessions module to stop Desktop Viewer automatically. Timeout periods For desktop sharing through the Axeda Service application, two timeout periods affect sessions. First, the Desktop Server asset must contact the Axeda Enterprise server to start the session within a default period of 120 seconds of the session s creation. If the asset does not contact the Axeda Enterprise server within that time period, the session is closed. For example, if the asset is offline for more than three minutes, the session would time out. For this reason, it is important for system administrators to coordinate this timeout period with the ping rate (or heartbeat ) for the assets. This rate is displayed in the Asset dashboard (with the general information about the asset). Second, once the session starts, if 60 seconds (the editable default) of inactivity elapse for the session, the session is closed. To configure these timeouts, your system administrator needs to edit the configuration file for the Enterprise server, DRMConfig.properties. For more information, system administrators should refer to the chapter on configuring Axeda ServiceLink Applications in the Axeda Enterprise Server Installation and Maintenance Guide. It contains a section on configuring properties for Axeda Service and the desktop viewing applications. Example of using Desktop Viewer through Axeda Service Let s assume a user is experiencing problems with the ACME application installed on his computer. The user contacts the Service and Support department at ACME. To troubleshoot the problem, the ACME Service Technician needs to share the desktop of the problematic computer. The Service Technician can connect to the Axeda Desktop Server computer through Axeda Service. Desktop sharing through Axeda Service 2-7

21 With an Axeda Gateway or Axeda Connector Agent installed on the Desktop Server asset or on the gateway asset managing the asset, Desktop Server started on that asset, and a remote desktop configuration (listening on port 5920) in the project that the Agent is running, the Service Technician starts her local browser. She logs into the Axeda ServiceLink Applications and opens the Axeda Service application. In the Axeda Service application, the Technician opens the Asset dashboard for the particular asset, and clicks the Desktop link in the Remote Sessions module. Axeda Service starts the Application Bridge applet and displays the following window: Figure 2-1. Starting a remote desktop session The Service Technician types a brief explanation of the activity she intends to perform during the session and clicks Start Session. The following screen appears: Figure 2-2. Waiting for the Agent to retrieve request Depending on how often the Axeda Gateway or Axeda Connector Agent running on the asset contacts the Enterprise server ( ping rate or heartbeat ), 30 seconds or five minutes may pass before the connection is ready. For this reason, it is important for system administrators to coordinate the timeout for remote sessions with the ping rate set for the assets running Desktop Server. Desktop sharing through Axeda Service 2-8

22 This screen displays the name of the asset and the type of remote session (Desktop). The Enterprise server is waiting for the asset to contact it so that it can pass the request for the remote session to the asset. Once the Axeda Gateway or Axeda Connector Agent running on the asset contacts the Enterprise server, the following screen appears: Figure 2-3. Remote connection ready When the Status message area displays the message, Remote connection ready, the ACME Service Technician can click the Launch Application button to request the Enterprise server to start the Desktop Viewer application. If it finds that the Desktop Viewer is not on her computer, the system downloads its current version of Desktop Viewer to the technician s computer. As long as the viewer has been configured to launch automatically for the model, the system starts the application. The Desktop Viewer Authentication dialog box appears: Figure 2-4. Desktop Viewer Authentication dialog box The ACME Service Technician types the password for the Desktop Server running on the asset, and clicks the Log On button. As long as the authentication succeeds, the desktop of the remote computer appears in a window of the monitor on the Service Technician s computer. She can now operate the remote desktop using her mouse and keyboard. She can start programs, initiate a chat session with the Desktop Server user, close and open windows, browse the computer s folders and files, and transfer files to and from the remote computer. Desktop sharing through Axeda Service 2-9

23 If the Service Technician s supervisor wants to review something on the Desktop Server desktop, he would follow the same procedure to make a connection. At that point, there would be two Desktop Viewer computers viewing the same remote desktop. If the supervisor wants to compare the user's ACME application settings to that of another computer, he can create a connection to a second Desktop Server computer from the current session. At that point, he would be operating two different remote desktops through two different remote sessions on his computer. Support for multiple languages Desktop sharing through Axeda Service accommodates computers using different languages and character sets. The computers running the client and server applications for desktop sharing must be configured to support the applicable character sets. Desktop sharing through Axeda Service 2-10

24 Chapter 3 Installing and Configuring Axeda Desktop Server About this chapter The Axeda Desktop Server installation program is available for supported Windows and Linux platforms. The graphical version of this program runs on Windows platforms, while a console version runs on Linux platforms. After installing the software, make sure that each computer or asset has a network connection to the Axeda Enterprise server. Both the Windows and Linux versions of Desktop Server provide a program that un-installs Desktop Server. Refer to the section on upgrading Desktop Server at the end of this chapter for details. This chapter contains the following main sections: Installing Desktop Server on Windows provides step-by-step instructions for installing Axeda Desktop Server on Windows platforms, with a section for additional steps required for running Axeda Desktop Server on Windows Vista and a section explaining how to create a response file and then run the installer in silent mode. Post-installation requirements explains the required post-installation steps for Windows platforms. Make sure you follow these instructions. Otherwise, certain features will not work. Configuring Desktop Server for Windows explains how to configure the Desktop Server and how to start the server on a Windows machine. Installing Desktop Server on Linux provides step-by-step instructions for installing Axeda Desktop Server on Linux platforms. Configuring and Starting Desktop Server on Linux explains how to configure the Desktop Server and how to start the server on Linux machines. Configuring an Image for Remote Monitors explains how to set up the Desktop Server to display an image during a service desktop session. Changing Default Settings explains considerations for creating a custom installer for your assets. This section explains how to edit the AxedaDesktop.ini file for the custom installer to change the default port numbers and also how to check that the port numbers you want to use are available on the asset. Upgrading Desktop Server explains how to upgrade an existing Axeda Desktop Server installation. Instructions are provided for both Windows and Linux platforms. These instructions also explain how to upgrade Desktop Viewer and the Quick Launch feature of the Axeda Enterprise server. About this chapter 3-1

25 Installing Desktop Server on Windows The Axeda Desktop Server installation wizard is provided with the installation CD. With the exception of computers or assets running Windows Vista, you can install the software to any directory location on the computer(s) or asset(s). The maximum number of Desktop Server installations and Desktop Viewer users is specified in your Axeda Desktop license agreement. Important!For all supported Microsoft Windows platforms, you must install Axeda Desktop Server as a service. In addition, you need to verify with your IT department that User Account Control (UAC) and Ctrl+Alt+Del (CAD) are active on the machines where you will be running Axeda Desktop Server before allowing Desktop Viewer users to access the Desktop Server machines. These two Windows security features must be active on the Desktop Server computer for Desktop Viewer users to be able to log in. If you are running Windows Vista, you must install Desktop Server to a secure location. The default location is c:\program Files\Axeda\Desktop, which is a secure location (the Program Files directory is secure ). If you are running Windows 7, you must log in as THE Administrator of the system to install Desktop Server as a service (which is required). If you want to run the installer in silent mode, refer to the section, "Installing Desktop Server in Silent Mode" on page 3-9, just after the installation procedure. To install Axeda Desktop Server 1. Log in as the highest level Administrator on your Windows system. 2. If a Java VM does not already exist on the asset where you are installing Axeda Desktop Server, select the version of the installation program in the VM subdirectory of the installation media. For example, when installing Axeda Desktop Server on a Windows XP-based asset, locate the installation program, Axeda_Desktop_Server.exe, in the directory, <drive_letter>:\windows\vm of the installation media. Be sure that the file, AxedaDesktop.ini, is in the directory from which you run the installer. If the asset does have a Java VM, then select the version of the installation program in the NoVM subdirectory. Using the Windows example again, run the installation program from the directory, <drive_letter>:\windows\novm of the installation media. Be sure that the file, AxedaDesktop.ini, is in the directory from which you run the installer. Important!If you copy the installation program before running it, be sure that you also copy the initialization file, AxedaDesktop.ini. Otherwise, you will be prompted with the properties dialog box immediately on completing the installation. The dialog box is prompting you to create a Server password for Desktop Viewer users to enter when attempting to create a desktop session. Once you enter a Server password and click OK, the dialog box closes. If you do not enter a Server password, the dialog box will not close. Installing Desktop Server on Windows 3-2

26 If you want to change the default port numbers before you install Desktop Server, you need to ensure that the port numbers you want to use are available and then edit the AxedaDesktop.ini file. For complete details, refer to "Changing Default Settings" on page Run the installation program, Axeda_Desktop_Server.exe. The Introduction screen appears, as shown in the following figure: Figure 3-1. Axeda Desktop Server Installer - Introduction 4. Read the information on the screen, and click Next. The License Agreement screen appears, as shown in the following figure: Figure 3-2. Axeda Desktop Server Installer - License Agreement Installing Desktop Server on Windows 3-3

27 5. Accept the license agreement, and, when the button becomes available, click Next. The Choose Install Folder screen appears, as shown in the following figure: Figure 3-3. Axeda Desktop Server Installer - Choose Install Folder 6. In the Where Would You Like to Install? field, leave the default location. Figure 3-3 on page 3-4 shows the default location for Windows computers, c:\program Files\Axeda\Desktop). As long as you are not running Windows Vista, you can change the location; click Choose to browse the file system for it or type a new location in the field. Important!For Windows Vista installations, you MUST install Desktop Server in a secure directory. The default directory, c:\program Files\Axeda\Desktop, is a secure directory. You will get a warning message that Desktop Server will not work correctly if you install it to a location that Vista considers to be not secure. Installing Desktop Server on Windows 3-4

28 7. When ready, click Next. The Service screen appears, as shown in the following figure: Figure 3-4. Axeda Desktop Server Installer - Service Important!By default Desktop Server is selected to be installed as a service. Installing as a service is required for all Windows installations. 8. Leave the Install as a service check box selected, and click Next. You are prompted whether to start the service immediately after installation, as shown in the following figure: Figure 3-5. Axeda Desktop Server Installer - Start Service 9. By default, the installation program will start the Axeda Desktop Server when installation is complete. This setting is recommended so that you can set the Server password for the Installing Desktop Server on Windows 3-5

29 Desktop Server immediately after installation. To keep this setting, continue to the next step. If you do not want to start the service after installation, you can clear the Start service check box. 10. Click Next. The next Service screen prompts you for a name for the service: Figure 3-6. Axeda Desktop Server Installer - Service Name 11. The default name for the service is Axeda Desktop Server. If desired, select the text and type the name you want to use. 12. Click Next. The Pre-Installation Summary screen appears, as shown in the following figure: Figure 3-7. Axeda Desktop Server Installer - Pre-Installation Summary Installing Desktop Server on Windows 3-6

30 This screen shows the location you chose to install the software as well as how much disk space is required for the installation and how much disk space is available. Important!For all Windows platforms, you must install Desktop Server as a service. In addition, if you are running Windows Vista, you must install Axeda Desktop in a secure directory, which the directory, c:\program Files, is. If you did not make these selections, click Previous to change these installation settings. For Windows 7, installing Desktop Server as a service will fail unless you are logged in as THE Administrator of the system. 13. Review the installation information, and when ready, click Install. The Please Wait screen appears. Note: If you are installing Desktop Server on a Windows 7 or Windows 2008 Server machine, a dialog box may appear, requesting the installation of the software, UVNC BVBA Display Adapters. Click Install so that this driver is installed with the Desktop Server software. This dialog box follows: Additional messages from the installation program appear quickly in succession; you may not see all of them. The first message informs you that the installer is opening port 5920 for use by Axeda Desktop, as shown in the following figure: Figure 3-8. Axeda Desktop Server Installer - opening port 5920 message The second message informs you that the video drivers are being installed and that the flickering of your screen is normal: Figure 3-9. Axeda Desktop Server Installer - installing drivers, flicker is normal message Installing Desktop Server on Windows 3-7

31 The third message tells you that the installer is registering Desktop Server as a service, as shown in the following figure: Figure Axeda Desktop Server Installer - registering as service message Note: If you need to re-install the Desktop Server, you do not need to stop the service before re-installing the software. The installation program detects that the existing Axeda Desktop Server service is running, stops it, and unregisters it. The messages informing you that the installation program is stopping and unregistering the existing service appear in quick succession, so you may not see both of them. In addition, if the video drivers are already installed and you choose not to overwrite the existing driver, the second message does not appear. When the installation is complete, the following screen appears: Figure Axeda Desktop Server Installer - Installation Complete 14. To exit the installer, click Done. 15. To verify that the service is running, look for the icon in the notification area of your Windows taskbar ( ). Installing Desktop Server on Windows 3-8

32 Installing Desktop Server in Silent Mode The installation package for Axeda Desktop Server (Windows) is an InstallAnywhere installer. To generate a response file to use with this installer in slient mode, use a command similar to the following: Axeda_Desktop_Server.exe -r c:\temp\response.properties Note: The installer will NOT create a new directory, so before you start, make sure that the c:\temp diirectory exists. To suppress the requirement for a password during silent installation, open the AxedaDesktop.ini file in a text editor such as Notepad and make sure that the value of the AuthRequired property is 0. Save and close the ini file and put it in the directory where the installer is located. Then proceed with the installation. To run the installer in silent mode, use a command similar to the following: Axeda_Desktop_Server.exe -i silent -f c:\temp\response.properties The changes you might make to these commands would be the location of the response.properties file. Post-installation requirements Important!To ensure authorized access to the asset running Desktop Server, you must set the Server password for Desktop Server in the Admin Properties dialog box and you must set the AuthRequired property in the AxedaDesktop.ini file to 1. If you are running on Windows platforms, you need to verify with your IT department that User Account Control (UAC) and Ctrl+Alt+Del (CAD) are active on the assets or computers where Desktop Server will be running. To be able to log on from Desktop Viewer, users must be able to issue Ctrl+Alt+Del. In addition to the UAC and CAD settings, Axeda Desktop Server must be running as a service. In addition, you need to make sure that Terminal Service is running. This service provides fast user switching, and remote desktop support. If it is not running, remote sessions cannot be established. Contact your IT department if this service is NOT running. If you are running Desktop Server on a 64-bit Windows 7 machine and the machine may go into sleep mode often, you need to configure the machine for Wake on LAN or Wake on Wireless LAN so that Desktop Viewer can awaken the machine. To enable this wake up feature, refer to the section, "Configuring power management for Windows 7" on page Next, you need to set other runtime properties and screen settings for users. The next section explains the configuration requirements and options. Post-installation requirements 3-9

33 Notes:The installation program automatically installs mirror drivers for Desktop Server on 32-bit Windows XP, Win2000, and 32-bit Windows Vista systems. When mirror drivers are installed and active, performance of remote desktop sessions improves significantly. To see which versions of the mirror drivers are installed (once the server is running), right-click the Desktop Server icon in the notification area of the taskbar, select Properties, and in the dialog box, click the Check the Video Hook Driver button. A dialog box displays the active version of the mirror driver. The mirror drivers will interfere with the display of a background image when a Desktop Viewer user selects to disable remote input and blank the remote monitor. You must disable the mirror drivers for the image to display while the remote desktop session is in progress. The Desktop Server cannot take advantage of the mirror driver in non-admin mode. Therefore, the CPU usage will be higher than when it is running in admin mode. On Windows XP, to attach the mirror driver to a desktop, it is necessary to modify the system registry under HKEY_LOCAL_MACHINE\SYSTEM. This operation is not allowed under a non-admin user account, so Axeda Desktop Server cannot use the mirror driver. As a result, it falls back to the Windows Hook mechanism, which is far less efficient. Configuring Desktop Server for Windows If you kept the option, the Desktop Server service starts immediately after installation. The server icon appears in the notification area of the taskbar on the Windows desktop. If this area contains more icons than can be displayed, you may need to click the << button to display Desktop Server icon. The Desktop Server has an initialization file (AxedaDesktop.ini) that sets default values for the server to use in handling incoming requests for connections. By default, anyone (administrator or non-administrator) can view and edit the default values in the two properties dialog boxes for the Desktop Server. The AxedaDesktop.ini file is located in c:\program Files\Axeda\Desktop\Server (by default). Important!To ensure authorized access to the asset running Desktop Server, you must set the Server password for Desktop Server and you must set the AuthRequired property in the AxedaDesktop.ini file to 1. You can also set a View Only password and require an MS Logon (User/Password/Domain). However, do NOT set the View Only password without setting the Server password. The Server and Admin passwords can be set ONLY in the Admin Properties dialog box. Next, you need to consider whether non-administrator users should be able to change any of the property values through the two administrative dialog boxes, including the Server password. This capability can be configured in the Desktop Server initialization file only. After setting this property, edit any other properties in the initialization file that cannot be edited in the dialog boxes. For property changes in the initialization file to take effect, you need to restart the service. The rest of this section explains the configuration options for the Desktop Server. Configuring Desktop Server for Windows 3-10

34 Setting the Server password By default, the requirement for authentication is disabled. To enable the requirement for authentication, first set the Server Password. Then, you must set the property in the initialization file (AxedaDesktop.ini), AuthRequired, to 1 to require authentication. If desired, you can also set a View-Only Password and require an MS Logon. To set a Server password (and any other properties in the dialog boxes) 1. Assuming that you kept the default setting to start the service immediately after installation, right-click the server icon ( ) in the notification area of the taskbar), and on the context menu, select Admin Properties. The Axeda Desktop Server Property Page appears, as shown in Figure 3-12: Figure Axeda Desktop Server Property Page (Admin Properties) 2. In the Server Password field under Authentication, select the bars and type the password for the Desktop Server. The password appears as bars as you type. You will need to notify Desktop Viewer users of this password. In the AxedaDesktop.ini file, the password appears in the [ultravnc] section after you add it, in an encrypted format. For example: [ultravnc] passwd=f326a a7501 Configuring Desktop Server for Windows 3-11

35 3. If you want to allow certain users View-Only access, enter a View-Only Password. Note that you must have a Server Password (and set AuthRequired to 1) as well to prevent unauthorized access to the machine where Desktop Server is running. As with the Server Password, the View-Only Password appears in the [ultravnc] section of the AxedaDesktop.ini file after you add it, in an encrypted format. For example: [ultravnc] passwd2=b82b048ac11e To save the passwords, click Apply. 5. If desired, you can set other properties at this time. Refer to Table 3-1, Desktop Server properties (ini file and UI) for details about the properties. The table shows the default values for the properties as well as the name that appears in the initialization file and brief descriptions. 6. To exit the dialog box, click OK. 7. To set screen-related properties, right-click the Desktop Server icon again, and on the context menu, select Properties. The Axeda Desktop Server Properties dialog box displays the default values for properties that control Server Screen Updates and whether to share only one window, as shown in Figure 3-13: Figure Axeda Desktop Server Property Page (Properties) 8. As needed for your environment, change the default settings. Refer to Table 3-1, Desktop Server properties (ini file and UI) for details about the properties. The table shows the default values for the properties as well as the name that appears in the initialization file and brief descriptions. Tip If you want to display an image that indicates to your customers that an asset is being serviced, refer to "Configuring an Image for Remote Monitors" on page Configuring Desktop Server for Windows 3-12

36 9. Click Apply to save the settings. 10. Click OK to exit the dialog box and keep the settings. After setting properties, if you want to prevent other users from changing them through the user interface, edit the initialization file. Editing the initialization file The initialization file (AxedaDesktop.ini) sets default values for the server to use for incoming requests for connections. By default, the file is located in the installation directory, c:\program Files\Axeda\Desktop\Server. Table 3-1, Desktop Server properties (ini file and UI), on page 3-15 lists the properties in this file, their default values, descriptions of the properties, and the corresponding names of the properties in the dialog boxes available through the Desktop Server menu commands, Admin Properties and Properties. For properties that enable or disable a feature, a value of 0 means that the feature is disabled and a value of 1 means that it is enabled. To edit the initialization file 1. Assuming you chose the default (and secure ) directory, navigate to the c:\program Files\Axeda\Desktop\Server directory. 2. Open the AxedaDesktop.ini file in your favorite text editor. 3. If you have not already set the AuthRequired property to 1, make that change first. 4. Axeda strongly recommends that you limit the use of polling mode (full-screen polling) because it can consume 100 percent of the CPU, especially on older hardware. To follow disable polling mode, locate the [poll] section near the end of the AxedaDesktop.ini file and make sure that the follow properties are Enabled (set to 1 in this file): Video Hook driver (EnableDriver=1) System Hook DLL (EnableHook=1) Poll Foreground Window (PollForeground=1) Poll Console Windows Only (OnlyPollConsole=1) Poll On Event Only (OnlyPollOnEvent=1) 5. To complete the disabling of polling mode, make sure that the following properties are Disabled (set to 0 in this file): Poll Window Under Cursor (PollUnderCursor=0) Poll Full Screen (Ultra Fast) (PollFullScreen=0) Configuring Desktop Server for Windows 3-13

37 6. If you want to allow local operators to use some of the features on the Desktop Server menu but not others, change the following property settings: To prevent remote Desktop Viewer users and local operators from changing the Server password or any other properties for the Desktop Server, search for the property, AllowProperties. Its default value is 1 (enabled). Changing the value to 0 renders the Admin Properties and Properties menu items unavailable. To prevent local operators from using the menu items related to Desktop Viewer sessions ( clients ), search for the property, AllowEditClients. Its default value is 1 (enabled). Changing the value to 0 renders the List All Clients, Add New Client, and Kill All Clients menu items unavailable. To prevent remote Desktop Viewer users or local operators from using the Close Axeda Desktop Server menu command to shut down the server, search for the property, AllowShutdown. Its default value is 1 (enabled). Changing the value to 0 renders the command unavailable on the menu. To completely prevent remote or local operators from accessing the Desktop Server menu, search for the DisableTrayIcon property and set it to 1. This property is also available by selecting Admin Properties, and in the dialog box under Misc, selecting or clearing the Disable Tray Icon check box. Note that if you make this change from the dialog box instead of the initialization file, you still need to restart the server for it to take effect. 7. If desired, change the values of additional properties. Table 3-1, Desktop Server properties (ini file and UI) lists the properties in the initialization file in alphabetical order, by the section in which they appear ([admin], [ultravnc], and [polling]) As applicable to the property, the table then shows the name of the property as it appears in one of the two properties dialog boxes, the default value of the property, the menu selection required to display the dialog box where the property appears, and finally, an explanation of the property and, as appropriate, its possible values. Keep in mind that a value of 0 typically means disabled, while a value of 1 means enabled. 8. If desired, you can change the default value for the timeout during file transfers (30 seconds). This value is not visible in the user interface, nor is it included in the default initialization file. To change the default value, locate the FileTransferTimeout parameter in the [admin] section of the initialization file, and specify a number of seconds, up to a maximum of 60 seconds. 9. After making your changes, save and close the file. Configuring Desktop Server for Windows 3-14

38 10. Restart the Desktop Server service through your Windows administrative tools. The following steps are based on Windows XP: a) On the Start menu, select Control Panel. b) In the Control Panel window, select Administrative Tools. c) In the Administrative Tools window, select Services. d) In the Services window, locate the name of the service, Axeda Desktop Server, and select it. e) When the command becomes available, click Restart the service. Table 3-1. Desktop Server properties (ini file and UI) Ini File UI Name Default Menu Description [admin] section AllowEditClients Not available in the UI 1 N/A When enabled (1), the Desktop Server operator can use the Client options on the Desktop Server menu to end Desktop Viewer sessions (Kill All Clients), view a list of sessions (List All Clients), or start a new session (Add New Client). AllowLoopback Incoming Connections > Allow Loopback Connections check box 1 Admin Properties This option is enabled by default and must be left enabled when Desktop Server is running on a machine with the Axeda Gateway or Axeda Connector Agent so that Desktop Server can accept connections from the Agent that is on the same machine. For assets that are managed by an Axeda Gateway and running Desktop Server only, disable this option. See also "Notes about loopback settings" on page AllowProperties Not available in the UI 1 N/A This property allows users at the Desktop Server machine to view and modify the properties, through the Admin Properties and Properties dialog boxes. This feature is enabled by default. AllowShutdown Misc > Forbid the user to close down Axeda Desktop Server check box 0 Admin Properties To prevent Desktop Viewer users and operators at the Desktop Server machine from using the Close Axeda Desktop Server command on the menu, set this property in either of the following ways: UI - select the check box Ini file - set the property to 0 By default, Desktop Server runs as a service, and this command is not available. This command does NOT stop the service. Configuring Desktop Server for Windows 3-15

39 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description AuthHosts Not available in the UI Empty (meaning connections from all hosts are accepted) NA Axeda strongly recommends that you leave the default setting of this property because this property has not been tested by Axeda. You can use this property to specify a set of IP address templates that incoming connections must match for Desktop Server to accept them. By default, the template is empty and connections from all hosts are accepted. The template uses the colon character (:) to indicate that the template has multiple entries and then to delimit those entries. Each entry can take one of the following formats: +[ip-address-template] tells Desktop Server to include (allow) all IP addresses that start with the IP address components that follow. For example, Desktop Server allows connections from incoming IP addresses that start with ?[ip-address-template] tells Desktop Server to present the query dialog box that allows the operator to accept or deny the connection for all IP addresses that start with the IP address components that follow. For example,?169 tells Desktop Server to present the query dialog box for all connection requests that come from IP addresses that start with [ip-address-template] tells Desktop Server to exclude (not allow) any IP addresses that start with the IP address components that follow. When this character appears at the beginning of the template (for example, -: :+10.1), it tells Desktop Server to exclude all connection requests except those from the IP addresses that follow. In these formats, [ip-address-template] represents the leftmost bytes of the desired IP address (where the IP address is a String). For example: AuthHosts=-: :+10.1:?169 This example tells Desktop Server to exclude all IP addresses except the set specified in the IP address templates that follow. This example provides three IP address templates. The first one, , tells Desktop Server to accept connections from all IP addresses starting with The second entry, +10.1, tells Desktop Server to accept connections from all IP addresses starting with The third entry,?169, tells Desktop Server to present the query dialog box for all IP addresses that start with 169. Configuring Desktop Server for Windows 3-16

40 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description AuthRequired Server Password 0 Admin Properties To apply security to the Desktop Server, a Server password and a value of 1 for this property are required. With the default setting of 0 for AuthRequired, an empty password or junk characters in a password are allowed. To set a password in the dialog box, type a password that is unique to this machine in the Admin Properties dialog box (under Server Password). You can also set a View-Only password. Once you set the password in the dialog box, Desktop Viewer users must enter this password to establish a remote session with this machine. The Desktop Server stores the password, in encrypted format, in the [ultravnc] section of the initialization file. It is recommended that you remove this property from the initialization file if you are not requiring a password. AutoPortSelect Incoming Connections > Display Number or Ports to use > Auto option 1 Admin Properties Desktop server uses the default port numbers for incoming connections, 5920 for Desktop Viewer connections and 5820 for JavaViewer connections (browser). To use different ports (not recommended), disable this option (0 or clear the radio button). Avilog Not available in UI 0 NA By default this property is disabled. Leave it disabled. BlackAlphaBlending Misc > Enable Blank Monitor on Viewer Request > Enable Alpha- Blending Monitor Blanking check box 1 Admin Properties For this property to be available in the Admin Properties dialog box, the Enable Blank Monitor on Viewer Request option (property name - BlankMonitorEnabled) must be set to 1 or enabled (which is the default). In addition the Disable Only Inputs on Blanking Request (BlankInputsOnly property) must be disabled (also the default). This property provides another method of disabling the monitor of the Desktop Server machine. However, if the Video Hook Driver option is eanbled, this property has no effect. That is, when Video Hook Driver is enabled, the monitor blanking is always achieved by turning off the monitor. Configuring Desktop Server for Windows 3-17

41 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description BlankInputsOnly Misc > Enable Blank Monitor on Viewer Request > Disable Only Inputs on Blanking Request 0 Admin Properties For this property to be available in the Admin Properties dialog box, the Enable Blank Monitor on Viewer Request option (property name - BlankMonitorEnabled) must be set to 1 or enabled (which is the default). By default, this property is disabled and not visible in AxedaDesktop.ini. Once you enable the option in the Admin Properties dialog box, this property is added to the ini file and is set to 1. You can then disable the property by setting it to 0 or clearing the check box in the Admin Properties dialog box. If you enable this property, the Enable Alpha- Blending Monitor Blanking option is not available. With this property enabled, no actual screen blanking takes place. Instead, only mouse and keyboard inputs are disabled. BlankMonitorEnabled Misc > Enable Blank Monitor on Viewer Request check box 1 Admin Properties By default, this property is enabled (1), which means that a remote Desktop Viewer user can request to disable the monitor of the Desktop Server machine during a session. To keep the monitor available, disable (set to 0 or clear the check box) this property. This property must be enabled for the Enable Alpha-Blending Monitor Blanking and Disable Only Inputs on Blanking Request options to be available. CaptureAlpha- Blending Misc > Capture Alpha-Blending check box 0 Admin Properties If set, Desktop Server captures pixel transparency along with the red, green, and blue components of the pixel. (Note: In testing on Windows XP, it does not matter if this property is on or off; transparency is captured in either case.) ConnectPriority Multi Viewer Connections 2 Admin Properties In the dialog box, select the option; in the ini file, type the number of the option to use: 0 - Disconnect all existing connections 1 - Keep existing connections 2 - Refuse all new connections DebugLevel set in Registry 0 Properties Controls the verbosity of the server when debug logging is enabled. Higher numbers give more detail. DebugMode Misc > Log debug info to a file 0 Admin Properties Enables or disables logging. By default, logging is disabled (0). To enable logging, set this property to 2. The log file is stored in the C:\Windows\system32 directory if Desktop Server is running as a service. You can enable debug logging without restarting the service. Within approximatly five seconds of saving and closing AxedaDesktop.ini, Desktop Server will starting writing to AxedaDesktop.log. Configuring Desktop Server for Windows 3-18

42 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description DefaultScale Misc > Default Server Screen Scale: 1 / 1 Properties By default the scaling of the Desktop Server screen to the Desktop Viewer window is 1 / 1. You can change this scaling by setting the denominator of this ratio in the text field. DisableTrayIcon Misc > Disable TrayIcon check box 0 Admin Properties If you do not want the Desktop Server icon to appear in the notification area of the Windows taskbar, enable this option (1). The default setting is to show the icon. A change to this setting either from the dialog box or in the initialization file requires that you restart Desktop Server for it to take effect. DSMPlugin DSM Plugin > list control Not set Admin Properties Not currently used EnableJapaneseInput EnableJapInput Keyboard and Mouse > Japanese 0 Admin Properties Disabled by default. When enabled, allow mapping of certain keys on Japanese keyboards to function (for example, backslash, yen, and kana_wo). FileTransferEnabled File Transfer > Enable check box 1 Admin Properties By default, the ability of users to transfer files to or from this machine is enabled and this property does not appear in the AxedaDesktop.ini file. If you want to disable file transfers, clear the check box for this option in the Admin Properties dialog box When you save the change, this property becomes available in the ini file, set to 0. FileTransferTimeout Not available in UI 30 Not available The default value is 30 seconds. This value suffices for most environments. If you are changing this value and the KeepAliveInterval value, make sure that the value of the FileTransferTimeout is greater than that of the KeepAliveInterval. Otherwise, Desktop Server will use the value of the FileTransferTimeout minus 1 second, for the KeepAliveInterval. FTUserImpersonation File Transfer > User impersonation (for Service only) check box 1 Admin Properties By default, this property is enabled. The Desktop Server must be running as a service for this property to take effect. Basically, it enables the server to transfer files using the credentials of the currently logged in user. HTTPConnect Incoming Connections > Enable JavaViewer (Http Connect) 0 Admin Properties By default, the JavaViewer is disabled. This option enables a user to view the Desktop Server machine by opening a browser and entering the address, IP_address:http-port/ where IP_address is the IP address of the Desktop Server machine and http-port is the HTTP port number for the JavaViewer (by default 5820). Configuring Desktop Server for Windows 3-19

43 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description HTTPPortNumber Incoming Connections > Display Number or Ports to use > Ports option > Http (port number) 5820 Admin Properties This property sets the number of the port on the Desktop Server machine that a JavaViewer client should use for communicating with Desktop Server. To run a viewer on Linux, you need to use the JavaViewer client. IdleTimeout Not available in UI 0 The number of seconds to wait for data from the client (Desktop Viewer) before disconnecting. InputsEnabled Keyboard & Mouse > Disable Viewers inputs check box 1 Admin Properties If a situation requires that the Desktop Viewer users not be able to send keyboard or mouse events to the Desktop Server computer, select this option. When this option is disabled, the Viewer users can send keyboard and mouse events to the Desktop Server computer. KeepAliveInterval Not available in the UI 5 N/A The default value is 5 seconds. This value is used if you do not specify a value. In addition, if you specify a value for this property that is greater than the FileTransferTimeout, then Desktop Server uses the value of the FileTransfterTimeout, minus 1 second, instead of the value you specified. Note regarding interaction with QuickLaunch: It is rather inconvenient to create a default options file on each computer used to access a remote system or to edit the Quick Launch command for each model that requires a customized keepalive interval. Therefore, when Axeda Desktop Server detects that a compatible Desktop VIewer has connected, the keepalive interval that Desktop Server is using is sent to the Viewer. This new value is then used by both ends of the connection during any file transfers that may occur during that session. This eliminates the need for client-side configuration of the keepalive interval, unless further tuning is required. LocalInputsDisabled Keyboard & Mouse > Disable Local inputs check box 0 Admin Properties If a situation requires that the Desktop Server operator not be able to use the keyboard or mouse while a remote Desktop Viewer user is connected, select this option. LockSetting When Last Client Disconnects > Do Nothing, Lock Workstation (W2K), or Logoff Workstation options 0 (Do Nothing option) Admin Properties In a help desk situation, the typical setting is to Do Nothing when disconnecting. When managing assets or computers remotely through Axeda Desktop, security may require that you choose to lock the workstation (1) or log off the workstation (2). Configuring Desktop Server for Windows 3-20

44 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description LoopbackOnly Incoming Connections > Loopback Only check box 0 Admin Properties When the Axeda Gateway or Axeda Connector Agent and Desktop Server are installed on the same machine and you want Desktop Server to accept connections from the Agent running on its machine, you must enable this option. When the Axeda Gateway or Axeda Connector Agent and Desktop Server are running on different assets, disable this option on the Desktop Server assets (for example, on assets managed by an Axeda Gateway). See also "Notes about loopback settings" on page MSLogonRequired Authentication > Require MS Logon (User/ Pass/Domain) check box NewMSLogon Authentication > New MS Logon (supports multiple domains) check box 0 Admin Properties 0 Admin Properties When this check box is selected, MS-Logon I is activated. This feature works on Windows 9x as well as Windows NT4, 2000, and XP. This option requires that the Desktop Server computer and the Desktop Viewer user be in the same domain. For cross-domain authentication, select NewMSLogon. To configure MS-Logon authorization, click the Configure MS Logon Groups button. For MS-Logon I, the dialog box allows you to configure three groups. When this check box is selected, MS-Logon II is activated. This feature allows for crossdomain authentication, where the Desktop Server machine is in one domain and the Desktop Viewer user is in another domain, with a trust between the two domains. This domain configuration is typical of MS Active Directory Server. This feature works only on Windows NT4, 2000, and XP. To configure MS-Logon authorization, click the Configure MS Logon Groups button. Note that you need to authenticate with an account with administrator privileges and you need to clear the check box next to Protect my computer and data from unauthorized activity in the Run As dialog box. path Not available in UI path where you installed Desktop Server NA The value of this property is set by the Desktop Server service on Windows machines. DO NOT CHANGE THIS PROPERTY. PortNumber Incoming Connections > Display Number or Ports to use > Ports option > Main (port number) 5920 Admin Properties This property sets the number of the main port on the Desktop Server machine that the Axeda Desktop Viewer should use for communicating with Desktop Server. Keep the default port number If you want to override the default port number, make sure that AutoPortSelect is set to 0 (disabled). Configuring Desktop Server for Windows 3-21

45 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description primary Not available in UI 1 NA When the machine running Desktop Server has dual screens, this property tells Desktop Server whether to share the primary screen. To share the primary screen, set this property to 1 (the default). If you do not want to share the primary screen, set this property to 0. QueryAccept Query on incoming connection > Default action: Refuse/Accept options 0 (Refuse option) Admin Properties If you enable the prompt for incoming connections, specify whether Desktop Server should always refuse or accept connections when the local operator does not respond to the prompt within the timeout period. QueryIfNoLogon Not available in UI 0 NA This property tells Desktop Server what to do if the machine where it is running is locked (that is, no one is logged on). If you enable this property (set it to 1), Desktop Server will display the query dialog box that prompts an operator to accept or deny an incoming request for a connection when the machine is locked. If you leave the default setting (0), Desktop Server will not display the query dialog box when the machine is locked. QuerySetting Query on incoming connection > Display Query Window check box 2 Admin Properties If enabled, the local Desktop Server operator is prompted to accept or refuse every connection request from Desktop Viewer users. If you enable this option, configure the timeout for this prompt and the action that the Desktop Server should take if the local operator does not respond in the timeout period (Refuse/Accept the connection). QueryTimeout Query on incoming connection > Timeout seconds 10 Admin Properties If you enable the prompt for incoming connections, specify a timeout, in seconds. RemoveAero Remove Aero (Vista) 1 Admin Properties Disables the new User Interface on Vista for improved performance. Enabled by default RemoveWallpaper secondary Misc > Remove Wallpaper for Viewers Not available in UI 1 Properties To speed up response time for communications with Desktop Viewer, leave this property enabled. This setting prevents the wallpaper image on the Desktop Server s desktop from being transmitted to the Desktop Viewer window. 0 NA When the machine running Desktop Server has dual screens, this property tells Desktop Server whether to share the secondary screen. To share the secondary screen, set this property to 1. If you do not want to share the secondary screen, set this property to 0 (the default). Note: The misspelling of secondary is from UltraVNC, not Axeda. Configuring Desktop Server for Windows 3-22

46 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description SocketConnect Incoming Connections > Accept Socket Connections 1 Admin Properties By default, this option is enabled (selected) and should remain enabled for normal operation. You can configure the Display number and Ports to use or select Auto, which automatically uses Display 0, Port 5920, and JavaViewer (Http) port 5820 (JavaViewer is for Linux machines). UseDSMPlugin DSM Plugin > Use check box 0 Admin Properties Not currently used UseRegistry XDMCPConnect Not available in UI Not available in UI 0 NA Do not change this property setting. NA Not Used Ignore this property. [ultravnc] section - properties appear only if you enter passwords in the dialog box. passwd Server Password Empty Authentic ation After you enter a password for Desktop Server in the Admin dialog box, an encrypted version of the password appears in this property. Desktop Server requires Desktop Viewer users to enter this password before it allows the Viewer user to connect. passwd2 View-Only Password Empty Authentic ation After you enter a View-Only password in the Admin dialog box, an encrypted version of the password appears here. [poll] section - corresponds to the Server Screen Updates Handling section of the Properties dialog box (per-user) Note: When the mirror driver is in use, all of the polling properties are ignored. EnableDriver Video Hook Driver 1 Properties In general, you may want to keep this property enabled. The video driver hook provides high speed and low CPU load on Windows 2000, XP, and In the dialog box, you can test the video hook driver, see the version number, and check whether it is currently active by clicking Check the Video Hook Driver. Note that the driver is not active unless there is a connected client. Checking the video driver when no client is connected will always say not active Note: When this option is enabled, the Enble Alpha-Blending Monitor Blanking option has no effect, and the only way to achieve monitor blanking is to turn off the monitor. EnableHook System Hook Dll 1 Properties Keep this property enabled. The system hook DLL provides DDI hooking. EnableVirtual Not in UI 0 N/A Not used. Configuring Desktop Server for Windows 3-23

47 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description OnlyPollConsole OnlyPollOnEvent PollForeground PollFullScreen PollUnderCursor SingleWindow Poll Console Windows Only Poll On Event Only Poll Foreground Window Poll Full Screen (Ultra Fast) Poll Window Under Cursor Single Window Sharing - Share only the Server window Named 1 Properties Keep this property enabled (1), Wnen this property is enabled, Desktop Server looks only for changes to console windows (Command Prompt windows) and ignores other screen updates. Enabling this property in conjunction with PollUnderCursor works well when you want to use polling only when the cursor is over a Command Prompt window. 1 Properties Keep this property enabled (1), Desktop Server looks for changes only when the remote user has done something (moved the mouse, pressed keys on the keyboard). Leaving this property enabled reduces system load when the remote user is idle. It is useful in networks with low bandwidth, where controlling the frequency of sending updates improves overall performance. 1 Properties Keep this property enabled (1). Desktop Server will poll only the currently selected window for changes. This setting is strongly recommended to avoid 100 percent CPU usage (especially on older hardware). 0 Properties Axeda strongly recommends that you avoid this mode by leaving this property disabled (0). Full-screen mode can consume 100 percent of the CPU, especially on older hardware. 0 Properties A variation on Poll Foreground Window, enabling this property causes the window under the mouse cursor to be polled for changes. If necessary, you can enable both this property and PollForeground at the same time. To update only the window where the cursor is positioned by the Desktop Viewer user, enable (1) this option. [empty] Properties If set to 1 (check box selected), enables sharing of only the window (on the Desktop Server machine) whose name matches that entered in the text field (only the first 15 characters are considered). This is currently broken from the server side. A client can share just one window through a button on the Desktop Viewer toolbar, however. Configuring Desktop Server for Windows 3-24

48 Table 3-1. Desktop Server properties (ini file and UI) (continued...) Ini File UI Name Default Menu Description SingleWindowName TurboMode Single Window Sharing - text field Low Accuracy (Turbo Speed) disabled Properties If you enable SingleWindow, this text field becomes available. Type the name of the window that you want to share (up to 15 characters are considered). 0 Properties To update the screen as quickly as possible, but with lower accuracy, enable (1) this option (select the check box). Note that the speed depends on the machine. Notes about loopback settings To avoid security risks, Axeda strongly recommends that you set the loopback properties as follows for assets running Desktop Server and the Axeda Gateway and Axeda Connector Agents and for assets running only Desktop Server: Axeda Connector or Axeda Gateway running on a different asset than Desktop Server Axeda Gateway running on a gateway asset that is also running Axeda Desktop Server Axeda Connector running on the same asset as Axeda Desktop Server Axeda Desktop Server Allow Loopback Connections - On Loopback Only - Off Allow Loopback Connections - On Loopback Only - On Allow Loopback Connections - On Loopback Only - On Managed asset running Axeda Desktop Server Managed asset running Axeda Desktop Server Managed asset running Axeda Desktop Server For ALL these managed assets Allow Loopback Connections - Off Loopback Only - Off Figure Setting the Loopback properties Configuring Desktop Server for Windows 3-25

49 Configuring power management for Windows 7 Windows 7 can go in to sleep mode after a specified period of inactivity. If the machine that is running Desktop Server is running on Windows 7, you need to ensure that Desktop Viewer can awaken the machine from a remote location. By default Windows 7 does not awake from sleep mode unless it receives input, either from the keyboard or from the network. Windows 7 provides the ability to awaken the machine from a LAN or from a Wireless LAN. To ensure that a Desktop Viewer user can access a Windows 7 machine that is running Desktop Server at any time, you either have to make sure that the machine does not go in to sleep mode (not very practical) or ensure that if the machine does go in to sleep mode, Desktop Viewer can awaken the machine from the LAN or Wireless LAN. The Windows 7 feature Wake on LAN or Wake on Wireless LAN allows you to ensure that Desktop Viewer can awaken the machine and connect to Desktop Server. For complete details on the Windows 7 power management features, go to technet.microsoft.com/en-us/library/ee617165(ws.10).aspx. It provides the prerequisites for network adapters and their drivers for using the Wake on LAN and Wake on Wireless LAN features. It also provides instructions for configuring power management. To enable Wake on LAN or Wake on WIreless LAN For your convenience, the instructions from the Microsoft web site have been adapted for using Desktop Server on a Windows 7 machine and for enabling Desktop Viewer to awaken the machine from sleep mode: 1. Click Start, type Network and Sharing in the Start Search box, and press Enter to display the Network and Sharing Center. 2. In the upper left of the navigation pane, click Change adapter settings. 3. Right-click the network connection for which you want to enable power management support, and click Properties. 4. Click Configure. 5. On the Power Management tab, select the check box next to Allow the computer to turn off this device to save power to enable power management on the network adapter. This setting enables Desktop Viewer to wake up the machine. 6. Enable Wake on LAN for all wake methods by selecting the check box next to Allow this device to wake the computer. 7. To save the settings, click OK. Configuring Desktop Server for Windows 3-26

50 Installing Desktop Server on Linux The installation program for Axeda Desktop Server on Linux is Axeda_Desktop_Server.bin. The default installation directory is /root/axeda/desktop. The maximum number of Desktop Server installations and Desktop Viewer users is specified in your Axeda Desktop license agreement. Notes:The Desktop Server runs in the background as a user daemon. When you log out of the Linux machine, the Desktop Server process stops. Although it is not trivial, a way to work around this exists. Refer to the instructions in "Running Desktop Server across X11 user sessions" on page A-2 (Appendix A, Running Desktop Server on UNIX/Linux). Axeda Desktop Viewer is not available on Linux. Linux users must download or launch the Java Viewer for Axeda Desktop Server, using the Axeda ServiceLink Applications (Home page, Asset dashboard, or Remote Sessions page for an asset in the Service application). To install Axeda Desktop Server 1. Log in to the system as the user whose desktop you want to share. 2. Copy the installation program, Axeda_Desktop_Server.bin, and the initialization file, AxedaDesktop.ini, to a temporary location. 3. If a Java VM does not already exist on the asset where you are installing Axeda Desktop Server, select the version of the installation program in the VM subdirectory of the installation media. For example, when installing Axeda Desktop Server on a Red Hat Linux-based asset, locate the installation program, Axeda_Desktop_Server.bin, in the directory, /Linux/VM of the installation media. If the asset does have a Java VM, then select the version of the installation program in the NoVM subdirectory. Using the same example, run the installation program from the directory, /Linux/NoVM of the installation media. 4. At the prompt in a system window, navigate to the installation program, Axeda_Desktop_Server.bin. Make sure that the initialization file, AxedaDesktop.ini, is in the same directory as the one from which you launch the installation program 5. Run the program by typing the following at the prompt: sh Axeda_Desktop_Server.bin 6. When it appears, read through the introduction. Press ENTER to continue. 7. When prompted, read through the license agreement, pressing ENTER to display each screen-full of the agreement. 8. When prompted, type Y to accept the license agreement, and press ENTER. 9. When prompted, press ENTER to accept the default path in which to install the Desktop Server ($USER_HOME/Axeda/Desktop/Server). If you want to use a different directory, type N and press ENTER. When prompted, type the path you want to use. 10. When the Ready to install prompt appears, press ENTER to install the Desktop software. 11. When the installation completes, press ENTER to exit the installation program. Installing Desktop Server on Linux 3-27

51 Configuring and Starting Desktop Server on Linux At this point you can set the Server password for Desktop Viewer users to type when attempting to access the asset or computer and then start Desktop Server, as follows: 1. To prevent unauthorized access, you should create a Server password and password file for the Desktop Server. Desktop Viewer users will be prompted to enter the password when they request a session. You have the following options: To create the Server password and store it in the default location (~/.AxedaDesktop/passwd), type./adspasswd at the prompt and press ENTER. To set the Server password and store it in a file other than the default file at the same time, type the following at the prompt and press ENTER:./adspasswd <path/file_name> 2. Either way, when prompted with Password:, type the password and press ENTER. You will not see any characters on the screen as you type. 3. When prompted with Verify:, type the password again and press ENTER. 4. You can now start the server as a background process (use an ampersand), with authentication enabled and the default password in force, as follows: Tips./AxedaDesktopServer -SecurityTypes VncAuth & For the server to require authentication from Desktop Viewer users, you MUST use the argument, -SecurityTypes VncAuth when starting the server. The ampersand (&) signals that the process should run in the background. Omit the ampersand if you do not want the server to run in the background. Any time you add a new password file, you need to restart the server. The server reads the password file each time a Desktop Viewer session is authenticated. If you change the password while Desktop Server is running, the password takes effect at the next session authentication. To simultaneously start the server and use the password that is stored in a different file than the default, type the following command:./axedadesktopserver -SecurityTypes VncAuth & -PasswordFile <path/file_name> 5. To set additional parameters for the Axeda Desktop Server, type the following at the prompt to see a listing and description of parameters:./axedadesktopserver -help In general, parameter names are not case sensitive. You can enable a parameter using the following syntax:./axedadesktopserver -<param_name> Configuring and Starting Desktop Server on Linux 3-28

52 You can disable a parameter using the following syntax:./axedadesktopserver -<param_name>=0 For parameters that take a value, type the parameter name with a hyphen and then type a space and the value:./axedadesktopserver -<param_name> <value> For example:./axedadesktopserver -pollrate 120 The -help argument generates a list of the parameters and the syntax needed to set them. The following table shows the parameters, what they set, and their default values. Table 3-2. Desktop Server Parameters (Linux) This Parameter Sets Default Value pollrate Poll rate used to scan desktop for updates 50 rfbport TCP port to listen for RFB protocol 5920 FMCompressDownload Whether to compress downloaded file content using Zlib 1 (enabled) Log QueryConnect Which log output should be directed to which target logger, and the level of output to log. Format is <log>:<target>:<level>[,...]. Whether to prompt the local user to accept or reject incoming connections. Not set 0 (disabled) SendCutText Whether to send clipboard changes to clients. 1 (enabled) AcceptCutText Whether to accept clipboard updates from clients. 1 (enabled) AcceptPointerEvents AcceptKeyEvents DisconnectClients NeverShared AlwaysShared Protocol3.3 CompareFB Whether to accept pointer press and release events from clients. Whether to accept key press and release events from clients. Whether to disconnect existing clients if an incoming connection is non-shared. If combined with NeverShared, then new connections will be refused while a client is active. Whether to never treat incoming connections as shared, regardless of the client-specified setting. When this parameter is enabled, NO incoming connections are treated as shared, regardless of the client-side setting. Whether to always treat incoming connections as shared, regardless of the client-specified setting. If this parameter is enabled, ALL incoming connections are treated as shared, regardless of the client-side setting. Whether to always use protocol version 3.3 for backwards compatibility with badly-behaved clients. Whether to perform pixel comparison on framebuffer to reduce unnecessary updates. 1 (enabled) 1 (enabled) 1 (enabled) 0 (disabled) 0 (disabled) 0 (disabled) 1 (enabled) Configuring and Starting Desktop Server on Linux 3-29

53 Table 3-2. Desktop Server Parameters (Linux) (continued...) This Parameter Sets Default Value ClientWaitTimeMillis IdleTimeout Password The number of milliseconds to wait for a client that is no longer responding The number of seconds after which an idle connection will be dropped (zero means no timeout) Obfuscated binary encoding of the password that Desktop Viewer clients must supply to access the server ms 3600 seconds Not set PasswordFile Password file for authentication Not set ReverseSecurityTypes SecurityTypes BlacklistTimeout BlacklistThreshold RemapKeys MaxCutText The encryption scheme to use for reverse connections (None) The security scheme to use for incoming connections. The possible values are None and VncAuth. The initial timeout applied when a host is first blacklisted (authentication fails the number of times set in BlacklistThreshold, 5 by default). The host cannot reattempt a connection until the timeout expires. Each successive authentication failure will double the timeout. The timeout is reset to the default value after a successful authentication or after the timeout expires. The number of unauthenticated connection attempts allowed from any individual host before that host is black-listed Comma-separated list of incoming keysyms to remap. Mappings are expressed as two hex values, prefixed by 0x, and separated by -> Maximum permitted length of an incoming clipboard update None None 10 seconds 5 Not set bytes ZlibLevel Zlib compression level -1 (no compression) Configuring and Starting Desktop Server on Linux 3-30

54 Configuring an Image for Remote Monitors Warning! This procedure requires you to use polling mode. On older hardware, polling mode has proven to cause CPU usage to spike to 100 percent. For this reason, Axeda strongly recommends limiting the use of polling mode. If you decide to use it, be very careful to test this procedure in a development environment before attempting to use it in your production environment. Make sure that you use hardware of the same specifications as that used in your production environment. While your service technicians are performing routine maintenance or troubleshooting remote assets, you may want to let people at the customer site know that this work is being done. You most likely also want to prevent a remote operator from engaging in any activity at the asset while the service technicians are working. Axeda Desktop supports the disabling of remote input and the blanking of the remote monitor. Instead of just blanking the remote monitor, you can display an image that informs remote operators that the asset is being serviced. To set up an image to be displayed and remote input to be disabled during service, you need to change configuration settings for the Desktop Server. You also need to ensure that the image file is named background.bmp and disable the mirror drivers installed with the Desktop Server. Once you have made these changes, service technicians can display the image and disable remote input by selecting a tool in the toolbar of Desktop Viewer. Note: When you select the menu option in Desktop Viewer or click the toolbar icon to display the Start menu while the remote monitor displays your background image, it is normal for the Start menu to flicker on the remote monitor. In addition, tool tips may be visible as black rectangles on the remote monitor. (Tool tips and menus take precedence over anything else on a display in Windows.) To configure Desktop Server to display an image when remote monitor is blanked This procedure assumes that the Desktop Server is installed and running as a service on a Windows machine. Note: The default settings for the two properties (Enable Blank Monitor on Viewer Request and Enable Alpha-Blending Monitor Blanking) are Enabled (1), so if you have not previously changed the default settings, you can skip steps 1 through On the asset running Desktop Server, right-click the Desktop Server icon and select Admin Properties from the menu. 2. Under Misc on the Property Page, select the check boxes next to Enable Blank Monitor on Viewer Request and Enable Alpha-Blending Monitor Blanking. 3. Click OK to apply and save the settings. Configuring an Image for Remote Monitors 3-31

55 4. Save your image file as background.bmp (this name is required). 5. Copy the image file to the same directory as the Axeda Desktop Server executable (by default on Windows, c:\program Files\Axeda\Desktop\Server). 6. Right-click the Desktop Server icon, and select Properties on the menu. 7. Under Server Screen Updates Handling, clear the check box next to Video Hook Driver. (The mirror drivers must be disabled for the image to be displayed.) 8. Click OK to save the change. 9. Restart the service. (If you need instructions, refer to "To restart the service on Windows" on page To display the image during service 1. From a remote location, start a Desktop Viewer session with the asset. 2. Select the Toggle Remote Input/Remote Blank Monitor tool ( ) on the tool bar. The image will appear on the asset monitor, and the operators at the asset location will not be able to use the asset. 3. When the service session is complete, remember to select the Toggle Remote Input/ Remote Blank Monitor ( ) tool to enable remote input and the remote monitor at the asset. Configuring an Image for Remote Monitors 3-32

56 Changing Default Settings The Axeda Desktop Server installation wizard (Axeda_Desktop_Server.exe) and the initialization file for Axeda Desktop Server (AxedaDesktop.ini) are provided in the same directory on the installation CD. If you want to modify the default settings of the Axeda Desktop Server installer for assets that require different settings, you need to edit the initialization file. Parameters that you may want to set include the port numbers on which Axeda Desktop Viewer clients will access the Desktop Server. This section explains how to ensure that a port is available (required if you are changing the default port numbers) and then how to edit the initialization file for Axeda Desktop Server. Important!The modified version of the initialization file, AxedaDesktop.ini, must be in the same directory as the installer. Otherwise, Axeda Desktop Server will display the Properties dialog box immediately on completion of the installation. The dialog box is prompting for a Server password for Desktop Viewer users to enter when attempting to create a desktop session. Once a user enters a password and clicks OK, the dialog box closes. If a password is not entered, the dialog box will not close. To ensure port availability You must ensure that the port that you want to use is available on the machine where Axeda Desktop Server is installed. The Axeda Desktop Server installer uses the following Windows command to open port 5920 in the firewall, which ensures that the port is available: netsh firewall add portopening protocol=all port=5920 name=axedadesktopserver You can use a script that runs this command, setting the port number in this command to the port number you want to use. For Linux assets, use a script and the appropriate command for the version of Linux running on the target assets. To edit the Axeda Desktop Server initialization file 1. From the installation directory for Axeda Desktop Server, open the AxedaDesktop.ini file in your favorite text editor (for example, Notepad). Changing Default Settings 3-33

57 The following figure illustrates this file opened in Notepad on a Windows XP machine: 1. Set AutoPortSelect to Set AuthRequired to Set PortNumber to the port number you want Windows clients to use to communicate with Desktop Server. 4. If Linux clients need to access this Desktop Server and you want to use a different port, change HTTPPortNumber to the port number you want to use. If these parameters do not appear in your ini file, then add them. The [ultravnc] section contains encrypted representations of the Server Password (passwd) and the View-Only Password (passwd2). Figure Changing Parameters in the AxedaDesktop.ini file Changing Default Settings 3-34

58 2. In the [admin] section of the file, locate the AutoPortSelect parameter and change its value from 1 to If you want to require a password, set the AuthRequired property to 1. If you are not requiring a password, remove the property from the file. 4. The next parameter to set is PortNumber, which is set to 5920 by default. Change 5920 to the port number that you want to use for Windows clients to access the Desktop Server. 5. If users at Linux machines need to access the Desktop Server directly through a browser (rather than through the Axeda Service application), they will need to use the Java Viewer client. In this case, if you also want to use a different port for these users, change the default HTTPPortNumber, 5800, to the port number you want to use. 6. If you want to set the same password for the assets in your custom installer, follow these steps: a) Install Desktop Server on a test machine. b) Right-click the server icon and select Admin Properties. c) In the dialog box, type a Server Password and a View-Only password, and click OK. d) Open the ini file for that Desktop Server and copy the encrypted passwords to this custom initialization file. The property in the ini file appears after the [admin] section, in the [ultravnc] section, as follows: [ultravnc] passwd=f326a a7501 passwd2=b82b048ac11e Figure 3-15 on page 3-34 illustrates the location of this section. Tip Setting the passwords this way has the result that multiple assets have the same passwords, which poses a security risk. Best practices would dictate that different assets have different passwords. 7. If there are other initialization parameters that you want to change, refer to Table 3-1 on page For the command-line parameters for Linux, refer to Table 3-2 on page Save and close the file. 9. Make sure this file is in the same directory as your custom installer when the installer runs. Changing Default Settings 3-35

59 Upgrading Desktop Server Upgrading from previous releases involves the following steps, in the sequence shown: 1. Uninstalling the existing Desktop Server 2. Installing the new Desktop Server 3. Performing post-installation tasks 4. Restarting Desktop Server 5. Upgrading Axeda Desktop Viewer 6. Upgrading Quick Launch The rest of this section provides more instructions for each step. Uninstalling the existing Desktop Server Before you can install a new version of Axeda Desktop Server, you must uninstall the existing version. Follow the instructions for your operating system. Linux First, make sure you stop the Desktop Server. To stop the Desktop Server on a Linux machine, bring it to the foreground and then type Ctrl+c at the shell prompt. You can also kill it. You can then un-install the Desktop Server by running the un-install program (available as of release 5.2.1) or by deleting the installation directory (releases prior to did not have an un-install program). You can then install the new version. If problems arise, try restarting the machine first. If problems persist, run the un-install program and then re-install the new version of Desktop Server. Windows You can uninstall Desktop Server from the Windows Control Panel > Add or Remove Software tools. Alternatively, you can run the uninstall program for Desktop Server, Uninstall_Axeda_Desktop_Server.exe, located in the directory, c:\program Files\Axeda\Desktop\Uninstall. When the Uninstall program finishes, it prompts you to restart your computer. It is recommended that you select Yes to restart the computer. Upgrading Desktop Server 3-36

60 Installing the new Desktop Server Important!For all supported Microsoft Windows platforms, you must install Axeda Desktop Server as a service. In addition, you need to verify with your IT department that User Account Control (UAC) and Ctrl+Alt+Del (CAD) are active on the machines where you will be running Axeda Desktop Server before allowing Axeda Desktop Viewer users to access the Axeda Desktop Server machines. These two Windows security features must be active on the Desktop Server computer for Desktop Viewer users to be able to log in. In addition, if you are running Windows Vista, you must install Desktop Server to a secure location. The default location is c:\program Files\Axeda\Desktop\Server, which is a secure location (the Program Files directory is secure ). Run the installation program for your operating system, Axeda_Desktop_Server.exe (Windows) or Axeda_Desktop_server.bin (Linux). Make sure you install the VM or Non-VM version, depending on what is already installed on the asset, as follows: If a Java VM does not already exist on the asset where you are installing Axeda Desktop Server, select the version of the installation program in the VM subdirectory of the installation media. If the asset does have a Java VM, then select the version of the installation program in the NoVM subdirectory. Follow the installation steps presented in the installation wizard. Refer to the appropriate section earlier in this chapter for specific installation instructions: "Installing Desktop Server on Windows " on page 3-2 or "Installing Desktop Server on Linux" on page If the installation program prompts you to install newer versions of files, select Yes. Performing post-installation tasks Depending on your platform, additional steps are required on the Desktop Server asset, especially for Windows Vista installations. Refer to the section, "Post-installation requirements" on page 3-9, for details. You must also upgrade Quick Launch. Restarting Desktop Server If you selected to install the server as a service (a requirement for Windows platforms), the installation program starts the service before closing, as indicated by the server icon in the notification area of the taskbar on the Windows desktop ( ). You can also determine the status of the service by viewing all services running in the Windows computer (Control panel > Administrative Tools > Services). Upgrading Desktop Server 3-37

61 To start the Axeda Desktop Server on Linux platforms Start the Desktop Server process so that it runs in the background (an ampersand signals that the process should run in the background), using the following syntax:./axedadesktopserver & Upgrading Axeda Desktop Viewer Axeda Desktop Viewer consists of a single executable file. Depending on the platforms of the computers initiating a desktop session and of the assets where Desktop Server is running, this file can be one of the following: For a Windows computer to a Windows asset AxedaDesktopViewer_vNNNNN.exe, where NNNNN represents the release number and the build number. For example, in the file name, AxedaDesktopViewer_v604.exe, is release 6.1, build 604. For a Windows computer to a Linux asset AxedaViewer4_vNNNNN.exe, where NNNNN represents the release number and the build number. For example,in the file name, AxedaViewer4_v61604.exe, is release 6.1, build 604. For a Linux computer to a Windows asset AxedaDesktopViewer_vNNNNN.jar, where NNNNN represents the release number and build number. For example, in the file name AxedaDesktopViewer_v61604.jar, is release 6.1, build 604. You can install Axeda Desktop Viewer in the following ways: When a remote desktop session is started from the Axeda Service application and you do not already have it installed, the Axeda Enterprise server will download the Desktop Viewer to your computer. You can copy Desktop Viewer from the Axeda installation media to the computer. You can download it from the Axeda Enterprise server. The Asset dashboard for any asset and the Remote Sessions page in the Axeda Service application for any asset provide a link to download a viewer application. As long as the asset is running Desktop Server, when you click Download link and confirm that you want to save the file, Axeda Desktop Viewer will be downloaded to your computer. Now, you can use the Axeda Desktop Viewer to connect to remote sessions. Note: System administrators should refer to the Axeda Enterprise Server Installation and Maintenance Guide to learn how to set up the viewer applications for downloading. If needed, refer to the Axeda Desktop Viewer User s Guide for more information about starting connections, configuring connection options, and using Desktop Viewer. Upgrading Desktop Server 3-38

62 Upgrading Quick Launch For the Quick Launch feature of the Axeda Service application to download the appropriate viewer for the new version of Desktop Server, the system administrator must run the migrate_desktop.sql script against the database. This script is located in the ddl directory of your installation media. This directory is at the top level, which is the same as the directories, Windows, Linux, and viewers. To upgrade Quick Launch 1. Stop the Enterprise server. 2. Make sure that you have the Desktop Server installation media. 3. Open a command prompt or shell, and change to the ddl directory containing the SQL script, migrate_desktop.sql. 4. At the prompt, start SQL*Plus (if not already running), connect to the existing database, and start the migration script by typing: sqlplus where: <username> is the name of the Oracle database user whose schema is being updated. <password> is the password associated with <username>. <servername> is the name of the database in the TNSNAMES.ORA file. The migration will be complete within a few minutes. 5. When this script finishes running, type EXIT to end the SQL*PLUS session. The database migration for Quick Launch is now complete. 6. Make sure that the new version of Axeda Desktop Viewer is available in the download directory on the Enterprise server. (If you need assistance with this, refer to Chapter 7 of the Axeda Enterprise Server Installation and Maintenance Guide.) 7. Restart your Enterprise server. 8. To test the upgrade, log in to the Axeda Service application and attempt to establish a remote session with an asset that is running the new version of Desktop Server. Upgrading Desktop Server 3-39

63 Chapter 4 Activities at the Axeda Desktop Server About this chapter This chapter explains the various activities you can perform using the Desktop Server menu options in the following sections: Overview of activities presents a summary of the tasks you can perform using Desktop Server menu. Accessing the Desktop Server menu explains how to display the menu for Desktop Server. Managing Desktop Viewer sessions explains the options available for managing Desktop Viewer ( client ) sessions. Managing the service (Windows) explains the options available for managing Desktop Server as a service. Managing Desktop Server (Linux) provides the ways to start and stop Desktop Server as a background process on Linux. Troubleshooting provides additional information to help you solve a problem locally. About this chapter 4-1

64 Overview of activities If you are a system administrator and have not disabled the appropriate properties, the Desktop Service menu allows you to edit configuration properties for the server and for screen updates (on a per-user basis). For details on editing properties, refer to Chapter 3, Installing and Configuring Axeda Desktop Server. In addition to editing the configuration properties, the menu of Axeda Desktop Server provides access to the following administrative activities: Managing connections Initiating a new connection Viewing a list of all current connections Stopping all current connections Chat with a Desktop Viewer user (of currently connected session) Managing the service (available only if Desktop Server is running as a service) Installing the service Starting the service Stopping the service Uninstalling the service Shutting Down Desktop Server Overview of activities 4-2

65 Accessing the Desktop Server menu To access the Axeda Desktop Server menu, right-click the icon in the notification area of the task bar on your Windows desktop. Once you select a command from the menu, the menu closes. Depending on the action you select, another dialog box may open. The following figure shows the Desktop Server menu as it appears when you have installed Desktop Server as a service and started the service: Figure 4-1. Desktop Server menu The rest of this chapter explains how to use these menu items to manage clients and the Desktop Service. Accessing the Desktop Server menu 4-3

66 Managing Desktop Viewer sessions The word clients in the Desktop Server user interface refers to the remote sessions or connections that are established through Desktop Viewer. You can view a list of all current sessions and then stop individual sessions in the list. If you need to shut down the machine where Desktop Server is running, you can stop all the remote sessions at once. After restarting the machine, you can initiate the sessions for the remote Desktop Viewer users so that they know the machine is running again. The rest of this section explains how to perform these activities. All procedures assume that the Desktop Server is running. To close all remote sessions from the Desktop Server computer 1. Right-click the Desktop Server icon in the Windows taskbar. 2. From the context menu, select Kill All Clients. To list all remote sessions from the Axeda Desktop Server computer 1. Right-click the Desktop Server icon in the Windows taskbar. 2. From the context menu, select List All Clients. The List Clients dialog box appears, as shown in the following figure: Figure 4-2. List Clients dialog box In the Currently Connected Clients list, you will see the IP addresses of the Desktop Viewer computers currently connected to this Desktop Server. 3. When done, click Close to exit the dialog box. Managing Desktop Viewer sessions 4-4

67 To stop a single Desktop Viewer session 1. Right-click the Desktop Server icon in the Windows taskbar. 2. From the context menu, select List All Clients. The List Clients dialog box appears, as shown in the following figure: 3. In the list of Currently Connected Clients, select the IP address of the Desktop Viewer computer whose session you want to end. 4. Click Kill Client. To chat with a Desktop Viewer user from the Desktop Server machine 1. From the taskbar, right-click the Desktop Server icon ( ). 2. On the context menu, select List All Clients. 3. From the Currently Connected Clients list in the List of Clients dialog box, select the client machine that you want to chat with. 4. Click Chat with Client. 5. When the Chat dialog box appears, type your message and click Send. 6. Continue your exchange by typing text and clicking Send. 7. When ready to end the chat session, click Close. The chat window closes on both machines, whether the Desktop Viewer Client or the Desktop Server operator clicks Close. If, however, other Axeda Desktop Viewer Clients are part of the same chat session, the chat window remains open on the desktops of those Clients and on the desktop of the Axeda Desktop Server computer. Notes:While users are chatting, another Axeda Desktop Viewer user can start a chat session with the same Axeda Desktop Server user. In this case, a chat window will appear for the second Axeda Desktop Viewer, but the same (already in use) chat window will be used for the session. The result is a three-way chat. Multiple Axeda Desktop Viewer users can connect to the same Axeda Desktop Server in this way. Chat sessions are NOT audited. Managing Desktop Viewer sessions 4-5

68 Managing the service (Windows) Note: This section focuses on managing the Desktop Server as a service on the supported Windows platforms. For information about configuration changes, Windows users should refer to Configuring Desktop Server for Windows in 3. Linux users should refer to the section, Managing Desktop Server (Linux) and also to Configuring and Starting Desktop Server on Linux in 3. You can run the Desktop Server as a Windows service, so that whenever the machine where it is running is started or stopped, the Desktop Server also starts and stops automatically, without operator intervention. During installation, the default setting is to install Desktop Server as a service. If you chose not to install Desktop Server as a service and you want to give the service a custom name, you can register Desktop Server to run as a Windows service from a Command Prompt. Refer to To register Desktop Server as a service using a custom name for details. If you want to register Desktop Server as a service and use the default name, you can use the Desktop Server menu. Figure 4-3. Desktop Server menu Table 4-1, Desktop Server commands lists and describes the Service commands on the Desktop Server menu. Managing the service (Windows) 4-6

69 Table 4-1. Desktop Server commands Use To Refer to Install Service Uninstall Service Register Desktop Server as a Windows service using the default name (Axeda Desktop Server). Uninstall the service for any reason (for example, while maintenance is performed on the machine). "To install the service from the menu" on page 4-8. "To uninstall (unregister) the service" on page 4-9. Stop Service Stop the Desktop Server service. "To stop the service" on page Start Service (needs to be previously installed) Restart Desktop Server service (assuming it is already installed as a service and was previously stopped) "To restart the service on Windows" on page To register Desktop Server as a service using a custom name If Desktop Server is already running as a service, you need to stop and then unregister the service first. 1. If it is running, stop Desktop Server. If not, continue to the next step. 2. Open a Command Prompt window. 3. Change to the installation directory, c:\program Files\Axeda\Desktop\Server. 4. If Desktop Server was not running as a service, continue to the next step. Otherwise, run the following command to unregister the service with its current name: AxedaDesktopServer -unregister 5. Run the following command to register the service with its new name: AxedaDesktopServer -register <custom_service_name> If you later want to unregister the service, use the -unregister switch, as follows: AxedaDesktopServer -unregister You do not need to use the custom service name with the -unregister switch. Managing the service (Windows) 4-7

70 To install the service from the menu This procedure assumes that you have installed Desktop Server and started it manually (from a Command Prompt or by double-clicking the file name). Note that installing the service from the menu also starts the service immediately. 1. On the taskbar, right-click the Desktop Server icon ( ), and select Install Service. The Run As dialog box appears, as shown in the following figure: Figure 4-4. Run as dialog box for Install Service 2. To install and start the service using the current user logon name (you must have Administrator permissions to install the service), select the Current user option. Otherwise, select the option, The following user, and then select a user name (with Administrator permissions) and type the password. 3. If you are using the Current user option, clear the check box next to Protect my computer and data from unauthorized program activity. 4. To install and start the service, click OK. The Desktop Server icon reappears in the notification area of the taskbar, and the service starts running. Managing the service (Windows) 4-8

71 To uninstall (unregister) the service 1. If you want to leave Desktop Server running after you unregister the Service, continue to the Step 2. Otherwise, follow these steps to stop the service first: a) From the Desktop Server menu, select Stop Service. The Run As dialog box appears, as shown in the following figure: Figure 4-5. Run as dialog box for Uninstall Service b) Stopping the service requires an account with Administrator permissions. To stop the service using the current user logon name, select the Current user option. Otherwise, select the option, The following user, and then select a user name (with Administrator permissions) and type the password. c) If you are using the Current user option, clear the check box next to Protect my computer and data from unauthorized program activity. d) Click OK to stop the service. The Desktop Server service stops and the icon disappears from the taskbar. e) From the Windows Start menu, select Start Axeda Desktop Server. The icon reappears in the taskbar, but the service is NOT started. 2. In the notification area of the taskbar, right-click the Desktop Server icon to display the menu. 3. From the Desktop Server menu, select Uninstall Service. The Run As dialog box appears (see Figure 4-5 above). Managing the service (Windows) 4-9

72 4. Unregistering ( uninstalling) a service requires an account with Administrator permissions. To unregister the service using the current user logon name, select the Current user option. Otherwise, select the option, The following user, and then select a user name (with Administrator permissions) and type the password. 5. If you are using the Current user option, clear the check box next to Protect my computer and data from unauthorized program activity. 6. Click OK. The Desktop Server service is unregistered. Important!If you did not stop the service before unregistering it, the Desktop Server icon remains in the taskbar. When you want to stop Desktop Server, you need to select Close Axeda Desktop Server from the menu. To restart Desktop Server when it is not registered, select Start Axeda Desktop Server from the Windows Start menu. If you stopped the service before unregistering it, the Desktop Service icon disappears from the taskbar. To start the Desktop Server (not as a service), select Start Axeda Desktop Server from the Windows Start menu. The icon reappears and you can access the menu again. To make Desktop Server run as a service again, select Install Service. To stop the service 1. In the notification area of the taskbar, right-click the Desktop Server icon. 2. On the context menu, select Stop Service. The Run As dialog box appears, as shown in the following figure: Figure 4-6. Run as dialog box for Stop Service 3. Stopping a service requires an account with Administrator permissions. To stop the service using the current user logon name, select the Current user option. Otherwise, select the option, The following user, and then select the user name (with Administrator permissions) and type the password. Managing the service (Windows) 4-10

73 4. If you are using the Current user option, clear the check box next to Protect my computer and data from unauthorized program activity. 5. To save your selection and stop the service, click OK. Momentarily, the Desktop Server stops running and the icon disappears from the taskbar. To restart the service on Windows 1. On the Start menu, select Start Axeda Desktop Server. The icon appears in the taskbar (as long as the tray icon is not disabled). 2. Once it appears, right-click the ( ) icon. In the menu, the Start Service (needs to be previously installed) command is available (as long as you have installed Desktop Server as a service). The following figure shows the menu: Figure 4-7. Desktop Server menu, with service stopped 3. Select Start Service (needs to be previously installed) from the menu. Managing the service (Windows) 4-11

74 The Run As dialog box appears: Figure 4-8. Run as dialog box for Start Service 4. Starting a service requires an account with Administrator permissions. To start the service using the current user logon name, select the Current user option. Otherwise, select the option, The following user, and then select the user name (with Administrator permissions) and type the password. 5. If you are using the Current user option, clear the check box next to Protect my computer and data from unauthorized program activity. 6. Click OK to start the service. You can also restart the service from the Services dialog box (Start > Control Panel > Administrative Tools > Services). Once the window is displayed, locate and select the name of the service, Axeda Desktop Server. Then click the Start the service link. Managing the service (Windows) 4-12