OpenText™ Exceed™ TurboX
Server Manager Administration Guide
OpenText™ Exceed™ TurboX (ETX) is a web-based platform
that enables users to launch UNIX and Windows desktops and
applications over the internet. Exceed TurboX provides IT with
a central platform to monitor and manage user access to
systems. It provides users with a seamless experience, where
desktops and applications running on remote hosts look and
feel like they are running locally.
This document describes how to configure and administer
Exceed TurboX using Exceed TurboX Server Manager. This
document is intended for Exceed TurboX administrators.
CONETX120501-AGD-EN-3
OpenText™ Exceed™ TurboX
Server Manager Administration Guide
CONETX120501-AGD-EN-3
Rev.: 2023-Jan-10
This documentation has been created for OpenText™ Exceed™ TurboX 12.5.1.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
Copyright © 2023 Open Text. All Rights Reserved.
Trademarks owned by Open Text.
One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.
Disclaimer
No Warranties and Limitation of Liability
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1
Using Exceed TurboX Server Manager ................................... 9
1.1
Signing in to Exceed TurboX Server Manager using the etxadmin
account ............................................................................................ 9
Signing in to Exceed TurboX Server Manager ................................... 11
Getting started with Exceed TurboX Server Manager ........................ 14
Monitoring license statistics ............................................................. 16
Viewing your messages ................................................................... 16
Configuring your user settings .......................................................... 18
Downloading and installing the Client Launcher ................................ 22
Working with API keys ..................................................................... 26
Creating API keys ........................................................................... 27
Viewing API keys ............................................................................ 28
Viewing detailed API key information ................................................ 29
Deleting API keys ............................................................................ 29
Signing out of Exceed TurboX Server Manager ................................. 30
Understanding Exceed TurboX Server Manager workflows ................ 30
Workflow 1: Monitoring and managing user sessions ......................... 30
Workflow 2: Creating and distributing profiles and templates .............. 31
Workflow 3: Monitoring and managing licenses ................................. 32
Managing Nodes, Node Groups, and Sessions ................................. 33
Managing users, groups, profiles and templates ................................ 34
Managing applications ..................................................................... 36
Managing the site settings ............................................................... 36
Managing the server settings ........................................................... 37
Maintaining the system .................................................................... 37
Working with Exceed TurboX Server Manager lists ........................... 37
Maximizing and minimizing Exceed TurboX Server Manager panes
with lists ......................................................................................... 38
Browsing Exceed TurboX Server Manager lists ................................. 38
Showing and hiding columns in Exceed TurboX Server Manager
grids ............................................................................................... 39
Exporting Exceed TurboX Server Manager lists ................................ 39
Sorting entries on Exceed TurboX Server Manager lists .................... 40
Searching in Exceed TurboX Server Manager lists ............................ 41
Types of search parameters ............................................................ 41
1.2
1.3
1.3.1
1.3.2
1.3.3
1.3.4
1.3.5
1.3.5.1
1.3.5.2
1.3.5.3
1.3.5.4
1.3.6
1.3.7
1.3.7.1
1.3.7.2
1.3.7.3
1.4
1.5
1.6
1.7
1.8
1.9
1.10
1.10.1
1.10.2
1.10.3
1.10.4
1.10.5
1.10.6
1.10.6.1
2
Managing Exceed TurboX as an administrator .................... 47
2.1
2.1.1
2.1.2
2.1.3
Managing nodes ............................................................................. 47
Monitoring nodes in the Nodes pane ................................................ 47
Registering connection nodes .......................................................... 49
Configuring node settings ................................................................ 50
CONETX120501-AGD-EN-3
Server Manager Administration Guide
iii
Table of Contents
2.1.4
2.1.5
2.1.6
2.2
2.2.1
2.2.2
2.2.3
2.2.4
2.3
2.3.1
2.3.2
2.3.3
2.3.4
2.3.5
2.3.6
2.4
2.4.1
2.4.2
2.4.3
2.4.4
2.4.5
2.4.6
2.4.7
2.4.8
2.4.9
2.4.10
2.5
2.5.1
2.5.2
2.5.3
2.5.4
2.5.5
2.6
2.6.1
2.6.2
2.6.3
2.7
2.7.1
2.7.1.1
2.7.1.2
2.7.2
iv
Viewing detailed node information .................................................... 54
Enabling a node .............................................................................. 55
Disabling a node ............................................................................. 55
Managing node groups .................................................................... 56
Viewing Node Group details in the Node Groups pane ...................... 56
Creating, editing, renaming, and deleting Node Groups ..................... 57
Adding nodes to Node Groups ......................................................... 58
Removing nodes from Node Groups ................................................. 59
Managing sessions ......................................................................... 60
Viewing general session details in the Sessions pane ........................ 60
Using the session details dialog box to monitor and manage a
session ........................................................................................... 62
Shadowing a user’s session ............................................................. 64
Reassigning a session ..................................................................... 66
Viewing the Performance Panel ....................................................... 66
Terminating or suspending sessions ................................................. 68
Managing users .............................................................................. 70
Working with user roles ................................................................... 70
Viewing user details in the Users pane ............................................. 75
Importing multiple user accounts to Exceed TurboX .......................... 76
Assigning roles to users in the Users list ........................................... 78
Creating a user account ................................................................... 78
Configuring user permissions ........................................................... 79
Modifying user settings, roles, and permissions for individual users .... 82
Deactivating and activating user accounts ........................................ 84
Deleting user accounts .................................................................... 84
Sending messages to users and user groups .................................... 85
Managing user groups ..................................................................... 86
Working with user groups ................................................................ 86
Viewing group details in the User Groups pane ................................. 87
Creating, editing, renaming, and deleting user groups ....................... 88
Adding users to user groups ............................................................ 89
Removing users from user groups .................................................... 90
Managing published applications ...................................................... 92
Publishing and editing applications ................................................... 93
Editing an application host ............................................................... 94
Understanding the application deployment workflow .......................... 95
Configuring general site settings ...................................................... 95
Configuring load balancing ............................................................ 101
Configuring custom load balancing ................................................. 101
Configuring load balancing for server-side OpenGL rendering .......... 103
Understanding Exceed TurboX fallback accounts ............................ 103
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Table of Contents
2.8
2.8.1
2.8.2
2.8.3
2.8.4
2.8.5
2.8.6
2.8.7
2.8.8
2.8.9
2.9
2.9.1
2.9.2
2.9.3
2.9.3.1
2.9.3.2
2.9.4
2.9.5
2.9.6
2.10
2.10.1
2.11
2.11.1
2.11.1.1
2.11.1.2
2.11.2
2.11.2.1
2.11.3
2.12
2.12.1
2.12.2
2.12.3
2.13
2.14
2.14.1
2.14.2
2.15
2.15.1
2.15.2
2.16
2.17
2.17.1
CONETX120501-AGD-EN-3
Managing appearance ................................................................... 104
Modifying themes .......................................................................... 104
Viewing profile icon information ...................................................... 105
Viewing and modifying icon properties ............................................ 106
Downloading blank backgrounds .................................................... 107
Adding profile icons ....................................................................... 107
Deleting profile icons ..................................................................... 108
Applying a custom style template ................................................... 108
Exporting appearance settings ....................................................... 109
Importing appearance settings ....................................................... 109
Configuring user authentication settings ......................................... 110
Configuring settings for Native authentication .................................. 113
Configuring settings for PAM authentication .................................... 114
Configuring settings for LDAP authentication .................................. 115
Editing the search filter for users .................................................... 118
Editing the search filter for groups .................................................. 119
Configuring settings for OTDS authentication .................................. 120
Configuring settings for WAM authentication ................................... 122
Executing commands to fetch user information ............................... 123
Managing a cluster ........................................................................ 124
Viewing cluster member details ...................................................... 125
Managing licenses ........................................................................ 127
Managing local license keys .......................................................... 128
Adding a license key ..................................................................... 129
Viewing license key details ............................................................ 130
Managing licenses for connected Exceed TurboX sites .................... 131
Adding, editing, and removing a member of the License Server ....... 133
Using a remote License Server ...................................................... 135
Setting up automated messages .................................................... 137
Setting up messages for administrators .......................................... 137
Configuring message options ......................................................... 139
Enabling email messages for users and administrators .................... 140
Configuring default user permissions and settings ........................... 141
Configuring user roles ................................................................... 149
Viewing permissions in the user role dialog box .............................. 151
Managing user roles ...................................................................... 152
Managing runtimes ........................................................................ 154
Adding runtimes ............................................................................ 155
Designating, disabling, and removing runtimes ................................ 156
Configuring security settings .......................................................... 157
Configuring Exceed TurboX Server settings .................................... 164
Switching the Server to maintenance mode .................................... 165
Server Manager Administration Guide
v
Table of Contents
vi
2.17.2
2.17.3
2.17.4
2.17.5
2.18
2.19
2.20
2.20.1
2.20.2
2.20.3
2.21
2.21.1
2.21.2
2.21.3
2.21.4
2.21.5
Configuring Server ports ................................................................ 166
Configuring Kerberos settings ........................................................ 168
Configuring memory allocation settings ........................................... 168
Configuring logging options ............................................................ 169
Reviewing Server logs ................................................................... 170
Monitoring the Server status .......................................................... 172
Monitoring Exceed TurboX events .................................................. 172
Viewing event details ..................................................................... 174
Archiving event details ................................................................... 175
Searching for events ..................................................................... 176
Creating reports ............................................................................ 177
Configuring and generating reports ................................................ 177
Sessions reports ........................................................................... 178
Licenses reports ........................................................................... 179
Top Users reports ......................................................................... 181
Downloading report data ................................................................ 182
3
Working with Profiles ............................................................ 183
3.1
3.2
3.3
3.3.1
3.3.2
3.3.3
3.3.4
3.3.5
3.3.6
3.3.7
3.3.8
3.3.9
3.4
3.4.1
3.4.2
3.4.3
3.4.4
3.4.5
3.4.6
3.4.6.1
3.4.7
3.4.7.1
3.4.8
About profiles ................................................................................ 183
About profile templates .................................................................. 185
Creating and managing profiles and templates ................................ 185
Viewing profile and template information ......................................... 185
Using Action icons to manage profiles and templates ...................... 187
Creating and editing profiles and templates ..................................... 188
Exporting and importing a profile or template .................................. 189
Distributing profiles to users or user groups .................................... 190
Publishing templates to all users .................................................... 192
Copying or deleting a profile or template ......................................... 192
Viewing linked profiles ................................................................... 193
Using the profile toolbar in Exceed TurboX Server Manager ............ 194
Customizing profiles in Advanced mode ......................................... 194
Configuring General settings in Advanced mode ............................. 194
Configuring Input settings in Advanced mode .................................. 196
Configuring Startup settings in Advanced mode .............................. 200
Restricting available startup modes ................................................ 201
Configuring Session settings in Advanced mode ............................. 202
Configuring Security settings in Advanced mode ............................. 210
Sharing user groups ...................................................................... 215
Configuring Protocol settings in Advanced mode ............................. 216
Configuring OpenGL Rendering modes .......................................... 221
Configuring Window mode settings in Advanced mode .................... 222
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Table of Contents
3.4.8.1
3.4.8.2
3.4.8.3
3.4.8.3.1
3.4.8.3.2
3.4.8.4
3.4.9
3.4.10
3.4.11
3.4.12
3.4.13
3.4.14
3.4.14.1
3.4.15
3.5
3.5.1
3.5.2
3.5.3
3.5.4
3.5.5
3.5.6
3.5.6.1
3.5.6.2
3.5.6.3
3.5.6.4
3.5.6.5
3.5.6.6
3.5.6.6.1
3.5.6.6.2
3.5.7
3.6
3.7
3.8
3.9
3.10
3.11
3.12
3.12.1
3.12.2
CONETX120501-AGD-EN-3
Selecting the window mode for working with applications
(Advanced mode) .......................................................................... 224
Configuring Monitor settings for Multiple or Single Window mode
(Advanced mode) .......................................................................... 225
Configuring Multiple window mode (Advanced mode) ...................... 226
Starting a window manager ............................................................ 228
List of Window title macros ............................................................ 229
Configuring Single window mode (Advanced mode) ........................ 229
Configuring Screen settings in Advanced mode .............................. 232
Configuring Performance settings in Advanced mode ...................... 235
Configuring Fonts settings in Advanced mode ................................. 237
Configuring Troubleshooting settings in Advanced mode ................. 239
Configuring File and print settings in Advanced mode ...................... 242
Configuring Devices settings in Advanced mode ............................. 245
Redirected device support ............................................................. 246
Configuring Copy and paste settings in Advanced mode .................. 247
Configuring Custom startup mode .................................................. 250
What is a startup configuration (Xstart)? ......................................... 252
Adding Xstarts to a Custom startup profile ...................................... 252
Configuring Xstart settings ............................................................. 254
Supported Custom startup methods ............................................... 257
Managing startup configurations (Xstarts) in Custom profiles ........... 259
Command syntax for starting applications ....................................... 259
Command Line Syntax for UNIX/Linux Hosts .................................. 260
Command Line Syntax for VMS Hosts ............................................ 261
Using Xstart Macros ...................................................................... 262
List of Xstart Macros ...................................................................... 262
Passing URL Parameters via Xstart Macros .................................... 264
Setting Environment Variables on UNIX/Linux Hosts ....................... 265
DISPLAY Environment Variable ..................................................... 265
PATH, OPENWINHOME, and LD_LIBRARY_PATH Environment
Variables ...................................................................................... 266
Launching Windows applications .................................................... 268
Configuring Published application startup mode .............................. 269
Configuring Windows application startup mode ............................... 270
Configuring the Windows Desktop - Direct startup mode .................. 271
Configuring the Windows Desktop - RDP startup mode ................... 274
Configuring XDMCP Broadcast startup mode .................................. 275
Configuring XDMCP Query startup mode ........................................ 277
About Advanced settings for select startup modes ........................... 278
Configuring startup settings on the General tab ............................... 279
Configuring startup settings on the Prompts tab .............................. 284
Server Manager Administration Guide
vii
Table of Contents
viii
3.12.3
3.12.3.1
3.13
Configuring startup settings on the ETX RDP tab ............................ 286
Configuring redirection for a specific printer .................................... 289
Using the Client Launcher to launch profiles and resume sessions ... 290
4
Getting started with Exceed TurboX REST APIs ................ 299
5
Managing Exceed TurboX Server from command line ...... 303
5.1
5.2
5.3
5.4
5.5
5.6
5.7
5.8
5.9
5.10
5.11
Starting and stopping Exceed TurboX Server on a Linux platform ..... 303
Managing the Exceed TurboX Server runtime version ..................... 306
Configuring Exceed TurboX Server settings .................................... 306
Managing the etxadmin account ..................................................... 308
Managing the bootstart options ...................................................... 309
Backing up and restoring Server settings ........................................ 309
Applying a patch to the Server ....................................................... 310
Managing Server runtimes ............................................................. 310
Managing a cluster ........................................................................ 311
Debugging launch errors ............................................................... 313
Checking Server information .......................................................... 313
6
Appendix A: Understanding activity log events ................. 315
6.1
6.2
6.3
Exceed TurboX Server Manager events ......................................... 315
Exceed TurboX License Server events ........................................... 318
Exceed TurboX Connection Node events ........................................ 318
7
Appendix B: Role Permissions ............................................ 321
7.1
7.2
7.3
7.4
7.5
7.6
Admin (Built-in) ............................................................................. 321
Admin (Full Access) ...................................................................... 324
Admin (Read Only) ........................................................................ 329
Session Manager .......................................................................... 331
Technical Support ......................................................................... 333
User ............................................................................................. 335
GLS
Glossary
OpenText™ Exceed™ TurboX
337
CONETX120501-AGD-EN-3
Chapter 1
Using Exceed TurboX Server Manager
This section introduces Exceed TurboX Server Manager, the web-based application
used by administrators to manage Exceed TurboX. You can access it from any
computer that has a supported web browser installed. For information about how to
access and sign in to Exceed TurboX Server Manager, see “Signing in to Exceed
TurboX Server Manager” on page 11.
You can use Exceed TurboX Server Manager to perform all management tasks
related to Exceed TurboX. For example:
• Monitor sessions that are currently running or suspended.
• Suspend and/or terminate user sessions.
• Create profiles and/or profile templates, and distribute them to Exceed TurboX
users or groups of users.
• Monitor Exceed TurboX client and server events.
• Manage site settings and server settings.
For an overview of Exceed TurboX Server Manager and examples of typical
workflows, see “Getting started with Exceed TurboX Server Manager” on page 14
and “Understanding Exceed TurboX Server Manager workflows” on page 30.
1.1 Signing in to Exceed TurboX Server Manager
using the etxadmin account
After installing Exceed TurboX Server and performing the basic Server
configuration, you must use the Built-in Administrator account (etxadmin) to sign in
to the Server Manager, and complete the initial Server configuration.
This section describes how to sign in to Exceed TurboX Server Manager for the first
time, using the etxadmin account.
To sign in to Exceed TurboX Server Manager for the first time:
1.
In a web browser, type the Exceed TurboX Server Manager URL and press
Enter.
The URL format must be http(s)://<host>/etx/admin, where <host> is the
host name (and port number, if necessary) of the host on which the Exceed
TurboX Server is installed.
Note: For a list of supported browsers, see the Exceed TurboX Release Notes.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
9
Chapter 1 Using Exceed TurboX Server Manager
2.
If the Server is in maintenance mode (for example, after starting the Server for
the first time), the Server startup page appears. This page displays the current
progress of the Server initialization or maintenance tasks.
When the Server initialization is complete, the Welcome to Exceed TurboX
page appears.
Note: If you already accepted the license agreement and set up a
password for the etxadmin account the during the Server command line
configuration, the Exceed TurboX Server Manager sign-in page appears.
You can now sign in to Server Manager web interface using the etxadmin
user account, to complete the initial Server configuration. Continue with
the steps provided in “Signing in to Exceed TurboX Server Manager”
on page 11.
If you already accepted the license agreement the during the Server
command line configuration, but you have not set up a password for the
etxadmin account, continue with Step 5.
3.
If this is your first time signing in to this Server using an administrator account,
and you have not accepted the license agreement during the Server command
line configuration, the End User License Agreement page is displayed. Review
the terms of the End User License Agreement, and click the appropriate button
to perform the following operations:
• To print a copy of this license agreement, click Print.
• To accept the terms of this license agreement and start using this software,
click Accept. You must accept this license agreement before you can use this
software.
If you already set up a password for the etxadmin account during the Server
command line configuration, the Exceed TurboX Server Manager sign-in
page appears. You can now sign in to Server Manager web interface using
the etxadmin user account, to complete the initial Server configuration.
Continue with the steps provided in “Signing in to Exceed TurboX Server
Manager” on page 11.
If you have not set up a password for the etxadmin account during the
Server command line configuration, the Welcome to Exceed TurboX page is
updated to allow you to activate this account. Continue with Step 5.
• To decline the terms of this license agreement, click Decline.
Confirm the operation in the dialog box that opens. You will be returned to
the Server sign-in page.
If you already accepted the license agreement the during the Server command
line configuration, but you have not set up a password for the etxadmin
account, continue with Step 5.
10
4.
If you already accepted the license agreement during the Server command line
configuration, the End User License Agreement page is bypassed.
5.
In the Welcome to Exceed TurboX page configure the following settings:
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.2. Signing in to Exceed TurboX Server Manager
• Password: Type the password for the etxadmin user account. For security
reasons, the password must include a minimum of 8 characters.
• Confirm password: Retype the password for the etxadmin user account.
6.
Click Save.
The Sign-in required dialog box opens. The etxadmin account is now activated.
7.
Click Continue to sign-in page.
The Exceed TurboX Server Manager sign-in page appears. You can now sign in
to Server Manager web interface using the etxadmin user account, to complete
the initial Server configuration. Continue with the steps provided in “Signing in
to Exceed TurboX Server Manager” on page 11.
1.2 Signing in to Exceed TurboX Server Manager
This section describes how to sign in to Exceed TurboX Server Manager. Follow the
steps specific to your sign-in workflow, depending on the user authentication
method configured for your Exceed TurboX site:
• When using Kerberos authentication, users are logged in automatically, without
performing manual sign-in steps. For more information about configuring
Kerberos, see “Configuring your environment for single sign-on authentication
based on Kerberos” in Exceed TurboX Installation and Configuration Guide.
• When using Native, PAM, or LDAP authentication, perform the steps provided
in “To sign in to Exceed TurboX Server Manager with Native, PAM, or LDAP:“
on page 11.
• When using OTDS authentication, perform the steps provided in “To sign in to
Exceed TurboX Server Manager with OTDS:“ on page 13.
To sign in to Exceed TurboX Server Manager with Native, PAM, or LDAP:
1.
In a web browser, type the Exceed TurboX Server Manager URL and press
Enter.
The URL format must be http(s)://<host>/etx/admin, where <host> is the
host name (and port number, if necessary) of the host on which the Exceed
TurboX Server is installed.
Note: For a list of supported browsers, see the Exceed TurboX Release Notes.
The Exceed TurboX Server Manager sign-in page opens.
2.
On the sign-in page, type your Username and Password.
Note: For Native authentication, you must sign in with a local user
account that exists on all authentication nodes.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
11
Chapter 1 Using Exceed TurboX Server Manager
For PAM sign-in, the Password field may have a custom label, and
additional prompts may be displayed. The following illustration shows
the default sign-in page for PAM, Native, and LDAP authentication.
For PAM authentication, if the prompt returned by the PAM server is very
long, only the first few lines of text are shown. The remainder of the
prompt is displayed in a tooltip.
3.
To display the Exceed TurboX Server Manager content in a different language,
select an option from the language drop-down list, located at the top-right
corner of the page.
Tip: You can also change the language of the Exceed TurboX user interface
after you sign in, by updating your user settings. See “Configuring your
user settings” on page 18 for more information.
4.
If Enable “Keep me signed in” option is enabled on your site (see “Configuring
general site settings” on page 95), a Keep me signed in check box is shown on
the sign-in page. Selecting this check box and logging in successfully will
generate a non-expiring sign-in token on the user’s computer. This will
automatically sign the user in from that computer the next time they navigate to
the Exceed TurboX Dashboard or REST APIs URL in their browser.
Note: When a user logs in with Keep me signed in, their user name and
password are cached on Exceed TurboX Server, and used to authenticate
the user on application servers via the Use session credentials
authentication method in Exceed TurboX profiles. If the user’s credentials
change after the cache is created, the cached credentials will no longer
work for authenticating user sessions. To resolve this issue, the user must
12
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.2. Signing in to Exceed TurboX Server Manager
update the saved credentials by signing out of Exceed TurboX and signing
in again with the new credentials.
This option requires LDAP or Native authentication without Kerberos
enabled. It is not recommended if you are using a shared or public
computer.
5.
Click Sign in.
Exceed TurboX Server Manager appears. For an overview of the interface, see
“Getting started with Exceed TurboX Server Manager” on page 14.
To sign in to Exceed TurboX Server Manager with OTDS:
1.
In a web browser, type the Exceed TurboX Server Manager URL. Then, press
Enter.
The URL format must be http(s)://<host>/etx/admin, where <host> is the
host name (and port number, if necessary) of the host on which the Exceed
TurboX Server is installed.
Note: For a list of supported browsers, see the Exceed TurboX Release Notes.
The OTDS sign-in page appears.
2.
On the sign-in page, type your User name and Password.
3.
Click Sign in.
If the user enters valid credentials, they are redirected to Exceed TurboX and are
signed-in. For an overview of the interface, see “Getting started with Exceed
TurboX Server Manager” on page 14.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
13
Chapter 1 Using Exceed TurboX Server Manager
Note: If your Server is configured for OTDS and you want to sign in using
the etxadmin administration account, you must disable the OTDS sign-in
page redirect by adding ?loginredirect=0 to the Exceed TurboX Server
Manager URL.
For example: https://etxserver:8443/etx/admin?loginredirect=0
This modified URL leads you to the Exceed TurboX native sign-in page,
where you can sign in using the Exceed TurboX Built-in Administrator
(etxadmin) account.
You can replace the default image displayed on the sign-in page banner
(the OpenText logo). For more information, see OTDS Installation and
Administration Guide on My Support.
1.3 Getting started with Exceed TurboX Server
Manager
This section provides an overview of Exceed TurboX Server Manager.
The Server Manager interface contains the following elements:
• Header bar:
–
14
(1) Web application selector: Allows you to switch between the following
Exceed TurboX Server web applications: Dashboard, Server Manager, and
REST APIs.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
Note: For information about using Dashboard, see the Exceed TurboX
Dashboard and Client Help.
For information about using REST APIs, see “Getting started with
Exceed TurboX REST APIs“ on page 299.
–
(2) Site banner area: Displays information about the Exceed TurboX Server
status. For more information, see Show Site banner in the “Configuring
general site settings” on page 95.
–
(3) License status area: Provides information about Exceed TurboX Server
license usage.
For more information, see “Monitoring license statistics” on page 16.
–
(4) Read messages
: Click this button to open the Messages dialog box
and review messages sent by the Exceed TurboX Server or by server
administrators.
For more information, see “Viewing your messages” on page 16.
–
(5) User settings
: Click this button to open the User settings dialog box
and configure your Exceed TurboX user settings.
For more information, see “Configuring your user settings” on page 18.
–
(6) Sign out
Manager.
: Click this button to sign out of Exceed TurboX Server
For more information, see “Signing out of Exceed TurboX Server Manager”
on page 30.
–
(7) Help: Click this button to access the Exceed TurboX Server Manager Help.
–
(8) User name area: Displays the name of the user signed in to the system.
• Navigation bar: Includes several tabs, which allow you to perform various
administrative tasks in Exceed TurboX Server Manager:
–
Nodes and Sessions: see “Managing Nodes, Node Groups, and Sessions”
on page 33
–
Users and Profiles: see “Managing users, groups, profiles and templates”
on page 34
–
Applications: see “Managing applications” on page 36
–
Site Settings: see “Managing the site settings” on page 36
–
Server Settings: see “Managing the server settings” on page 37
–
Maintenance: see “Maintaining the system” on page 37
• Content area: Displays various settings that you can configure or monitor,
depending on the tab selected on the Navigation bar.
• Footer: Displays the Exceed TurboX version and build number, product
copyright and trademark information, and a link to additional legal information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
15
Chapter 1 Using Exceed TurboX Server Manager
1.3.1
Monitoring license statistics
This section describes the license statistics that you can monitor in the License status
area. This information is updated automatically and is useful when allocating
licenses to Exceed TurboX users.
License total
Displays the number of licenses available for launching sessions,
according to the following rules:
• For a stand-alone Exceed TurboX Server or an Exceed TurboX Server
cluster with locally installed license keys, this represents the total
number of licenses available to the Server or Server cluster.
• For a Connected Site (either a stand-alone Exceed TurboX Server or an
Exceed TurboX Server cluster) that consumes licenses from a remote
license server, one or two numbers may be displayed:
– Single number: This number represents the number of static
licenses allocated to the site.
– Two number separated by a slash (/) : This indicates that the Site is
sharing licenses dynamically with zero or more Connected Sites.
The number to the left of the slash is the total number of dynamic
licenses currently available to the local Site. That is, the total
dynamic licenses available in the pool, minus licenses currently in
use by other Site. The number to the right of the slash is the total
number of dynamic licenses in the pool.
• License Servers that consume part of their own license pool follow the
same behavior as Connected Sites. That is, the License total displays a
single number if licenses are statically allocated, or two numbers
separated by a slash if sharing dynamic licenses with Connected Sites.
Licenses in use
1.3.2
The total number of licenses that are currently in use by the local Server or
Server cluster.
Viewing your messages
This section describes the types of messages you can receive when using Exceed
TurboX, and how to access this information.
As an administrator, you can receive communications from two sources:
• Other Exceed TurboX administrators can send messages to your message box.
• Depending on how Exceed TurboX is configured, you can also receive systemgenerated messages, such as license usage, proxy crashes, and lost node
connections.
Note: To configure system settings, including the types of messages you want
to receive and whether you want to receive them by email, see “Setting up
automated messages” on page 137.
When you receive a new message, the Messages dialog box opens automatically
after you sign in to Exceed TurboX. This dialog box displays the messages you need
to review before you continue.
16
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
After signing in, you can view your messages at any time by clicking the Read
messages
icon on the header bar.
icon when messages are received.
A red icon appears over the Read messages
It displays the number of unread messages you have.
To delete a message:
•
In the Messages dialog box, position the pointer over the message and click the
Delete this message icon.
To delete all the messages:
•
In the Messages dialog box, click the Delete all read messages icon.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
17
Chapter 1 Using Exceed TurboX Server Manager
1.3.3
Configuring your user settings
This section describes how to configure your Exceed TurboX user settings, which
contain your user information, preferences for automated messages, and your client
settings.
To configure your user settings:
1.
After signing in to Exceed TurboX Dashboard, click the User settings
on the header bar.
icon
The User settings dialog box opens.
Note: If you are signing in for the first time, the Client settings and API
keys tabs (not shown in the figure above) are not available.
For more information, see “Signing in to Exceed TurboX Dashboard for
the first time” in Exceed TurboX Dashboard and Client Help.
2.
18
Confirm or enter the following information in the User information area of the
General tab. All of these fields are required:
Username
The username assigned by your system administrator.
Full name
The name associated with your Exceed TurboX user account.
Email address
The email address associated with your user account. All Exceed
TurboX messages (for example, event messages and invitations to
join shared sessions) will be sent to this email address.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
Note: If your administrator configured an LDAP server in your
environment, the name and email address displayed in your user settings
are retrieved from the LDAP server. In this case, these values are readonly.
When using OTDS authentication, your full name and email address are
retrieved from the OTDS server and displayed in your user settings.
3.
In the Preferences area:
• Select the Language for the Exceed TurboX interface.
• To enable profile shortcuts to allow suspended sessions to be resumed, select
Always allow desktop shortcuts to resume suspended sessions.
For more information, see “Working with shortcuts” in Exceed TurboX
Dashboard and Client Help.
4.
On the Messages tab, configure the types of message that you want to receive
when specific events occur in Exceed TurboX. These messages are sent to your
Exceed TurboX Dashboard.
You can configure the followings settings in the Messages tab:
Session is
terminated by
an
administrator
CONETX120501-AGD-EN-3
Send a message when an administrator terminates one or more
sessions that the user owns.
Server Manager Administration Guide
19
Chapter 1 Using Exceed TurboX Server Manager
Session is
suspended by
an
administrator
Send a message when an administrator suspends one or more
sessions that the user owns.
Session is
terminated due
to idle timeout
Send a message when one or more sessions that the user owns have
been terminated by Exceed TurboX after they have been suspended
for a defined period of time. This function is controlled by the
Terminate suspended sessions after [n] [units] option in the site
settings.
The message contains the session ID(s) of the automatically
suspended session(s).
20
Session is
suspended due
to idle timeout
Send a message when one or more sessions that the user owns have
been suspended by Exceed TurboX because there has been no session
activity for a defined period of time. This function is controlled by
the Suspend idle sessions after [n] minute(s) option in the site
settings.
Session is
suspended for
more than [n]
hour(s)
Send a message when one or more sessions that the user owns have
been suspended for longer than the specified time period.
Send a
reminder
message every
[n] [units] after
initial warning
Send reminder messages if one or more sessions that a user owns has
been suspended longer than the time period defined in Session is
suspended for more than [n] hour(s). If you enable this option, you
must enter the frequency of the reminder messages in minutes,
hours, or days.
Suspended
session is
terminated due
to timeout
Send a message when one or more sessions that the user owns have
been terminated due to timeout.
Send a warning
message [n]
[units] before
timeout
Send a message when one or more suspended sessions that the user
owns are about to be terminated. The message indicates when the
suspended session will terminate.
Send a
reminder
message every
[n] [units] after
initial warning
Send reminder messages if a suspended session that the user owns is
terminated due to timeout. This option is available if Suspended
session is terminated due to timeout. is selected. If you enable this
option, you must enter the frequency of the reminder messages in
minutes, hours, or days.
ETX Proxy has
crashed
Send a message when the Exceed TurboX session proxy process
terminates abnormally, causing a session that the user owns to
terminate. The message includes a URL linking to more information
about the crash.
If you select this option, you must enter the time period in hours.
If you select this option, you must enter the time period in minutes,
hours, or days.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
Session is
reassigned
Send a message when a session that the user owns is reassigned by
an administrator. The message includes the session title and node on
which it was started. The message to the user that started the session
includes the username of the new session owner. The message to the
session owner includes the name of the previous session owner.
Account is
locked because
of too many
failed sign-in
attempts
Send a message when the user’s account is locked after too many
consecutive failed sign-in attempts. This function is controlled by the
Lock users out of ETX Server after [n] consecutive failed sign-in
attempts option in the site settings.
Profile is edited Send a message when an administrator modifies one or more profiles
by an
that the user owns. The message contains the names of the modified
administrator
profiles.
API key is
created
Send a message when the user creates an API key.
Note: Users who do not have permissions to create API keys
(see “Working with API keys” on page 26) receive a message
when an Exceed TurboX administrator creates an API key on
their behalf.
Receive a copy
of all messages
via email
5.
Select this option to send a copy of all messages via email. If this
option is not selected, messages will be delivered only to the user’s
Exceed TurboX Dashboard.
On the Client settings tab:
• In the Client Preference area, select the Exceed TurboX client that you
would prefer to use to launch a session:
–
Native Client only: Always use the Native Client. If you are on a device
which does not support the Native Client, the session will not start.
–
Native if supported, Web otherwise: Use the Native Client on any
device which supports it (generally, any Windows, Linux or Mac PC)
and the Web Client on any other device (such as a tablet).
–
Web Client only: Always use the Web Client.
–
Prompt: Have Exceed TurboX prompt you for the client to use.
Notes
– This setting is used only if the Profile you are using to launch the
session allows the user to select the client type. A client type setting
in a Profile overrides the user’s client preference.
– The Native Client includes more features than the Web Client, and in
many configurations also offers better performance. In most cases,
we recommend you use the Native Client, if possible. However, it
does require you to install the Client Launcher on your local system.
If you do not want to install any software locally, for devices where
the Native Client is not supported, or if for any other reason you do
not want to use the Native Client, use the Web Client.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
21
Chapter 1 Using Exceed TurboX Server Manager
• In the Client Launcher area, ensure that Exceed TurboX Client Launcher is
installed on your system and is able to launch sessions:
–
If you do not have a Client Launcher installed on your computer, select
one of the Launcher packages available for your platform and click
Download launcher. The selected installation package is downloaded
and saved on your system; you must install the package before you can
launch Exceed TurboX sessions in the Native Client. For more
information, see “Downloading and installing the Client Launcher”
on page 22.
–
If you have a Client Launcher installed on your computer, click Test
launcher. This launches the Client Compatibility Wizard, which checks
the compatibility of the launcher with your system and determines
whether you need to perform any launcher downloads or upgrades. For
more information, see “Downloading and installing the Client Launcher”
on page 22.
• If required, click Clear Native Client cache to clear the data cached by
Exceed TurboX Native Client. Occasionally, you may need to clear the
cached data to reduce disk usage of old client runtimes or to delete clientside cached settings.
1.3.4
6.
Depending on the way your system is configured, you may see the API keys
tab. To work with API keys, click the API keys tab. For more information, see
“Working with API keys” on page 26.
7.
Click Save to save your user settings.
Downloading and installing the Client Launcher
Exceed TurboX uses an executable program called the Client Launcher to launch
Native Client sessions. The Client Launcher must be installed on the user’s
computer. It is responsible for:
• Downloading and extracting the Native Client runtime from Exceed TurboX
Server when a session is launched.
• Validating the integrity of the downloaded Native Client runtime.
• Invoking the Native Client runtime (etxc) with the necessary connection
information to start the session.
• Updating itself when a new Client Launcher is available.
• Launching or resuming sessions via a Windows shell command or shortcut.
This section describes how to download and install the Client Launcher on your
computer. It also describes how to use the Client Compatibility Wizard to check the
compatibility of the launcher with your system and determine whether you need to
perform any launcher downloads or upgrades.
22
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
Note: The Client Launcher is not required to launch session using the Web
Client. If you will use only the Web Client, not the Native Client, you do not
need to install the Client Launcher.
When using the Client Launcher over HTTPS with a fully-verified certificate
chain, you may see a mixed content warning issued by the browser. This is
because some browsers inform the user when information is leaving the
browser (in this case, to launch a remote session). For example, in Chrome, the
HTTPS lock symbol to the left of the address bar changes from green to orange
after launching a session. This is an expected behavior.
Starting with Exceed TurboX 12.0.1, the Client Launcher supports client-side
HTTP(S) proxy configuration when connecting to Exceed TurboX Server to
download launcher and client runtime updates.
For more information, see Use proxy server for client connections in
“Configuring general site settings” on page 95.
The Client Launcher is supported on Windows, Linux, and Mac. For details about
supported operating systems, see the Exceed TurboX Release Notes.
To download and install the Client Launcher on Windows:
.
1.
On the Exceed TurboX header bar, click User settings
2.
In the User settings dialog box, click the Client settings tab.
3.
In the Client Launcher area, select one of the launcher packages from the list:
• ETXLauncher-<version>.msi: This package is available for all users.
• ETXLauncher-<version>_AllUsers.msi: This package is for users of the
machine that require Admin rights.
4.
Click Download launcher.
Depending on the file you downloaded, either the ETXLauncher<version>.msi or the ETXLauncher-<version>_AllUsers.msi installation file
is saved on your system.
5.
Run the installer package from the download location.
If prompted with a Security Warning, click Run.
6.
On the Welcome page of the OpenText Setup Wizard, click Next.
7.
Read the OpenText End User License Agreement. Click I accept the terms in
the License Agreement, then click Next.
8.
To install the Client Launcher, click Install.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
23
Chapter 1 Using Exceed TurboX Server Manager
Note: Allow third party libraries to be loaded in ETX Client Launcher
should be selected under special circumstances only. (For example, if a
previous installation failed with a security warning.) If you select this
option, a less secure version of the Client Launcher, ETXLauncherl<version>.msi is installed. This version allows non-system DLLs to be
used. If you install this version of the Client Launcher, future service pack
updates will be applied to this version and will not update your
installation to the more secure version.
9.
When the installation process is complete, click Finish.
The Client Launcher is now installed on your system. You can now test the
compatibility of this launcher. See “To verify the Client Launcher compatibility:
“ on page 25 for more information.
To download and install the Client Launcher on Linux:
1.
On the Exceed TurboX header bar, click User settings
2.
In the User settings dialog box, click the Client settings tab.
3.
In the Client launcher area, select the Linux (.TAR) launcher package and click
Download.
4.
When the download is complete, unpackage the .tar file to your local drive:
.
sudo tar -xvzf ETXLauncher-<ETX Version>.<Build Number>-<SP
Number>-<Platform>-<CPU>.tar.gz
For example:
sudo tar -xvzf ETXLauncher-12.0.1.5790-SP1-linux-x64.tar.gz
5.
Run the installation script:
./etxlauncher_<version>/bin/install
6.
Follow the script prompts to complete the installation.
When the installation is complete, you can test the compatibility of this
launcher. See “To verify the Client Launcher compatibility:“ on page 25 for
more information.
To download and install the Client Launcher on Mac:
.
1.
On the Exceed TurboX header bar, click User settings
2.
In the User settings dialog box, click the Client settings tab.
3.
In the Client launcher area, select the Mac OS X (.DMG) launcher package and
click Download.
A new page appears, allowing you to either open the file or save it.
4.
24
Click Open.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
The ETXLauncher-<ETX Version>.<Build Number>-<SP Number><Platform>-<CPU>.dmg file is downloaded to the Download folder on your
local machine.
For example, the Mac Client Launcher package name for version 12.0.1 (build
5790) is: ETXLauncher-12.0.1.5790—SP1–macosx—x86_64.dmg.
5.
Double-click the .dmg file name.
The Exceed TurboX Client Launcher 12 dialog box opens.
6.
Drag the Exceed TurboX Client Launcher.app icon and drop it over the
Applications folder icon. This ensures that Exceed TurboX Client Launcher.app
is registered.
Note: You can also register the ETXLauncher.app by opening the
Download folder and right-clicking the file.
When the installation is complete, you can test the compatibility of this
launcher. See “To verify the Client Launcher compatibility:“ on page 25 for
more information.
To verify the Client Launcher compatibility:
1.
On the Exceed TurboX header bar, click User settings
.
2.
In the User settings dialog box, click the Client settings tab.
3.
Click Test launcher.
The Client Compatibility Wizard opens.
Note: To ensure optimal performance, run the Client Compatibility
Wizard the first time Exceed TurboX is accessed from a computer.
If you are signing in to Exceed TurboX Dashboard for the first time, the
Client settings tab is not available. Instead, if Verify client launcher
during registration is enabled on the New User Settings page, the Client
Compatibility Wizard opens automatically. For more information, see
“Configuring default user permissions and settings” on page 141. If
Verify client launcher during registration is not enabled, clicking Save
creates the user and causes the User settings dialog box to close.
4.
On the Welcome page, review the information and click Next.
The wizard tries to start the Client Launcher and test whether it is compatible
with your system.
5.
On the Attempting to start Exceed TurboX Client Launcher page, read and
accept any dialogs that appear.
If you are using Google Chrome and you receive an External Protocol Request
for ETX Client Launcher prompt, click Open ETX Client Launcher.
If the test fails, the Exceed TurboX Client Launcher was not detected page
displays. Continue with Step 6.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
25
Chapter 1 Using Exceed TurboX Server Manager
If the test is successful, the Exceed TurboX Client Launcher started
successfully page displays. Continue with Step 8.
6.
On the Exceed TurboX Client Launcher was not detected page, select a
package from the list and click Download launcher to download and install the
Launcher package. For installation instructions, see:
• “To download and install the Client Launcher on Windows:“ on page 23
• “To download and install the Client Launcher on Linux:“ on page 24
• “To download and install the Client Launcher on Mac:“ on page 24
1.3.5
7.
When the Launcher package installation is complete, return to the Client
Compatibility Wizard and click Next. Continue with Step 5.
8.
Click Finish to close the Client Compatibility Wizard.
9.
Click Save to save any changes made to the client settings.
Working with API keys
This section provides an overview of API keys and describes how to manage the API
keys associated with your Exceed TurboX user name.
API keys provide secure authentication for REST API calls to Exceed TurboX Server
by not requiring user credentials to be saved to a script file in plain text. API keys
are useful in several cases. For example:
• When writing scripts and saving credentials to a file.
• When accessing Exceed TurboX Server via HTTP instead of HTTPS. In this case,
credentials are sent over the wire in plain text and can be stolen.
• When API calls, including typed credentials, can be seen by other users. For
example, when accessing APIs during a webinar.
Active API keys must be stored in a safe location. Anyone with access to the API
keys can perform actions in Exceed TurboX on the user’s behalf.
You can manage the API keys on the API keys tab of the User settings dialog box.
You can create, view, and delete API keys associated with your Exceed TurboX user
name. For more information, see:
• “Creating API keys” on page 27
• “Viewing API keys” on page 28
• “Viewing detailed API key information” on page 29
• “Deleting API keys” on page 29
Note: Depending on your user permissions and site settings, you may not see
the API keys tab. Users with the User role are permitted to create API keys
26
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
only when the Access REST APIs and Allow users to create API keys settings
are both enabled.
See “Configuring user permissions” on page 79 and “Configuring general site
settings” on page 95 for more information.
Users can also manage API keys by calling Exceed TurboX REST APIs to create or
delete API keys. Use the Exceed TurboX REST APIs web interface to browse the list
of REST APIs provided with the server. See “Getting started with Exceed TurboX
REST APIs“ on page 299 for more information.
1.3.5.1
Creating API keys
This section describes how to create API keys using the User settings dialog box.
You can generate API keys that can be used to authenticate REST API calls.
To create an API key:
1.
In the User settings dialog box. click the API keys tab.
2.
Click the Create API key
3.
In the Create API key dialog box, specify the following fields:
Usage limit
icon.
Select how many times the API key can be used:
• Single use: The API key can be used only once.
• Multiple use: The API key can be used an unlimited number of
times.
Expiration
Select the length of time after which the API key expires:
• Never: The API key never expires.
• 1 hour: The API key expires after 1 hour.
• 24 hours: The API key expires after 24 hours.
Note: The Never option is available only if the Users can
create never-expiring API keys setting is enabled in the Site
Settings > General page.
See “Configuring general site settings” on page 95 for more
information.
4.
Click Create.
The Information area displays the API key, Usage limit, and Expires
information.
If your system has reached the maximum number of allowed API keys, you
may receive a message indicating you need to delete keys before you can create
new ones. See “Deleting API keys” on page 29 for more information.
5.
Copy the API key code to your clipboard.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
27
Chapter 1 Using Exceed TurboX Server Manager
Note: If you close the Create API key dialog box before copying the API
key, you cannot view this key again.
1.3.5.2
6.
Save the API key code to a location that only you, or the intended users of the
key, can access.
7.
Click Close.
Viewing API keys
This section describes how to view information about the active and expired API
keys that are associated with your Exceed TurboX user name, using the User
settings dialog box > API keys tab. Depending on the selection of the Hide used and
expired API keys check box, you may or may not see used and expired API keys in
the list.
Note: For security reasons, API keys are hashed before being stored. Exceed
TurboX cannot show the actual API key after its creation. API keys should be
copied to a safe location when they are created.
To view API keys:
1.
In the User settings dialog box, click the API keys tab.
2.
Review the information about the existing API keys.
3.
To hide used and expired API keys, select the Hide used and expired API keys
option. To display used and expired API keys, de-select the Hide used and
expired API keys option.
Note: The information in the tab is updated only if you reload the current
page or click the Refresh
icon in the top-right corner.
The following information is available in the API keys tab of the User settings
dialog box:
28
Created
When the API key was created.
Status
The current status of the API key. (Active, Used, or Expired.)
Usage
The availability of the API key for usage. (Single or Multiple.)
Expires
When the API key expires, or Never if the key does not expire.
Last used
When the API key was last used.
Actions
The actions you can perform on an API key. To view the available actions,
position the pointer over the Actions column.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
1.3.5.3
Viewing detailed API key information
This section describes how to view detailed information for an API key.
To view API key information:
1.
In the User settings dialog box > API keys tab, position the pointer over the
Actions column of the API key whose information you want to view.
2.
Click Details
3.
Review the information for the selected API key.
4.
When you are finished, click OK.
.
You can view the following information on the API key dialog box:
1.3.5.4
ID
The ID number of the API key is displayed at the top of the dialog box.
This is a 36-character string that includes a timestamp and unique ID.
API key
The API key code is visible only when the key is created. This field
displays (Only visible when created) to indicate the unavailability of the
API key code.
Created
When the API key was created.
Created from
The IP address where the API key was created.
Usage limit
How many times the API key can be used. (Single or Multiple.)
Expires
When the API key expires, or Never if the key does not expire.
Last used
When the API key was last used.
Last used from
The IP address from which the API was last used.
Deleting API keys
This section describes how to delete API keys using the User settings dialog box.
You can delete a single API key or all API keys.
Note: Ensure you do not need the API keys you are about to delete. You
cannot retrieve deleted API keys; you can only recreate them.
To delete a single API key:
1.
In the User settings dialog box, click the API keys tab.
2.
Position the pointer over the Actions column of the API key that you want to
delete.
3.
Click Delete API key
4.
When prompted, confirm that you want to delete the API key.
CONETX120501-AGD-EN-3
.
Server Manager Administration Guide
29
Chapter 1 Using Exceed TurboX Server Manager
To delete all API keys:
1.3.6
1.
In the User settings dialog box, click the API keys tab.
2.
Click the Delete API keys
3.
Optional: To delete used and expired API keys only, select the Delete used and
expired API keys only check box, and then click Yes.
4.
When prompted, confirm that you want to delete the API keys.
icon.
Signing out of Exceed TurboX Server Manager
This section describes how to sign out of Server Manager. When you are finished
using Server Manager, it is recommended that you sign out, to protect the security of
your user account. Signing out is strongly recommended if, for example, you are
using a public or shared computer.
To sign out:
•
Click the Sign out
icon on the header bar.
The sign-in page appears.
1.3.7
Understanding Exceed TurboX Server Manager
workflows
This section describes common Server Manager workflows:
• “Workflow 1: Monitoring and managing user sessions” on page 30
• “Workflow 2: Creating and distributing profiles and templates” on page 31
• “Workflow 3: Monitoring and managing licenses” on page 32
Note: You must set up an Exceed TurboX site before you can start using
Exceed TurboX Server Manager. For more information, see “Setting up the
Exceed TurboX site” in the Exceed TurboX Installation and Configuration Guide.
1.3.7.1
Workflow 1: Monitoring and managing user sessions
This topic describes the high-level tasks involved in monitoring and managing user
sessions in Server Manager.
1. Sign in to Exceed TurboX Server Manager.
You need an administrative user account and password to sign in to Exceed
TurboX Server Manager. For more information, see “Signing in to Exceed
TurboX Server Manager” on page 11.
2. Monitor session details.
30
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.3. Getting started with Exceed TurboX Server Manager
In Exceed TurboX Server Manager, you can view information about all the user
sessions that are currently running or suspended in Exceed TurboX.
General session details (for example, the names of the users running sessions and
session start times) are displayed in the Sessions pane in Exceed TurboX Server
Manager. For each entry in the Sessions pane, you can open the session details
dialog box to view specific information about a session (for example, memory
usage and a thumbnail image of the user’s desktop).
For more information, see “Viewing general session details in the Sessions pane”
on page 60 and “Using the session details dialog box to monitor and manage a
session” on page 62.
3. If needed, suspend or terminate a user’s session.
If necessary, you can suspend or terminate a user’s session. For example, you
may decide to terminate a session if it is idle and occupying system resources
unnecessarily.
You can use the icons available in the Sessions pane or in the session details
dialog box to manage a user’s session.
For more information, see “Viewing general session details in the Sessions pane”
on page 60 and “Using the session details dialog box to monitor and manage a
session” on page 62.
4. When you are finished monitoring and managing user sessions, sign out of
Exceed TurboX Server Manager. For more information, see “Signing out of
Exceed TurboX Server Manager” on page 30.
1.3.7.2
Workflow 2: Creating and distributing profiles and templates
This topic describes the high-level tasks involved in creating profiles or templates in
Server Manager. The profiles can be distributed to users and user groups under
Exceed TurboX Dashboard.
1. Sign in to Exceed TurboX Server Manager.
You need an administrative user account and password to sign in to Exceed
TurboX Server Manager. For more information, see “Signing in to Exceed
TurboX Server Manager” on page 11.
2. Create or modify the profile(s) or template(s) you want to distribute to users.
You can create or modify profiles or templates to control how users launch
sessions in your Exceed TurboX environment. For more information, see
“Creating and managing profiles and templates” on page 185.
3. Create an Exceed TurboX user group.
If you plan to distribute a profile to a user group, you need to create an Exceed
TurboX user group. Profiles can be distributed either to individual users or to
groups of users.
Templates can be published to the All Users group only; they cannot be
distributed to individual users.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
31
Chapter 1 Using Exceed TurboX Server Manager
For more information, see “Creating, editing, renaming, and deleting user
groups” on page 88.
4. Distribute the profile or template to users.
You can distribute a profile to make it available to an individual user or to a
group of users. You can publish a template to make it available to the All Users
group. For more information, see “Distributing profiles to users or user groups”
on page 190.
5. When you are finished monitoring and managing user sessions, sign out of
Exceed TurboX Server Manager. For more information, see “Signing out of
Exceed TurboX Server Manager” on page 30.
1.3.7.3
Workflow 3: Monitoring and managing licenses
This topic describes the high-level tasks involved in managing licenses in Server
Manager.
1. Sign in to Exceed TurboX Server Manager.
You need an administrative user account and password to sign in to Exceed
TurboX Server Manager.
For more information, see “Signing in to Exceed TurboX Server Manager”
on page 11.
2. Add licenses to Exceed TurboX Server Manager as needed.
Each Exceed TurboX user requires a license. You must add licenses so that users
can launch sessions.
For more information, see “Managing licenses” on page 127.
3. Monitor server details and license usage.
You can view the server and license statistics displayed in Exceed TurboX Server
Manager at all times.
For more information, see “Monitoring license statistics” on page 16.
4. View detailed license information as needed.
You can view detailed information for each license added in Exceed TurboX
Server Manager.
For more information, see “Viewing license key details” on page 130.
5. When you are finished monitoring and managing user sessions, sign out of
Exceed TurboX Server Manager. For more information, see “Signing out of
Exceed TurboX Server Manager” on page 30.
32
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.4. Managing Nodes, Node Groups, and Sessions
1.4 Managing Nodes, Node Groups, and Sessions
The Nodes and Sessions tab allows you to perform administrative tasks related to
nodes, node groups, and sessions. It includes the following panes:
• Node Groups: Displays the names of Node Groups that have been created by an
administrator. Administrators can create a Node Group if the system is
configured to use load balancing and administrators want to restrict it to a
certain set of Connection Nodes.
The following is a list of tasks that you can perform in the Node Groups pane:
–
View Node Group details. See “Viewing Node Group details in the Node
Groups pane” on page 56.
–
Create, edit, rename, or delete a Node Group. See “Creating, editing,
renaming, and deleting Node Groups” on page 57.
–
Add Nodes to an existing Node Group. See “Adding nodes to Node Groups”
on page 58.
–
Remove Nodes from an existing Node Group. See “Removing nodes from
Node Groups” on page 59.
–
Search for a Node Group. See “Searching in Exceed TurboX Server Manager
lists” on page 41.
–
Send a message to all users who have active or suspended sessions on a Node
Group. See “Sending messages to users and user groups” on page 85.
• Nodes: Displays information about the nodes that are currently available and
configured within the Exceed TurboX site.
This pane also provides action icons for performing common administrative
tasks related to nodes, such as editing node settings and viewing node
information. You can also access the node properties dialog box, which lets you
configure, enable, and disable the node.
The information about node status at the top of the pane only includes nodes
shown in the list. If you have performed a search, only nodes included in the
search results are reflected in these numbers.
The following is a list of tasks that you can perform in the Nodes pane:
–
Monitor the available nodes. See “Monitoring nodes in the Nodes pane”
on page 47.
–
Register a node. See “Registering connection nodes” on page 49.
–
Configure node settings. See “Configuring node settings” on page 50.
–
View detailed information about a node. See “Viewing detailed node
information” on page 54.
–
Enable or disable a node. See “Enabling a node” on page 55 and “Disabling
a node” on page 55.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
33
Chapter 1 Using Exceed TurboX Server Manager
–
Search for nodes. See “Searching in Exceed TurboX Server Manager lists”
on page 41.
–
Send a message to all users who have active or suspended sessions on a node.
See “Sending messages to users and user groups” on page 85.
• Sessions: Displays information about the sessions that are currently running or
suspended on Exceed TurboX Server. For example, you can view the names of
users who are currently running sessions, and the status of each session (active
or suspended). This pane also provides action icons for performing common
administrative tasks related to sessions. For example, suspending and
terminating a session.
The following is a list of tasks that you can perform in the Sessions pane:
–
View session details in the Sessions pane. See “Viewing general session
details in the Sessions pane” on page 60.
–
Search for sessions: See “Searching in Exceed TurboX Server Manager lists”
on page 41.
–
Send a message to all users or particular user(s). See “Sending messages to
users and user groups” on page 85.
–
Shadow a session. See “Shadowing a user’s session” on page 64.
–
Suspend or terminate a session. See “Terminating or suspending sessions”
on page 68.
Note: By default, each pane is minimized. You can maximize a pane to
display its contents in the full height and width of the page. See
“Maximizing and minimizing Exceed TurboX Server Manager panes with
lists” on page 38 for more information.
1.5 Managing users, groups, profiles and templates
The Users and Profiles tab allows you to perform administrative tasks related to
user settings, user groups, profiles and templates. It includes the following panes:
• User Groups: Displays the names of user groups that have been created by an
administrator. Administrators can create a user group if they plan to distribute a
profile to a specific set of users. For more information, see “Working with user
groups” on page 86.
The following is a list of tasks that you can perform in the User Groups pane:
34
–
View group details. See “Viewing group details in the User Groups pane”
on page 87.
–
Create, edit, rename, or delete a group. See “Creating, editing, renaming, and
deleting user groups” on page 88.
–
Add users to an existing group. See “Adding users to user groups”
on page 89.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.5. Managing users, groups, profiles and templates
–
Remove users from an existing group. See “Removing users from user
groups” on page 90.
–
Send a message to users in a group. See “Sending messages to users and user
groups” on page 85.
–
Search for a group. See “Searching in Exceed TurboX Server Manager lists”
on page 41.
• Users: Displays information about the users who have already signed in to
Dashboard and set up their user settings.
The following is a list of tasks that you can perform in the Users pane:
–
View user account details. See “Viewing user details in the Users pane”
on page 75.
–
Modify user settings. See “Modifying user settings, roles, and permissions for
individual users” on page 82.
–
Send a message to a user. See “Sending messages to users and user groups”
on page 85.
–
Deactivate or activate a user account. See “Deactivating and activating user
accounts” on page 84.
–
Delete a user account from Exceed TurboX. See “Deleting user accounts”
on page 84.
–
Search for a user. See “Searching in Exceed TurboX Server Manager lists”
on page 41.
–
Import multiple users in bulk. See “Importing multiple user accounts to
Exceed TurboX” on page 76.
• Profiles and Templates: Displays information about the profiles that individual
users have created in Dashboard, as well as profiles and templates that
administrators have created in Exceed TurboX Server Manager.
The following is a list of tasks that you can perform in the Profiles and
Templates pane:
–
Sort the profiles and templates alphabetically. To do so, click the arrow on the
Name column.
–
View profile and template details in the Profiles and Templates pane. See
“Viewing profile and template information” on page 185.
–
Search for a profile or template. See “Searching in Exceed TurboX Server
Manager lists” on page 41.
–
Create or edit a profile or template. See “Creating and editing profiles and
templates” on page 188.
–
Distribute a profile to users and groups. See “Distributing profiles to users or
user groups” on page 190.
–
Copy an existing profile. See “Copying or deleting a profile or template”
on page 192.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
35
Chapter 1 Using Exceed TurboX Server Manager
–
Delete profile or template. See “Copying or deleting a profile or template”
on page 192.
–
Import/Export profile or template. See “Exporting and importing a profile or
template” on page 189.
Note: By default, each pane is minimized. You can maximize a pane to
display its contents in the full height and width of the page. For more
information, see “Maximizing and minimizing Exceed TurboX Server
Manager panes with lists” on page 38.
1.6 Managing applications
The Applications tab allows you to manage published applications (that is,
applications that have been deployed to various hosts for user access).
The following is a list of tasks that you can perform on the Published Applications
page:
• View currently published applications. See “Managing published applications”
on page 92.
• Publish and edit a list of scanned applications. See “Publishing and editing
applications” on page 93.
• Edit an application host. See “Editing an application host” on page 94.
1.7 Managing the site settings
The Site Settings tab allows you to perform various administrative tasks related to
managing the Exceed TurboX site. It includes the following pages:
• General: Configure general Exceed TurboX site settings, including load
balancing, credentials for launching profiles, and site notifications to be
displayed on the header bar. For more information, see “Configuring general site
settings” on page 95.
• Appearance: Manage the theme of your Exceed TurboX system and the icons
available for use in profiles. For more information, see “Managing appearance”
on page 104.
• Authentication: Configure the authentication methods used to sign in to Exceed
TurboX Server. For more information, see “Configuring user authentication
settings” on page 110.
• Cluster: Review cluster status and detailed information about each member of
the cluster. For more information, see “Managing a cluster” on page 124.
• Licenses: Manage Exceed TurboX licenses. For more information, see “Managing
licenses” on page 127.
• Messages: Set up email messages for administrators and users. For more
information, see “Setting up automated messages” on page 137
36
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.8. Managing the server settings
• New User Settings: Configure default user permissions. For more information,
see “Configuring default user permissions and settings” on page 141.
• User Roles: Create, modify, and delete user roles. For more information, see
“Configuring user roles” on page 149.
• Runtimes: Install and manage runtimes. For more information, see “Managing
runtimes” on page 154
• Security: Configure security settings including HTTP proxy, session, and API
settings. For more information, see “Configuring security settings” on page 157.
1.8 Managing the server settings
The Server Settings tab allows you to perform various administrative tasks related
to managing the Exceed TurboX Server. It includes the following pages:
• Configuration: Configure the Exceed TurboX Server. For details, see
“Configuring Exceed TurboX Server settings” on page 164.
• Server Logs: Monitor the Exceed TurboX Server logs. For details, see “Reviewing
Server logs” on page 170.
• Server Status: Monitor the health of the main server and track resource usage.
For details, see “Monitoring the Server status” on page 172.
1.9 Maintaining the system
The Maintenance tab allows you to perform various administrative tasks related to
maintaining the Exceed TurboX system (for example, viewing event details or
creating reports). It includes the following pages:
• Activity Log: Monitor session and system events. For details, see “Monitoring
Exceed TurboX events” on page 172.
• Reports: Generate reports to view information about sessions, licenses, and
users. For details, see “Creating reports” on page 177.
1.10 Working with Exceed TurboX Server Manager
lists
This section contains information about working with Exceed TurboX Server
Manager panes that include lists.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
37
Chapter 1 Using Exceed TurboX Server Manager
1.10.1
Maximizing and minimizing Exceed TurboX Server
Manager panes with lists
This section provides information about how to maximize and minimize the Exceed
TurboX panes that include lists (for example, Nodes, Node Groups, Sessions, etc.).
By default, all of the panes in Server Manager are minimized. That is, each pane
occupies only a portion of the page. You can maximize a pane to display its contents
in the full height and width of the page.
You can maximize a pane to reduce scrolling when monitoring or managing various
items in Exceed TurboX Server Manager.
To maximize or minimize a pane:
1.
In Exceed TurboX Server Manager, click one of the tabs that includes panes with
lists (for example, Nodes and Sessions).
2.
To maximize or minimize the pane, use the following buttons, located on the
top-right corner of the pane:
: This icon is displayed when the pane is minimized.
• Maximize view
Click to maximize the pane.
This icon is displayed when the pane is maximized. Click
• Minimize view
to minimize a pane.
1.10.2
Browsing Exceed TurboX Server Manager lists
To browse the entries of a list, use the navigation icons in the lower-right corner of
the pane:
Display the beginning of the list.
Display the previous set of entries in the list.
Display the next set of entries in the list.
Display the end of the list.
At the bottom of each pane, you can view the range of entries currently displayed in
the list, as well as the total number of entries available in the list.
For example, if 1-6 of 12 is displayed at the bottom of the pane, entries 1 through 6
are currently displayed, and 12 entries in total are available on multiple pages.
38
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.10. Working with Exceed TurboX Server Manager lists
1.10.3
Showing and hiding columns in Exceed TurboX Server
Manager grids
For most types of objects, Exceed TurboX can display more information than can
easily be shown in a grid, especially when the pane containing the information is
minimized. For this reason, by default, the grids do not display every available
column. You can use the Change view dialog box to show/hide columns, and to
rearrange the order in which columns are displayed.
Your column display preferences are preserved after you sign off, even if you sign
on again using a different browser.
To show and hide columns in Exceed TurboX grids:
1.
In Exceed TurboX, go to the pane you want to view.
2.
Click the Change view button
3.
In the Change view dialog box, for each column, select whether you want that
column to Hide, Show, or Show in maximized view only.
4.
To change the order of the columns, click and hold each column’s Reorder
button
5.
at the top-right corner of the pane.
. Drag and drop each column, as needed, to get the order you want.
Click Save.
Tip: To return the columns to their default settings, in the Change view dialog
box, click Reset. Then click Save.
1.10.4
Exporting Exceed TurboX Server Manager lists
You can use the Export...list button
to export information that is displayed in
Server Manager lists to a .csv file. The Export...list button is available on the
following Server Manager panes:
• Node Groups
• Nodes
• Sessions
• Users
• Profiles and Templates
Administrators can export these lists in their current view only. To change the
current view, use the Search or Change view options available on each pane. See
“Searching in Exceed TurboX Server Manager lists” on page 41 and “Showing and
hiding columns in Exceed TurboX Server Manager grids” on page 39 for more
information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
39
Chapter 1 Using Exceed TurboX Server Manager
To export a list:
1.
Open the pane whose list you want to export. For example, Sessions.
2.
Ensure that the pane is displaying the information you want to export.
If needed, use the Search or Change view options to change the current view.
3.
Click the Export...list button
. For example, Export sessions list.
A File download window is displayed, listing the file to be exported in the
following format:
etx-<pane>.csv
For example:
etx-sessions.csv
1.10.5
4.
In the File download window, select or enter a location to save the file to.
5.
Click Save.
Sorting entries on Exceed TurboX Server Manager lists
When first displayed, each list is sorted by a default column. You can change the
column that the list is sorted by, and whether it is sorted in ascending or descending
order.
To change how a list is sorted:
1.
In the Exceed TurboX web interface, go to the list you want to sort.
2.
Click the name of the column you want to use to sort the list entries.
One of the following icons appears beside the name of the column:
The list is sorted in ascending order, according to the values in the
column.
The list is sorted in descending order, according to the values in the
column.
3.
To reverse the sort order, click the column name again.
Note: Not all columns are sortable.
Your column display preferences are preserved after you sign off, even if you
sign on again using a different browser.
You can customize which columns appear, and the order in which the columns
appear. See “Showing and hiding columns in Exceed TurboX Server Manager
grids” on page 39 for more information.
40
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.10. Working with Exceed TurboX Server Manager lists
1.10.6
Searching in Exceed TurboX Server Manager lists
You can perform a search to locate specific entries within a Server Manager list. You
can perform a search based on multiple search parameters. Search criteria that you
apply to a list are automatically applied to all lists on that page. Searches are not case
sensitive.
To search in Exceed TurboX Server Manager panes:
1.
In Exceed TurboX Server Manager, go to the pane in which you want to
perform the search.
2.
Click the Search button
3.
In the Search for dialog box, specify the search parameters you want to apply.
See “Types of search parameters” on page 41 for more information.
located at the top-right corner of the pane.
Note: You can apply search parameters to columns that are hidden.
However, the search results display visible columns only. See “Showing
and hiding columns in Exceed TurboX Server Manager grids” on page 39
for more information.
4.
Click Search.
The search results are displayed on the pane in which you performed the
search. One or more labels in the top-left corner of the page indicate the search
criteria that are currently applied. For example:
5.
1.10.6.1
To clear the search criteria, click the close button (the x) on the right side of each
label.
Types of search parameters
The following search parameters are available in the Search for nodes dialog box:
Node ID
Specify the ID of the Node. You can search for the entire ID, which is a 36character string in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, or
for a partial ID (for example, the first 8 or 13 characters of the ID).
Node address
Specify the full or partial name of a host.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
41
Chapter 1 Using Exceed TurboX Server Manager
Node status
Select one of the following criteria:
• Any: Any node.
• Disabled: Nodes that are disabled.
• Enabled, Ready: Nodes that are enabled and fully functional (can be
•
•
•
•
used for launching sessions).
Enabled, Connected: Nodes that are enabled and connected to Exceed
TurboX Server. Connected indicates that a network connection to the
node is established, but the Server has not completed the node
upgrades.
Enabled, Error: Nodes that are enabled, but Exceed TurboX Server
cannot establish a connection with the node, the node is reporting an
error, or Exceed TurboX Server detected an error while working with
the node.
Enabled, Patch queued: Nodes that are connected but need to be
patched before they can be used. Patching starts automatically for
nodes in the queue based on the maximum concurrent patching limit.
Enabled, Patching: Nodes that are currently patching as a result of a
server update that includes new node packages.
Enabled, Patched: Nodes that have been patched.
•
• Enabled, Synchronizing: Nodes that are currently synchronizing
connection node data (such as sessions and connection node events).
Node roles
Select one of the following search criteria:
•
•
•
•
Any: Search for nodes that are assigned any role.
None: Search for nodes that are not assigned a role listed here.
AUTH: Search for all Authentication nodes.
AUTH, PM (Launch:On):Search for nodes that have the role of
Authentication Node or Proxy Manager, and which can be used to
launch new sessions.
• AUTH, PM (Launch:Off): Search for nodes that have the role of
Authentication Node or Proxy Manager, but which cannot be used to
launch new sessions.
• PM (Launch:On): Search for nodes that have the role of Proxy
Manager, and which can be used to launch new sessions.
• PM (Launch:Off): Search for nodes that have the role of Proxy
Manager but which cannot be used to launch new sessions.
For information about nodes, see “Managing nodes” on page 47.
The following search parameters are available in the Search for node groups dialog
box:
Group ID
Specify the ID of the Node Group. You can search for the entire ID (which
is a 36-character string in the form xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx), or for a partial ID (for example, the first 8 or 13 characters
of the ID).
Group name
Specify the full or partial name of the node group you want to locate.
For more information, see “Managing node groups” on page 56.
42
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.10. Working with Exceed TurboX Server Manager lists
The following search parameters are available in the Search for sessions dialog box:
Session ID
Specify the ID of the Session. You can search for the entire ID (which is a
36-character string in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx),
or for a partial ID (for example, the first 8 or 13 characters of the ID).
Username
Specify the full or partial name of a user running one or more sessions.
This parameter allows you to search according to the names specified in
Exceed TurboX user settings.
Client IP
Specify a full or partial IP address value. You must specify a numeric
value.
Runtime
version
Specify the version number of the Exceed TurboX client runtime used to
run one or more sessions. You must specify a numeric value.
Profile name
Specify a full or partial name of the profile.
Status
Select the session status you want to search (active or suspended).
Started on
Select the time or date range that you want to search.
Maximum
search results
Enter the maximum number of search results to show in the pane.
For more information, see “Managing sessions” on page 60.
The following search parameters are available in the Search for user groups dialog
box:
Group ID
Specify the ID of the User Group. You can search for the entire ID (which
is a 36-character string in the form xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx), or for a partial ID (for example, the first 8 or 13 characters
of the ID).
Group name
Specify the full or partial name of the user group you want to locate.
Searching for a particular LDAP group enables you to reduce the list of LDAP
groups shown in Exceed TurboX, and list only those groups you want to see. Note
that up to 200 groups may be listed in Exceed TurboX. Nested LDAP groups are
supported. If you are searching for an LDAP user group, search results are obtained
from the LDAP server.
For more information, see “Managing user groups” on page 86.
The following search parameters are available in the Search for users dialog box:
User ID
Specify the ID of the User. You can search for the entire ID (which is a 36character string in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx), or
for a partial ID (for example, the first 8 or 13 characters of the ID).
Username
Specify the full or partial name of the user you want to search. The user
name corresponds to the name defined for the user in the Linux
environment.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
43
Chapter 1 Using Exceed TurboX Server Manager
Full name
Specify the name of the user you want to search. The full name
corresponds to the name defined in the User settings dialog box.
Role
Select the system-defined role of the user that you want to search.
User group
Specify the user group name to search for all users belonging to that
group.
Account status
Search for:
• All—all accounts
• Active—currently active accounts
• Deactivated—accounts that are no longer active. When a user account
is deactivated, its previously configured user settings are saved, but
the user cannot sign in to Exceed TurboX.
See “Deactivating and activating user accounts” on page 84.
For information about users and their accounts and permissions, see “Managing
users” on page 70.
The following search parameters are available in the Search for profiles/templates
dialog box:
Profile/
Template ID
Specify the ID of the Profile/Template. You can search for the entire ID
(which is a 36-character string in the form xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx), or for a partial ID (for example, the first 8 or 13 characters
of the ID).
Name
Specify the name of the profile or template you want to search.
Type
Select the type of entry that you want to search (template, group profile,
or user profile).
Access
Specify the full or partial name of the user or user group to which a profile
or template has been distributed. The filter will only return results where
the Access column matches the specified string; it will not include profiles
or templates that are distributed to user groups of which a searched user
is a member.
Startup mode
Select the startup mode of the profile or template you want to search.
Window mode
Select the window mode of the profile or template you want to search.
Runtime
version
Select the runtime version of the profile or template you want to search.
Notes
• Wildcard characters (for example, *) are not supported. If needed, you can
specify a partial string to perform a search.
• You can click the Clear button to clear the search parameters from the dialog
box if needed.
For information about profiles and templates, see “Working with Profiles“
on page 183.
44
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
1.10. Working with Exceed TurboX Server Manager lists
The following search parameters are available in the Search for applications dialog
box:
Application ID
Specify the ID of the Application. You can search for the entire ID (which
is a 36-character string in the form xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx), or for a partial ID (for example, the first 8 or 13 characters
of the ID).
Application
name
Specify the name of the application you want to search.
Description
Enter keywords that might be included in the description of an
application.
Platform
Specify the platform on which the application is running.
For information about published applications, see “Managing published
applications” on page 92.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
45
Chapter 2
Managing Exceed TurboX as an administrator
This section describes how to use Exceed TurboX Server Manager to perform
administrative tasks.
Note: You must have the Admin (Full Access) user role assigned to you in
your user settings to perform these tasks. For more information on user roles,
see “Working with user roles” on page 70 and “Managing users”
on page 70.
2.1 Managing nodes
The Nodes pane on the Nodes and Sessions page displays information about the
nodes that are currently available and configured within your Exceed TurboX site,
and provides action icons for performing common node administration tasks.
This section provides information about the tasks you can perform on the Nodes
pane.
2.1.1
Monitoring nodes in the Nodes pane
The Nodes pane on the Nodes and Sessions page displays the following
information about the Connection Nodes configured for your Exceed TurboX site:
Node address
The fully qualified domain name of the computer that hosts the node.
A node that is not connected to the Exceed TurboX Server is denoted by a
strikethrough line (horizontal line drawn through text).
Roles
The function of the node:
• AUTH: The node is an Authenticator node, which handles only PAM
•
•
•
•
CONETX120501-AGD-EN-3
and Native user authentication requests.
AUTH, PM (Launch: On): The node handles both PAM and Native
user authentication and manages sessions. The node functions as both
an Authenticator node and a Proxy Manager, and launching new
sessions is enabled.
AUTH, PM (Launch: Off): The node handles both PAM and Native
user authentication and manages sessions. The node functions as both
an Authenticator node and a Proxy Manager, but launching new
sessions is disabled.
PM (Launch: On): The node is a Proxy Manager, which manages
sessions, and launching new sessions is enabled.
PM (Launch: Off): The node is a Proxy Manager, which manages
sessions, but launching new sessions is disabled.
Server Manager Administration Guide
47
Chapter 2 Managing Exceed TurboX as an administrator
Status
The status of the node:
• Disabled: The node is disabled.
• Enabled, Ready: The node is enabled and ready to launch sessions.
• Enabled, Connected: The node is enabled and connected to Exceed
TurboX Server. Connected indicates that a network connection to the
node is established, but the Server has not completed the node
upgrades. Once these types of tasks complete successfully, the status
changes to Ready, and the node can be used to launch sessions. The
status changes to Error if the Server detects an error while working
with the node.
•
•
•
Note: If a node that is registered to a Server is reinstalled on the
same system, the node is automatically reconnected. You do not
need to remove the node and add it back to Server Manager.
Enabled, Error: The node is enabled, but Exceed TurboX Server cannot
establish a connection with the node, the node is reporting an error, or
Exceed TurboX Server detected an error while working with the node.
Enabled, Patch queued: The node is connected but needs to be
patched before it can be used. Patching starts automatically for nodes
in the queue based on the maximum concurrent patching limit.
Enabled, Patching: The node is currently patching as a result of a
server update that includes new node packages.
Enabled, Patched: Patching of the node is complete.
•
• Enabled, Synchronizing: The node is currently synchronizing
connection node data (such as sessions and connection node events).
48
Total sessions
The total number of both active and suspended sessions running on the
node.
Active sessions
The number of active sessions running on the node.
Suspended
sessions
The number of suspended sessions running on the node.
Users
The total number of users running active or suspended sessions on the
node.
CPU (%)
The percentage of processor (CPU) resources used by the node at a given
time.
Memory (%)
The percentage of memory (RAM) used by the node at a given time.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.1. Managing nodes
Actions
The actions you can perform on a node. To view the available actions,
position the pointer over the Actions column.
•
•
•
Properties
: View additional node information, configure node
settings, or enable or disable a node. See “Configuring node settings”
on page 50 for more information.
Send message to all session owners
: Send a message to all users
who have active or suspended sessions on a node. See “Sending
messages to users and user groups” on page 85 for more information.
Delete node
: Delete a node. Click this icon to delete the selected
node. Click Yes to confirm the deletion.
The following icons are displayed at the top-right corner of the Nodes pane:
Export nodes
list
Register node
Save a copy of the current view of the pane. See “Exporting Exceed
TurboX Server Manager lists” on page 39 for more information.
See “Registering connection nodes” on page 49 for more information.
Refresh view of Click this button to update the information displayed in this pane.
nodes
Search for
Perform a search to locate one or more specific nodes in the pane.
nodes
See “Searching in Exceed TurboX Server Manager lists” on page 41 for
more information.
Change view
Use the Change view dialog box to customize the columns that are
displayed in the grid. See “Showing and hiding columns in Exceed
TurboX Server Manager grids” on page 39 for information.
Maximize view Click this button to see an expanded view of the pane. See “Maximizing
and minimizing Exceed TurboX Server Manager panes with lists”
on page 38 for more information.
2.1.2
Registering connection nodes
This section describes how to register a connection node if you did not register the
node during the node installation process. For more information about node
installation, see “Installing Exceed TurboX Connection Nodes” in Exceed TurboX
Installation and Configuration Guide.
When using PAM or Native authentication, you must install and register an
authentication node before users can sign in to Exceed TurboX Server. The Exceed
TurboX Server administrator can always sign in as the etxadmin user, to configure
authentication and register or configure the authentication nodes.
To register a node, you need the following information:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
49
Chapter 2 Managing Exceed TurboX as an administrator
• The host name or IP address of the node
• The port number (default 5510)
Note: This information is displayed on the final screen of the Windows
connection node installer and at the end of the installation script for UNIXbased Nodes. For more information, see “Installing Exceed TurboX Connection
Nodes” in Exceed TurboX Installation and Configuration Guide..
To register a connection node:
1.
On the Nodes and Sessions page, in the Nodes pane, click the Register node
button
on the top-right corner of the pane.
The Register node dialog box opens.
2.
In the Registration tab, type the connection node Address and Port number.
3.
Click Register.
When the registration process is completed, the connection node appears in the
Server Manager Nodes pane. The node properties dialog box opens, displaying
the Settings tab. The Settings tab allows you to configure the node. For more
information, see “Configuring node settings” on page 50.
2.1.3
Configuring node settings
This section provides information about configuring a node using the node settings
dialog box.
To open the node settings dialog box:
1.
On the Nodes and Sessions page, in the Nodes pane, position the pointer over
the Actions column beside the node entry you want to edit.
2.
Click Properties
.
The node properties dialog box opens. At the top of the dialog box, you can see
the name of the connection node, with a port number. At this port, Exceed
TurboX Connection Node listens for connection requests from Exceed TurboX
Client and communicates with Exceed TurboX Server.
Note: The port number is set during the Exceed TurboX Connection Node
installation. For more information, see “Installing Exceed TurboX
Connection Nodes” in Exceed TurboX Installation and Configuration Guide.
The node properties dialog box allows you to:
• Change the Address or Port information on the Registration tab. For more
information, see “To change the node address or port number:“ on page 51.
• Configure various node settings on the Settings tab. For more information, see
“To configure node settings:“ on page 51.
50
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.1. Managing nodes
• Review detailed node information on the Information tab. For more information,
see “Viewing detailed node information” on page 54.
• Enable/disable the node, using the Enable node /Disable node buttons on the
top-right corner of the dialog box. For more information, see “Enabling a node”
on page 55 and “Disabling a node” on page 55.
• Send a message to all users who have active or suspended sessions on the node,
using the Send message to all session owners
of the dialog box.
button on the top-right corner
To change the node address or port number:
Important
You can perform this operation only on a node that is Disabled.
When you change the name and/or the port of a connection node, any existing
profiles and templates that have the Node/Group name configured with the
original node address will NOT be automatically updated with the new node
address/port. This will result in a failure when launching a session with one of
these profiles. Also, the node will appear as an invalid host (will be marked by
a strikethrough line) when the profiles are viewed. To resolve this issue, you
must re-select the proper node in each of the profiles and templates affected by
this change.
1.
In the node settings dialog box > Registration tab, modify the node address or
port number, as required.
2.
Click Change. This button is available only for nodes that are Disabled.
To configure node settings:
Important
You can perform this operation only on a node that is Enabled, Ready.
1.
In the node settings dialog box, click the Settings tab.
2.
In the General area, configure the node role, by selecting one or both of the
following options:
• AUTH - Native/PAM authentication: Designates the node as an
Authenticator node, which handles user authentication requests.
• PM - Proxy Manager: Designates the node as a Proxy Manager node, which
will manage sessions.
• (Optional) In the Notes box, add a note of up to 512 characters describing the
connection nodes, such as the reason for pausing a node. A warning dialog
is displayed if you exceed the character limit.
Note: For AIX, Linux, and Solaris connection nodes, the node can function
as both an Authenticator node and a Proxy Manager (that is, the node
CONETX120501-AGD-EN-3
Server Manager Administration Guide
51
Chapter 2 Managing Exceed TurboX as an administrator
handles both user authentication and session management). A Windows
connection node can be assigned a Proxy Manager role only, as PAM and
Native authentication are only for UNIX-based systems.
3.
If you select the PM - Proxy Manager check box, configure the following
settings in the Proxy Manager area, as needed:
Launch new
sessions
Select this check box to allow users to launch sessions on this node.
Limit total
sessions to [n]
Select this option to specify the maximum number of sessions that
can run on this node. This includes both active and suspended
sessions.
You can configure this option only when Launch new sessions is
selected.
Limit sessions
per user to [n]
Select this option to specify the maximum number of sessions, both
active and suspended, that any user can own on this node.
You can configure this option only when Launch new sessions is
selected.
Note: The value of Limit sessions per user to [n] may not
exceed the value of Limit total sessions to [n].
Enable Web
Adaptor for
Web Client
Check this box if you want to be able to run Web Client sessions on
this node.
Web Adaptor
port
If Enable Web Adaptor for Web Client is checked, enter the port to
use for the Web Adaptor.
Enable
application
scanning
Select this option to list the node’s locally installed applications in the
Applications tab and make the available for publishing. See
“Managing published applications” on page 92 for more
information.
Note: Click the Refresh button to re-scan the node. Any newly
detected applications are made available in the Applications
tab.
The Refresh button switches to Remove if you disable the PM
role or clear the Enable application scanning check box on the
node. The Remove button is enabled only if the node has been
scanned and there is an application cache that can be removed.
Clicking Remove deletes the node from all Published
Applications, so that those applications no longer launch on
the node. The node is not removed automatically because
administrators may want to disable the PM role or application
scanning on the node temporarily, not permanently remove the
node from all published applications.
52
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.1. Managing nodes
Starting
display ID
Specify the number at which Exceed TurboX Server begins assigning
X11 display IDs to sessions. This number can be different for each
node. You can specify a starting display ID from 1 to 9999. The
default value is 1.
You may need to specify this value if, for example, you need to
prevent collisions with occupied ports on the node.
SSH command
override
Specify the path of the Secure Shell client executable file if you want
to allow the Secure Shell startup method in profiles.
You must first save the Secure Shell client executable file on the
server. You can then specify the path of the executable file in this
box.
Note: In a profile, the Secure Shell method is available for the
Custom startup mode. For more information, see “Configuring
Custom startup mode” on page 250.
4.
Depending on where the node is located in your company, you might want to
expose a hostname or IP address which is different than the hostname or IP
address that the node was registered with. For example, the node can be
installed in front of, or behind, your organization’s firewall. If it is installed
behind, on a machine called InternalName.example.net , and you want
Exceed TurboX Client to access it by another name, you can configure an
alternative name, such as PublicName.example.com. You can also configure
the name that Exceed TurboX Server uses to connect to the node.
To do this, in the Alternative node addresses area, enter one of the following
formats:
• <fully_qualified_hostname>
• <ipaddress>
• <fully_qualified_hostname>:<port>
• <ipaddress>:<port>
For server
Enter the fully qualified domain name or the IP that you want
Exceed TurboX Server to use to connect to the node.
For client
Enter the fully qualified domain name or the IP that you want
Exceed TurboX Client to use to connect to the node.
Note: You can specify multiple addresses using a commaseparated list. If the port is not specified, then the port number
of the registered connection node is assumed.
If you configure both settings, the names do not have to match.
5.
If needed, specify node configuration values in the Optional settings box.
In some situations, these values are provided by OpenText Professional Services
to address specific issues or requirements. Otherwise, leave this box blank.
6.
When you are finished editing the node settings, click Save.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
53
Chapter 2 Managing Exceed TurboX as an administrator
2.1.4
Viewing detailed node information
The Information pane of the Node Settings dialog box provides the following
detailed information about the selected node:
Note: The connection node name, port number, and ID number are displayed
in the header area.
The port is used by both the Client and the Server to communicate with the
node. The port number is configured during node installation.
For information about the fields on the Settings page of the Node Settings
dialog box, see “Configuring node settings” on page 50.
• General information:
Installation
path
The path in which the node software is installed.
Platform
The type of operating system on which the node is installed.
etxpm version
The version of Exceed TurboX Proxy Manager installed on the node.
etxauth version The version of Exceed TurboX Authenticator installed on the node.
This component is used to perform PAM and Native authentication of
Exceed TurboX users.
etxscan version
The version of the etxscan utility installed on the node.
Compatible
with server
Whether the node is compatible with the server API levels. If a
connection node uses an incompatible (older) API level, the
connection between the node and the server may not be established.
A node that is incompatible and may not be connected to is identified
in the Nodes pane by a strikethrough line (horizontal line drawn
through text). For details on the Nodes pane, see “Managing nodes”
on page 47.
Installation
date
The date and time when the node was installed.
Started
The date and time when the node was started.
Enabled
Whether the node is enabled.
Exceed TurboX Server will try to establish a connection with an
enabled node. Once a node is enabled and a connection is established,
Exceed TurboX Server will ask the node to perform tasks such as
launching sessions, scanning for applications, or handling PAM/
Native authentication requests.
54
Connected
Whether the node is connected to Exceed TurboX Server. A connected
node can perform tasks such as launching sessions, scanning for
applications, and handling PAM/Native authentication requests.
Connection
time
The date and time when the node established the current connection
to Exceed TurboX Server.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.1. Managing nodes
Ready time
The date and time when the node was enabled and became ready to
launch sessions.
Last health
update
The date and time when the Server health was last monitored.
Error
Indicates whether the node is reporting an error or the Exceed TurboX
Server cannot establish a connection with the node.
• Detailed state information: The fields included in this area may be used for
troubleshooting purposes.
2.1.5
Enabling a node
Administrators can enable a node to make it available to users again after it has been
disabled.
To enable a node:
1.
On the Nodes pane, position the pointer over the Actions column beside the
node you want to enable.
2.
Click the Properties
icon.
The node properties dialog box opens.
3.
Click the Enable node button, located in the top-right corner of the dialog box.
The node is now enabled
You can disable a node later, as necessary. For more information, see “Disabling a
node” on page 55.
2.1.6
Disabling a node
Administrators can disable a node if they want to make it unavailable to users
temporarily, for example when a computer requires maintenance or upgrades.
Note: You can send a message to inform users that the node will be disabled.
For more information, see “Sending messages to users and user groups”
on page 85.
To disable a node:
1.
On the Nodes pane, position the pointer over the Actions column beside the
node you want to disable.
2.
Click the Properties
icon.
The node properties dialog box opens.
3.
Click the Disable node button, located in the top-right corner of the dialog box.
4.
When prompted to confirm the operation, click Yes.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
55
Chapter 2 Managing Exceed TurboX as an administrator
You can enable the node later, as necessary. For more information, see “Enabling a
node” on page 55.
2.2 Managing node groups
Exceed TurboX administrators can create Node Groups to control node resources by
using load balancing. The Node Groups pane on the Nodes and Sessions page
displays information about the node groups connected to your Exceed TurboX
Server, and provides action icons for performing common administrative tasks.
This section provides information about the tasks you can perform on the Node
Groups pane.
2.2.1
Viewing Node Group details in the Node Groups pane
The Node Groups pane displays information about the Node Groups created by
Exceed TurboX administrators.
By default, the Node Groups pane displays the Group Name and the total number
of members (nodes) in the group. If you maximize the pane, it also lists the number
of active members, the number of profiles, and templates that target each group.
The Node Groups pane on the Nodes and Sessions page displays the following
information:
Group Name
The name of the node group.
Total Members
The total number of members (nodes) in the group.
Actions
The actions you can perform on a node group. To view the action icons,
position the pointer over the Actions column.
•
•
•
Properties
: View additional information about the node group,
configure node group settings, add members to the node group, or
remove members from the node group. See “Creating, editing,
renaming, and deleting Node Groups” on page 57 for more
information.
Send messages to ETX Dashboards of all session owners
: Send a
message to all users who have active or suspended sessions within a
node group. See “Sending messages to users and user groups”
on page 85 for more information.
Delete node group
: Delete a node group. Click this icon to delete
the selected node group. Click Yes to confirm the deletion.
The following icons are displayed at the top-right corner of the Node Groups pane:
Export node
groups list
56
Save a copy of the current view of the pane. See “Exporting Exceed
TurboX Server Manager lists” on page 39 for more information.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.2. Managing node groups
Add node
See “Adding nodes to Node Groups” on page 58 for more information.
group
Refresh view of Click this button to update the information displayed in this pane.
node groups
Search for node Perform a search to locate one or more specific node groups in the pane.
groups
See “Searching in Exceed TurboX Server Manager lists” on page 41 for
more information.
Change view
Use the Change view dialog box to customize the columns that are
displayed in the grid. See “Showing and hiding columns in Exceed
TurboX Server Manager grids” on page 39 for information.
Maximize view Click this button to see an expanded view of the pane. See “Maximizing
and minimizing Exceed TurboX Server Manager panes with lists”
on page 38 for more information.
2.2.2
Creating, editing, renaming, and deleting Node Groups
This section describes how to create, edit, rename, or delete Node Groups using the
Nodes and Sessions page.
To create a Node Group:
1.
At the top of the Node Groups pane, click the New node group button
.
The New group dialog box opens.
2.
Click New group at the top of the dialog box. Type a name for the Node Group,
and click Save.
Note: Node Group names must be unique.
3.
In the Load balancing criteria list, do one of the following:
• Select Default to use the Exceed TurboX server’s load balancing criteria.
• Select the criteria to use for load balancing: CPU, Memory, or Sessions.
4.
In the Maximum sessions per user box, specify the maximum number of
sessions that any user can run on any node within the Node Group. This
number includes both active and suspended sessions. The default value is zero,
which indicates that there is no limit.
5.
Add nodes to the Node Group. See “Adding nodes to Node Groups”
on page 58 for more information.
6.
Click Save.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
57
Chapter 2 Managing Exceed TurboX as an administrator
To edit or rename a Node Group:
1.
In the Node Groups pane, position the pointer over the Actions column of the
Node Group you want to rename.
2.
Click the Properties button
3.
You can perform the following tasks in the Node Group dialog box to modify
the Node Group:
.
• To change the name of the Node Group, click the Edit button
new name for the Node Group.
and type a
• Use the Load balancing criteria list and the Maximum sessions per user box
to modify load balancing.
• Modify which nodes belong to the Node Group. See “Adding nodes to Node
Groups” on page 58 and “Removing nodes from Node Groups”
on page 59 for more information.
4.
Click Save to save the changes.
To delete a Node Group:
1.
In the Node Groups pane, position the pointer over the Actions column of the
group you want to delete.
2.
Click the Delete node group button
3.
When prompted to delete the node group, click Yes.
.
Note: The Delete node group icon does not appear if the Node Group has
been specified as a Session target on the Session tab of a profile or
template (accessed from the Profiles and Templates pane on the Users
and Profiles page). To delete the node group, you must first remove the
specification. See “Configuring Session settings in Advanced mode”
on page 202 for more information.
2.2.3
Adding nodes to Node Groups
This section describes how to add nodes to an Exceed TurboX Node Group using the
Nodes and Sessions page.
To add nodes to a Node Group:
1.
In the Node Groups pane, click the Properties button
for the Node Group that you want to add nodes to.
in the Actions column
The Node Group dialog box opens. Available nodes are listed on the left-hand
side. Nodes that are already members of the Node Group are listed on the right.
2.
58
To search for nodes to add, do the following:
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.2. Managing node groups
a.
In the Candidates box, type the full or partial name of the node you want
to add.
b.
Click the Search button
beside the Candidates box.
The search results are displayed under the Candidates box.
3.
In the search results, click to select the nodes you want to add. You can click
and select multiple entries within the pane.
4.
Click the Add node to node group button
5.
Click Save.
.
Note: To clear the search results from the pane, click the Clear button
the Candidates box.
2.2.4
in
Removing nodes from Node Groups
This section describes how to remove nodes from an Exceed TurboX Node Group
using the Nodes and Sessions page.
To remove nodes from a Node Group:
1.
in the Actions
In the Node Groups pane, Click the Properties button
column for the Node Group that you want to remove nodes from.
The Node Group dialog box opens. Available nodes are listed on the left-hand
side. Nodes that are already members of the Node Group are listed on the right.
2.
In the Members box, type the full or partial name of the node you want to
remove.
3.
Click the Search button
beside the Members box.
The search results are displayed in the right pane.
4.
In the search results, click to select the nodes you want to remove from the
Node Group. You can click and select multiple entries in the pane.
5.
Click the Remove node from node group button
6.
Click Save.
.
Note: To clear the search results from the pane, click the Clear button
the Members box.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
in
59
Chapter 2 Managing Exceed TurboX as an administrator
2.3 Managing sessions
The Sessions pane on the Nodes and Sessions page displays information about the
sessions that are currently running or suspended on your Exceed TurboX site, and
provides action icons for performing common administrative tasks.
This section provides information about the tasks you can perform on the Sessions
pane.
2.3.1
Viewing general session details in the Sessions pane
The Sessions pane on the Nodes and Sessions page displays the following
information about each session that is running or suspended on your Exceed TurboX
site:
60
Started on
The date/time at which the session was started.
Username
The name of the user running the session, as specified in the Exceed
TurboX user settings.
Client IP
The IP address of the computer used to start the session.
Runtime
version
The version of the Exceed TurboX client used to start the session.
Node address
The fully qualified domain name of the node on which the session is
running.
Display
The display number assigned to the session by the node.
CPU (%)
The percentage of processor (CPU) resources being used by the session.
Bandwidth
(Mbps)
The average bandwidth used within the last 60 seconds, in Mbps.
Profile name
The name of the profile used to launch the session.
Status
The status of the session (Active or Suspended).
Idle since
The date and time the session became idle. (No user inputs have been
detected in the session since this time.)
Suspended for
The length of time the session has been suspended, if applicable.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.3. Managing sessions
Actions
The actions you can perform on a session. To view the action icons,
position the pointer over the Actions column.
•
Details
: Opens the session details dialog box, which allows you to
view detailed session information and manage a session. See “Using
the session details dialog box to monitor and manage a session”
on page 62 for more information.
• Send message to ETX Dashboard of session owner and all clients of
this session : Send a message to the session owner (the user running
the session) and to all participants of a shared session. For example,
you can send a message to inform a user that a session will be
terminated or suspended. This icon is available when a session is
active. See “Sending messages to users and user groups” on page 85
for more information.
•
•
Shadow this session
: Request to join a user’s session. This icon is
available when a session is active. See “Shadowing a user’s session”
on page 64 for more information.
: Assign the session to a different user. This is
Reassign this session
shown only if the profile for the session has Allow administrators to
reassign session to a different user enabled. See “Reassigning a
session” on page 66 for more information.
• Suspend this session
: Suspend a user’s session. This icon is
available when a session is active. See “Terminating or suspending
sessions” on page 68 for more information.
•
Terminate this session : Terminate a user’s session. See
“Terminating or suspending sessions” on page 68 for more
information.
The following icons are displayed at the top-right corner of the Sessions pane:
Export sessions Save a copy of the current view of the pane. See “Exporting Exceed
TurboX Server Manager lists” on page 39 for more information.
list
Suspend all
active sessions
Bulk suspend multiple sessions. See “Terminating or suspending
sessions” on page 68 for more information.
in the list
Terminate all
sessions in the
Bulk terminate multiple sessions. See “Terminating or suspending
sessions” on page 68 for more information.
list
Refresh view of Click this button to update the information displayed in this pane.
sessions
Search for
Perform a search to locate one or more specific sessions in the pane.
sessions
See “Searching in Exceed TurboX Server Manager lists” on page 41 for
more information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
61
Chapter 2 Managing Exceed TurboX as an administrator
Change view
Use the Change view dialog box to customize the columns that are
displayed in the grid. See “Showing and hiding columns in Exceed
TurboX Server Manager grids” on page 39 for information.
Maximize view Click this button to see an expanded view of the pane. See “Maximizing
and minimizing Exceed TurboX Server Manager panes with lists”
on page 38 for more information.
2.3.2
Using the session details dialog box to monitor and
manage a session
You can use the session details dialog box to view detailed information about
sessions that are Activeor Suspended in your Exceed TurboX site. The session
details dialog box displays detailed session information, and provides action icons
that you can use to manage the session.
To open the session details dialog box:
1.
On the Nodes and Sessions page, in the Sessions pane, move the pointer over
the Actions column of the session you want to view.
2.
Click the Details button
.
If the node is Enabled, Ready, the session details dialog box opens.
If the node is Disabled, an error message is displayed.
The session details dialog box displays the following information about a session:
Thumbnail
image
Displays a screenshot of the user’s desktop as a thumbnail image. You can
click the following links to view larger versions of the image in a separate
window:
• Medium: Displays the image in a medium-sized window.
• Full: Displays the image in a window that occupies the full length and
width of the page.
62
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.3. Managing sessions
General
The following information applies to both active and suspended sessions:
•
•
•
•
Version: The version of Exceed TurboX Client used to start the session.
Profile name: The name of the profile used to launch the session.
Status: The status of the session (active or suspended).
Display ID: The fully qualified domain name of the node on which the
session is running.
The following information applies to suspended sessions only:
• Last suspended: The date and time at which the user suspended the
session.
• Suspended by: The name of the user who suspended the session.
• Suspended reason: Describes how the session was suspended (for
example, triggered automatically by an X screen saver, initiated
manually by the user, and so on).
Last
resumed: The date and time at which the session was resumed.
•
Resources
• VM size: The amount of virtual memory in MB.
• Memory: The amount of memory used to run the session.
• CPU: The percentage of processor (CPU) resources used to run the
session.
Bandwidth:
The average bandwidth used within the last 60 seconds, in
•
Mbps.
Time
• Idle since: The date and time the session became idle (that is, no
activity has occurred in the session).
• Total idle time: The total amount of time the session has been idle.
• Total suspended time: The total amount of time the session has been
suspended. This value applies to sessions that are currently
suspended, as well as sessions that are currently running, but were
previously suspended.
• Total active time: The total amount of time the session has been
actively running.
The session details dialog box provides the following action icons to manage a
session:
Refresh
Click this button to update the contents of the dialog box.
Send message
to ETX
Dashboard of
session owner
and all clients
of this session
Sends a message to the session owner (the user running the session) and
to all participants of the session, if it is a shared session. For example, you
can send a message to inform a user that a session will be terminated or
suspended. See “Sending messages to users and user groups”
on page 85 for more information.
Shadow this
Sends a request to the session owner to permit you to shadow (join) the
session. See “Shadowing a user’s session” on page 64 for more
information.
session
CONETX120501-AGD-EN-3
Server Manager Administration Guide
63
Chapter 2 Managing Exceed TurboX as an administrator
Reassign this
session
Launch session
Performance
Panel
Assigns the session to a different user. This is shown only if the profile for
the session has Allow administrators to reassign session to a different
user enabled. See “Reassigning a session” on page 66 for more
information.
Allows administrators to view usage statistics in the Performance Panel
for sessions. See “Viewing the Performance Panel” on page 66 for more
information.
Note: This icon is available if Open from performance icon is
enabled in the session’s profile. See “Configuring Performance
settings in Advanced mode” on page 235 for more information.
Suspend this
session
Terminate this
session
2.3.3
Suspends the session. See “Terminating or suspending sessions”
on page 68 for more information.
Terminates the session. See “Terminating or suspending sessions”
on page 68 for more information.
Shadowing a user’s session
This topic describes how to shadow a session owned by an user. Session sharing and
shadowing differ only in the initial step (a permission to participate is requested by
the administrator).
As an administrator, you can:
• request permission to shadow (participate in) a session owned by an user.
• join the session, if the permission is granted (at which point the session is shared
with you fully).
• participate in this shared session.
The shadowing workflow is as follows:
1. In Exceed TurboX Server Manager, the administrator requests permission to
shadow the session.
The session owner receives a message that identifies the requesting
administrator.
2. The user chooses to grant permission to shadow the session.
Exceed TurboX initiates the sharing workflow as follows:
• If the user is already sharing the session with other users, the administrator is
added to the existing shared session list.
• If the user is not already sharing the session, Exceed TurboX displays the
shared session list (Share Manager), adds the administrator to this list, and
invites the administrator to join.
3. The administrator accepts the invitation.
64
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.3. Managing sessions
The administrator clicks Join in the Share Manager. The status of the
administrator is now Joined.
The session owner can still control the shared session. The owner can:
• give the administrator control of the session.
• remove the administrator from the shared session list.
• pause/stop session sharing.
• invite additional users to join the session.
For more information about session sharing, see the Exceed TurboX Dashboard and
Client Help.
To request permission to shadow a user’s session:
1.
On the Nodes and Sessions page, in the Sessions pane, position the pointer
over the Actions column of the session you want to shadow.
2.
Click the Shadow this session button
3.
Click Yes to confirm the request.
.
A message is displayed, notifying you that the session owner has been
prompted to grant you permission to shadow.
You can click Close to cancel the request.
To join a session after the session owner has granted you permission to do
so:
After the owner grants permission to shadow the session, you are notified and the
Share Manager is displayed.
•
In the Share Manager, click Join.
The user’s session is displayed on your screen. Your user name appears in the
user’s Share Manage, with the status, Joined.
Note: From this point, shadowing works the same as session sharing. For
more information on working within a shared session, see the Exceed
TurboX Dashboard and Client Help.
If a session is set to Full Screen mode in either the profile or Quick
Settings, it will stay in that mode after sharing starts. If the owner switches
a session to Full Screen mode after sharing starts, the application will
correctly switch on the owner screen and the new resolution (if any) will
be sent to the participants.
To leave a session:
1.
Right-click on the session icon in the task bar at the bottom of your screen.
2.
Click Close window.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
65
Chapter 2 Managing Exceed TurboX as an administrator
3.
Click OK to confirm that you want to leave.
Note: Administrators can click the Leave button under the Share
Manager.
2.3.4
Reassigning a session
If the profile for a session allows it, administrators can assign an active or suspended
session to themselves or to any other user. This can be useful if the user who started
the session is not available and you need access to the session.
To reassign a session
1.
On the Nodes and Sessions page, on the Sessions pane, place your cursor over
the Actions column of the session you want to reassign.
2.
Click Reassign
.
The Reassign a session dialog box is displayed.
3.
Optionally, to search for a user, enter the user’s name into the Candidates field,
and then click Search
.
The search results are displayed in the results box.
To clear the search, click Clear search results
4.
Select the user to assign the session to.
5.
Click OK.
.
You will be prompted to confirm the reassignment.
6.
Click Yes to confirm the reassignment.
The session is reassigned to the selected user.
If Session is reassigned is enabled in the user settings, a message is sent to the
user that started the session and to the new session owner. See “Configuring
default user permissions and settings” on page 141 for more information.
2.3.5
Viewing the Performance Panel
You can view performance details such as bandwidth usage, network latency, frame
rate, and CPU/GPU utilization of Exceed TurboX sessions in the Performance Panel.
To open the Performance Panel:
66
1.
On the Nodes and Sessions page, in the Sessions pane, position the pointer
over the Actions column of the session whose Performance Panel you want to
view.
2.
Click the Details button
.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.3. Managing sessions
3.
On the sessions details dialog box, click the Launch session Performance Panel
button
.
The Performance Panel for the session is displayed.
4.
Use the following options to define how information is displayed:
• Show data for: Select Last minute, Last hour, Last day, or Last month.
• Optimize for Quality vs. FPS: Use the slider to set the balance between the
image quality and the frame rate at which Exceed TurboX draws the session
• Target bandwidth [n] Mbps: Define the target bandwidth for the session in
megabits per second. For example, to limit the session to half a megabit per
second, enter 0.5. To set the limit to 10 Mbps, enter 10.
Note: The target bandwidth defined here is a soft limit only. It may be
exceeded by the session proxy, if required.
Exceed TurboX automatically and dynamically scales its bandwidth
usage to current conditions. To control the total bandwidth used, use
Quality of Service in your router.
The Performance Panel includes the following information:
ThinX traffic
(Kbps)
Total network bit sent or received between the Client and the Proxy. This
does not include TLS or TCP/IP overhead.
Round-trip
latency (ms)
The amount of time it takes for a message to go from the Client to the
Proxy, and back. If there is heavy drawing or if the network is
constrained, this may be longer than the ICMP (ping) round-trip time.
Codec usage
(%)
The percentage of total pixels compressed with individual codecs.
Node memory
(%)
Select one of the Node memory usage options to view from the list:
• Proxy process: Memory usage of the etxproxy process.
• User processes: Total memory usage on the Node for all processes
running under the same user account as etxproxy (that is, the session
owner). There is no special handling for fallback accounts.
Note: Node memory usage data is not available on AIX or
Windows Nodes.
• All processes: Total memory usage of all processes on the Node.
Note: The information displayed in the tooltip when you position
your pointer over the graph title is controlled by the Use cgroups
limits for node CPU/memory option in the profile’s performance
settings. See “Configuring Performance settings in Advanced
mode” on page 235 for more information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
67
Chapter 2 Managing Exceed TurboX as an administrator
Node CPU (%)
Select one the Node CPU options to view from the list:
• Proxy process: CPU usage by the etxproxy process. 200% indicates that
two cores are fully used.
User
processes: CPU usage by all processes running under the same
•
user account as etxproxy (that is, the session owner). 200% indicates
that two cores are fully used. There is no special handling for fallback
accounts.
Note: Node CPU usage data is not available on AIX or Windows
Nodes.
All
processes:
CPU usage by all processes on the Node system. 200%
•
indicates that two cores are fully used.
Note: This data is not available on Solaris Nodes.
• Per core: Usage of each CPU core on the Node system. 100% indicates
that a core is fully used.
Note: The information displayed in the tooltip when you position
your pointer over the graph title is controlled by the Use cgroups
limits for node CPU/memory option in the profile’s performance
settings. See “Configuring Performance settings in Advanced
mode” on page 235 for more information.
Node GPU (%)
GPU usage for memory, rendering, and video encoding tasks. The Node
GPU list displays the GPU number and name. Select any GPU in the
system to view its usage. The default GPU is 0.
Client CPU (%)
Select one of the usage options to view from the list:
• Client process: CPU usage by the etxc process. 200% indicates that two
cores are fully used.
• All processes: CPU usage by all process on the Client system. 200%
indicates that two cores are fully used.
• Per Core: Usage of each CPU core on the Client system. 100% indicates
that a core is fully used.
2.3.6
Terminating or suspending sessions
Administrators can suspend any active session, and terminate any active or
suspended session, listed in the Sessions pane. Administrators can also bulk
terminate or suspend multiple sessions at once. Suspending a session allows the user
to resume their work at a later time. Terminating a session ends that session for all
participants. When you terminate an active session, the Exceed TurboX Client
notifies the user that the session has been terminated.
Warning
When you terminate a user’s session, the user’s unsaved work is lost.
68
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.3. Managing sessions
Notes
• Suspended sessions occupy resources on the server. If a large number of
sessions are suspended, server performance can degrade.
• If you suspend sessions running OpenGL applications, the applications are
terminated and the users’ work is lost. Users’ work will not be lost if the
OpenGL applications use server-side rendering.
To terminate or suspend a session:
1.
On the Nodes and Sessionspage, in the Sessions pane, position the pointer
over the Actions column of the session that you want to terminate or suspend.
Alternatively, use the action icons in the session details dialog box to suspend
and terminate a session. For more information, see “Using the session details
dialog box to monitor and manage a session” on page 62.
2.
Click one of the following action icons:
• Suspend this session
• Terminate this session
: Suspends the highlighted session only.
:Terminates the highlighted session only.
The Suspend a session or Terminate a sessiondialog box is displayed,
respectively.
3.
Do one of the following:
• In the Suspend a session dialog box, enter a description of the session. This
description will be displayed in the Description column of the Sessions
pane. Then, click Suspend.
Suspension details are displayed in the session details dialog box.
• In the Terminate a session dialog box, click Terminate to terminate the
session.
Note: If the Session Control option is enabled, suspended sessions are
automatically terminated after a predetermined period. See “Configuring
general site settings” on page 95 for more information.
To bulk terminate or suspend multiple sessions:
1.
On the Nodes and Sessions page, in the Sessions pane, click one of the
following action icons located at the top-right corner of the pane:
• Suspend all active sessions in the list
the Sessions grid.
: Suspends all the sessions listed in
You can use the Search for sessions dialog box to limit the sessions listed in
the grid. See “Searching in Exceed TurboX Server Manager lists” on page 41
for more information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
69
Chapter 2 Managing Exceed TurboX as an administrator
• Terminate all sessions in the list
Sessions grid.
: Terminates all the sessions listed in the
You can use the Search for sessions dialog box to limit the sessions listed in
the grid. See “Searching in Exceed TurboX Server Manager lists” on page 41
for more information.
The Suspend all active sessions or Terminate all sessionsdialog box is
displayed, respectively.
2.
Do one of the following:
• In the Suspend all active sessions dialog box, enter a description of the
action you are performing. Then, click Suspend.
Suspension details are displayed in the session details dialog box.
This description is displayed in the Description column of the Sessions
pane.
• In the Terminate all sessions dialog box, click Terminate to terminate the
sessions.
2.4 Managing users
The Users pane on the Users and Profiles page displays information about the users
who have already signed in to the Exceed TurboX Dashboard and set up their user
settings.
This section provides information about the tasks you can perform on the Users
pane of the Users and Profiles page.
2.4.1
Working with user roles
User roles determine the actions that users can perform in the system. You can
assign roles when you create a new user, or when you edit the settings for an
existing user You can also create user roles, as well as copy, modify, and delete some
existing user roles.
The following user roles are standard Exceed TurboX user roles that are available by
default. You can assign, copy, modify, and delete these roles:
• Admin (Full Access): Can view and perform all actions in both Exceed TurboX
Dashboard and Exceed TurboX Server Manager.
• Admin (Read Only): For system auditors and other users who require the ability
to view administrative information, but do not need to change settings.
• Session Manager: Can manage sessions and nodes, and make changes to noderelated settings. All other settings in Exceed TurboX Server Manager are viewonly.
• Technical Support: Can affect sessions, nodes, profiles and templates, user
accounts, and groups. All other settings in Server Manager are view-only.
70
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
• User: Can sign in to, and perform all actions in, Exceed TurboX Dashboard. Has
no access to Exceed TurboX Server Manager.
The following user role is a standard role that exists in the system. However, you
cannot add, assign, copy, modify, or delete this role using the Exceed TurboX Server
Manager:
• Admin (Built-in): Has access to all Server Manager functionality, except for
actions that require launching Clients (for example, shadowing an active
session). This user role does not require authentication (such as with LDAP,
PAM, OTDS, etc.).
The only user account with the Admin (Built-in) role is the etxadmin user. The
etxadmin user account is configured during initial Server configuration.
Use this user account to access the Server Manager, Dashboard, and most of the
content of the REST APIs interface. You can also use this account to sign in to the
Server if there is a problem with authentication. This account can be used to fix
authentication settings, add new administrative users, and configure
authentication nodes.
Note: For information about assigning user roles, see “Modifying user settings,
roles, and permissions for individual users” on page 82.
For information about creating, copying, modifying, and deleting user roles,
see “Configuring user roles” on page 149.
The following tables describe the actions that users with each role can perform in the
Exceed TurboX Server Manager interface.
Actions related to nodes: The following node-related actions can be performed on
the Nodes and Sessions page:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
View (info) Yes
Yes
Yes
Yes
Yes
N/A
Enable /
Disable
Yes
Yes
No
Yes
No
N/A
Configure
Yes
Yes
No
Yes
No
N/A
No
Yes
No
Yes
Yes
N/A
(Edit
Settings)
Send
message
Actions related to node groups: The following node group-related actions can be
performed on the Nodes and Sessions page:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
71
Chapter 2 Managing Exceed TurboX as an administrator
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
View
Yes
Yes
Yes
Yes
Yes
N/A
Create
Yes
Yes
No
Yes
No
N/A
Edit
Yes
Yes
No
Yes
No
N/A
Delete
Yes
Yes
No
Yes
No
N/A
Send
message
No
Yes
No
Yes
Yes
N/A
Actions related to sessions: The following session-related actions can be performed
on the Nodes and Sessions page:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
View
Yes
Yes
Yes
Yes
Yes
N/A
Terminate
Yes
Yes
No
Yes
Yes
N/A
Suspend
Yes
Yes
No
Yes
Yes
N/A
Shadow
No
Yes
No
Yes
Yes
N/A
Send
message
No
Yes
No
Yes
Yes
N/A
Reassign
No
Yes
No
Yes
Yes
No
Actions related to users: The following user-related actions can be performed on the
Users and Profiles page:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
View
Yes
Yes
Yes
Yes
Yes
N/A
Create
Yes
Yes
No
No
Yes
N/A
Edit
Yes
Yes
No
No
Yes
N/A
Disable
Yes
Yes
No
No
Yes
N/A
Import
Yes
Yes
No
No
Yes
N/A
Export list
Yes
Yes
Yes
Yes
Yes
N/A
Assign
Yes
Yes
No
No
Yes
N/A
Delete
Yes
Yes
No
No
Yes
N/A
(Prevent
Sign in)
72
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
Send
message
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
No
Yes
No
Yes
Yes
N/A
Actions related to user groups: The following group-related actions can be
performed on the Users and Profiles page:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
View
Yes
Yes
Yes
Yes
Yes
N/A
Edit
Yes
Yes
No
No
Yes
N/A
Create
Yes
Yes
No
No
Yes
N/A
Delete
Yes
Yes
No
No
Yes
N/A
Send
message
No
Yes
No
Yes
Yes
N/A
Actions related to profiles and templates: The following profile- and templaterelated actions can be performed on the Users and Profiles page:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
View
Yes
Yes
Yes
Yes
Yes
N/A
Create
No
Yes
No
No
Yes
N/A
Copy
No
Yes
No
No
Yes
N/A
Edit
No
Yes
No
No
Yes
N/A
Delete
No
Yes
No
No
Yes
N/A
Distribute
No
Yes
No
No
Yes
N/A
Actions related to published applications: The following published applicationrelated actions can be performed on the Applications page:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
View
Yes
Yes
Yes
Yes
Yes
N/A
Create
Yes
Yes
No
No
Yes
N/A
Edit
Yes
Yes
No
No
Yes
N/A
Delete
Yes
Yes
No
No
Yes
N/A
CONETX120501-AGD-EN-3
Server Manager Administration Guide
73
Chapter 2 Managing Exceed TurboX as an administrator
Permissions related to Site Settings: Users can access these pages of the Site
Settings tab, based on their assigned role:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
General
Full Access Full Access View Only
View Only
View Only
N/A
Appearanc
e
Full Access Full Access View Only
View Only
View Only
N/A
Authentica
tion
Full Access Full Access View Only
View Only
View Only
N/A
Cluster
Full Access Full Access View Only
View Only
View Only
N/A
Licenses
Full Access Full Access View Only
View Only
View Only
N/A
Messages
Full Access Full Access View Only
View Only
View Only
N/A
New User
Setting
Full Access Full Access View Only
View Only
View Only
N/A
User Roles
Full Access Full Access View Only
View Only
View Only
N/A
Runtimes
Full Access Full Access View Only
View Only
View Only
N/A
Security
Full Access Full Access View Only
View Only
View Only
N/A
Permissions related to Server Settings: Users can access these pages of the Server
Settings tab, based on their assigned role:
Admin
(Built-in)
Admin
(Full
Access)
Admin
(Read
Only)
Configurati Full Access Full Access View Only
on
Session
Manager
Technical
Support
User
View Only
View Only
N/A
Server Logs Full Access Full Access Full Access Full Access Full Access N/A
Server
Status
Full Access Full Access Full Access Full Access Full Access N/A
Permissions related to Maintenance: Users can access these pages of the
Maintenance tab, based on their assigned role:
Admin
(Built-in)
74
Admin
(Full
Access)
Admin
(Read
Only)
Session
Manager
Technical
Support
User
Activity
Log
Full Access Full Access Full Access Full Access Full Access N/A
Reports
Full Access Full Access Full Access Full Access Full Access N/A
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
2.4.2
Viewing user details in the Users pane
You can view the following user details in the Users pane on the Users and Profiles
page:
Username
The user name, as defined in the corporate environment in which Exceed
TurboX Server is installed.
Full name
The name assigned to the user, as specified in the user settings set up in
Exceed TurboX Dashboard.
Role
The role assigned to the user. For more information, see “Modifying user
settings, roles, and permissions for individual users” on page 82.
Created on
Date and time when the user was created.
User groups
The groups that the user is a member of. For more information, see
“Working with user groups” on page 86.
Profiles
The number of profiles that have been distributed to the user. For more
information, see “Distributing profiles to users or user groups”
on page 190.
Most recent
sign-in
The date and time when the user most recently signed in to the Exceed
TurboX Server, and the IP address from which the sign-in was performed.
Note: This column is not visible in the default (minimized) view. To
view this column, click the Maximize view
right corner of the Users pane.
Actions
icon in the top-
The actions you can perform to manage user accounts. To view the action
icons, position the pointer over the Actions column.
•
•
•
Properties
: View and edit settings for the selected user. See
“Modifying user settings, roles, and permissions for individual users”
on page 82 for more information.
Send message to ETX Dashboard and all sessions of this user :
Send a message to the selected user, and to all sessions that are owned
by the user. See “Sending messages to users and user groups”
on page 85 for more information.
Delete user
: Delete the selected user account from Exceed TurboX
Server. See “Deleting user accounts” on page 84 for more
information.
The following action icons are displayed at the top-right corner of the Users pane:
Export users
list
Import users
CONETX120501-AGD-EN-3
Save a copy of the current view of the pane. See “Exporting Exceed
TurboX Server Manager lists” on page 39 for more information.
Import multiple user accounts simultaneously. See “Importing multiple
user accounts to Exceed TurboX” on page 76 for more information.
Server Manager Administration Guide
75
Chapter 2 Managing Exceed TurboX as an administrator
Assign a role to Select a user role to assign to all users in the list. See “Assigning roles to
users in the list users in the Users list” on page 78 for more information.
Create a new user account. See “Creating a user account” on page 78 for
more information.
New user
Refresh view of Click this button to update the information displayed in this pane.
users
Search for users Perform a search to locate one or more specific sessions in the pane.
See “Searching in Exceed TurboX Server Manager lists” on page 41 for
more information.
Change view
Use the Change view dialog box to customize the columns that are
displayed in the grid. See “Showing and hiding columns in Exceed
TurboX Server Manager grids” on page 39 for information.
Maximize view Click this button to see an expanded view of the pane. See “Maximizing
and minimizing Exceed TurboX Server Manager panes with lists”
on page 38 for more information.
2.4.3
Importing multiple user accounts to Exceed TurboX
You can import multiple LDAP or PAM user accounts simultaneously from a .csv
(Comma Separated Value) file as a bulk action.
After the initial import, subsequent imports of the same file will not update users’
information or remove user accounts. Including an already-existing user in the
import file returns an error and no users are imported.
Before importing, review the import file formatting rules and order of fields.
Formatting the .csv file
The following common rules apply:
• The file extension should be .csv or .txt
• A header row is not allowed
• A field should be double quoted when it contains a comma or double quote, for
example, “John Smith, Jr.”
• A double quote in a field should be repeated twice, for example, “John ““J””
Smith, Jr.”
• Any leading and trailing spaces found in a field are removed
• The import skips blank lines in the file
76
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
Ordering the fields
Include all mandatory fields, separated by commas. Use a comma for optional fields
that are left blank (see examples). Use the following order:
1. Username
2. Full name
3. Email
4. (Optional) Role (one of User, AdminReadOnly, SessionManager,
TechnicalSupport, AdminFullAccess ). The default role is User if this field is
not specified.
5. (Optional) Language (one of DE, EN, ES, FR, IT, JA, KO, TW, and ZH ). If this
field is not specified, the default language is EN.
Note: This field is ignored during import. To define the system default
language, use the Default language field in the Site Settings. See
“Configuring general site settings” on page 95 for more information.
6. (Optional) List of existing Exceed TurboX group name(s) separated by the pipe
‘|’ character. If no group is specified, the user is included in the All Users group.
Example 1:
asmith,Alex Smith,as@example.com,User,EN,
Example 2:
jdoe,”John Doe, JR”,jd@example.com,,FR,Designers|Montreal
To import user accounts from a file:
1.
On the Users and Profiles page, in the Users pane, click the Import users
icon (located in the top right corner).
2.
In the File Upload dialog box, select the appropriate .csv or .txt file.
3.
Click Open.
All records from the file are imported.
Note: The import process does not create any user records in Exceed
TurboX if any errors are found in the .csv file data. In this case, an error
message is displayed with up to ten errors shown in the order of
appearance.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
77
Chapter 2 Managing Exceed TurboX as an administrator
2.4.4
Assigning roles to users in the Users list
This section describes how to bulk-assign a user role to all users listed in the Users
pane.
To bulk-assign a role to all users in the list:
1.
On the Users and Profiles page, at the top of the Users pane, click the Assign a
role to users in the list button
2.
.
In the Assign a role to user dialog box, select a role to assign to all users in the
list.
Tip: You can refine the list to only display users whose role you want to
change. See “Searching in Exceed TurboX Server Manager lists”
on page 41 for more information.
3.
2.4.5
Click Assign.
Creating a user account
This section describes how to create a single user account.
To create a user account:
1.
On the Users and Profiles page, at the top of the Users pane, click the New user
button
.
The New user dialog box is displayed.
2.
Fill in the Username, Full name, and Email address values. Mandatory boxes
are indicated by an asterisk.
3.
To add the user to one or more user groups, in the User Groups area, select the
check box(es) beside the group name(s) that you want to add the user to. To
remove the user from one or more groups, clear the check box(es) beside the
group name(s). See “Working with user groups” on page 86 for more
information.
Tip: You can also add and remove users from groups in the User Groups
details dialog box. See “Creating, editing, renaming, and deleting user
groups” on page 88 for more information.
78
4.
To block the user from signing in, enable Prevent user from signing in. See also
“Deactivating and activating user accounts” on page 84.
5.
To assign a role to the user, select the role from the Role drop-down list. See
“Working with user roles” on page 70 for more information about each role.
6.
If applicable, select the permissions you want to assign to the user. See
“Configuring user permissions” on page 79 for more information.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
7.
2.4.6
Click Save when you are finished. The Save button is enabled if the Username
is new (that is, it does not already exist in the user list) and all the mandatory
boxes are filled in correctly.
Configuring user permissions
Administrators can assign the following permissions to individual users on the user
properties dialog box:
Note: These settings override default sharing settings specified in
“Configuring default user permissions and settings” on page 141.
• Session control
Resume
sessions from
anywhere
Allows the user to resume suspended sessions from client computers
other than the one on which the session was suspended.
Suspend idle
sessions after
[n] minute(s)
Suspends user’s sessions automatically if no activity has occurred
within a session for a specified time period. You must specify the time
period in minutes.
Terminate
suspended
sessions after
[n] [units]
Specifies how long a session can remain suspended before it is
terminated.
If you select this option, you must specify the time period in minutes,
hours, or days.
If you define a timeout value here and the user defines a timeout value
in the Terminate suspended sessions after [n] [units] field of the
profile, the smaller of the two values is used by default.
Limit number
of sessions to
[n]
Specifies the maximum number of sessions that the user can run at
once.
Share sessions
Allows the user to share sessions.
If this option is cleared, the user can run an unlimited number of
sessions.
• Profile control
Create profiles
Allows the user to create profiles in Exceed TurboX Dashboard.
Note: If users are not allowed to create profiles, an
administrator must create and distribute the appropriate
profiles to the user. Otherwise, only the default profiles are
available to the user.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
79
Chapter 2 Managing Exceed TurboX as an administrator
Copy personal
profiles
Allow the user to create copies of personal profiles in Exceed TurboX
Dashboard.
A separate option, Copy group profiles, controls the ability of the
users to copy group profiles.
Note: If a user is not allowed to copy their profiles, an
administrator must create and distribute the appropriate
profiles to the user. Otherwise, only the default profiles are
available to the user.
Edit personal
profiles
Allows the user to edit their personal profiles.
Delete personal Allows the user to delete their personal profiles.
profiles
Copy group
profiles
Allows the user to create copies of group profiles in Exceed TurboX
Dashboard
A separate option, Copy personal profiles, controls the ability of the
users to copy personal profiles.
View details of
group profiles
Allows the user to view group profile details in Exceed TurboX
Dashboard.
Customize
group profiles
Allows users to customize group profiles in Exceed TurboX
Dashboard, instead of copying a profile and making changes. A user
with this permission can customize any setting in a group profile that
is not locked in the template. Users cannot modify the profile’s title.
The profile customizations are saved only for that user and are not
visible to other users. Only custom settings that are different from the
group profile are saved. Saving custom settings does not create a new
group profile. If a user duplicates a customized group profile, custom
settings are applied to the new profile.
Users’ custom settings are preserved if a profile property is changed
by an administrator but is not locked. If a user or a profile is deleted,
custom settings associated with that user are also deleted.
When distributing group profiles, if Keep original profile is not
selected, the distributed profile preserves custom user settings. If
Keep original profile is selected, a copy of the profile is created that
does not preserve custom user settings. See “Distributing profiles to
users or user groups” on page 190 for more information.
The user will also be able to modify existing Xstarts. When an Xstart is
deleted, associated custom Xstarts are also deleted.
If Customize group profiles is not enabled, profile details are readonly. If an administrator locks a property in the group profile, or if the
user’s role is changed from User, the user’s custom settings are
ignored .
80
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
Access
Allows the user to edit profiles in Advanced mode in Exceed TurboX
advanced mode Dashboard.
If this option is not selected, the user can edit profiles in Basic mode
only.
If the Show REST API tooltips option is enabled, users who open a
profile in Advanced mode will see the Show REST API tooltips
checkbox at the top of the profile window. If the user selects this
checkbox, REST API tooltips are enabled for each profile option and
will be shown when hovering over an item. REST API tooltips show
the attribute name and a list of valid and current values for the option.
The tooltips also include the attribute description in certain cases.
Further, the content of the tooltips is selectable for copy and paste
operations.
The Access advanced mode setting is always enabled for
administrator roles. Show REST API tooltips is disabled by default.
• General
Allowed
Clients
Sets whether the user is allowed to use either client to start a session,
only the Native client, or only the Web client.
Access REST
APIs
Allows the user to access the Exceed TurboX REST APIs web
interface, make REST API calls, and access the API keys tab in the
User settings dialog box.
Note: The Access REST APIs setting is always enabled for nonUser roles. Many of the REST APIs are for administrative
functions and are not available to users. Some APIs are also
hidden from non-full administrators. For a list of permissions by
user role and API, see “Appendix B: REST API Permissions” in
the Exceed TurboX REST API User Guide.
Blocking a user's access to REST APIs does not prevent the
Client Launcher from working.
Refresh
snapshots
Refreshes the thumbnail images of user sessions automatically in
Exceed TurboX Dashboard.
View full
resolution
image
Allows the user to view a full-sized version of any session snapshot in
Exceed TurboX Dashboard.
View log
Allows users to view a session’s log file from the Exceed TurboX
Client Menu.
If this option is cleared, the user can view thumbnail images only.
If this option is cleared, the View Log option on the Exceed TurboX
Client Menu is dimmed.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
81
Chapter 2 Managing Exceed TurboX as an administrator
2.4.7
Modifying user settings, roles, and permissions for
individual users
Administrators can use the Users pane on the User and Profiles page to configure
user settings, roles, and permissions for individual users to access certain features in
Exceed TurboX Dashboard.
You can use the Users pane to:
• Create a new user and configure user roles, settings, and permissions for that
user. See “Creating a user account” on page 78 for more information.
• Modify settings, roles, and permissions for existing individual users.
This section describes how to modify settings, roles, and permissions for existing
individual users.
To modify user settings for an individual user:
1.
On the Users and Profiles page, in the Users pane, position your pointer over
the Actions column of the user entry you want to modify.
2.
Click the Properties button
.
The user settings dialog box for the selected user opens.
3.
Modify the settings, as needed.
4.
When you are finished modifying the settings, click Save.
Note: To configure default permissions that apply to all new user accounts, use
the Site Settings > New User Settings page. See “Configuring default user
permissions and settings” on page 141 for more information.
To create, copy, modify, view and delete user roles, see “Configuring user
roles” on page 149.
You can modify the following settings in the user settings dialog box:
Full name
Email address
The value that the user specified in their user settings will be overwritten
with the values you enter here.
Note: These fields are not available if you are using LDAP or OTDS
authentication.
82
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
User Groups
To add the user to a user group, select the check box beside the group
name that you want to add the user to. To remove the user from a user
group, clear the check box beside the group name. You can add the user to
more than one group.
To select all the check boxes, click Select all. To clear all the check boxes,
click Clear all.
See “Working with user groups” on page 86 for more information.
Tip: You can also add and remove users from user groups in the
User Groups details dialog box. See “Creating, editing, renaming,
and deleting user groups” on page 88 for more information.
Prevent user
Select this check box to prevent the user from signing in. See
from signing in “Deactivating and activating user accounts” on page 84 for more
information.
Account is
locked out
Select this check box to lock the user’s account. Clear this check box to
unlock the account.
Roles
Select a role from the list to assign to the user. See “Working with user
roles” on page 70 for information about each role.
Session control
Profile control
General
Edit the permissions in each of these areas, as needed. See “Configuring
user permissions” on page 79 for more information.
The following details are shown at the top of the User settings dialog box:
• Created on: The date and time when the user was created.
• Most recent sign-in: The time, date, and IP address used when the user last
signed in to the Exceed TurboX Dashboard.
• Most recent failed sign-in: The time, date, and IP address used when the user
last tried and failed to sign in to the Exceed TurboX Dashboard.
• Consecutive failed sign-ins: The current number of consecutive failed sign-in
attempts for this user, if any. This information is shown only when the Lock
users out of ETX Server after [n] consecutive failed sign-in attempts option is
enabled on the site settings. See “Configuring security settings” on page 157 for
more information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
83
Chapter 2 Managing Exceed TurboX as an administrator
2.4.8
Deactivating and activating user accounts
At any time, you can deactivate a user account if you want to prevent the user from
signing in to Exceed TurboX, but do not want to delete the account. When a user
account is deactivated, its previously configured user settings are saved, but the user
cannot sign in to Exceed TurboX.
You can activate a deactivated account if you want to make it available to the user
again.
To deactivate or activate a user account:
1.
On the Users and Profiles page, in the Users pane, position the pointer over the
Actions column of the user account that you want to deactivate or activate.
2.
Click the Properties
icon.
The user settings dialog box for the selected user opens.
3.
Select the Prevent user from signing in check box to deactivate the user
account. If you want to activate the user account, clear the check box.
4.
Click Save.
In the Users pane, the names of deactivated user accounts are displayed with a
strikethrough line.
2.4.9
Deleting user accounts
When you delete a user account from Exceed TurboX Server, the user settings
associated with the account and any user-specific profiles are also deleted from the
server.
To delete a user account:
84
1.
On the Users and Profiles page, in the Users pane, position the pointer over the
Actions column of the user account that you want to remove.
2.
Click the Delete user
3.
When prompted to remove the user account, click Yes.
icon.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.4. Managing users
2.4.10
Sending messages to users and user groups
Administrators can send messages to individual users, user groups, session owners,
and users running sessions on specific nodes or within node groups. This is useful
when you need to inform users of maintenance tasks (such as restarting the server)
and other events that may affect their work.
Use the Nodes and Sessions page to send messages to session owners, users
running sessions on specific nodes, and users running sessions within specific node
groups. Use the Users and Profiles page to send messages to specific users and user
groups.
Users receive messages in the following ways:
• In the message box in Exceed TurboX Dashboard.
• In dialog boxes in active or resumed sessions.
• For a suspended shared session, the temporary session leader will see the dialog
box when they resume the session.
• For an active shared session, only one user will see the dialog box. This is usually
the user who started the session.
Note: To configure the types of system-generated messages you want users to
receive, see “Setting up automated messages” on page 137.
To send a message to one or more users running sessions:
1.
On the Nodes and Sessions page, do one of the following:
• To send a message to all users running sessions on a node, in the Nodes
pane, position the pointer over the Actions column for the node you want to
send the message to.
• To send a message to all users running sessions on nodes within a node
group, in the Node Groups pane, position the pointer over the Actions
column for the node group you want to send the message to.
• To send a message to a user running a specific session, in the Sessions pane,
position the pointer over the Actions column for the session you want to
send the message to.
2.
Click the Send message button
.
3.
In the message dialog box, enter a subject for the message, and the message
body.
4.
Click Send.
The message is displayed in the message box in Exceed TurboX Dashboard, and
in active or resumed sessions. If a shared session is suspended and then
resumed, only the session owner is shown the message in the resumed session.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
85
Chapter 2 Managing Exceed TurboX as an administrator
5.
Click Close in the message confirmation dialog box.
To send a message to user groups or individual users:
1.
On the Users and Profiles page, do one of the following:
• To send a message to all the users in a user group, in the User Groups pane,
position the pointer over the Actions column for the group you want to send
the message to.
• To send a message to a specific user, in the Users pane, position the pointer
over the Actions column for the user you want to send the message to.
.
2.
Click the Send message button
3.
In the message dialog box, enter a subject for the message, and the message
body.
4.
Click Send.
The message is displayed in the message box in Exceed TurboX Dashboard, and
in active or resumed sessions. If a shared session is suspended and then
resumed, only the session owner is shown the message in the resumed session.
5.
Click Close in the message confirmation dialog box.
2.5 Managing user groups
The User Groups pane on the Users and Profiles page displays information about
the groups of users created in your Exceed TurboX Server.
This section provides an overview of user groups, and provides information about
the tasks you can perform on the User Groups pane.
2.5.1
Working with user groups
Administrators can create user groups to do the following:
• Control user access to profiles and templates.
• Distribute profiles to a specific set of users (see “Distributing profiles to users or
user groups” on page 190).
An Exceed TurboX user group may contain:
• Exceed TurboX users (that is, users who have already signed in to Exceed
TurboX and set up their user settings)
• User groups from a corporate LDAP server. LDAP groups in Exceed TurboX are
dynamic and depend on the user membership as it is defined on the LDAP
server.
Exceed TurboX supports nested LDAP groups. Users may access and use profiles
configured for their own group and for its parent group(s), up to three levels up.
86
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.5. Managing user groups
For example, if Group 2 is a child of Group 1, and Group 3 is a child of Group 2,
and so on, then a user in Group 5 may use the profiles configured for Group 5,
Group 4, Group 3, and Group 2.
Note: If LDAP is chosen as the authentication method, Exceed TurboX uses
LDAP groups to determine access to profiles and templates as long as the
Use LDAP for authentication only check box is not selected on the
Authentication page.
If the Try Kerberos single sign-on first authentication option is enabled
and authentication is configured for LDAP, then a user's group
membership information is pulled from the LDAP Server when a user signs
in using Kerberos. This allows the user to take advantage of LDAP groups
in Exceed TurboX as if they signed in using LDAP credentials
See “Configuring settings for LDAP authentication” on page 115 for more
information.
• User groups from a corporate OTDS server, if you are using OTDS
authentication. OTDS groups in Exceed TurboX are dynamic and depend on the
user membership as it is defined on the OTDS server.
2.5.2
Viewing group details in the User Groups pane
The User Groups pane on the Users and Profiles page displays information about
user groups in Exceed TurboX Server. This includes user groups created by Exceed
TurboX administrators, as well as a group called All Users, which contains all
Exceed TurboX users. The All Users group cannot be edited or deleted.
For more information about user groups, see “Working with user groups”
on page 86 and “Managing users, groups, profiles and templates” on page 34.
You can view the following information in the User Groups pane:
Group name
The name of the user group.
Total members
The number of users in the group.
Actions
The actions you can perform to manage user groups. To view the action
icons, position the pointer over the Actions column.
•
Properties
: View and edit settings for the selected user group. See
“Creating, editing, renaming, and deleting user groups” on page 88
for more information.
• Send message to ETX Dashboards and all sessions for users of this
group : Send a message to the selected user group, and to all
sessions that are owned by users in this group. See “Sending messages
to users and user groups” on page 85 for more information.
•
CONETX120501-AGD-EN-3
Delete user group
: Delete the selected user group from Exceed
TurboX Server. See “Creating, editing, renaming, and deleting user
groups” on page 88 for more information.
Server Manager Administration Guide
87
Chapter 2 Managing Exceed TurboX as an administrator
The following action icons are displayed at the top-right corner of the User Groups
pane:
New user
Create a new user group. See “Creating, editing, renaming, and deleting
user groups” on page 88 for more information.
group
Refresh view of Click this button to update the information displayed in this pane.
user groups
Search for user
Perform a search to locate one or more specific user groups in the pane.
groups
See “Searching in Exceed TurboX Server Manager lists” on page 41 for
more information.
Change view
Use the Change view dialog box to customize the columns that are
displayed in the grid. See “Showing and hiding columns in Exceed
TurboX Server Manager grids” on page 39 for information.
Maximize view Click this button to see an expanded view of the pane. See “Maximizing
and minimizing Exceed TurboX Server Manager panes with lists”
on page 38 for more information.
2.5.3
Creating, editing, renaming, and deleting user groups
This section describes how to create, edit, rename, and delete user groups.
To create a user group:
1.
On the Users and Profiles page, click the New user group button
the top of the User Groups pane.
located at
The New user group dialog box opens.
2.
In the text box at the top of the dialog box, type a name for the user group and
press ENTER.
You can now add users to the user group. See “Adding users to user groups”
on page 89.
3.
Click Save when you have finished.
To edit or rename a user group:
1.
On the Users and Profiles page, in the User Groups pane, position the pointer
over the Actions column of the user group you want to modify.
2.
Click the Properties button
.
The properties dialog box for the selected user group opens.
3.
Modify the user group settings by performing the relevant tasks:
• Add users to the user group. See “Adding users to user groups”
on page 89 for more information.
88
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.5. Managing user groups
• Remove users from the user group. See “Removing users from user groups”
on page 90 for more information.
• Rename the user group. Click the Edit button next to the group name,
type a new name for the user group, and then press ENTER.
4.
Click Save to save the changes.
To delete a user group:
Note: When you delete a user group, profiles associated with the user group
are also deleted.
If you have applications published to this group, you need to manually delete
or re-configure these applications.
2.5.4
1.
On the Users and Profiles page, in the User Groups pane, position the pointer
over the Actions column of the user group you want to delete.
2.
Click the Delete user group button
3.
When prompted to confirm the deletion, click Yes.
.
Adding users to user groups
This section describes how to add the following types of users to an Exceed TurboX
user group:
• Exceed TurboX users
• LDAP user groups, found on a corporate LDAP server
• OTDS user groups, found on a corporate OTDS server
For more information, see “Working with user groups” on page 86.
Note: You can also add a user to a user group in the User settings dialog box.
For more information, see “Modifying user settings, roles, and permissions for
individual users” on page 82.
To add users to a user group:
1.
In the User Groups pane, position the pointer over the Actions column of the
user group you want to add users to, and click the Properties button
.
The properties dialog box for the selected user group opens.
Note: The Properties icon is not available for the All Usersgroup. This
user group is read-only.
2.
To search for an Exceed TurboX user, or an LDAP or OTDS user group to add,
do the following:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
89
Chapter 2 Managing Exceed TurboX as an administrator
a.
Select one of the radio buttons located below the Candidates box:
All
Search results will include users with existing Exceed TurboX
user settings and, if applicable, user groups defined on an
LDAP or OTDS server. This option is selected by default.
Users
Search results will list users with existing Exceed TurboX user
settings.
LDAP groups
Search results will list user groups defined on an LDAP server.
This option is available if you have an LDAP server configured
in your environment.
OTDS groups
Search results will list user groups defined on an OTDS server.
This option is available if you have an OTDS server configured
in your environment.
b.
In the Candidates box, type the full or partial name of the user, LDAP
group, or OTDS group you want to find.
c.
Click the Search button
beside the Candidates box.
The search results are displayed in the left pane, below the Candidates box.
The results include the Username/Group and the Full Name columns.
Tip: To clear the results from the pane and perform another search,
click the Clear button
3.
located in the Candidates box.
In the left pane, click to select the names of the users or groups that you want to
add. You can select multiple entries within the pane.
Tip: To deselect a user or group, click the entry a second time.
2.5.5
4.
Click the Add user to user group button
5.
Click Save.
.
Removing users from user groups
You can remove users from a user group at any time.
To remove users from a user group:
1.
On theUsers and Profiles page, in the User Groups pane, position the pointer
over the Actions column of the user group from which you want to remove
users.
2.
Click the Properties button
.
The properties dialog box for the selected user group opens.
90
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.5. Managing user groups
Note: The Properties icon is not available for the All Usersgroup. This
user group is read-only.
3.
To search for users or groups in the members list, do the following:
a.
Select one of these radio buttons located below the Members box:
All
Search results will include users with existing Exceed TurboX
user settings and, if applicable, user groups defined on an
LDAP or OTDS server. This option is selected by default.
Users
Search results will list users with existing Exceed TurboX user
settings.
LDAP groups
Search results will list user groups defined on an LDAP server.
This option is available if you have an LDAP server configured
in your environment.
OTDS groups
Search results will list user groups defined on an OTDS server.
This option is available if you have an OTDS server configured
in your environment.
b.
In the Members box, type the full or partial name of the user or group you
want to remove.
Note: You can search according to the Username, Group, or Full
Name columns. All are included in the search results.
c.
Click the Search button
beside the Members box.
The search results are displayed in the right-hand pane, below the
Members box.
The results include the Username/Group and the Full Name columns.
Tip: To clear the results from the pane and perform another search,
click the Clear button
4.
located in the Members box.
In the right pane, click to select the users or groups you want to remove from
the Exceed TurboX group. You can click and select multiple entries in the pane.
Tip: To deselect a user or group, click the entry a second time.
5.
Click the Remove user from user group button
6.
Click Save.
CONETX120501-AGD-EN-3
.
Server Manager Administration Guide
91
Chapter 2 Managing Exceed TurboX as an administrator
2.6 Managing published applications
This section provides information about the Published Applications page, which
allows you to manage published applications (that is, applications that have been
deployed to various hosts and are available for deployment in profiles).
The Published Applications page provides the following information about
applications published on your Exceed TurboX site:
Application
name
Name of the published application.
Platform
Platform on which the application is running (Windows or X Window).
Hosts
Number of available hosts where the application is published.
User access
Users who have access to the application (All users, the names of specific
users, or the names of specific user groups).
Description
Application description.
Actions
The actions you can perform on a published application. To view the
available actions, position the pointer over the Actions column.
•
•
To modify the selected application, click the Properties
icon. The
application properties dialog box opens. Use this dialog box to edit a
published application, as necessary. For more information, see
“Publishing and editing applications” on page 93.
To delete the selected application, click the Delete application
icon, then click Yes to confirm the operation.
You can perform the following tasks on the Published Applications page:
•
button at the topTo publish an application, click the Publish application
right corner of the page. You can then select and publish an application. For
more information, see “Publishing and editing applications” on page 93.
• To update the information displayed on this page, click the Refresh view of
applications
•
button at the top-right corner of the page.
To search for a published application, click the Search for applications
button at the top-right corner of the page. For more information, see “Searching
in Exceed TurboX Server Manager lists” on page 41.
For an overview of the application deployment process, see “Understanding the
application deployment workflow” on page 95.
92
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.6. Managing published applications
2.6.1
Publishing and editing applications
This section provides information about how to select and publish an application,
and how to edit an existing published application.
To publish an application:
1.
On the Published Applications page, click the Publish application
at the top-right corner.
button
The Publish application dialog box opens.
2.
In the Available applications list, search for the application you want to
publish. You can do this either by scrolling through the list or by entering text in
the Search box. You can further filter the list by selecting either the Windows or
X Window option, to limit the results.
3.
In the Available applications list, click the application that you want to publish.
4.
In the Application properties pane, configure the following settings for the
selected application:
• Use the User access list to select which users have access to this application.
If you select Specific user or User group, enter the name in the box to search
for the user or user group name.
• In the Description box, add a description for this application.
5.
In Available hosts pane, select the hosts to publish the application to. By
default, all available hosts are selected.
6.
Optionally, if you need to edit one of the hosts, click the Properties icon in the
Actions column. For more information, see “Editing an application host”
on page 94.
7.
Click Publish to publish the application to the specified hosts.
The application is now displayed on the Published Applications page, and it is
available for selection when you create/edit profiles based on the Default
Published Application template.
To edit a published application:
1.
On the Published Applications page, position the pointer over the Actions
column of the application that you want to modify.
2.
Click the Properties
icon.
The application properties dialog box opens.
3.
Edit the following settings in the Application properties pane, as desired:
• To change the name of the published application, click the edit
a new name, and press ENTER.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
icon, type
93
Chapter 2 Managing Exceed TurboX as an administrator
• Use the User access list to select which users have access to this application.
If you select Specific user or User group, enter the name in the box to search
for the user or user group name.
• In the Description box, add or modify the description of this application.
2.6.2
4.
In Available hosts pane, select the hosts to publish the application to. By
default, all available hosts are selected.
5.
Optionally, if you need to edit one of the hosts, click the Properties icon in the
Actions column. For more information, see “Editing an application host”
on page 94.
6.
Click Save to save the changes.
Editing an application host
This section provides information about how to edit an application host.
To edit an application host:
1.
On the Published Applications page, position the pointer over the Action
column of the application to modify.
2.
Click the Properties
icon.
The <Application name> dialog box opens.
3.
In the Available hosts pane, position the pointer over the Action column of the
host to edit.
4.
Click the Properties
5.
In the Application dialog box, modify the parameters as desired:
icon.
• Host: (Read only) Displays the name of the host running the application.
• Platform: (Read only) Displays the platform or operating system running on
the host machine.
• Application: (Read only; Windows only) Displays the path on the host to the
published application.
• Parameters: (Windows only) Enter or edit the required parameters. See
“Command syntax for starting applications” on page 259 for more details.
• Command: (X Window only) Enter or edit a command. See “Command
syntax for starting applications” on page 259 for more details.
94
6.
If necessary, click the Reset button to return to the original parameters.
7.
Click OK to return to the <Application name> dialog box.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.7. Configuring general site settings
2.6.3
Understanding the application deployment workflow
This section describes application scanning, publishing, and deployment in profiles.
Exceed TurboX can scan one or more Connection Nodes and provide a list of
applications available on those nodes. The listed applications can be published to all
users, specific users, and user groups. Users with access to a published application
can use Exceed TurboX Dashboard to assign it to a profile, then run a session using
this profile.
In order to access the applications on a node, application scanning must be enabled
for that node. Once enabled, the node is scanned and returns a list of available
applications. Node scanning can be enabled through the individual node properties.
Exceed TurboX provides the following workflow:
1. Scan available applications on a particular node. See “Configuring node
settings” on page 50.
2. Configure Group Policy on a Remote Desktop Host during node installation. See
“Configuring Remote Desktop Services for Windows Server Connection Nodes”
in Exceed TurboX Installation and Configuration Guide.
3. Publish and edit a list of scanned applications. See “Publishing and editing
applications” on page 93.
4. Edit an application host. See “Editing an application host” on page 94.
5. Create a profile based on the Default Published Application template and assign
to it one of the published applications. See “Configuring Published application
startup mode” on page 269.
6. Run a session using this profile. See “Configuring Published application startup
mode” on page 269.
2.7 Configuring general site settings
The General tab page of the Site Settings page allows you to configure general
Exceed TurboX site settings, including load balancing, credentials for launching
profiles, notifications to be displayed in the Server Manager and Dashboard header
bar, and more.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
95
Chapter 2 Managing Exceed TurboX as an administrator
Note: Users with the Admin (Full Access) role can configure the site settings
using the Server Manager interface, or via REST APIs (/v2/site/settings).
To configure general site settings:
1.
Navigate to the Site Settings > General page.
2.
Modify the settings provided on this page, as necessary, then click Save.
The settings are saved and applied to your Exceed TurboX site.
You can configure the following Website settings on the General page:
Default
language
Specify the system default language you want Exceed TurboX to use.
Note: Users can update their language preferences on the sign-in
page and in the User settings dialog box. See “Signing in to Exceed
TurboX Server Manager” on page 11 and “Configuring your user
settings” on page 18 for more information.
96
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.7. Configuring general site settings
Server Manager If you deployed a load balancer or a web proxy in front of your Exceed
URL
TurboX Server(s), the public-facing URL for your Exceed TurboX Site is
not the same as any of the Exceed TurboX Server hostnames. Exceed
TurboX Servers behind a load balancer or web proxy need the Server
Manager Site URL for several reasons, including:
• To provide the correct Site URL in messages and emails sent to
administrators and users.
• If OTDS authentication is used, this URL is used when redirecting back
to the Site after OTDS authentication is complete.
• When Exceed TurboX Server is writing activity logs or other log
entries that require the public-facing Site URL.
If the Server Manager Site URL is not set, Exceed TurboX Servers in the
HA cluster or behind the web proxy will use the server hostname instead
of the Site URL.
The supported format for the Server Manager Site URL is:
http[s]://<load_balancer_server_manager_url>[:<port>]/
<site_path>/
This URL should match the public-facing (front-end) URL for the Site, as
defined in the proxy load balancer configuration.
Note: Exceed TurboX Server Manager and Exceed TurboX
Dashboard may be configured on different ports. You may also use
a separate load balancer for each section of the Site.
If you are using a single public address for both Server Manager
and Dashboard, the Server Manager and Dashboard Site URLs may
be set to the same value.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
97
Chapter 2 Managing Exceed TurboX as an administrator
Dashboard
URL
If you deployed a load balancer or a web proxy in front of your Exceed
TurboX Server(s), the public-facing URL for your Exceed TurboX site is
not the same as any of the Exceed TurboX Server hostnames in the cluster.
Exceed TurboX Servers behind a load balancer or web proxy need the
Dashboard Site URL for several reasons, including:
• To provide the correct Exceed TurboX sign-in URL in messages and
emails about sessions-related issues to users.
• If OTDS authentication is used, this URL is used when redirecting
users back to the Dashboard after OTDS authentication is complete.
When
Exceed TurboX Server is writing activity logs or other log
•
entries that require the public-facing Site URL.
If the Dashboard Site URL is not set, Exceed TurboX Servers in the HA
cluster or behind the web proxy will use the server hostname instead of
the Dashboard Site URL.
The supported format for the Dashboard Site URL is:
http[s]://<load_balancer_dashboard_url>[:<port>]
Note: Exceed TurboX Server Manager and Exceed TurboX
Dashboard may be configured on different ports. You may also use
a separate load balancer for each section of the Site.
If you are using a single public address for both Server Manager
and Dashboard, the Server Manager and Dashboard Site URLs may
be set to the same value.
You can configure the following Session control settings on the General page:
Terminate
suspended
sessions after
[n] [units]
To specify that a suspended session should be automatically terminated if
it is not resumed for a specified time period, select this check box and set
the time period. You can set the time in minutes, hours, or days.
Load balancing If your Exceed TurboX site includes multiple nodes, select one of the
criteria
following options as the load balancing criteria for your Server Manager:
• CPU: Base the session distribution on the node CPU usage. When a
user requests a session, the node with the lowest CPU usage receives
the startup request.
• Memory: Base the session distribution on the node memory usage.
When a user requests a session, the node with the lowest memory
usage receives the startup request.
• Sessions: Base session distribution on the number of sessions on a
node. When a user requests a session, the node hosting the fewest
number of sessions receives the startup request. This option is selected
by default.
If desired, you can write your own load balancing script to further
customize the load balancing of your Exceed TurboX site to meet your
specific requirements. For more information, see “Configuring load
balancing” on page 101.
98
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.7. Configuring general site settings
Client
Launcher
detection
timeout [n]
second(s)
\
When a user attempts to launch a session, if Exceed TurboX does not
detect the Client Launcher on their machine, it stops the session launch
and displays a message. The message prompts the user to download and
install the latest Client Launcher version. This setting specifies the number
of seconds that will pass before Exceed TurboX decides the Launcher
cannot be started and displays the message.
Note: Be sure to allow sufficient time for the user to accept any
browser prompts to start the Launcher. If this time-out is set too
low, the user may not have enough time to accept the prompts, and
the session launch may be terminated even though the Launcher is
present.
Client
Launcher
HTTP cookie
filter
This setting filters out unnecessary HTTP cookies when invoking the
Exceed TurboX Launcher on client systems.
It is important to set this filter to include only HTTP cookies that are
necessary for maintaining the session. If you have a load balancer in front
of your Exceed TurboX Servers, this list must include the load balancer
“server” cookie name that is used to direct requests to the correct Server.
This filter is set to .* by default, indicating that all cookies are included.
However, this default can cause an error on the client’s system when
launching sessions due to length limitations in the user’s browser or
operating system.
This field supports both literal and wildcard string matching, with
multiple values separated by a comma. For example, SM_*,lb-server,
session.
Cookies for Exceed TurboX Server session and known load balancers are
hard-coded and appended to the specified filter. If this field is empty, no
cookies are appended and only the default, hard-coded list of cookies is
used.
You can configure the following Data retention settings on the General page:
Usage
reporting [n]
day(s)
Specify how many days you would like Exceed TurboX to keep usage
data. The default value is 30 days. To have Exceed TurboX keep all data
permanently, enter 0.
Activity log [n]
day(s)
Specify how many days you would like Exceed TurboX to keep activity
log data. The default value is 180 days. To have Exceed TurboX keep all
data permanently, enter 0.
You can configure the following Profile launch credentials settings on the General
page:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
99
Chapter 2 Managing Exceed TurboX as an administrator
Default domain (Windows Desktop or Published Application startup modes only) Enter
the domain name that users should use to sign in. To use the default
domain name in a profile, you must also select the Use session
credentials option, as described in “Adding Xstarts to a Custom startup
profile” on page 252.
Authentication
format
Select the format to use to authenticate launch credentials:
• Legacy (DOMAIN\username)
• User Principal Name (username@domain.com)
You can configure the following Site messages settings on the General page:
Show Site
banner
Select this option to display Server status information in the Site banner
area of the Server Manager and Dashboard header bar.
To customize the message displayed in the Site banner area, enter the text
in the Site banner box. You can enter up to 20,000 characters of plain or
HTML-formatted text.
Show sign-in
message to
users
Select this option to set up a sign-in message to display when a user logs
in to Exceed TurboX Dashboard.
In the Sign-in message title box, enter the sign-in message title. Leave this
box blank to display Sign-in messages as the sign-in message title.
In the Sign-in message box, enter the message to display. You can enter
up to 20,000 characters of plain or HTML-formatted text.
Note: If both Message title and Sign-in message are blank, the
Show sign-in message to users check box is automatically cleared
and no sign-in message is displayed.
Select Pop up during session start/resume (HTML) not supported to
make the sign-in message display every time a session is started or
resumed. Only the session owner will see the message.
Use custom
welcome
message
Select this option to replace the default welcome message on the Exceed
TurboX sign-in page (“Welcome to Exceed TurboX!”) with a custom
message. Enter the custom message in the Welcome message box.
Enabling this option without providing text in the Welcome message box
has no effect.
You can configure the following Other settings on the General page:
100
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.7. Configuring general site settings
Enable Quality
of Service
(QoS)
Select this option if your network environment supports Quality of
Service (QoS) technology, and you require QoS to optimize the
performance of Exceed TurboX on your network. In the DSCP value box,
enter the DSCP value appropriate for your UNIX environment. The DSCP
value you specify will be used by Exceed TurboX Proxy (server side) and
etxc (client component).
Since Windows OS has different QoS implementations, QoS will be
mapped to a value that is suitable for Windows OS. The QoS mappings
used for Windows OS are as follows:
• QOSTrafficTypeBackground = 1 (for DSCP values between 1 and 32)
• QOSTrafficTypeAudioVideo = 3 (for DSCP values between 33 and 160)
• QOSTrafficTypeControl = 5 (for DSCP values greater than 160)
To assign a different DSCP value for client to proxy versus proxy to client
communication, you may set the following flags in the profile to override
the client-side DSCP value for data flowing from the end user’s PC to the
session proxy.
• proxy.ClientQoSValue= any number from 1 to 5
• proxy.ClientDSCPValue= any number > 0
Caution
By default, this option is disabled. Before enabling this option,
make sure that you consult with your network administrator to
determine which DSCP value is appropriate for your
environment.
Optional
settings
2.7.1
Use this box to enter optional flags for configuring additional site settings.
These flags are provided by customer support, when needed.
Configuring load balancing
This section describes how to further customize the load balancing of your Exceed
TurboX site to meet the requirements specific to your production environment.
2.7.1.1
Configuring custom load balancing
This section describes how to configure custom load balancing to best meet the
needs of your production environment.
To configure custom load balancing:
1.
Create a load balancing script that returns the name of a target Connection
Node for starting a session, based on your own rules and policies for selecting a
target node.
The external script must be an executable and should be accessible by the
Exceed TurboX Server in a stand-alone configuration, or by all Exceed TurboX
Servers in a High Availability cluster. The script may use the following
environment variables that will be supplied by Exceed TurboX Servers when
CONETX120501-AGD-EN-3
Server Manager Administration Guide
101
Chapter 2 Managing Exceed TurboX as an administrator
the script is launched: ETX_SERVER, ETX_USERNAME, ETX_CLIENT_IP, and ETX_
PROFILE.
The script should print one of the following output results to stdout:
• “NODE ANY”
• “NODE <ETX Connection Node>[:<port>]”
• “NODEGROUP <ETX Node Group>”
• “ERROR <any error message>”
The following is a shell script example for UNIX/Linux platforms:
#!/bin/sh
# echo "NODE etxcn1.example.com:5510"
# echo "NODE etxcn1.example.com"
# echo "NODEGROUP ETXCN_NA_NODES_GROUP"
# echo "ERROR User $ETX_USERNAME not allowed to launch a session. Please contact
administrators..."
# echo "NODE ANY"
2.
Add full paths of the script filenames to the list of scripts authorized to run on
the Exceed TurboX Server.
a.
In Exceed TurboX Server Manager, open the Site Settings > General page.
b.
Add the following flag to the Optional settings box:
server.LBCustomScriptList=<path1>,<path2>,<pathN>
where “<path1>,<path2>,<pathN>” indicate the paths of the load
balancing scripts authorized to run by Exceed TurboX Servers.
Example (for UNIX):
server.LBCustomScriptList=/opt/etxscripts/customlbscript2.sh
Note: Script names are case-sensitive. Multiple script names must be
separated by commas.
c.
3.
Click Save.
Configure the target node with the load balancing script.
a.
In Exceed TurboX Dashboard, select the profile where you want to
configure the target node.
b.
In Advanced mode, open the Session tab.
c.
Define Node targeting as Specific node.
d.
In the Node/Group name box type @=<pathN>
where “<pathN>” indicates the path of the load balancing script to be used
for a session launched by this profile.
Example: @=/opt/etxscripts/customlbscript2.sh
e.
102
Click Save.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.7. Configuring general site settings
2.7.1.2
Configuring load balancing for server-side OpenGL rendering
Exceed TurboX can perform server-side OpenGL 3D rendering. This reduces the
resources required on the client side. When multiple GPUs are detected on a 3D
rendering X Server, Exceed TurboX can use load balancing to detect the GPU with
the lowest load, and automatically use that GPU for the 3D rendering.
Note: This feature currently only works with GPUs using NVIDIA’s binary
driver, and expects each GPU to be configured as a separate screen of the same
display. This is the default configuration used by nvidia-xconfig --enableall-gpus.
Load balancing is on by default in Exceed TurboX.
The ssrrun --balancegpu off option can be used to disable GPU load balancing.
If GPU load balancing is disabled, all applications will render on the same GPU,
rather than the least loaded GPU.
2.7.2
Understanding Exceed TurboX fallback accounts
This section describes the Exceed TurboX etxproxy and etxstart fallback accounts
and the effects of enabling them.
Typically, when launching an Exceed TurboX session, the session proxy process,
custom startup applications, and published applications run as the user specified in
the Exceed TurboX profile. If fallback accounts are enabled and the specified user
does not exist on the session node, Exceed TurboX launches the proxy or application
using a fallback account.
When multiple users launch sessions this way, there are side effects due to multiple
users running processes under a shared account. Review the following information
to understand some of the consequences of enabling fallback accounts.
Proxy Fallback
Account
When two or more users launch proxy processes as the proxy fallback
account, consider the following:
• The proxy fallback account is not a sign-in shell account, so users
cannot sign in with it.
Multiple
proxy processes may run under the same fallback account,
•
even though the remote sessions were launched by different Exceed
TurboX users.
• It may be difficult or impossible for super users to determine which
session proxy is associated with each Exceed TurboX user, because the
proxy processes run under the same account name.
• User settings for a fallback account are shared for all session proxies
running under the fallback account. User-based limits like cpulimit
should be disabled for fallback accounts to avoid performance
degradation.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
103
Chapter 2 Managing Exceed TurboX as an administrator
Xstart Fallback
Account
When two or more users launch Exceed TurboX profiles with the Xstart
fallback account, consider the following:
• Multiple application processes may run under the same fallback
•
•
•
•
account, even though the remote sessions were launched by different
Exceed TurboX users.
It may be difficult or impossible for super users to determine which
application is associated with each session or user, because the
application processes run under the same account name.
Custom startup and published applications launched from an Exceed
TurboX profile by different users run under the same user session. For
example, a user launching xterm is able to terminate another user’s
application if both users run as the fallback account.
User settings for a fallback account are shared for all applications
running under the fallback account. User-based limits like cpulimit
should be disabled for fallback accounts to avoid performance
degradation.
There is a security risk when users enable dynamic Xauthority in the
Exceed TurboX profile. Because all user Xauthority keys are stored
under the same user name, any user can read/access the Xauthority
key of other users. This allows users to view other user sessions or
launch X applications into other user sessions.
2.8 Managing appearance
You can use the Appearance tab page of the Site Settings page to manage the
Exceed TurboX system’s theme, and the icons available for use in profiles. Profile
icons are displayed in Exceed TurboX Dashboard to help users easily identify a
profile. You can also export site appearance settings from one server and import
those settings to another server.
2.8.1
Modifying themes
This section describes how to modify themes. You can modify the appearance of
your Exceed TurboX system by changing the colors of the following elements:
• Navigation bar colors:
–
Primary
–
Selected item
–
Selected item marker
–
Hover over marker
–
Text
• Button colors:
104
–
Primary
–
Hover over
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.8. Managing appearance
–
Text
Changes to the theme of your system are visible to all users.
You can also reset all themes to the default colors.
To change the theme of an element:
1.
On the Appearance tab page, in the Theme pane, locate the element you want
to modify.
2.
In the text box for each element that you want to modify, type the appropriate
color.
Note: You can use RGB codes, HEX codes, or the name of a color.
3.
When you are finished, click Apply.
To reset theme colors:
Tip: Do this only if you want to rest all colors to their defaults. You cannot
reset only certain colors.
•
On the Appearance tab page, in the Theme pane, click Reset.
All elements reset to their default color.
2.8.2
Viewing profile icon information
This section describes how to view information about profile icons.
To review profile icon information:
1.
In Exceed TurboX Server Manager, click the Site Settings page.
2.
Click the Appearance tab.
The Profile Icons pane is displayed.
The following information is provided for each profile icon:
Icon
A thumbnail of the icon.
Status
Is the icon available for use for new profiles?
Added by
The user who added the icon or System default if the icon is a system
icon.
Linked profiles The number of profiles and templates using the icon.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
105
Chapter 2 Managing Exceed TurboX as an administrator
Actions
The actions you can perform to manage profile icons. To view the action
icons, position the pointer over the Actions column.
•
•
Properties
: Opens the Profile icon dialog box, which allows you
to change the icon image and make the icon available for new profiles
and templates. See “Viewing and modifying icon properties”
on page 106 for more information.
Delete
: Deletes non-system icon. See “Deleting profile icons”
on page 108 for more information.
The following action icons are displayed at the top-right corner of the Appearance
tab page, and the top-right corner of the Profile Icons pane:
Export
appearance
settings
Import
appearance
settings
Add profile
icon
Refresh list of
Export appearance settings in a .zip file to share with a different Exceed
TurboX Server. See “Exporting appearance settings” on page 109 for more
information.
Import appearance settings to be used across different Exceed TurboX
Servers. See “Importing appearance settings” on page 109 for more
information.
Upload an icon to be used by profile in Exceed TurboX Dashboard. See
“Adding profile icons” on page 107 for more information.
Click this button to update the information displayed in this pane.
icons
Change view
2.8.3
Use the Change view dialog box to customize the columns that are
displayed in the grid. See “Showing and hiding columns in Exceed
TurboX Server Manager grids” on page 39 for more information.
Viewing and modifying icon properties
This section describes how to view and modify icon properties. You can use the
Profile icon dialog box to view the large and small previews of an existing icon,
change the images for the icon, and modify the availability of the icon for new
profiles and templates.
To view and modify icon properties:
106
1.
On the Appearance page, in the Profile Icons pane, position the pointer over
the Actions column of the profile icon you want to view.
2.
Click Properties
3.
In the Profile icon dialog box, review the large and small preview images.
4.
To change an icon image, click the Change button beside the large or small icon
image. Browse to and select the new image.
.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.8. Managing appearance
Note: You can change the icon images for user-added icons only. You
cannot change System default icon images.
2.8.4
5.
To modify the availability of the icon for profiles and templates, select or clear
the Available for profiles and templates check box,as needed.
6.
When you are finished, click OK.
Downloading blank backgrounds
This section describes how to download blank backgrounds for icon images. Before
you add a new profile icon, you can download blank backgrounds in the
appropriate sizes, and use the background to create your own icon images. Grey and
white backgrounds are available in the provided .zip package.
To download blank backgrounds
2.8.5
1.
On the Appearance page, in the Profile Icon Template pane, click Download.
2.
Locate the downloaded backgrounds on your machine, and modify as needed.
3.
Proceed to “Adding profile icons” on page 107.
Adding profile icons
This section describes how to upload custom profile icons to use in Exceed TurboX
Dashboard.
Icon files must meet the following criteria:
• The icon files must be in .png format.
• You must add both large (128 x 128 pixels) and small (58 x 58 pixels) images.
• Image files must not be larger than 150 x 150 pixels.
To add a profile icon:
1.
On the Appearance tab page, click Add profile icon
2.
At Large icon (128 x 128 .PNG), click Choose.
3.
Select the file to upload, and then click Open.
.
Tip: You can download blank backgrounds to create your icons in the
appropriate sizes. See “Downloading blank backgrounds” on page 107 for
more information.
4.
At Small icon (58 x 58 .PNG), click Choose.
5.
Select the file to upload, and then click Open.
6.
(Optional) Select the Available for profiles and templates check box to make the
icon available for profiles and templates.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
107
Chapter 2 Managing Exceed TurboX as an administrator
7.
Click Add.
Note: The Add button is available only after you have uploaded both a
large and a small icon.
Once you have added a profile icon, you can assign it to a profile. See “Configuring
General settings in Advanced mode” on page 194 for more information.
2.8.6
Deleting profile icons
This section describes how to delete profile icons. You can delete profile icons that
have been added to the system by users. You cannot delete system default icons.
Deleting a user-added icon resets the profiles and templates using the icon to the
system default icon. Before you delete a profile icon, review the number of profiles
using the icon.
To delete a profile icon:
1.
On the Appearance tab page, in the Profile Icons pane, position the pointer in
the Actions column of the profile icon you want to delete.
Note: The Delete icon is not available for system default icons.
2.8.7
2.
Click Delete
3.
When prompted, confirm that you want to delete the icon.
.
Applying a custom style template
This section describes how to apply custom style templates to create a uniform
appearance or rebranding for your Exceed TurboX installation.
To apply a custom style template:
1.
Locate the custom styling directory in your Exceed TurboX install location. It
should be located in a path similar to the following: .
/etxsvr -<x.x>/data/custom
2.
Create a backup copy of the existing etx_custom.template file.
To create a backup copy, rename the etx_custom.template file or create a
copy and store it at a different location.
3.
On the Appearance tab page, modify the custom color settings, such as
Navigation bar colors and Button colors.
4.
Click Apply.
The Exceed TurboX server generates a new custom CSS file and reloads the
Appearance page with the custom style applied.
108
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.8. Managing appearance
Note: Clear the cache of your browser to ensure that the previous style
definitions are not cached by your browser and the updated custom style
is effective.
5.
Optional: In the etx_custom.template file, define additional customizations
based on your requirements and preferences.
6.
Sign out or return to the Exceed TurboX Server Manager sign-in page.
The sign-in page is updated with the custom styling.
2.8.8
Exporting appearance settings
This section describes how to export site appearance settings, including the Exceed
TurboX system theme and profile icons.
You can customize the appearance settings based on your preferences and export
them as a .zip file. You can then share the exported settings with other users or
import those settings to a different Exceed TurboX Server.
Note: The profile icons that you export must include an ID so that when you
import the appearance settings, profiles are correctly associated with their
icons.
To export the site appearance settings:
1.
On the Appearance tab page, customize the site appearance settings based on
your preferences.
2.
Click the Export appearance settings
page.
icon in the top-right corner of the
The appearance settings are downloaded as a ZIP file named etx_appearance.
zip.
3.
2.8.9
Save the ZIP file on your hard drive.
Importing appearance settings
This section describes how to import site appearance settings for reusing them
across different servers.
Note: If your current Exceed TurboX instance contains a profile with the same
ID as the imported profile ID, it will be overwritten with the imported version.
To import the site appearance settings:
1.
On the Appearance tab page, click the Import appearance settings
located on the top-right corner of the page.
icon
The Open dialog box is displayed.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
109
Chapter 2 Managing Exceed TurboX as an administrator
2.
Browse to the location of the ZIP file containing the appearance settings, and
click Open.
The Import appearance settings dialog box appears.
3.
Select the check boxes beside the types of settings you want to import, and click
OK.
If the parsing of the ZIP file you selected is unsuccessful, the Import appearance
settings dialog box displays the message,
Invalid import file.
Click Close and open the Import appearance settings dialog box again to select
the correct ZIP file.
2.9 Configuring user authentication settings
The Authentication tab page of the Site Settings page allows you to configure the
authentication methods for Exceed TurboX users.
Exceed TurboX supports the following authentication methods:
Kerberos single The single sign-on (SSO) authentication method, based on Kerberos,
sign-on
ensures secure communication by assigning a ticket to each user who
signs in to the network. The ticket is then embedded in messages to
identify the sender of the message.
For more information about configuring Kerberos, see “Configuring your
environment for single sign-on authentication based on Kerberos” in
Exceed TurboX Installation and Configuration Guide.
Native
110
When using the Native authentication method, Exceed TurboX users are
authenticated based on the user credentials defined on the Linux
operating system where the Exceed TurboX Connection Node is installed.
The user accounts that use this authentication method must be created in
your Linux environment.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.9. Configuring user authentication settings
PAM
The PAM authentication method ensures secure communication by
passing user Client credentials to a pluggable authentication module
(PAM) service, for verification. A PAM service must be installed and
configured in your Linux or UNIX environment.
The PAM interface works with multiple methods, such as LDAP, 2FA, or
Kerberos.
The PAM service name for Exceed TurboX Nodes is exceedconnection-node. In a Linux environment, create the Exceed TurboX
PAM service file, exceed-connection-node, which typically resides
at /etc/pam.d/.
The following example shows potential etc/pam.d/exceedconnection-node configuration in a RedHat Linux environment.
#%PAM-1.0
auth
auth
account
session
session
password
*required
include
include
required
include
include
pam_nologin.so
password-auth
password-auth
pam_loginuid.so
password-auth
password-auth
Note: File content must be customized based on your environment
and PAM configuration.
LDAP
The LDAP authentication method ensures secure communication by
authenticating users based on credentials supplied by an LDAP server.
Exceed TurboX can retrieve user and group information from RFC2307compliant LDAP servers. An LDAP server must be configured with the
user accounts and groups you plan to use in Exceed TurboX.
OTDS
The OTDS (OpenText Directory Services) method allows Exceed TurboX
to forward authentication requests to an OTDS server on your network.
An OTDS server must be configured with the user accounts and groups
you plan to use in Exceed TurboX.
OTDS is a stand-alone server that provides scalable authentication and
user management services to enterprise applications.
OTDS supports a variety of authentication systems, including LDAP,
Active Directory, SAML (Security Assertion Markup Language), OAuth
1.0/2.0, REST, web services auth, HTTP auth, and OpenID. It supports 2factor authentication (2FA) for SAML/OAuth, as well as the ability to
synchronize users across multiple directories and define which users can
access which applications.
OTDS is available on My Support for all OpenText customers, free of
charge.
For detailed information about installing, configuring, and administering
OpenText Directory Services, see OTDS Installation and Administration
Guide on My Support.
WAM
CONETX120501-AGD-EN-3
The WAM method forwards authentication requests to a Web Access
Management solution, such as CA SiteMinder, which uses HTTP cookies
to identify authenticated users.
Server Manager Administration Guide
111
Chapter 2 Managing Exceed TurboX as an administrator
Warning
Exceed TurboX Server identifies users by sign-in name. If you switch between
authentication modes, you must ensure there are no collisions and the same
sign-in names belong to the same person. If you cannot ensure this, to avoid
the risk of unauthorized access, we recommend that you delete the user
accounts that are likely to collide.
To configure user authentication settings:
1.
Navigate to the Site Settings > Authentication tab page.
2.
If you want to use single sign-on (SSO) authentication based on Kerberos, select
the Try Kerberos single sign-on first check box and configure the Kerberos
settings on the server Configuration page (for information about these settings,
see “Configuring Kerberos settings” on page 168).
Note: Your environment must be already configured to support Kerberos.
If you select this option, Exceed TurboX Server first attempts SSO
authentication using a Kerberos ticket. If the SSO authentication process fails,
Exceed TurboX then uses the authentication method you select from the
Authentication type list.
3.
Select the user authentication method you want to use. The following options
are available:
Note: Windows connection nodes cannot be authentication nodes.
• Native: Exceed TurboX Server passes all authentication requests to a UNIXbased connection node which is configured as an authenticator. The node
will verify the user credentials against its list of native user accounts and
return success or failure. For information about settings specific to Native
authentication, see “Configuring settings for Native authentication”
on page 113.
• PAM: Exceed TurboX Server passes all authentication requests to a UNIXbased connection node which is configured as an authenticator. The node
will pass the user credentials to a PAM (Pluggable Authentication Module)
service for verification and return success or failure. For information about
settings specific to PAM authentication, see “Configuring settings for PAM
authentication” on page 114.
• LDAP: Exceed TurboX Server authenticates user credentials against an
LDAP (Light Directory Access Protocol) server. For information about
settings specific to LDAP authentication, see “Configuring settings for
LDAP authentication” on page 115.
• OTDS: Exceed TurboX Server forwards authentication requests to an
OpenText Directory Services (OTDS) server on your network. For
information about settings specific to OTDS authentication, see
“Configuring settings for OTDS authentication” on page 120.
112
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.9. Configuring user authentication settings
• WAM: Exceed TurboX Server forwards authentication requests to a Web
Access Management solution, such as SiteMinder, which uses HTTP cookies
to identify authenticated users. For information about settings specific to
WAM authentication, see “Configuring settings for WAM authentication”
on page 122.
4.
Modify the settings provided on this page, as necessary and click Save.
The settings are saved and applied to your Exceed TurboX site.
The Status area is updated to show the number of full administrators defined in
your system and, with Native or PAM authentication only, the number of
Exceed TurboX Connection Nodes configured with the authenticator role.
2.9.1
Configuring settings for Native authentication
If you select Native authentication, you can configure the following User
information settings on the Authentication tab page:
Username
capitalization
Allows administrators to define capitalization rules for usernames entered
during user sign-in. When a user signs in for the first time, or if a
matching username with different capitalization already exists, the
username is updated according to the rule defined here.
Select one of the following options:
• As typed by the user. This is the default setting. The username is sent
to the authenticator as it is typed by the user on the sign-in page.
Force
to lowercase: The username is converted to all lowercase letters
•
for authentication.
• Force to uppercase: The username is converted to all uppercase letters
for authentication.
Execute
command to
fetch user
information on
first sign-in
Allows administrators to execute a shell script or command to retrieve the
user’s full name and email address. This information can be used to
populate the user information when the user signs in to Exceed TurboX
Dashboard for the first time and their account is created. For more
information about these custom scripts, see “Executing commands to fetch
user information” on page 123.
If the Hide new user sign-in dialog if user information is available
option is selected on the New User Settings page, the user information is
passed to Exceed TurboX Server and the user is taken directly to the
Dashboard without seeing the first time sign-in dialog box.
Full name
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
name_cn).
Email address
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
email_mail).
CONETX120501-AGD-EN-3
Server Manager Administration Guide
113
Chapter 2 Managing Exceed TurboX as an administrator
2.9.2
Configuring settings for PAM authentication
If you select PAM authentication, you can configure the following PAM settings on
the Authentication page:
PAM password The initial PAM password prompt for Exceed TurboX to use on the signprompt
in page for PAM authentication. Different PAM systems have different
initial prompts, such as PIN, Password, or root’s Password. This prompt
support regular expressions.
If this box is left empty, Exceed TurboX looks for the default Password:
PAM prompt. If your PAM authentication displays PIN or another
prompt, you must customize this box to match your PAM settings.
Otherwise, users will see an extra authentication prompt when signing in
to the Exceed TurboX Server web interface
This prompt also specifies which PAM prompt is saved and passed to the
XStart as the password for Use session credentials authentication. For
more information, see “Configuring Xstart settings” on page 254.
Valid values include a regular string or a string with regular expression.
Show PAM
password
prompt as
The text of the first prompt of the sign-in screen. The default value is
Password, without a colon at the end of the string. Additional PAM
prompts appear below this one, if applicable.
You can configure the following User information settings on the Authentication
page:
Username
capitalization
Allows administrators to define capitalization rules for usernames entered
during user sign-in. When a user signs in for the first time, or if a
matching username with different capitalization already exists, the
username is updated according to the rule defined here.
Select one of the following options:
• As typed by the user. This is the default setting. The username is sent
to the authenticator as it is typed by the user on the sign-in page.
• Force to lowercase: The username is converted to all lowercase letters
for authentication.
• Force to uppercase: The username is converted to all uppercase letters
for authentication.
Remove
domain from
username
during sign-in
114
When Exceed TurboX Server is configured to create user accounts on first
sign-in, the username for the newly created user is set to the username
typed on the sign-in page. If the back-end LDAP directory allows
usernames in the DOMAIN\username or username@domain formats,
enabling this option removes the domain prefix or suffix when the user
account is created, so that usernames in Exceed TurboX have a consistent
username format. Do not enable this setting if your organization uses
multiple domains, because the trimmed username (without the domain)
will not be unique across all domains.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.9. Configuring user authentication settings
Execute
command to
fetch user
information on
first sign-in
Allows administrators to execute a shell script or command to retrieve the
user’s full name and email address. This information can be used to
populate the user information when the user signs in to Exceed TurboX
Dashboard for the first time and their account is created. For more
information about these custom scripts, see “Executing commands to fetch
user information” on page 123.
If the Hide new user sign-in dialog if user information is available
option is selected on the New User Settings page, the user information is
passed to Exceed TurboX Server and the user is taken directly to the
Dashboard without seeing the first time sign-in dialog box.
2.9.3
Full name
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
name_cn).
Email address
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
email_mail).
Configuring settings for LDAP authentication
If you select LDAP authentication, you can configure the following LDAP server
settings on the Authentication tab page:
Note: A red asterisk indicates a required field.
Warning
If you switch to LDAP authentication, you will not be able to sign in to Exceed
TurboX Server Manager using your original user account. To avoid this,
specify an administrative account that exists in your LDAP directory.
Server and port The URL and port number of the LDAP server that will supply the
credentials for user authentication (for example, ldap01.example.com:
389).
The URL is required; the port is optional. If you do not specify the port,
authentication uses the default LDAP port number: 389 without SSL or
636 with SSL.
Note: You can specify multiple servers in this box, separated by
spaces. If the connection attempt to the first server fails, an attempt
is made to connect to the next server, until a successful connection is
made. The credentials for all servers must be the same.
Use SSL/TLS
CONETX120501-AGD-EN-3
Select this check box if the LDAP server supports SSL/TLS and you want
to transfer the authorization information over a secured SSL/TLS
connection.
Server Manager Administration Guide
115
Chapter 2 Managing Exceed TurboX as an administrator
Use explicit
Select this check box to cause the LDAP server to use the StartTLS
TLS encryption extension on a non-SSL/TLS port for encrypting LDAP traffic.
Note: To enable this feature, you must also select the Use SSL/TLS
check box.
Bind as
Select the LDAP binding method:
• Service account: Bind to LDAP using a pre-defined service account
(proxy account). To specify the authentication parameters for this
method, fill in the Bind DN or username and the Password boxes.
• Anonymous: Bind to LDAP using anonymous simple authentication,
which does not require a distinguished name for the LDAP service
account. Your LDAP server must support anonymous binds.
Authenticating
user: Bind to LDAP using the credentials of the user
•
signing in to Exceed TurboX. Specify the distinguished name format in
the User DN format box.
Bind DN or
username
The distinguished name or the user name for the LDAP service account.
Appears only when Service account is selected as LDAP binding method.
Password
The password for the LDAP service account. Appears only when Service
account is selected as LDAP binding method.
User DN
format
The distinguished name format for the LDAP service account. Appears
only when Authenticating user is selected as LDAP binding method. Use
{u} to represent the user name of the authenticating user.
Test
Click this button to test the selected LDAP binding method (and
parameters, where applicable). This button is enabled when all mandatory
boxes are set.
Use LDAP for
authentication
only
Select this check box to instruct Exceed TurboX to use LDAP only to
authenticate users when they sign in to Exceed TurboX Dashboard. LDAP
groups are not supported if this option is selected. This option is preselected when Authenticating user is selected as the LDAP binding
method.
When this check box is cleared, LDAP is used to:
•
•
•
•
116
Authenticate users when they sign in to Exceed TurboX Dashboard.
Display LDAP groups in the User Groups Add and Edit dialog boxes.
Display an option in these dialogs to show/hide LDAP groups.
Enable nesting of LDAP groups in Exceed TurboX user groups
(members of the LDAP group will be counted as members of the
Exceed TurboX group for the purposes of profile publishing and usage
tracking).
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.9. Configuring user authentication settings
Base DN for
users
Specify the base distinguished name (that is, the top level of the LDAP
directory tree) from which to search for users. For example: ou=users,
dc=example,dc=com.
Click the Edit filter button on the right side of the box to define or modify
the search filter for users. The Edit search filter for users dialog box
opens. For more information, see “Editing the search filter for users”
on page 118.
The Base DN for users box and the Edit filter button are unavailable
when Authenticating user is selected as LDAP binding method.
Base DN for
groups
Specify the base distinguished name (that is, the top level of the LDAP
directory tree) for the user groups that are visible in Exceed TurboX Server
Manager. If left blank, the Base DN for users is used for listing groups.
Click the Edit filter button on the right side of the box to define or modify
the search filter for user groups. The Edit search filter for groups dialog
box opens. For more information, see “Editing the search filter for groups”
on page 119.
The Base DN for groups box and the Edit filter button are disabled when
Authenticating user is selected as the LDAP binding method or when the
Use LDAP for authentication only check box is selected.
You can configure the following User information settings on the Authentication
page:
Full name
attribute(s)
Specify the LDAP attribute(s) for the user’s full name (for example, sn
givenName).
More than one attribute can be specified, separated by spaces or commas.
This is retrieved automatically when the user name is loaded from LDAP.
Email attribute
Specify the LDAP attribute which contains the user’s email address (for
example, mail).
This is retrieved automatically when the user’s email address is loaded
from LDAP.
Username
capitalization
Allows administrators to define capitalization rules for usernames entered
during user sign-in. When a user signs in for the first time, or if a
matching username with different capitalization already exists, the
username is updated according to the rule defined here.
Select one of the following options:
• As typed by the user. This is the default setting. The username is sent
to the authenticator as it is typed by the user on the sign-in page.
• Force to lowercase: The username is converted to all lowercase letters
for authentication.
• Force to uppercase: The username is converted to all uppercase letters
for authentication.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
117
Chapter 2 Managing Exceed TurboX as an administrator
Remove
domain from
username
during sign-in
When Exceed TurboX Server is configured to create user accounts on first
sign-in, the username for the newly created user is set to the username
typed on the sign-in page. If the back-end LDAP directory allows
usernames in the DOMAIN\username or username@domain formats,
enabling this option removes the domain prefix or suffix when the user
account is created, so that usernames in Exceed TurboX have a consistent
username format. Do not enable this setting if your organization uses
multiple domains, because the trimmed username (without the domain)
will not be unique across all domains.
Execute
command to
fetch user
information if
not set by
attributes
Select this option to allow administrators to execute a shell script or
command to retrieve the user information in the following cases:
• When the LDAP attributes (Full name attribute(s) and Email
attribute) are not set.
• When the LDAP attributes (Full name attribute(s) and Email
attribute) are set, but are invalid or return an empty result.
This information can be used to populate the user information when the
user signs in to Exceed TurboX Dashboard for the first time and their
account is created. For more information about these custom scripts, see
“Executing commands to fetch user information” on page 123.
If the Hide new user sign-in dialog if user information is available
option is selected on the New User Settings page, the user information is
passed to Exceed TurboX Server and the user is taken directly to the
Dashboard without seeing the first time sign-in dialog box.
2.9.3.1
Full name
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
name_cn).
Email address
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
email_mail).
Editing the search filter for users
The Edit search filter for users dialog box allows you to define an LDAP filter that
specifies which users can sign in to Exceed TurboX.
Specify the LDAP filter in the Users search filter pane. The LDAP filter syntax is
defined by RFC4515 or RFC2254 standards for LDAP filters. It requires {u}, which
represents the user name. For example:
(&(|(sAMAccountType=SAM_USER_OBJECT)(sAMAccountType=SAM_TRUST_
ACCOUNT)(objectClass=inetOrgPerson)(objectClass=user)(objectClass=
person)(objectClass=account)(objectClass=msSFU30PosixAccount)
(objectClass=msSFUPosixAccount)(objectClass=PosixAccount)
(objectClass=aixAccount))(|(uid={u})(cn={u})(mail={u})
(sAMAccountName={u})(userPrincipalName={u})))
118
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.9. Configuring user authentication settings
Click Test to verify the specified LDAP filter and review the results. If the filter
syntax is correct, the Filter results pane is updated to display the list of users that
are allowed to sign in to Exceed TurboX. A maximum of 100 entries are displayed in
this pane.
If the filter syntax is incorrect or the LDAP parameters are invalid, an error message
is displayed.
Click Reset to default to return the LDAP filter for users to its default value.
Click OK to close the Edit search filter for users dialog box and return to the
Authentication page. This button is enabled only if the LDAP filter test returns at
least one result.
2.9.3.2
Editing the search filter for groups
The Edit search filter for groups dialog box allows you to define an LDAP filter that
specifies which user groups are used in Exceed TurboX.
Specify the LDAP filter in the Groups search filter pane. The LDAP filter syntax is
defined by RFC4515 or RFC2254 standards for LDAP filters. For example:
(|(sAMAccountType=SAM_NON_SECURITY_ALIAS_GROUP_OBJECT)
(sAMAccountType=SAM_ALIAS_GROUP_OBJECT)(objectClass=
organizationalUnit)(sAMAccountType=SAM_GROUP_OBJECT)(sAMAccountType=
SAM_NON_SECURITY_GROUP_OBJECT)(objectClass=group)(objectClass=
groupOfNames)(objectClass=posixGroup)(objectClass=msSFU30PosixGroup)
(objectClass=msSFUPosixGroup)(objectClass=aixaccessgroup)
(objectClass=groupOfUniqueNames))
Click Test to verify the specified LDAP filter and review the results. If the filter
syntax is correct, the Filter results pane is updated to display the list of LDAP user
groups that can be used in Exceed TurboX user groups. A maximum of 100 entries
are displayed in this pane.
If the filter syntax is incorrect or the LDAP parameters are invalid, an error message
is displayed.
Click Reset to default to return the LDAP filter for groups to its default value.
Click OK to close the Edit search filter for groups dialog box and return to the
Authentication page. This button is enabled only if the LDAP filter test returns at
least one result.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
119
Chapter 2 Managing Exceed TurboX as an administrator
2.9.4
Configuring settings for OTDS authentication
If you select OTDS authentication, you can configure the following OTDS server
settings on the Authentication tab page:
Note: A red asterisk indicates a required field.
OTDS server
URL
The URL and the port number of the server running OpenText Directory
Services (for example, https://otds.example.com:8443). The URL
is required; the port number is optional. If you do not include the port,
authentication uses the default port, 8443 .
OTDS sign in
URL
The URL of the OTDS server sign-in page (for example, https://otds.
example.com:8443/otdsws/oauth2/auth ).
Note: Configuring this setting incorrectly will prevent users from
signing in to Exceed TurboX Server. Ensure that the URL provided
is correct before saving the authentication settings.
ETX resource
identifier
The OTDS resource identifier assigned to Exceed TurboX (for example,
9480572D-EF2C-1F4D-A293-84414EB9FDB7 ). Each resource in
Directory Services is represented by a unique name and resource
identifier.
OAuth client
ID
The name of the OAuth Client created for Exceed TurboX in OTDS (for
example, ETX_SERVER ). In order to use the OAuth 2.0 with OTDS, each
OAuth Client must be registered in OTDS.
OAuth client
secret
The OAuth Client secret created for Exceed TurboX in OTDS (for example,
prso8kBhNcIdyz7MC43VZRUHghr3Af5R ).
Test
Click this button to connect to the OTDS Server via a REST API and test
the authentication using the specified OAuth Client credentials.
If the test is successful, complete the OTDS authentication configuration
by configuring the settings in the User attributes area.
If the test fails, update the OTDS server settings as needed, then test the
authentication again.
Use OTDS for
authentication
only
Select this check box to have Exceed TurboX use OTDS only to
authenticate users when they sign in to Exceed TurboX Dashboard. OTDS
groups are not supported if this option is selected.
When this check box is cleared, OTDS is used to:
• Authenticate users when they sign in to Exceed TurboX Dashboard.
• Display OTDS groups in the User Groups Add and Edit dialog boxes.
• Display an option in these dialogs to show/hide OTDS groups.
You can configure the following User information on the Authentication page:
Note: OTDS attributes are mapped to the Exceed TurboX Site administrator
credentials.
120
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.9. Configuring user authentication settings
Username
attribute
The OTDS attribute for the Exceed TurboX user’s name (for example,
oTExternalID1). The user name may be used for host authentication.
Full name
attribute
The OTDS attribute for the Exceed TurboX user’s full name (for example,
cn).
Email attribute
The OTDS attribute for the user’s email address (for example, mail).
Username
capitalization
Allows administrators to define capitalization rules for usernames entered
during user sign-in. When a user signs in for the first time, or if a
matching username with different capitalization already exists, the
username is updated according to the rule defined here.
Select one of the following options:
• As typed by the user. This is the default setting. The username is sent
to the authenticator as it is typed by the user on the sign-in page.
• Force to lowercase: The username is converted to all lowercase letters
for authentication.
• Force to uppercase: The username is converted to all uppercase letters
for authentication.
Execute
command to
fetch user
information if
not set by
attributes
Select this option to allow administrators to execute a shell script or
command to retrieve user information in the following cases:
• When the OTDS attributes (Username attribute, Full name
attribute(s), and Email attribute) are not set.
• When the OTDS attributes (Username attribute, Full name
attribute(s), and Email attribute) are set, but are invalid or return an
empty result.
This information can be used to populate the user information when the
user signs in to Exceed TurboX Dashboard for the first time and their
account is created. For more information about these custom scripts, see
“Executing commands to fetch user information” on page 123.
If the Hide new user sign-in dialog if user information is available
option is selected on the New User Settings page, the user information is
passed to Exceed TurboX Server and the user is taken directly to the
Dashboard without seeing the first time sign-in dialog box.
Full name
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
name_cn).
Email address
The full path to the script file which will retrieve the user information. The
script must be located on the Exceed TurboX Server filesystem (for
example, /ETX/Server_Scripts/User_Attributes/get_user_
email_mail).
CONETX120501-AGD-EN-3
Server Manager Administration Guide
121
Chapter 2 Managing Exceed TurboX as an administrator
2.9.5
Configuring settings for WAM authentication
If you select WAM authentication, you can configure the following WAM settings
and related User information on the Authentication tab page:
Tip: If you do not know the information to use for any of the WAM-related
fields, contact your WAM solution administrator.
Username
cookie
The HTTP cookie containing the Exceed TurboX user name.
Full name
cookie
The HTTP cookie containing the user’s full name.
E-mail cookie
The HTTP cookie containing the user’s email address.
WAM session
cookie
The HTTP cookie containing the WAM session ID.
Enable
agentless access
of cookies
through Open
Format Cookie
(OFC)
Select this option to enable agentless access of cookies through Open
Format Cookie (OFC) for WAM authentication. If this option is enabled,
cookie values will be read from the OFC instead of a separate cookie
header.
OFC Cookie
Enter the name of the OFC cookie that will be read by the agent.
This option is not enabled by default.
This option is available if Enable agentless access of cookies through
Open Format Cookie (OFC) is enabled.
OFC
encryption key
Execute
command to
fetch user
information on
first sign-in
Enter the encryption key produced by SiteMinder.
This option is available if Enable agentless access of cookies through
Open Format Cookie (OFC) is enabled.
Select this option to allow administrators to execute a shell script or
command to retrieve the user information (Full name and Email address).
This information can be used to populate the user information, when the
user signs in to Exceed TurboX Dashboard for the first time and their
account is created. For more information about these custom scripts, see
“Executing commands to fetch user information” on page 123.
If the Hide new user sign-in dialog if user information is available
option is also selected (on the New User Settings page), the user
information retrieved can be passed to Exceed TurboX Server and, upon
successful authentication, the user is taken directly to the Dashboard
without seeing the first time sign-in dialog box.
Full name
122
Specify the full path to the script file which will retrieve the user
information. The script must be located on the Exceed TurboX Server
filesystem (for example, /ETX/Server_Scripts/User_Attributes/
get_user_name_cn).
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.9. Configuring user authentication settings
Email address
2.9.6
Specify the full path to the script file which will retrieve the user
information. The script must be located on the Exceed TurboX Server
filesystem (for example, /ETX/Server_Scripts/User_Attributes/
get_user_email_mail).
Executing commands to fetch user information
This section provides information about how to use custom scripts to retrieve user
information and pass it to the Exceed TurboX Server to populate the user
information on the sign-in page when the user signs in to Exceed TurboX Dashboard
for the first time.
If the Hide new user sign-in dialog if user information is available option is
selected on the New User Settings page, the user information is passed to Exceed
TurboX Server and the user is taken directly to the Dashboard without seeing the
first time sign-in dialog box.
When writing a script to populate the user information, you must ensure the
following:
• The script must be stored on the Exceed TurboX Server filesystem, in a location
where the Server has “execute” permission to this file.
• The script must be a valid script for the system. For example, it must include the
shebang (#!/bin/sh) followed by the script that can be interpreted by that shell.
• The script can be a shell script or an executable file.
• The script must use the ${ETX_USER} environment variable. Exceed TurboX
Server will set this environment variable to the user name of the authenticating
user.
• The script must print the email or full name to stdout (for example, using the
print command).
Example: A shell script that allows you to retrieve the authenticating user’s full
name from an LDAP directory.
#!/bin/sh
ldapsearch -LLL -h dc.example.com -D dcadmin -w mypassword -b CN=Users,DC=example,com
-s sub sAMAccountName="${ETX_USER}" | awk -F ": " '$1 == "userPrincipalName" {print $2}'
where:
• dc.example.com = Active Directory machine name>
• dcadmin = Admin name
• mypassword = Active Directory password
• CN=Users,DC=example,com = LDAP Base DN
• userPrincipalName =User’s full name
You cannot execute commands directly from the server with command line options,
such as -h and -D in the above example. If command line options are required, you
CONETX120501-AGD-EN-3
Server Manager Administration Guide
123
Chapter 2 Managing Exceed TurboX as an administrator
must write a script on the Exceed TurboX Server machine and call the script using
the script name. The command or script may retrieve user information using any
method, for example by reading from a text file or environment variable, or by
fetching it via a RESTful web service. The only requirement is that the script or
command prints a string representing the user’s full name or email address to
stdout.
If the script does not terminate within a short period or does not print a valid email
or name string to stdout, the user’s information is not pre-populated. This results in
the first time sign-in dialog box being displayed, even if the Hide new user sign-in
dialog if user information is available option is selected.
2.10 Managing a cluster
The Cluster tab page of the Site Settings page displays all the Exceed TurboX
Servers in a High Availability (HA) cluster, and provides information about each
Server.
The Servers pane provides the following information:
124
Server name
Unique identifier for the Server in the cluster.
Server address
Server address used for data replication.
Server version
Exceed TurboX Server version.
Link status
Status of the network connection.
Replication
status
Indicates if the Server is ready to send and receive replication data.
Resync data
Amount of data accumulated in the recovery journal (due to the Server
being offline).
Replication
backlog
Amount of data not replayed to the Server.
Last heartbeat
The last time and date when a message was received from the Server.
Server URL
Exceed TurboX Server Manager URL. Click the link for a connected Server
to open the URL in a web browser.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.10. Managing a cluster
Actions
The actions you can perform on a cluster member. To view the available
actions, position the pointer over the Actions column.
To view details about a cluster member, click the Details button . The
Server details dialog box opens. See “Viewing cluster member details”
on page 125 for more information.
Note: When an abnormal or error condition is detected for a member of the
cluster, that Server is displayed in red, indicating that it requires immediate
attention.
To update the information displayed on this pane, click the Refresh view of
servers button
at the top-right corner of the pane.
To customize the columns displayed in this pane, use the Change view dialog
box. See “Showing and hiding columns in Exceed TurboX Server Manager
grids” on page 39 for more information.
2.10.1
Viewing cluster member details
The Server details dialog box displays detailed information about a member of a
cluster.
To view Server details
1.
Position your pointer in the Actions column of the Server you want to view.
2.
Click the Details button
.
The Server details dialog box opens. You can view the following details:
Server name
Unique identifier for the Server in the cluster.
Server ID
Timeline
Dboid
Identity tuple used to identify a Server for replication purposes. This
information is useful for troubleshooting replication issues.
Local
Yes indicates that the member is a local Server.
No indicates that the member is a connected Server.
Local address
Server address used for replication.
Local port
Server port used for replication.
Server version
Exceed TurboX Server version.
Server URL
Exceed TurboX Server Manager URL.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
125
Chapter 2 Managing Exceed TurboX as an administrator
Last heartbeat
The last time and date when a message was received from the Server. It
also displays a nine-digit number representing the nanoseconds of the
Server timestamp.
Note: Exceed TurboX Servers in a cluster can be deployed in
multiple regions with different time zones. Exceed TurboX Servers
are able to handle the time zone differences such that all timestamps
from different Servers are automatically converted to timestamps in
a time zone of connecting Exceed TurboX Servers when the
information is presented on the Server Manager web interface or via
REST APIs.
Replication
status
Indicates if the Server is ready to send and receive replication data.
Readonly
The state of etxdb (Readonly or Read/Write).
Replication
sender state
The state of replication sender process, which replicates data accumulated
in the recovery journal when a remote Server connects.
Replication
sender PID
Process ID of the replication sender process.
Replication
sender start
time
Start time of the replication sender process. It displays the date, time, and
a nine-digit number representing the nanoseconds of the Server
timestamp.
Note: Exceed TurboX Servers in a cluster can be deployed in
multiple regions with different time zones. Exceed TurboX Servers
are able to handle the time zone differences such that all timestamps
from different Servers are automatically converted to timestamps in
a time zone of connecting Exceed TurboX Servers when the
information is presented on the Server Manager web interface or via
REST APIs.
Remote address Remote Server address connecting to the local Server to which the Server
Manager is currently connected.
Remote port
Remote Server port connecting to the local Server to which the Server
Manager is currently connected.
Resync data
Amount of data in the recovery journal (due to the Server being offline).
Pending
backlog
Amount of data in the recovery journal that has been generated but not
sent to a remote Server yet.
Write backlog
Amount of data in the recovery journal that has been sent to a remote
Server but not written yet.
Flush backlog
Amount of data in the recovery journal written by a remote Server but not
flushed to permanent storage.
Note: If the remote Server crashes, these changes are lost, because
they have not been flushed yet.
Replay backlog Amount of data in the recovery journal that has been flushed to the
permanent storage but not replayed yet. When replicated data is replayed,
changes from the local Server would reach the remote Server in full.
126
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.11. Managing licenses
Replication
total backlog
Total amount of data not replayed to the Server.
2.11 Managing licenses
The Licenses tab of the Site Settings page allows you to manage Exceed TurboX
licenses for each Exceed TurboX Site. It also allows you to configure an Exceed
TurboX Site/Server as a License Server.
Each Exceed TurboX user requires a license in order to launch sessions.
Licenses are derived from the following Exceed TurboX sources:
• License keys: The Exceed TurboX Site uses licenses derived from local license
keys. To use this method, select Local license keys in the License source area.
See “Managing local license keys” on page 128 for more information.
A site configured to use local license keys can be configured as a License Server.
In this case, this License Server uses local license keys to establish a license pool
that is shared among multiple servers, statically or dynamically. See “Managing
licenses for connected Exceed TurboX sites” on page 131 for more information.
Note: A Server running in a cluster cannot be used as a License Server for
other Exceed TurboX Servers.
• License Server: The Exceed TurboX Site connects to a remote License Server to
obtain licenses from that server’s license pool. To use this license method, select
Remote License Server in the License source area. For more information, see
“Using a remote License Server” on page 135.
By default, an Exceed TurboX Site is configured to use local licenses keys. Exceed
TurboX administrators can switch the license method of the site from local license
keys to remote License Server, and back, as needed.
Note: Exceed TurboX Users can view their Dashboards and configure profiles
without a license.
Launching, joining, and sharing one or more sessions, on one or more devices,
occupies one license.
Administrators can limit the number of active/suspended sessions that is
permitted per user. This number is not determined by licenses. See
“Configuring default user permissions and settings” on page 141 for more
information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
127
Chapter 2 Managing Exceed TurboX as an administrator
2.11.1
Managing local license keys
OpenText provides a license key when you purchase Exceed TurboX. Each license
key specifies the license type, the number of user licenses purchased, and their start
and end dates. You can purchase additional license keys in order to support more
users.
You can have several license keys on the same server. The total license count is
derived by combining all licenses from all your license keys. Licenses are available
as either time-limited evaluations, or perpetual retail licenses. You can also
configure an Exceed TurboX Site/Server to act a License Server for other Exceed
TurboX Sites. See “Managing licenses for connected Exceed TurboX sites”
on page 131 for more information.
You can use the Local license keys pane to manage the license keys for the Exceed
TurboX Site.
The Local license keys pane provides the following action buttons at the top-right
corner of the pane:
Add license
key
Click this button to add a license key to your site. See “Adding a license
key” on page 129 for more information.
Refresh view of Click this button to refresh the contents of the pane.
license keys
The Local license keys pane provides the following information about the license
keys available on your site:
Date added
128
The date and time when the administrator added the license key.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.11. Managing licenses
License type
This can be a Premium or a Standard license key.
Note: With a Standard license key and with a Windows license key,
when a session is suspended, the session continues to use a license.
However with a Windows license key, when a session is suspended,
the session is prevented from using non-Windows Nodes and nonWindows startup methods. With a Premium license key, a
suspended session releases its license back to the license pool.
Limit
The total number of user licenses included in the license key.
Days
remaining
The number of days remaining until expiration. If this is blank, the license
does not expire.
Actions
Use the available action icons to manage the license keys. To display the
action icons, select a license key and position the pointer over the Actions
column.
•
•
in the
To view details about a license key, click the Details button
Actions column of the license key you want to view. The License key
dialog box opens. See “Viewing license key details” on page 130 for
more information.
To delete a license key, click the Delete license key button
in the
Actions column of the license key you want to view delete. When
prompted to confirm the deletion, click Yes. You can delete a license if
it is not in use.
Note: License information on the screen may be denoted by a strikethrough
line. This identifies license sources that are associated with the preceding
version of the product that are still in use.
The preceding version license(s) remains valid for any running sessions or
suspended sessions until they are closed. After you close a running session, or
resume and then close a suspended session, the legacy licenses are no longer
valid, and are discarded.
2.11.1.1
Adding a license key
This section describes how to add a license key to your site.
To add a license key:
1.
In the Local license keys pane, click the Add license key button
the top-right corner of the pane.
, located at
The Add license key dialog box opens.
2.
Paste the license text into the License key box.
Note: The license keys you purchased from OpenText are provided to you
in plain text format. The key text indicates the type and number of licenses
you purchased. To apply a license key, fully copy and paste all of the
CONETX120501-AGD-EN-3
Server Manager Administration Guide
129
Chapter 2 Managing Exceed TurboX as an administrator
license key text. Exceed TurboX handles the distribution of licenses on a
user-by-user basis.
You cannot mix Premium and Standard license key types.
3.
Click Save.
The Local license keys pane is updated to display the newly added license key.
2.11.1.2
Viewing license key details
This section describes how to display information about currently available license
keys.
To view the license key details:
1.
In the Local licenses keys pane, position the pointer in the Actions column of
the license key.
2.
Click the Details button
.
The License key dialog box opens. You can view the following information:
ID
The ID of the license key, which is a 36-character string in the form
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
License key
The license keys you purchased from OpenText, displayed in plain
text format.
Date added
The date and time when the license key was added.
Version
The current version of the product license.
Type
This can be Premium or a Standard license key.
Note: With a Standard license key, when a session is
suspended, the session continues to use a license. With a
Premium license key, a suspended session releases its license
back to the license pool. This is the only difference between
these two license types.
3.
130
Limit
The total number of user licenses included in the license key.
Expiry date
The date and time when the license expires.
Days
remaining
The days remaining until the license expires.
Click OK to close the dialog box.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.11. Managing licenses
2.11.2
Managing licenses for connected Exceed TurboX sites
You can configure an Exceed TurboX Site/Server to act as License Server for other
Exceed TurboX Servers. A License Server provides centralized management of
licenses and assigns licenses to sites from its license pool. A license pool is
comprised of one or more license keys. Each license key contains multiple licenses. If
a License Server contains two license keys, where one of the license keys has 50
licenses and the other one has 20 licenses, then the license count in the license pool is
70. Sites requesting licenses from this License Server can, depending on
configuration, receive a fixed number of licenses, or be granted licenses dynamically
until all 70 of the licenses have been allocated.
Note: A Server running in a cluster cannot be used as a License Server for
other Exceed TurboX Servers.
To configure an Exceed TurboX Site Server to act as a License Server for other
Exceed TurboX Servers:
1.
On the Site settings > Licenses page, select Local license keys.
2.
Select Act as License Server for other ETX Sites.
The Connected ETX Sites pane appears when Act as License Server for other
ETX Sites is selected.
Note: If the server is part of a cluster, this option appears as Act as License
Server for other ETX Sites (License Server clustering is not supported). If
the server is part of a cluster, the Server will not be configured to act as a
License Server for other Exceed TurboX Servers, as this functionality is not
supported.
You can use the Connected ETX Sites pane to:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
131
Chapter 2 Managing Exceed TurboX as an administrator
• Approve the membership request for an Exceed TurboX Site (Server). If a site’s
membership is not approved, the site reverts to local license keys.
• Pre-allocate licenses to new members.
• Manage the license allocation of existing members, or remove their membership
access to the License Server.
The Connected ETX Sites pane provides the following information about the
Exceed TurboX Sites that have membership access to this License Server:
Server
The name of the Exceed TurboX Site/Server that has membership access.
• Local: Indicates the local License Server.
• Hostname:port: Indicates a stand-alone Server.
• Servername / hostname:port: Indicates that the host is a member of a
cluster of Exceed TurboX Servers that share the allocated license pool.
Site ID
The unique ID of the Connected Site of which the server is a member.
Multiple Servers can be members of the same Site (i.e., members of a
cluster). If the connected site has multiple Servers, each Server is listed in
a separate row.
Note: The Connected ETX Sites pane is sorted by the Site ID
column by default. This way, Servers that are members of a cluster
are grouped together.
Version
The version of the product license.
Status
Site/Server status:
• On hold: The administrator of the License Server has not added this
Site/Server as a member yet (that is, no licenses are assigned to it).
• Connected: The Exceed TurboX Server has membership access, is
connected to the License Server, and may use its licenses. If the License
Server goes offline, the members can still use licenses for another 24
hours, due to the failover policy. After 24 hours, these licenses expire.
• Disconnected: The Exceed TurboX Server has membership access, but
is disconnected from the License Server.
Last connection The last date and time when the Server communicated with the License
Server.
Allocation type The method used by the License Server to allocate licenses to its members:
• Dynamic: Licenses are accessed dynamically, as they become
available.
• Static: A fixed number of licenses is allocated to the member by the
License Server administrator. If you are administering an Exceed
TurboX Server that needs to be allocated a fixed number of licenses,
contact the administrator of the License Server.
132
Licenses
allocated
The number of licenses that have been allocated to this member (when
using Static allocation type).
Licenses in use
The number of licenses currently in use.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.11. Managing licenses
Actions
Use the available action icons to manage the connected sites. To display
the action icons, select a member and position the pointer in the Actions
column.
•
•
•
Add Site
: When a Server initially connects to the License Server, it
is displayed in the Connected ETX Sites pane, but does not have any
licenses allocated to it. To grant licenses to the connected site, click the
Add Site button. The member properties dialog box opens. See
“Adding, editing, and removing a member of the License Server”
on page 133 for more information.
Properties
: To edit a member’s settings, click the Properties
button. The member properties dialog box opens. See “Adding,
editing, and removing a member of the License Server” on page 133
for more information.
: To remove a connected Exceed TurboX Site and free
Remove Site
up licenses allocated to that site, click the Remove Site button. See
“Adding, editing, and removing a member of the License Server”
on page 133 for more information.
Tip: To temporarily disable a server from launching sessions and
consuming licenses without stopping that server, reduce the
license allocation for that server to zero.
The Connected ETX Sites pane provides the following action button, at the top-right
corner of the pane:
Refresh view of Click this button to refresh the content of the pane.
ETX Sites
2.11.2.1
Adding, editing, and removing a member of the License Server
This section describes how to add a member of the License Server, how to modify
the settings for an existing member, how to delete a member, and how to define
whether licenses from the License Server are allocated to a member statically or
dynamically.
Note: Exceed TurboX version 12 License Server allows Exceed TurboX 11.5
Connected Sites, but not vice versa.
To add a member of the License Server:
1.
In the Connected ETX Sites pane, position the pointer over the Actions column
of an Exceed TurboX Site that is listed as On hold in the Status column.
2.
Click the Add Site button
.
The member properties dialog box opens.
3.
In the member properties dialog box, select Allocation type.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
133
Chapter 2 Managing Exceed TurboX as an administrator
4.
Select Static or Dynamic.
• If you selected Static allocation, in the License allocation box, enter the
number of licenses to allocate to this member.
5.
Click Save.
The Connected ETX Sites pane is updated to display the settings configured for
this new member.
To edit a member of the License Server:
1.
In the Connected ETX Sites pane, position the pointer over the Actions column
of the member whose information you want to modify.
2.
Click the Properties button
.
The member properties dialog box opens. It indicates the version of the product
license and the site/server status.
3.
Modify the Allocation type, as necessary.
4.
If you selected Static allocation, in the License allocation box, enter the number
of licenses to allocate to this member.
5.
Click Save.
The Connected ETX Sites pane is updated to display the new settings
configured for this member.
To remove a member of the License Server:
1.
In the Connected ETX Sites pane, position the pointer over the Actions column
of the member you want to remove.
2.
Click the Remove Site button
.
• If the Site is still registered as a Connected Site, the Remove member dialog
box appears, prompting you to unreigister the Site before removing it. See
“To unregister a remote License Server:“ on page 136 for information about
removing a Connected Site.
• If the Site is already disconnected (unregistered), you will be prompted to
confirm its removal. Click Yes to confirm the removal.
Tip: To temporarily disable a server from launching sessions and
consuming licenses without stopping that server, reduce the licence
allocation for that server to zero.
134
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.11. Managing licenses
2.11.3
Using a remote License Server
A License Server provides centralized management of licenses and assigns licenses
to sites from its license pool. A license pool is comprised of multiple license keys.
Each license key contains one or more licenses. If a License Server contains two
license keys, where one of the license keys has 50 licenses and the other one has 20
licenses, then the license count in this license pool is 70. Sites requesting licenses
from this License Server can, depending on configuration, receive a fixed number of
licenses or be granted licenses dynamically until all 70 of the license keys have been
allocated.
You can configure an Exceed TurboX Site/Server to obtain licenses from a remote
License Server by selecting the Remote License Server option on the Licenses page.
The following illustration presents the Licenses page when the Remote License
Server option is selected, and no remote License Server has been registered for the
site.
To register a remote License Server
1.
On the Site Settings > Licenses tab page, select Remote License Server as the
License source.
The Remote License Server settings are displayed.
2.
In the Server URL box, enter or modify the URL for the License Server. The
following formats are supported:
• http(s)://<hostname>:<port>
• https(s)://<ipv4_addr>:<port>
• https(s)://<[ipv6_addr]>:<port>
3.
Click Register.
If the specified URL has a valid format, the License Server can be reached, and
the License Server administrator approves the connection request, the
registration is completed successfully.
Exceed TurboX Server disables the use of local license keys and starts using
licenses provided by the registered License Server.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
135
Chapter 2 Managing Exceed TurboX as an administrator
Note: The page is updated to display the Unregister button beside the
Server URL box. To later modify the remote License Server for your Site,
unregister this server and then register a new remote License Server. (See
“To unregister a remote License Server:“ on page 136.)
The Remote License Server area displays the following information about the
remote License Server:
Server URL
License Server URL (this box is empty when no remote License Server is
registered for your Site).
Status
License Server status:
• Unregistered: The Exceed TurboX administrator has not registered a
License Server yet.
Connected:
The Exceed TurboX Server has membership access, is
•
connected to the License Server, and may use its licenses. If the License
Server goes offline, the members can still use licenses for another 24
hours, due to the failover policy. After 24 hours, these licenses will
expire.
• Disconnected since <Date>] <Time>: The Exceed TurboX Server has
membership access, but has been disconnected from the License Server
since the specified date and time.
License Server
version
Exceed TurboX License Server version.
Allocation type The method used by the License Server to allocate licenses to its members:
• Dynamic: Licenses are accessed dynamically, as they become
available.
• Static: A fixed number of licenses is allocated to the member by the
License Server administrator. If you are administering a Exceed
TurboX Server that needs a fixed number of licenses, contact the
administrator of the License Server.
Licenses
allocated
When using Static allocation, the number of licenses that have been
allocated to this member.
Date registered
The date when the License Server was registered.
To unregister a remote License Server:
1.
Click the Unregister button located near the Server URL box.
A confirmation dialog box opens.
2.
Click Yes to unregister this server as your remote License Server.
Exceed TurboX Server disables the use of licenses provided by the License
Server and starts using local license keys.
If an Exceed TurboX Site (Server) departs from an Exceed TurboX License
Server:
• The Site reverts to local license keys.
136
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.12. Setting up automated messages
• The License Server reclaims any pre-allocated licenses and put them in the
dynamic license pool.
2.12 Setting up automated messages
Use the Messages page of the Site Settings tab to define which messages are
automatically sent to administrators, and to define some message options for users.
Messages are sent to users and administrators via the internal Exceed TurboX
messaging system. To configure Exceed TurboX to send email copies of all messages,
see “Enabling email messages for users and administrators” on page 140.
Note: The Messages page is used to define the messages that Exceed TurboX
sends to administrators. To define the messages that Exceed TurboX sends to
new and existing users, including session owners, see “Configuring default
user permissions and settings” on page 141.
Alternatively, if you enable Users can change message options in user
settings, users can use the User settings dialog box > Messages page to set
their own message options. See “Configuring message options” on page 139
and “Configuring your user settings” on page 18 for more information.
2.12.1
Setting up messages for administrators
The Messages tab page of the Site settings page allows you to configure Exceed
TurboX to send automated messages about specific Server events, Node events, and
Other events to administrators.
To set up messages for administrators:
1.
Navigate to the Site Settings > Messages page.
2.
In the three For administrators areas, select the check box for each type of
message that you want Exceed TurboX to send.
3.
Click Save.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
137
Chapter 2 Managing Exceed TurboX as an administrator
You can choose the following message types under For administrators – Server
events:
Server in
Send a message when any Exceed TurboX Server cannot contact another
cluster is
Exceed TurboX Server in the same cluster for the period of time you
unreachable for specify.
[n] minute(s)
Note: If an Exceed TurboX Server is unreachable for more than 60
minutes, a message is repeatedly sent every 60 minutes. This is to
remind Exceed TurboX administrators to address the connection
issue, in order to avoid the entire cluster becoming unstable. For
more information, see Exceed TurboX High Availability Configuration
Guide.
Server in
cluster is
reconnected
Send a message when a connection with the Exceed TurboX Server in the
same cluster is re-established, after the Server had been unreachable.
Server is
started
Send a message when an administrator starts the Exceed TurboX Server.
Free disk space
on server falls
below [n] GB
Send a message when the free space on the Exceed TurboX Server falls
below the value you enter.
Free memory
on server falls
below [n] MB
Send a message when the free memory on the Exceed TurboX Server falls
below the value you enter.
Average CPU
usage of server
is above [n] %
for more than
[n] minute(s)
Send a message when the average CPU usage of the Exceed TurboX
Server is more than the specified percentage for the specified length of
time.
You can choose the following message types under For administrators – Node
events:
Node is
Send a message when the Exceed TurboX Server loses a connection with
unreachable for the Exceed TurboX Connection Node for the specified length of time.
[n] minute(s)
138
Node is
reconnected
Send a message when the Exceed TurboX Server re-establishes a
connection with an Exceed TurboX Connection Node, after the node had
been unreachable.
ETX Proxy has
crashed
Send a message when the Exceed TurboX session proxy process
terminates abnormally. The message includes a link to more information
about the crash.
Proxy Manager
has crashed
Send a message when the Exceed TurboX Proxy Manager terminates
abnormally.
Free disk space
on node falls
below [n] GB
Send a message when the free space on the Exceed TurboX Connection
Node falls below the specified value.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.12. Setting up automated messages
Average CPU
usage of node
is above [n] %
for more than
[n] minute(s)
Send a message when the average CPU usage of the Exceed TurboX Proxy
is more than the specified percentage for the specified length of time.
You can choose the following message types under For administrators – Other
events:
2.12.2
License Server
is unreachable
for [n]
minute(s)
Send a message when the Exceed TurboX License Server cannot be
reached by Exceed TurboX Server for the specified length of time.
License Server
is reconnected
Send a message when the connection with the Exceed TurboX License
Server is re-established, after the License Server had been unreachable.
License usage
exceeds [n] %
of total
Send a message when the license usage exceeds the specified maximum
percentage.
A user account
is locked
because of too
many failed
sign-in
attempts
Send a message when a user account is locked after too many consecutive
failed sign-in attempts.
A user is
running more
than [n]
sessions
Send a message when a user is running more than the specified number of
sessions.
Configuring message options
The settings in the Message options area of the Messages page allow you to
configure general options for handling system-generated messages.
To configure general message options:
1.
Navigate to the Site Settings > Messages page.
2.
In the Message options area, select the check box for each message option that
you want to enable.
3.
Click Save.
You can configure the followings message options:
Delete
messages older
than [n] day(s)
CONETX120501-AGD-EN-3
If this option is enabled, Exceed TurboX deletes all messages older than
the defined number of days.
Server Manager Administration Guide
139
Chapter 2 Managing Exceed TurboX as an administrator
Users can
change
message
options in user
settings
2.12.3
Allow users to set their own message settings in the Messages tab of the
User settings dialog box.
Enabling email messages for users and administrators
Exceed TurboX sends messages to users and administrators via the internal Exceed
TurboX messaging system. In addition, you can use the Email server settings to
configure Exceed TurboX to send copies of all messages via email.
To enable email messages for users and administrators:
1.
Navigate to the Site Settings > Messages page.
2.
In the Email server area, select Enable email server.
3.
Configure the Email server settings.
4.
Click Send test email to ensure a connection can be established between the
configured email server and Exceed TurboX.
5.
Click Save.
Note: If you select Enable email server but do not configure all the
required settings, you will not be able to save your changes.
You can configure the followings Email server settings:
140
SMTP server
The email server that will be used to send email messages to users and
administrators.
Port
The port number of the email server.
Use SSL/TLS
Select this option to encrypt the connection between the email server and
Exceed TurboX.
Send from
The name that will appear as the sender of the email messages.
Username
Password
The user name and password that will be used to send emails from
Exceed TurboX to users and administrators.
Send test email
Click this button to verify whether the connection between the email
server and Exceed TurboX can be established correctly. The connection is
tested using the credentials defined in Username and Password.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.13. Configuring default user permissions and settings
2.13 Configuring default user permissions and
settings
The New User Settings tab of the Site Settings page allows you to:
• Configure user settings, roles, and permissions for new users.
• Configure how the sign-in page is presented to users when they sign in to the
Exceed TurboX web interface for the first time.
• Apply settings, roles, and permissions to existing users who belong to user
groups.
Tip: You can modify settings, roles, and permissions for individual users from
the Users and Profiles page. See “Modifying user settings, roles, and
permissions for individual users” on page 82 for more information.
To configure new user settings:
1.
Navigate to the Site Settings > New User Settings page.
2.
In the User registration area, modify the settings to configure how the sign-in
page and user registration process is presented to users when they sign in to
Exceed TurboX for the first time.
3.
In the Default user preferences area, configure the default user preferences to
be assigned to new users when their accounts are created.
4.
In the Default user settings area, configure the default user settings to be
assigned to new users when their accounts are created.
5.
Click Save.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
141
Chapter 2 Managing Exceed TurboX as an administrator
If you modified any settings, the Changing new user settings dialog box opens.
6.
In the Changing new user settings dialog box:
• To apply the updated settings to new users and all existing users, in the
Apply default setting changes to existing users list, select All users. Click
Yes.
• To apply the updated settings to new users only, in the Apply default
setting changes to existing users list, select No. Click Yes.
• To apply the updated settings to new users and a group of users, in the
Apply default setting changes to existing users list, select the user group to
apply the changes to. Click Yes.
• To close the Change new user settings dialog box without saving the
changes for any users or groups, click No.
You can configure the following User registration settings on the New User
Settings page:
New users can
sign in to
register an
account
Allows users with valid security credentials to sign in to Exceed TurboX,
even if they do not have an Exceed TurboX user account. When they sign
in for the first time, Exceed TurboX will create a new user account for
them.
Clear this option to allow only existing Exceed TurboX users to sign in to
the Dashboard.
Default role for Select the role that will be assigned to all new users at the time of
new users
registration by default. If no role is selected, User is applied by default.
Note: You can modify the user role for individual users in the Users
pane. See “Modifying user settings, roles, and permissions for
individual users” on page 82 for more information.
You can create and customize the user roles that are listed here. See
“Configuring user roles” on page 149 for more information.
142
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.13. Configuring default user permissions and settings
Hide user
settings during
registration if
user
information is
known
Hides the sign-in dialog box that is normally displayed when a new user
signs in for the first time, if the user’s full name and email address can be
retrieved by Exceed TurboX Server. How Exceed TurboX retrieves this
information depends on the authentication type:
• If you are using OTDS or LDAP authentication, Exceed TurboX
retrieves the full name and email address from the LDAP or OTDS
user record, as defined on the Site Settings > Authentication page. If
the information is not available in the user record, it can be retrieved
by the scripts defined on Site Settings > Authentication.
• If you are using PAM or Native authentication, the full name and
email address are retrieved using the scripts defined on the Site
Settings > Authentication page.
If the full name and email address cannot be retrieved and added to the
user record, the first-time sign-in dialog box will be displayed, even if this
setting is enabled. The user can then enter their full name and email
address. For example, this will happen if there is no script defined to
retrieve the information with PAM or Native authentication, or if the
script does not return any information.
For more information, see “Configuring user authentication settings”
on page 110.
Verify client
launcher
during
registration
Launches the Client Compatibility Wizard when a user signs in to
Exceed TurboX for the first time. The Client Compatibility Wizard is
used to verify the Client Launcher. If the Client Launcher is not installed
when the user signs in, the user is prompted to install it.
If this option is not enabled, the Client Launcher will not be verified when
the user signs in for the first time.
If the Launcher is pre-installed on the user’s machine, you may want to
clear this option as the user will not need to verify or install the Launcher.
Show
registration
message
(replaces signin message)
Displays the registration message instead of the sign-in message when the
user signs in for the first time.
Use the Registration message title and Registration message boxes to
customize the registration message.
Clear this option to have the sign-in message display instead. For more
information about the sign-in message, see “Configuring general site
settings” on page 95.
You can configure the following Default user preferences settings on the New User
Settings page:
Always allow
desktop
shortcuts to
resume
suspended
sessions
CONETX120501-AGD-EN-3
Allows profile shortcuts launched from the user’s desktop to resume any
suspended sessions based on the same profile instead of launching a new
session.
For more information, see “Working with shortcuts” in Exceed TurboX
Dashboard and Client Help.
Server Manager Administration Guide
143
Chapter 2 Managing Exceed TurboX as an administrator
Sorting order
of sessions and
profiles in
Dashboard
icons view
Select Date or A-Z to define how sessions and profiles will be sorted for
users in the Exceed TurboX Dashboard. The default setting is Date.
Users can update this setting in the Exceed TurboX Dashboard.
You can configure the following Default message settings on the New User
Settings page:
Session is
terminated by
an
administrator
Send a message when an administrator terminates one or more sessions
that the user owns.
Session is
suspended by
an
administrator
Send a message when an administrator suspends one or more sessions
that the user owns.
Session is
terminated due
to idle timeout
Send a message when one or more sessions that the user owns have been
terminated by Exceed TurboX after they have been suspended for a
defined period of time. This function is controlled by the Terminate
suspended session after [n] [units] option in the Default user settings
area.
Session is
suspended due
to idle timeout
Send a message when one or more sessions that the user owns have been
suspended by Exceed TurboX because there has been no session activity
for a defined period of time. This function is controlled by the Suspend
idle session after [n] minute(s) option in the Default user settings area.
Session is
suspended for
more than [n]
hour(s)
Send a message when one or more sessions that the user owns have been
suspended for longer than the specified time period. If you enable this
option, you must enter the time period in hours.
Send a
reminder
message every
[n] [units] after
initial warning
Send reminder messages if one or more sessions that a user owns has been
suspended for longer than the time period defined in Session is
suspended for ore than [n] hours.
Suspended
session is
terminated due
to timeout
Send a message when one or mores sessions that the user owns have been
terminated due to timeout.
Send a warning Send a message when one or more suspended sessions that the user owns
message [n]
are about to be terminated. The message indicates when the suspended
[units] before
session will be terminated.
timeout
This option is available if Suspended session is terminated due to
timeout is selected.
144
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.13. Configuring default user permissions and settings
Send a
reminder
message every
[n] [units] after
initial warning
Send reminder messages if one or more sessions that a user owns is about
to be suspended due to timeout. If you enable this option, you must enter
the frequency of the reminder messages in minutes, hours, or days.
ETX Proxy has
crashed
Send a message when the Exceed TurboX session proxy terminates
abnormally, causing a session that the user owns to terminate. The
message includes a URL linking to more information about the crash.
Session is
reassigned
Send a message when a session that the user owns is reassigned by an
administrator. The message includes the session title and node on which it
was started. The message to the user that started the session includes the
username of the new session owner. The message to the session owner
includes the name of the previous session owner.
Account is
locked because
of too many
failed sign-in
attempts
Send a message when the user’s account is locked after too many
consecutive failed sign-in attempts. This function is controlled by the Lock
users out of ETX Server after [n] consecutive failed sign-in attempts
option in the Security settings.
This option is available if Suspended session is terminated due to
timeout is selected.
Profile is edited Send a message when an administrator modifies one or more profiles that
by an
the user own. The message contains the names of the modified profile(s).
administrator
API key is
created
Send a message when the user creates an API key. Users who do not have
permission to create API keys receive a message when an Exceed TurboX
administrator creates an API key on their behalf.
Receive a copy
of all messages
via email
If this option is enabled, Exceed TurboX sends a copy of all messages to
the user’s email. If this option is not enabled, messages are delivered to
the user’s Exceed TurboX Dashboard only. If you enable this option, you
must enable and configure the email server. See “Enabling email messages
for users and administrators” on page 140.
You can configure the following Default user settings for Session control on the
New User Settings page:
Resume
sessions from
anywhere
If this option is enabled, users will be able to resume suspended sessions
from any client computer. If this option is not enabled, users will only be
able to resume suspended sessions from the client computer on which the
session was suspended.
Suspend idle
sessions after
[n] minute(s)
Automatically suspends the user’s session if no activity occurs within a
session for the specified period of time. Enter the period of time in
minutes.
Terminate
suspended
sessions after
[n] [units]
Terminates suspended sessions automatically after the specified period of
time. Enter the time period in minutes, hours, or days.
CONETX120501-AGD-EN-3
Clear this option to let sessions remain suspended indefinitely.
Server Manager Administration Guide
145
Chapter 2 Managing Exceed TurboX as an administrator
Limit number
of sessions to
[n]
Defines the maximum number of sessions the user can have running at
one time.
Share sessions
Allows the user to share sessions.
Clear this option to let users run an unlimited number of sessions.
You can configure the following Default user settings for Profile control on the
New User Settings page:
Create profiles
Allows users to create profiles.
Note: If users are not allowed to create profiles, an administrator
must create and distribute the appropriate profiles to the user.
Otherwise, the user can use only the default profiles.
Copy personal
profiles
Allows users to create copies of personal profiles.
A separate option, Copy group profiles, controls the ability of users to
copy group profiles.
Note: If users are not allowed to copy profiles, an administrator
must create and distribute the appropriate profiles to the user.
Otherwise, the user can use only the default profiles.
Edit personal
profiles
Allows users to edit their personal profiles.
This option enables administrators to distribute personal profiles to users
either with or without the ability to modify those profiles.
Delete personal Allows users to delete their personal profiles.
profiles
This option enables administrators to distribute personal profiles to users
either with or without the ability to delete those profiles.
146
Copy group
profiles
Allows users to create copies of group profiles.
View details of
group profiles
Allows users to view group profile details in Exceed TurboX Dashboard.
A separate option, Copy personal profiles, controls the ability of users to
copy personal profiles.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.13. Configuring default user permissions and settings
Customize
group profiles
Allows users to customize group profiles in Exceed TurboX Dashboard,
instead of copying a profile and making changes. A user with this
permission can customize any setting in a group profile that is not locked
in the template. Users cannot modify the profile’s title.
The profile customizations are saved only for that user and are not visible
to other users. Only custom settings that are different from the group
profile are saved. Saving custom settings does not create a new group
profile. If a user duplicates a group profile, custom settings are applied to
the new profile.
Users’ custom settings are preserved if a profile property is changed by an
administrator but is not locked. If a user or a profile is deleted, custom
settings associated with that user are also deleted.
When distributing group profiles, if Keep original profile is not selected,
the distributed profile preserves custom user settings. If Keep original
profile is selected, a copy of the profile is created that does not preserve
custom user settings. See “Distributing profiles to users or user groups”
on page 190 for more information.
The user will also be able to modify existing Xstarts. When an Xstart is
deleted, associated custom Xstarts are also deleted.
If Customize group profiles is not enabled, profile details are read-only. If
an administrator locks a property in the group profile, or if the user’s role
is changed from User, the user’s custom settings are ignored .
Access
Allows users to edit profiles in Advanced mode in Exceed TurboX
advanced mode Dashboard.
If this option is not selected, users are allowed to edit profiles in Basic
mode only.
If the Show REST API tooltips option is enabled, users who open a
profile in Advanced mode will see the Show REST API tooltips checkbox
at the top of the profile window. If the user selects this checkbox, REST
API tooltips are enabled for each profile option, and will be shown when
the user hovers their cursor over an item. REST API tooltips show the
attribute name and a list of valid and current values for the option. In
some cases, the tooltips also include a description of the attribute. The
content of the tooltips is selectable for copy and paste operations.
The Access advanced mode setting is always enabled for non-User roles.
Show REST API tooltips is disabled by default.
You can configure the following Default user settings for General operations on the
New User Settings page:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
147
Chapter 2 Managing Exceed TurboX as an administrator
Allowed
Clients
Specifies whether users can use any client, only the Native Client, or only
the Web Client to launch sessions. This setting overrides any setting at the
profile or user level. For example, if you set this to Native Client only,
and there is a profile that is set to Web Client only, no one will be able to
launch a session using that profile.
Note: The Native Client includes more features than the Web
Client, and in many configurations also offers better performance.
In most cases, we recommend you use the Native Client, if possible.
However, this does require that each user install the Client
Launcher on their local system. Use the Web client if you do not
want to install any software locally, on devices where the Native
Client is not supported, or if you do not want to use the Native
Client for any other reason.
Access REST
APIs
Allows the user to access the Exceed TurboX REST API web interface,
make REST API calls, and access the API keys tab in the User settings
dialog box.
If the Access REST APIs web portal option is enabled, the user’s Web
application selector list includes the REST API option. Otherwise, the
REST API item is hidden.
If this option is not enabled and the user tries to access the api/URL
directly, they will be redirected back to the Dashboard.
Note: The Access REST APIs setting is always enabled for non-User
roles.
The Access REST APIs web portal option is disabled by default.
Blocking a user's access to REST APIs does not prevent the Client
Launcher from working.
Refresh
snapshots
Automatically refreshes the thumbnail images of user sessions in Exceed
TurboX Dashboard.
View full
resolution
image
Allows the user to view a full-sized version of the session snapshots in
Exceed TurboX Dashboard.
View log
Allows users to view a session’s log file from the Exceed TurboX Client
Menu.
If this option is cleared, the user can view thumbnail images only.
If this option is cleared, the View Log option on the Exceed TurboX Client
Menu is unavailable.
148
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.14. Configuring user roles
2.14 Configuring user roles
The User Roles tab of the Site Settings page allows you to:
• Create, copy, modify, and delete user roles.
• View the permissions assigned to each role.
• View the number of users assigned each role.
Note: You cannot assign user roles on this page. For information about
assigning user roles, see “Modifying user settings, roles, and permissions for
individual users” on page 82.
You can view the following information on the User Roles tab:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
149
Chapter 2 Managing Exceed TurboX as an administrator
Name
The name of the user role. The following standard user roles are created
by default:
• Admin (Built-in): The administrator role tasked with setting up
•
•
•
•
•
Exceed TurboX. You cannot create, edit, copy, delete, assign, or
reassign this role.
Admin (Full Access): By default, this user role has the Unrestricted
permission enabled, which grants full access to Exceed TurboX. You
can assign edit, copy, and delete this role.
Admin (Read Only): For system auditors and other users who require
the ability to view information but who do not need to modify settings.
You can assign, edit, copy, and delete this role.
Session Manager: Can manage sessions and nodes, and make changes
to node-related settings. All other settings in Server Manager are viewonly. You can assign edit, copy, and delete this role.
Technical Support: Can make changes to sessions, nodes, profiles.
templates, user accounts, and user groups. All other settings in Server
Manager are view-only. You can assign edit, copy, and delete this role.
User: Users who are permitted to sign in to, and perform all actions in
Exceed TurboX Dashboard. This user role has no access to Exceed
TurboX Server Manager. You can assign edit, copy, and delete this
role.
For more information about the standard user roles, see “Working with
user roles” on page 70.
For information about assigning, creating, copying, editing, and deleting
user roles, see “Managing user roles” on page 152.
To view all the available permissions, see “Viewing permissions in the
user role dialog box” on page 151.
Total
permissions
The number of permissions that are enabled for the user role.
To view the permissions enabled for a user role, see “Managing user
roles” on page 152.
To view all the available permissions, see “Viewing permissions in the
user role dialog box” on page 151.
Total users
The number of users that are currently assigned the user role.
Note: To update the information that appears on this page, click the Refresh
button
in the top-right corner.
You can customize which columns appear, and the order in which they appear.
See “Showing and hiding columns in Exceed TurboX Server Manager grids”
on page 39 for more information.
150
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.14. Configuring user roles
2.14.1
Viewing permissions in the user role dialog box
The user role properties dialog box displays a list of all the available user
permissions, as well as a description of each permission.
You can use this dialog box to view the permissions associated with a particular user
role. You can also use this dialog box to edit the name and permissions associated
with a user role. See “Managing user roles” on page 152 for more information.
You can access the user roles dialog box in one of two ways:
•
Click the Add new role button
on the User Roles page.
The user role dialog box is displayed. You can create a user role with a unique
name and permissions. See “Managing user roles” on page 152 for more
information.
•
Click the Properties button
view or edit.
in the action column of the user role you want to
The user role dialog box for the user role is displayed. Permissions that are
enabled for the user role are marked with a check mark. You can edit the name of
the user role, and the permissions assigned to that role. See “Managing user
roles” on page 152 for more information.
In the user role dialog box, the permissions are listed on the left, under Permission.
A description of each permission is listed on the right, under Description. Scroll
through the list to view all the available permissions.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
151
Chapter 2 Managing Exceed TurboX as an administrator
2.14.2
Managing user roles
The User Roles tab of the Site Settings page allows you to create, copy, edit, and
delete user roles.
Note: You cannot assign user roles on this page. For information about
assigning user roles, see “Modifying user settings, roles, and permissions for
individual users” on page 82.
You can create a new user role by adding a new user role, or by copying and
modifying an existing user role.
To add a new user role:
1.
Click the Add new role button
.
The new role dialog box is displayed.
2.
At the top of the new role dialog box. enter a name for the user role.
3.
Under Permissions, select the permissions that will be enabled for the new role.
If you select Unrestricted, all the permissions will be enabled.
4.
Click Save.
The new user role is displayed on the User Roles pane.
152
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.14. Configuring user roles
To copy and modify an existing user role:
1.
In the Actions column of the user role you want to copy, click the Copybutton
.
The Copy a role dialog box appears, displaying the name of the user role you
are copying.
2.
In the Role name field, enter a name for the new user role.
3.
Click Save.
The new user role is displayed on the User Roles pane.
4.
In the Actions column of the user role you created, click the Properties button
.
The the user role’s properties dialog box is displayed, showing the same
permissions as the user role you copied.
5.
In the user role’s properties dialog box, modify the permissions by selecting and
deselecting permissions, as required.
6.
Click Save.
Note: The users assigned to the role you copied are not transferred to the copy.
To assign users to the copy, see “Modifying user settings, roles, and
permissions for individual users” on page 82.
In addition to the User Roles pane, any user roles you create are also listed in
the Role drop down list of the user settings dialog box, and in the Default role
for new users list. See “Modifying user settings, roles, and permissions for
individual users” on page 82, and “Configuring default user permissions and
settings” on page 141, respectively, for more information.
You can change the name and permissions associated with an existing user role.
To edit a user role:
1.
In the Actions column of the user role you want to edit, click the Properties
button
.
The properties dialog box for that user role appears.
2.
Perform the relevant tasks to edit the user role:
• To change the name of the user role, click the Click to Edit button
type a new name for the user role.
, and
• To change the permissions associated with the user role, under Permissions,
selected or deselect permissions, as needed.
3.
Click Save to save your changes.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
153
Chapter 2 Managing Exceed TurboX as an administrator
To delete a user role:
1.
In the actions column of the user role you want to delete, click the Delete button
.
2.
When prompted to confirm the deletion, click Delete.
Note: The Admin (Built-in) user role cannot be deleted.
A role cannot be deleted if Default role for new users is set to that role. See
“Configuring default user permissions and settings” on page 141 for more
information.
A role that is assigned to at least one user cannot be deleted. Before deleting a
user role, make sure that it is not assigned to any users. See “Modifying user
settings, roles, and permissions for individual users” on page 82 for
information about reassigning user roles.
2.15 Managing runtimes
The Runtimes tab of the Site Settings page allows you to manage the runtimes for
your Exceed TurboX site.
Exceed TurboX runtimes, issued as updates by OpenText, allow administrators to
update both the client and node, which must be at the same version level for the
product to function. The Runtimes page lists all available runtimes, one of which
must be designated as the default runtime.
Every time a user starts a session, the Client Launcher checks if the client runtime
version specified in the profile is available in the cache on the user’s machine. If not,
the launcher contacts Exceed TurboX Server to download the correct runtime before
launching the remote session. This means that on a slow network, there will be a
delay launching a session with a new client runtime version for the first time. The
Proxy part of the runtime is automatically pushed out to all connected nodes
whenever a new runtime is added on the Runtimes page in Server Manager. This
ensures that runtimes are always available to all clients and nodes.
The correct runtime version is determined as follows:
• The Client Versions available for launching profiles are limited to the currently
installed and enabled runtime versions. You can set the Runtime version for a
profile on the General tab of Advanced mode, or on the Other tab of Basic mode.
For more information, see “Working with Profiles“ on page 183.
• If you remove or disable a specific runtime, any profile configured to use that
runtime reverts to the default runtime version.
Note: Starting with Exceed TurboX 11.5.4, the display drivers required for
Windows Desktop - Direct multi-user access are part of the Exceed TurboX
Runtime file. To manually update these drivers to a version later than 11.5.4,
154
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.15. Managing runtimes
install a runtime which contains a driver package that has a higher version
than the currently installed drivers. When you start a new Windows Desktop Direct session on your machine using the new runtime, the new session will
use the new display drivers. If you have any active sessions, the drivers update
will take place only after all active sessions have been stopped, when the first
new session starts again. In some cases, a full reboot may be required before
the system can use the new display drivers.
The Runtimes page provides the following information:
Version
The runtime version.
Client
platforms
The client platforms where you can use the runtime.
Node platforms The node platforms where you can use the runtime.
Type
The runtime type.
Actions
The actions you can perform on a runtime. To view the available actions,
position the pointer over the Actions column. The available action icons
appear when there are two or more runtimes installed. For more
information, see “Designating, disabling, and removing runtimes”
on page 156.
Note: To update the information displayed on this page, click the Refresh
button in the top-right corner.
To add a runtime, click the Add runtime
See “Adding runtimes” on page 155.
2.15.1
button in the top-right corner.
Adding runtimes
This section describes how to add (install) a runtime using Server Manager.
To add a runtime:
1.
On the Site Settings page, click Runtimes.
2.
Click the Add runtime
icon.
The Add runtime dialog box opens.
3.
Click Choose a file to upload, and then browse to and select the runtime file
(.zip) sent to you by OpenText.
4.
Review the Runtime details area in the Add runtime dialog box to verify that
you have selected the correct file.
5.
Click Install.
When the installation is complete, the Runtimes page updates and the new
runtime is displayed in the list.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
155
Chapter 2 Managing Exceed TurboX as an administrator
If the new runtime is not visible, click the Refresh runtimes icon in the top-right
corner of the page.
2.15.2
Designating, disabling, and removing runtimes
This section describes how to disable or remove a runtime using Server Manager. It
also describes how to designate a runtime as the default version.
More than one runtime must be available before you can disable, designate, or
remove a runtime.
To designate the default client/node version:
1.
On the Site Settings page, click Runtimes.
2.
Position the pointer in the Actions column of the runtime that you want to
make the default. The available action icons appear.
3.
Click the Make default
icon.
The Change the Default Runtime Version dialog box opens. It informs you
that you are about to make the current version the default runtime version for
all future sessions.
4.
Click Yes.
Any profile that does not have a specific version associated with it will now be
launched using this runtime.
To disable a runtime:
1.
On the Site Settings page, click Runtimes.
2.
Position the pointer in the Actions column of the runtime that you want to
disable. The available action icons appear.
3.
Click the Disable runtime
icon.
The Disable runtime dialog box opens.
4.
Click Yes.
Any profiles that specifically use this runtime version will revert to using the
default runtime.
To remove a runtime from the library:
1.
On the Site Settings page, click Runtimes.
2.
Position the pointer in the Actions column of the runtime that you want to
remove. The available action icons appear.
3.
Click the Remove runtime
icon.
The Remove runtime dialog box opens.
156
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.16. Configuring security settings
4.
Click Yes.
Any profiles that specifically use this runtime version will revert to using the
default runtime.
2.16 Configuring security settings
The Security tab of the Site Settings page allows you to configure Exceed TurboX
security settings, including session, Website, HTTP proxy, and API settings.
You can configure the following Session settings on the Security page:
Use TLS
between client
and proxy
Ensures that all connections between Exceed TurboX Client and Exceed
TurboX Proxy (all session communication) use TLS for secure connections.
This option is enabled by default.
If this setting is disabled, the Session title displays the words [Not
Secure].
Important
All nodes must have SSL keys and certificates with the same
encryption level.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
157
Chapter 2 Managing Exceed TurboX as an administrator
Block client
Blocks the following operations when the fingerprint of a server certificate
connections if
from a connecting node does not match the fingerprint of a certificate
node certificate received from the Exceed TurboX Server:
validation fails
• Launching a new session.
• Resuming a suspended session.
• Joining a shared session.
This mismatch may be caused by an MITM (man-in-the-middle) attack,
and the connection may not be secure. Should this occur, an error message
is displayed, informing the user about the security issue and that the client
connection is blocked. Otherwise, the session is launched, resumed, or
joined normally, without prompts to accept the connection certificate.
Clear this option to allow the Exceed TurboX Clients to skip the
fingerprint verification of certificates.
Allow file
transfer and
printing
Allows file transfer and printing on the Exceed TurboX site.
Clear this option to disable the file transfer and printing features. If this
option is disabled, the file transfer and print options in the profile will be
ignored. See “Configuring File and print settings in Advanced mode”
on page 242for more information.
Use the Maximum file transfer size [n] MB text box to define the
maximum size, in megabytes, of the file to be transferred. The default
value is 0, indicating that there is no limit.
Note: If you clear this option, RDP drive redirection is disabled.
Enable fallback Uses the specified user account as proxy (created when a node under X
account for ETX Window was installed).
Proxy
Note: Consider the effects of enabling fallback accounts. For more
information, see “Understanding Exceed TurboX fallback accounts”
on page 103.
Enable fallback Uses the specified user account as fallback user for Xstart (created when a
account for
node under X Window was installed).
Xstart
Note: Consider the effects of enabling fallback accounts. For more
information, see “Understanding Exceed TurboX fallback accounts”
on page 103.
Hide insecure
startup
methods in
Xstart
158
Hides any startup methods that are not secure. Secure methods are Secure
Shell (SSH), Windows Application, and X Window Host Application. All
other startup methods are considered not secure.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.16. Configuring security settings
Authenticate
session
credentials for
X Window Host
Application
startup method
in Xstart
Enables authentication of session credentials when using the X Window
Host Application startup method and Use session credentials is selected
in the Xstart dialog box. For more information, see “Configuring Xstart
settings” on page 254.
If this option is not selected, Xstart continues the session without
authenticating the session credentials.
This option is unchecked by default.
You can configure the following Website settings on the Security page:
Enable “Keep
me signed in”
option
Makes the Keep me signed in check box available to users on the Exceed
TurboX sign-in page. Enabling this setting causes Exceed TurboX to store
encrypted user passwords in the database.
Note: This option requires LDAP, Native, or PAM authentication,
without Kerberos enabled. It is not recommended if you are using a
shared or public computer.
Lock users out
of ETX Server
after [n]
consecutive
failed sign-in
attempts
Automatically locks a user account after a specified number of
consecutive failed sign-in attempts. If this setting is enabled, the user
whose account was locked may try to sign in after the specified time
period. Otherwise they must contact the Exceed TurboX administrator to
unlock the account.
Automatically
Automatically unlocks a locked user account after a set time period. Enter
unlock after [n] the time period in minutes.
minute(s)
Sign users out
of ETX Server
after [n]
minute(s) of
inactivity
Automatically sign users out of the web interface after a period of
inactivity. Enter the time period in minutes.
Disable
inactive user
accounts [n]
day(s) after last
successful signin
Inactive user accounts will be disabled at the end of the period of
inactivity defined in this setting. The period of inactivity starts at the last
recorded log in time for the user. Inactive users who have been disabled
are prevented from signing in to Exceed TurboX.
Reject Server
Manager
requests on non
Server Manager
ports
If this setting is enabled, the Server Manager host must match the Server
Manager port.
Once an inactive user has been disabled, you can delete their profile
settings, or reactivate them. You may also use a script to delete multiple
inactive users in bulk.
If the Server Manager host and port do not match, any Server Manager
requests that are not connected to a Server Manager port will be rejected.
For information about configuring the Server Manager port number, see
“Configuring Server ports” on page 166.
This setting is disabled by default.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
159
Chapter 2 Managing Exceed TurboX as an administrator
Disable Help
icon in
Dashboard
If this setting is enabled, users will not be able to access Exceed TurboX
Help from the Dashboard. The Help icon
will be hidden from the
Dashboard, as well as any dialog boxes that appear as a result of using the
Dashboard.
When you enable this setting, the change is applied when a user refreshes
their Dashboard.
This setting is disabled by default.
You can configure the following HTTP proxy settings on the Security page:
160
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.16. Configuring security settings
Use proxy
If this option is enabled, Exceed TurboX Client uses an HTTP or HTTPS
server for client proxy server for session traffic between the end-user machines and the
connections
Connection Nodes. If this option is not enabled, Exceed TurboX Client
connects with the Node directly.
Use the following options to specify which proxy server will be used for
these connections:
• Use proxy server settings from client system: Proxy settings from the
end-user’s operating system will be used.
– Exceed TurboX Client will read the proxy information from
Windows or Linux System Settings. Mac Clients and some Linux
desktops do not support this option. To configure proxy settings on
these platforms, use the etx_proxy environment variable to
override the Server’s proxy settings. See Client override, below, for
more information.
– Proxy Auto-Config (PAC) proxy settings configured in the
Windows or Linux System Settings are supported, as long as the
PAC file returns the correct proxy information for all Connection
Node addresses.
Note: When configuring your PAC file, include proxy entries
for your Connection Nodes if they are deployed behind a
proxy. When a session is established, the Client system needs
to return the correct proxy information for the session node it
is connecting to.
• Use the following proxy server: Specify a proxy server in the
following format:
[http[s]://][<proxy_username>:<proxy_
password>@]<proxy_address>:<proxy_port>
– Items in square brackets are optional. The proxy address and proxy
port are required.
– The proxy address can be any client-resolvable IP address or
hostname.
– If the proxy does not require authentication, leave out <proxy_
username>:<proxy_password>@
• Additional proxy server chain list:
To enable multiple proxies (proxy chaining), select Use proxy server
for client connections, and enter a chain of proxy servers in the
Additional proxy server chain list box. If proxy chaining is enabled,
Exceed TurboX connects with each proxy server specified in the chain
before connecting with a Connection Node. If Exceed TurboX is unable
to establish a connection with the first proxy server in the list, the
remaining servers in the list are ignored.
In the Additional proxy server chain list box, specify a chain of proxy
servers in the following format, separating each entry with a comma:
[http[s]://][<proxy_username>:<proxy_
password>@]<proxy_address>:<proxy_port>
– Items in square brackets are optional. The proxy address and proxy
port are required.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
161
Chapter 2 Managing Exceed TurboX as an administrator
– The proxy address can be any client-resolvable IP address or
hostname.
– If the proxy does not require authentication, leave out <proxy_
username>:<proxy_password>@
Note: Proxy server chaining is supported on all Exceed TurboX
Clients that support the HTTP/ proxy server, and is backwardcompatible with older Runtimes.
The PAC file does not support proxy chaining.
Client override
In some cases, you may want to override the Exceed TurboX Server’s
proxy settings on specific client systems. For example, you may want to
specify a proxy server for the majority of users, but use a different proxy
for certain client machines. To allow for these scenarios, set the etx_
proxy environment variable to override proxy settings received from
Exceed TurboX Server.
The etx_proxy environment variable is supported on all platforms
(Windows, Linux, and Mac). It supports the following values:
• direct://
Exceed TurboX Client connects to the Connection Node directly,
without using a proxy, regardless of Exceed TurboX Server settings.
• system://
Exceed TurboX Client reads the proxy information from Windows or
Linux System Settings, including Proxy Auto-Config (PAC). Mac
Clients and some Linux desktops do not support this option. In
environments where this option is not supported, or if the system
settings do not specify a proxy server, Exceed TurboX Client reads the
proxy server settings from the Additional proxy server chain list box.
If proxy server settings are not defined, Exceed TurboX Client falls
back to direct://.
• [http[s]://][<proxy_username>:<proxy_
password>@]<proxy_address>:<proxy_port>
– Items in square brackets are optional. The proxy address and proxy
port are required.
– The proxy address can be any client-resolvable IP address or
hostname.
– If the proxy does not require authentication, leave out <proxy_
username>:<proxy_password>@. Alternatively, you may set
the etx_proxy_cred environment variable instead of specifying
credentials as part of etx_proxy. To do so, use the <proxy_
username>:<proxy_password> format.
162
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.16. Configuring security settings
Use proxy
server for
Client
Launcher
connections
Uses an HTTP or HTTPS proxy server for communication between the
Exceed TurboX Client Launcher and the Exceed TurboX Server. When a
session is launched, the Launcher communicates with Exceed TurboX
Server to download Client Launcher updates and the Client Runtime, and
may also pass settings to Exceed TurboX Server. These connections are
established during session launch, before the session connection to the
Connection Node.
Client Launcher proxy functionality and configuration is identical to Use
proxy server for client connections, with the following important
differences:
• The environment variable used to override server proxy settings is
etxlauncher_proxy instead of etx_proxy.
• To store proxy credentials in a separate environment variable, use
etxlauncher_proxy_cred instead of etx_proxy_cred.
• When configuring Proxy Auto-Config (PAC), ensure that a valid proxy
is specified for all Exceed TurboX Server addresses (and/or load
balancer addresses, if applicable).
You can configure the following REST API settings on the Security page:
Allow basic
authentication
for API calls
Allows the Exceed TurboX Server to accept basic authentication for REST
APIs.
Clear this option to force API key-based authentication for all users.
Allow users to This permission takes effect only if the Access REST APIs setting in the
create API keys New User Settings tab is also enabled. (See “Configuring default user
permissions and settings” on page 141).
When both settings are enabled, the user:
• can generate API keys using the User settings dialog box > API keys
tab.
• receives a notification when an API key is created, provided that the
API key has been created notification is enabled in the user settings.
access
the Exceed TurboX Server API interface in order to generate API
•
keys or call the /v2/apikeys APIs.
Note: The Access REST APIs setting is always enabled for non-User
roles. Many of the REST APIs are for administrative functions and
are not available to users. Some APIs are also hidden from non-full
administrators. For a list of permissions by user role and API, see
“Appendix B: REST API Permissions” in the Exceed TurboX REST
API User Guide.
Users can create Allows users to create never-expiring API keys using the API keys tab in
never-expiring the user settings or by calling the appropriate REST APIs.
API keys
Clear this option to disable the Never expiration option and block any API
calls with the expiry set to Never. In this case, Exceed TurboX
administrators can still create never-expiring API keys on behalf of the
users by using the REST APIs web interface, and users are able to use the
API keys generated for them by the administrators.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
163
Chapter 2 Managing Exceed TurboX as an administrator
Allow API calls Restricts the IP addresses and subnets from which Exceed TurboX REST
only from
API calls can be invoked. This adds additional security to your
subnets
environment.
Enabling this option does not prevent the Client Launcher from working.
You can enter multiple IP addresses or subnets as space-separated items
in the list of allowed subnets. The following IPv4 and IPv6 formats are
supported:
•
•
•
•
192.168.2.1
192.168.2.0/24
fe80:0:0:0:0:0:c0a8:11
fe80:0:0:0:0:0:c0a8:1/120
You can configure the following Client Launcher settings on the Security page.
Allow Client
Restricts the IP addresses and subnets from which Client Launcher
Launcher
commands can be invoked.
commands only
You can enter multiple IP addresses or subnets as space-separated items
from subnets
in the list of allowed subnets. The following IPv4 and IPv6 formats are
supported:
•
•
•
•
192.168.2.1
192.168.2.0/24
fe80:0:0:0:0:0:c0a8:11
fe80:0:0:0:0:0:c0a8:1/120
If you enable this feature and do not enter any IP addresses or subnets, no
Client Launcher commands will be permitted.
This option is disabled by default.
2.17 Configuring Exceed TurboX Server settings
The Configuration tab page on the Server Settings page tab allows you to configure
various Exceed TurboX settings for this Server:
• Port settings. For details, see “Configuring Server ports” on page 166.
• Kerberos settings. For details, see “Configuring Kerberos settings” on page 168.
• Memory allocation settings. For details, see “Configuring memory allocation
settings” on page 168.
• Logging options. For details, see “Configuring logging options” on page 169.
This page also allows you to switch Exceed TurboX Server to maintenance mode, for
performing special administrative tasks (for example, server replication). For more
information, see “Switching the Server to maintenance mode” on page 165.
164
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.17. Configuring Exceed TurboX Server settings
Note: Some configuration changes may require a Server restart to take effect.
Other configuration changes may require the Server to switch to maintenance
mode.
Note: Exceed TurboX administrators can also configure these settings from
shell, using the %server_install_path%/bin/etxsvr config command.
2.17.1
Switching the Server to maintenance mode
The Maintenance mode allows Exceed TurboX you to perform special administrative
tasks that affect all users (for example, network infrastructure changes, server
replication, etc.). In this mode:
• Your Server Manager session remains active.
• Users cannot sign in to the Exceed TurboX Dashboard or the REST APIs web
interface. A message on the Dashboard sign-in page indicates that the Server is in
maintenance mode.
• Users who are already signed in are automatically signed out, notified that the
Server is in maintenance mode, and redirected to the sign-in page.
• Active and suspended sessions are not affected, and session controls are still
available on the Exceed TurboX menu.
To switch the server to maintenance mode:
1.
In the General area, click Switch to maintenance mode.
The Switch to maintenance mode dialog box opens.
2.
To modify the default message displayed to Exceed TurboX users while the
Server is in maintenance mode, edit the Show the following message to users
box.
3.
Click Yes to confirm the operation.
The Server is switched to maintenance mode and you can now perform any
administrative tasks that require the Server to be in this mode.
The server Configuration page is updated as follows:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
165
Chapter 2 Managing Exceed TurboX as an administrator
• Server status changes to Maintenance mode.
• The Switch to maintenance mode button changes to Switch to live mode.
• The Maintenance message box displays the message to be shown to users
while the Server is in maintenance mode.
To switch the server to live mode:
1.
In the General area, click Switch to live mode.
The Switch to live mode dialog box opens.
2.
Click Yes to confirm the operation.
The Server is switched to live mode. The changes made are applied to your
Server and any connections are re-initialized as necessary.
The server Configuration page is updated as follows:
• Server status changes toRunning.
• The Switch to live mode button changes to Switch to maintenance mode.
• The Maintenance message box is not displayed.
2.17.2
Configuring Server ports
You can configure the following Ports for Dashboard and REST APIs settings on
the Server Settings > Configuration page:
Note: Exceed TurboX Dashboard and Server Manager have the same default
port settings.
Ports for Exceed TurboX Dashboard and Server Manager can be independently
enabled/disabled.
Enable HTTP
on port
Enables communication via unsecured connections (non-SSL) for Exceed
TurboX Dashboard and REST APIs.
When enabled, specify the port number to be used by Exceed TurboX
Dashboard and REST APIs for unsecured connections. The default value
is 8080.
Enable HTTPS
on port
Enables communication via secured connections (SSL) for Exceed TurboX
Dashboard and REST APIs.
When enabled, specify the port number to be used by Exceed TurboX
Dashboard and REST APIs for secured connections. The default value is
8443.
You can configure the following Ports for Server Manager settings on the Server
Settings > Configuration page:
Note: Exceed TurboX Dashboard and Server Manager have the same default
port settings.
166
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.17. Configuring Exceed TurboX Server settings
Ports for Exceed TurboX Dashboard and Server Manager can be independently
enabled/disabled.
Enable HTTP
on port
Enables communication via unsecured connections (non-SSL) for Exceed
TurboX Server Manager.
When enabled, specify the port number to be used by Exceed TurboX
Server Manager for unsecured connections. The default value is 8080.
Enable HTTPS
on port
Enables communication via secured connections (SSL) for Exceed TurboX
Server Manager.
When enabled, specify the port number to be used by Exceed TurboX
Server Manager for secured connections. The default value is 8443.
You can configure the following Port options setting on the Server Settings >
Configuration page:
Redirect HTTP
to HTTPS
Select this check box to redirect all HTTP requests (received on the
specified HTTP port) to HTTPS (to the specified HTTPS port). This
ensures that all connections to the Exceed TurboX Server web interfaces
are encrypted with SSL, and that users who try to access the Server via
HTTP arrive at the secure HTTPS sign-in page rather than seeing a “404”
error.
Note: REST API HTTP connections are not redirected to HTTPS,
because some clients may not handle them correctly if redirected.
To configure the Server ports
1.
Modify the Ports for Dashboard and REST APIs, Ports for Server Manager,
and Port options settings, as necessary.
Note: You must specify different ports for HTTP and HTTPS connections.
2.
Click Save.
If you disabled the Server Manager port for the currently logged in protocol
(HTTP or HTTPS), but the other protocol is still enabled, this configuration
change will end your current web session and require you to re-authenticate
with the Server Manager. In the dialog box that opens, click Disable {HTTP/
HTTPS} port to confirm the operation. You will be directed to the Server
Manager sign-in page.
If you disabled both HTTP and HTTPS Server Manager ports, this configuration
change will end your current web session. You will be able to access the Server
Manager again only after re-enabling these ports via command line instructions.
In the dialog box that opens, click Disable Server Manager to confirm the
operation.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
167
Chapter 2 Managing Exceed TurboX as an administrator
2.17.3
Configuring Kerberos settings
You can configure the following Kerberos settings for Kerberos single sign-on
authentication, on the Server Settings > Configuration page:
Keytab file
The path to the Kerberos keytab file located on the Exceed TurboX Server
host (for example, /etc/krb5.keytab).
Service
principal name
The name of the Kerberos service principal (for example, HTTP/
@EXAMPLE.COM).
Test
Click this button to verify that Kerberos requests authentication.
To configure Kerberos settings:
1.
Modify the Kerberos settings provided on the Configuration page as desired.
2.
Click Save.
Some configuration changes may require a server restart, to take effect; other
configuration changes may require the server to switch to maintenance mode.
2.17.4
Configuring memory allocation settings
You can configure the following Memory allocation settings on the Server Settings
> Configuration page:
Maximum Java
heap size
Define the maximum value of the Java heap. Select one of the following
options:
• Percentage of total system memory: Defines the size of the Java heap
as a percentage of the total system memory. Indicate the maximum
value as a percentage. The default value is 50%.
• Specified amount: Defines the size of the Java heap as a fixed value.
Enter the amximum size in megabytes. The default value is 4000 MB.
Maximum
The maximum value of the memory allocated for the etxdb, in
shared memory megabytes. The default value is 128 MB.
for etxdb
To configure the memory allocation settings:
1.
Modify the Memory allocation settings, as desired.
2.
Click Save.
These configuration changes will take effect only after you restart the Server. In
the dialog box that opens, click OK to confirm the operation.
If you want the changes to take effect immediately, restart the Server via
command line instructions.
168
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.17. Configuring Exceed TurboX Server settings
2.17.5
Configuring logging options
You can configure the following Logging options settings on the Server Settings >
Configuration page:
Log level
The level of detail to include in server logs that you can view and
download on the Server Settings > Server Logs page (for details, see
“Reviewing Server logs” on page 170). You can select one of the following
options: Trace (most verbose), Debug, Info (default value), Warn, and
Error (least verbose).
Log filter
Enter a filter string. Exceed TurboX Server uses this to collect additional
information for troubleshooting server issues.
Enable web
access logs
Collects information about accessing the Exceed TurboX Server web
interface and makes these logs available for review on the Server Settings
> Server Logs page (for details, see “Reviewing Server logs” on page 170).
A log file is generated daily for the number of days specified in Delete
web access logs after [n] day(s).
Compress old
web access log
files
Compresses Exceed TurboX web access log files into *.zip files. You can
download these files from the Server Settings > Server Logs page (for
details, see “Reviewing Server logs” on page 170).
This option is available only if Enable web access logs is enabled.
Delete web
The number of days to retain access log files on the Server. This setting
access logs after determines the number of access log files made available for review on the
[n] day(s)
Server Settings > Server Logs page.
Web access log
format
Use this field to specify the format of the Web access logs (such as
combined/extended or common). If this field is left empty, the default
format will be used.
• To configure the combined/extended log format, enter the following
string:
LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%
{User-agent}i\"
• To configure the common log format, enter the following string:
LogFormat "%h %l %u %t \"%r\" %>s %b"
To configure the logging options:
1.
Modify Logging options, as desired.
2.
Click Save.
If you modified the Delete web access logs after [n] day(s) value, the
configuration change will take effect only after you restart the Server. In the
dialog box that opens, click OK to confirm the operation. If you want the
change to take effect immediately, restart the Server via command line
instructions.
All other changes to logging options are saved and applied to the Server
immediately.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
169
Chapter 2 Managing Exceed TurboX as an administrator
2.18 Reviewing Server logs
The Server Logs page on the Server Settings tab allows you to monitor the Exceed
TurboX Server logs. You can download a package containing all the Server log files
or display a selected Server log file on this page.
To view a Server log:
1.
Select a file from the Log file list. The list includes the following types of log
files:
• etxsvr.log: Provides information about the Exceed TurboX Server activity.
• Web access log files: Provide information about accessing the Exceed
TurboX Server web interface. This information is collected daily if the
Enable web access logs setting is enabled on your Server. The number of
access log files depends on the value specified on the Delete web access logs
after [n] day(s) setting for your Server. For more information about these
settings, see “Configuring Exceed TurboX Server settings” on page 164.
2.
Click View.
The log file is displayed.
Note: A Search for dialog box opens automatically. It allows you to
perform a search to locate specific strings within the log. For more
information, see “To search for strings in the opened Server log:“
on page 171.
The View button is unavailable if the Compress old web access log files
option is enabled on your server. In this case, these files can be
downloaded but not viewed in the Server Manager.
170
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.18. Reviewing Server logs
To download a Server log:
1.
Select a file from the Log file list.
2.
Click Download.
3.
The file is downloaded using your browser’s download feature.
To download a package of all Server logs:
1.
Click Download all server logs (.zip).
2.
The file is downloaded using your browser’s download feature.
To search for strings in the opened Server log:
1.
Click View to display the Search for box if it is not shown.
2.
In the Search for box, type the string to search for.
3.
Click the following icon(s) to restrict the search results to specific option(s):
RegExp Search
Search using wildcard characters (for example, *). The search finds all
items that contain the sequence of characters that you specify, and
may include other unspecified characters.
CaseSensitive
The search finds only occurrences of the string that match the
capitalization you type.
Search
Whole Word
Search
The search finds only occurrences of the complete string you type in
the text box.
To disable a search option, click its icon again.
The first search match is highlighted in the <Filename.log> pane.
4.
Click the Previous
and Next
icons to navigate the log file and review
the search results one by one, or click the All
results that match your search criteria.
5.
To close the Search for dialog box, click the Close
CONETX120501-AGD-EN-3
icon to highlight all the
icon.
Server Manager Administration Guide
171
Chapter 2 Managing Exceed TurboX as an administrator
2.19 Monitoring the Server status
The Server Status page on the Server Settings tab allows you to monitor the health
of the main server and track resource usage. Real-time graphs display up to 24 hours
of historical data. Select the timeframe of the historical data to display from the list.
2.20 Monitoring Exceed TurboX events
The Activity Log tab page on the Maintenance page allows you to monitor events
related to sessions and the Exceed TurboX system.
The Activity Log page provides the following information:
172
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.20. Monitoring Exceed TurboX events
Type
Event type, based on severity:
• Info: A regular Exceed TurboX operation has occurred successfully
(for example, a user signed in to Exceed TurboX). These events do not
require further action.
• Warning: An event that may require further action.
• Error: A regular Exceed TurboX operation has failed (for example, a
proxy crash). These events may require further action.
Date
The date and time at which the event occurred.
Message ID
The message ID of the event. Each event has a unique numeric identifier.
For more information, see “Appendix A: Understanding activity log
events“ on page 315.
Username
The name of the user who caused the event, if applicable.
IP Address
The IP address of the client on which the event occurred, if applicable.
Server
The Server where the event was generated, when working in a cluster
environment.
Node
The Connection Node the event pertains to, if applicable.
Display
The display ID used by the session in which the event occurred, if
applicable.
Event
A brief description of the event.
Actions
The actions you can perform on an event. To view the available actions,
position the pointer in the Actions column. The available action icons
appear when there is more than one runtime installed.
•
: View details about the selected event. See “Viewing event
Details
details” on page 174 for more information.
The following action icons are displayed at the top-right corner of the Activity Log
pane:
Export activity
log
Remove event details from the Activity Log page and save them to
a .csv file. See “Archiving event details” on page 175 for more
information.
Refresh view of Click this button to update the information displayed in this pane.
activity log
Search for
events
Change view
CONETX120501-AGD-EN-3
Perform a search to locate one or more specific events. See “Searching for
events” on page 176 for more information.
Use the Change view dialog box to customize the columns that are
displayed in this grid. See “Showing and hiding columns in Exceed
TurboX Server Manager grids” on page 39 for more information.
Server Manager Administration Guide
173
Chapter 2 Managing Exceed TurboX as an administrator
2.20.1
Viewing event details
The Activity Log tab page on the Maintenance page contains information about
events related to sessions and the Exceed TurboX system. You can use this
information for monitoring and troubleshooting purposes.
To display information about a particular event in the Activity Log:
1.
Place the pointer in the Actions column of the event you want to view.
2.
Click the Details button
.
The Event dialog box opens and displays detailed information about the event.
3.
To save the event details to a .txt file, click Download. If prompted, save the
file to your computer.
The Event details dialog box displays the following information:
Event ID
The ID of the event, which is a 36-character string in the form xxxxxxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx.
Message
A brief description of the event.
Message ID
The unique message ID of the event. See “Appendix A: Understanding
activity log events“ on page 315 for more information.
Type
Event type, based on severity:
• Info: A regular Exceed TurboX operation has occurred successfully
(for example, a user signed in to Exceed TurboX). These events do not
require further action.
• Warning: An event that may require further action.
• Error: A regular Exceed TurboX operation has failed (for example, a
proxy crash). These events may require further action.
174
Date
The date and time when the event occurred.
Source
Where the event originated.
Server
The Server where the event was generated, when working on a cluster
environment.
IP Address
The IP address of the client the event occurred on, if applicable.
Username
The name of the user who caused the event, if applicable.
Node
The server node on which the event occurred.
Display
The display ID used by the session in which the event occurred, if
applicable.
Session ID
The session ID, which is a 36-character string in the form xxxxxxxx-xxxxxxxx-xxxx-xxxxxxxxxxxx.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.20. Monitoring Exceed TurboX events
Object type
The type of object described in an event:
•
•
•
•
Object ID
2.20.2
User
Profile/Template
Node Group
User Group
The object identifier, which is a 36-character string in the form xxxxxxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx.
Archiving event details
For maintenance purposes, you can remove event details from the Activity Log page
in Exceed TurboX Server Manager, and save the event details to a .csv file. You can
also specify whether the event details will be permanently removed from the Exceed
TurboX database.
To archive event details:
1.
On the Maintenance page, click the Activity Log tab.
2.
Click the Export activity log button
3.
In the Export activity log dialog box, at Export records from, select a date range
for archiving event details.
4.
At Time zone, select the time zone for the entries that will be archived.
5.
(Optional): To permanently remove event details from the Exceed TurboX
database for the specified date range, select Purge records from database after
export.
6.
Click Export.
7.
If prompted, save the archive file.
CONETX120501-AGD-EN-3
.
Server Manager Administration Guide
175
Chapter 2 Managing Exceed TurboX as an administrator
Details of the events that occurred between the dates you specified are saved in
this file.
Note: The file displays event information according to your current view
settings. To customize the columns that are displayed, use the Change view
dialog box. See “Showing and hiding columns in Exceed TurboX Server
Manager grids” on page 39 for more information.
2.20.3
Searching for events
You can perform a search to locate specific events within the Activity Log page. You
can perform a search based on multiple search parameters, including date range,
message ID, event type, and more. Searches are case insensitive.
To search for events:
1.
On the Maintenance page, click the Activity Log tab.
2.
Click the Search for events button
3.
In the Search for events dialog box, specify the search parameters.
.
Type
The event type (Any, Info, Warning, Error, or Fatal).
Date from/to
The date range to search.
Message ID
A numeric message ID. For more information, see “Appendix A:
Understanding activity log events“ on page 315.
Username
The full or partial name of the user who performed the event.
IP Address
A full or partial client IP address.
Node
The full or partial name of the node on which the event occurred.
Display
The display ID of the client on which the event occurred.
Session ID
The session ID. You can search for the entire ID, which is a 36character string in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
or for a partial ID (for example, the first 8 or 13 characters).
Object type
The object type: Any, User, Profile/Template, Node, or Group.
Object ID
The object ID. You can search for the entire ID, which is a 36character string in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
or for a partial ID (for example, the first 8 or 13 characters).
Note: Wildcard characters (for example, *) are not supported. If needed,
enter a partial string to perform a search.
Click Clear to clear all search parameters.
4.
Click Search.
The search results are displayed on the Activity Log page. One or more labels at
the top of the page display the current search criteria. For example:
176
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.21. Creating reports
To clear the search results, click the close button (that is, the x) on the right side of
each label.
2.21 Creating reports
This section describes the reporting capabilities of Exceed TurboX. Reports help
administrators monitor, optimize, and troubleshoot the system.
The Reports page on the Maintenance tab allows you to generate the following
types of reports:
• Sessions: Information about sessions launched by users, including the total
number of sessions launched or resumed and their durations.
• Licenses: Information about available licenses. The information included in these
reports depends on the license model used on your site. When a License Server is
not installed, the license model is considered to be “Local”. If a License Server is
installed, the license model is considered to be “License Server” and it is possible
to distinguish between “Local” and “Global” license usage. For more
information, see “Licenses reports” on page 179.
• Top Users: Information about Exceed TurboX user activity, ranked in order of
session and license consumption.
2.21.1
Configuring and generating reports
This section describes how to configure and generate Exceed TurboX reports.
Note: When you open it, the Reports page displays a report based on the
default query parameters.
To configure and generate a report:
1.
On the Maintenance page, click the Reports tab.
2.
Select the report type: Sessions, Licenses, or Top Users.
The left pane updates to display the query parameters available for the selected
report type.
3.
Select the query parameters for your report. For more information about query
parameters, see:
• “Sessions reports” on page 178
• “Licenses reports” on page 179
• “Top Users reports” on page 181
4.
For Sessions and Licenses reports only: If the Frequency parameter is set to
Hour, use the Time zone drop-down list to select one of the following options:
UTC
CONETX120501-AGD-EN-3
Show query results based on Coordinated Universal Time.
Server Manager Administration Guide
177
Chapter 2 Managing Exceed TurboX as an administrator
Local (UTC <time shift>)
Use local time as specified in your browser. The time shift from UTC
is indicated in parentheses.
Tip: If you change this selection after you generate a report, click Query
again to update the graph.
5.
Click Query.
The report is shown in the right pane.
6.
Review the information presented in the right pane.
The Sessions and Licenses reports include a graph and a table. For more
information, see “Sessions reports” on page 178 and “Licenses reports”
on page 179. You can export the reports as graph data or raw data to CSV files.
For more information, see “Downloading report data” on page 182.
The results for the Top Users queries are displayed in a list. For more
information, see “Top Users reports” on page 181.
2.21.2
Sessions reports
The following parameters are available for Sessions queries:
• Date: Select the query period.
Last 24 hours
24 hours of data, starting from the current hour (rounded down) of the
previous day. For example, if you start this query at 13:15 local time,
results are displayed starting at 13:00 from the previous day.
Today
Up to 24 hours of data, starting from 00:00 (local time) of the current
day.
Yesterday
24 hours of data, starting at 00:00 (local time).
Last Week
Seven days of data, starting from Sunday of the previous week.
Last Month
One month of data, starting on the first day of the previous month.
Custom
Click the start and end dates to access the calendar windows and
select the dates you want.
• Frequency: Select the intervals to chart. The intervals available for selection
depend on the specified Date period.
178
Date selection
Available Frequency options
Last 24 hours
Hour
Today
Hour
Yesterday
Hour
Last Week
Hour, Day
Last Month
Day, Week
Custom
Depends on the entered query period.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.21. Creating reports
• Filters: The availability of query filters depends on the selected report type and
on other filter settings. For example, if you specify a User, the User group box is
unavailable.
Session
All: All active and suspended sessions.
Active: Only sessions that are currently running.
Suspended: Only sessions that have been suspended, whether the
sessions are still suspended or not.
Shared: Only sessions that users have shared.
Node
The node to restrict the query to.
Node group
The node group to restrict the query to.
User
The user to restrict the query to.
User group
The user group to restrict the query to.
Profile
A specific profile to restrict the query to.
The Sessions report table includes the following data:
2.21.3
Sessions
launched
The total number of times sessions were launched, including multiple
launches by the same user.
Sessions
resumed
The total number of times sessions were resumed, regardless of when they
were suspended.
Top time
consumer
The name of the user who launched the longest-running session.
Avg duration
(Active)
The average duration that sessions were active.
Avg duration
(Suspended)
The average duration that sessions were suspended.
Licenses reports
The following parameters are available for Licenses queries:
• Date: Select the query period.
Last 24 hours
24 hours of data, starting from the current hour (rounded down) of the
previous day. For example, if you start this query at 13:15 local time,
results are displayed starting at 13:00 from the previous day.
Today
Up to 24 hours of data, starting from 00:00 (local time) of the current
day.
Yesterday
24 hours of data, starting at 00:00 (local time).
Last Week
Seven days of data, starting from Sunday of the previous week.
Last Month
The previous month, starting on the first of the month.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
179
Chapter 2 Managing Exceed TurboX as an administrator
Custom
Click the start and end dates to access the calendar windows and
select the dates you want.
• Frequency: Select the intervals to chart. The intervals available for selection
depend on the specified Date period.
Date selection
Available Frequency options
Last 24 hours
Hour
Today
Hour
Yesterday
Hour
Last Week
Hour, Day
Last Month
Day, Week
Custom
Depends on the query period you specified.
• Usage: Available only if your site uses a “License Server” license model.
Local
Information about local license usage.
Global
Information about combined license usage by all the members of the
License Server.
• Filters: The availability of query filters depends on the selected report type and
on other query parameters. For example, if you set Usage as Global, the User
group box is unavailable.
User group
Specify the user group to restrict the query to.
The Licenses – Local report table includes the following data:
Maximum
usage
The maximum number of licenses in use locally at any one time. This is
also displayed as a percentage of the total licenses available.
Top time
consumer
The individual user who occupied a license for the most time.
Peak usage in a The day on which local license use peaked.
day (last 7
days)
Peak usage (last The number of local licenses in use at peak usage.
7 days)
The Licenses – Global report table includes the following data:
180
Maximum
usage
Number of licenses in use during the query period, by all and any
members of the License Server. See also “Managing licenses” on page 127.
Top time
consumer
The License Server member who occupied a license for the most time.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
2.21. Creating reports
Peak usage in a The day on which global license use peaked.
day (last 7
days)
Peak usage (last The number of global licenses in use at peak usage.
7 days)
2.21.4
Top Users reports
The following parameters are available for Top Users queries:
• Date: Select the query period.
Last 24 hours
24 hours of data, starting from the current hour (rounded down) of the
previous day. For example, if you start this query at 13:15 local time,
results are displayed starting at 13:00 from the previous day.
Today
Up to 24 hours of data, starting from 00:00 (local time) of the current
day.
Yesterday
24 hours of data, starting at 00:00 (local time).
Last Week
Seven days of data, starting from Sunday of the previous week.
Last Month
The previous month, starting on the first of the month.
Custom
Click the start and end dates to access the calendar windows and
select the dates you want.
• Filters:
User group
The user group to restrict the query to, or leave blank to include users
in all groups.
The Top Users report includes the following data:
Username
The user name assigned to the user, as defined in the corporate
environment in which Exceed TurboX Server is installed.
Full name
The user’s full name, as specified in the user settings set up in Exceed
TurboX Dashboard.
Active hours
Total hours of active session usage.
Suspended
hours
Total hours of suspended session usage.
Total hours
Total hours of active and suspended session usage.
Max active
Maximum number of concurrently active sessions.
Max suspended Maximum number of concurrently suspended sessions.
License used
(%)
CONETX120501-AGD-EN-3
Percentage of time that a license was consumed.
Server Manager Administration Guide
181
Chapter 2 Managing Exceed TurboX as an administrator
Notes
• To update the information displayed in this pane, click the Refresh view of
top users
button at the top-right corner of the pane.
• To download the Top Users report as a Comma Separated Values (CSV) file,
click the Download top users
2.21.5
button at the top-right corner of the pane.
Downloading report data
This section describes your options for downloading (exporting) query results after
you generate a report. For Sessions and Licenses reports, you can download two
types of data generated by your query: Graph data and raw data. For a Top Users
report, you can download the raw report data.
To download report data:
1.
Generate the required report. See “Configuring and generating reports”
on page 177.
2.
In the top-right corner of the chart pane, click the relevant action icon:
Download
graph data
Download raw
data
3.
182
Downloads the graph information as a Comma Separated Values
(CSV) file. Available only for Sessions and Licenses reports.
Downloads a CSV file containing the raw event data for the specified
query period.
Complete downloading the file using your browser’s download feature.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Chapter 3
Working with Profiles
This section includes an overview of Exceed TurboX profiles and templates, and
provides detailed information about how to create and customize profiles using the
Exceed TurboX web interface.
3.1 About profiles
This section provides an overview of Exceed TurboX profiles.
Profiles define what happens when a user launches a remote session. They can be
defined by both administrators and users, if the users have the needed permissions.
Profiles may include:
• Which application or desktop to launch in a remote session
• How to authenticate the session for single sign-on
• The Exceed TurboX runtime version to use
• Window and monitor settings
• Keyboard and locale
• Copy and paste options
• File transfer settings
• Security settings
• Logging settings
To launch a session, Exceed TurboX users must have access to at least one profile.
An Exceed TurboX administrator may distribute pre-configured profiles to users, or
distribute profile templates to allow users to create profiles of their own. Any
number of profiles can be created to accommodate different session and application
requirements.
The settings available for users to configure may vary, depending on which
properties are locked in the underlying template.
For detailed information about profile settings, see “Customizing profiles in
Advanced mode” on page 194.
The following types of profiles are available:
• Group profiles are profiles that have been distributed to more than one user or
user group. Group profiles cannot be edited by users, as changes to group
profiles would affect other users of the profile. Group profiles can only be
CONETX120501-AGD-EN-3
Server Manager Administration Guide
183
Chapter 3 Working with Profiles
modified by Exceed TurboX administrators. However, users with the proper
permissions can copy a group profile to create a new user profile, or customize a
group profile’s settings for their own use.
Users with the Copy group profiles permission may copy a group profile and
modify the copy to suit their needs. Properties that are locked in the underlying
template appear as read-only and cannot be modified. Copied profiles are only
visible to the user who created the copy. Changes made to a copied profile do not
affect other users.
Users with the Customize group profiles permission may change settings in a
group profile. Properties that are locked in the underlying template appear as
read-only and cannot be modified. The settings are modified for the user only.
The group profile maintains its original settings for other users. Users with
Customize group profiles enabled are also able to customize existing Xstarts.
See “Configuring user permissions” on page 79 for more information.
The difference between copying and customizing a group profile is that copying
the profile creates a new profile for the user’s use while leaving the original
group profile in place. The user can launch a session using either the original
group profile or the copy with their modified settings. Customizing a profile
does not create a new profile. Instead, it modifies the group profile settings for
the user who performs the customization. When the user launches a session
using the group profile, the profile uses their customized settings instead of the
original group settings.
New installations include default templates and group profiles for each startup
mode. These default profiles and templates contain optimal settings and provide
a good starting point for creating and distributing new profiles.
• A user profile is a profile created in one of the following ways:
184
–
By a user with the Copy group profiles or Copy personal profiles
permission, who duplicated a group profile or a user profile.
–
By a user with the Create profiles permission, who created a new profile
based on an existing template.
–
By a user or administrator who imported profiles from an export file. All
imported profiles are initially distributed to the user who imported them.
–
By an administrator who distributed a profile to a single user.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.2. About profile templates
3.2 About profile templates
This section provides an overview of profile templates.
Exceed TurboX administrators can create and configure profile templates. Templates
can be used by administrators and users as a starting point for creating new profiles.
These templates contain administrator-specified profile settings. An administrator
may lock individual properties, property groups, and/or tab pages in a template to
ensure that profiles based on the template cannot change those values. Locked
properties appear as read-only in Exceed TurboX Dashboard.
When creating a new profile or template, users and administrators must base it on
an existing template. Templates created in this way are a copy of the existing
template, including locks and property settings. Profiles created from a template are
permanently linked to that template and respect all locks and default template
settings.
A new template must be published before any profiles based on the template can be
distributed to users. Unlike profiles, templates can only be published to the All
Users group. This makes the template appear in the list of available templates
whenever a user or administrator creates a new profile or template.
When an administrator updates a profile template in Exceed TurboX Server
Manager, the change is reflected in all profiles that are based on that template.
For detailed information about modifying profile templates, see “Creating and
editing profiles and templates” on page 188.
3.3 Creating and managing profiles and templates
This section describes how to create, edit, delete, import/export, distribute, and
manage profiles and templates in Exceed TurboX Server Manager. Templates can be
created or deleted in Exceed TurboX Server Manager by administrators only.
3.3.1
Viewing profile and template information
On the Server Manager Users and Profiles page, the Profiles and Templates pane
displays the following information about profiles and templates available on your
Exceed TurboX site:
Created on
The date and time when the profile was created.
Name
The name of the profile or template.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
185
Chapter 3 Working with Profiles
Type
The type of item, which can be one of the following:
• Group profile: A profile that has been distributed to a user group by
an administrator. The name of the group to which the profile was
distributed is displayed in the Access column.
• User profile: This can be one of the following types of user profiles:
– A profile that was created by an individual user in Exceed TurboX
Dashboard. The name of the user who created the profile is
displayed in the Access column.
– An administrator-defined profile that has been distributed to an
individual user, but not to any groups. The name of the user to
which the profile was distributed is displayed in the Access
column.
– An administrator-defined profile that has not yet been distributed
to any users or groups. The name of the administrator who created
the profile is displayed in the Access column.
• Template: A profile template that was created by an administrator.
Access
The name of the user or group that has access to the profile or template.
Startup mode
The startup mode defined in the profile or template: Custom startup,
Published Application, Windows Application, Windows Desktop - Direct,
Windows Desktop - RDP, XDMCP Broadcast, XDMCP Query.
Window mode
The window mode defined in the profile or template: Single or Multiple.
Screen size
If Single Window is set as the default window mode, the window size
value that is defined in the profile or template.
Runtime
version
The Exceed TurboX runtime version to be used when the profile launches
a remote session.
Actions
The actions you can perform on this profile or template. To view the
available actions, position the pointer in the column. See “Using Action
icons to manage profiles and templates” on page 187 for information
about each action icon.
The following action icons are available at the top right corner of the Profiles and
Templates pane:
Export profiles
and templates
Save a copy of the current view of the pane. See “Exporting Exceed
TurboX Server Manager lists” on page 39 for more information.
list
Import profile / Import a profile or template. See “Exporting and importing a profile or
template” on page 189 for more information.
template
New profile /
template
186
Create a new profile or template. See “Creating and editing profiles and
templates” on page 188 for more information.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.3. Creating and managing profiles and templates
Refresh view of Click this button to update the contents of the pane.
profiles /
templates
Search for
profiles /
Perform a search to locate one or more specific entries. See “Searching in
Exceed TurboX Server Manager lists” on page 41 for more information.
templates
Change view
Customize which columns appear, and the order in which the columns
appear. See “Showing and hiding columns in Exceed TurboX Server
Manager grids” on page 39 for more information.
Maximize view Click this button to see an expanded view of the pane. See “Maximizing
and minimizing Exceed TurboX Server Manager panes with lists”
on page 38 for more information.
3.3.2
Using Action icons to manage profiles and templates
This section describes the action icons you can use to manage profiles and templates.
You can view, edit, copy, import/export, distribute, or delete profiles and templates.
To do so, use the following icons in the Actions column for the profile or template:
Properties
Opens the profile details dialog box, where you can view and edit the
profile or template parameters. See “Customizing profiles in Advanced
mode” on page 194 and “Viewing linked profiles” on page 193 for more
information.
Copy
Creates a copy of the profile or template. You can use this to create a new
profile or template based on an existing one. See “Copying or deleting a
profile or template” on page 192 for more information.
Distribute
Distributes a profile to specific users or user groups. See “Distributing
profiles to users or user groups” on page 190 for more information.
Publish
Publishes a template to all users. See “Publishing templates to all users”
on page 192 for more information.
Export
Delete
CONETX120501-AGD-EN-3
Exports the profile or template. See “Exporting and importing a profile or
template” on page 189 for more information.
Deletes the profile or template. You can delete a template only if it is not
associated with a profile that is in use. See “Copying or deleting a profile
or template” on page 192 for more information.
Server Manager Administration Guide
187
Chapter 3 Working with Profiles
3.3.3
Creating and editing profiles and templates
This section describes how to create new profiles and templates, and edit existing
profiles or templates.
To create a profile or template:
1.
In the Profiles and Templates pane, click the New profile/template button
in the top-right corner of the pane.
The Select template dialog box opens.
2.
In the left pane, select the name of the template you want to base the new
profile or template on.
3.
Click Create template or Create profile.
4.
In the text box at the top of the new template/profile properties dialog box, type
a name for the new profile or template and press Enter.
5.
Optional Select Show REST API tooltips to display tooltips when hovering over
each profile option.
6.
Configure the profile or template, as needed. Click each tab in the left pane to
display different groups of settings. See “Customizing profiles in Advanced
mode” on page 194 for more information.
If you are creating a template, you can lock some of its options. To do so, click
the lock icon beside an option or option group. This will ensure that they are set
as read-only and cannot be modified by users.
Note: Locking a property in a template forces any linked profile(s) to use
this value. It also prevents the value from being changed inside any
profiles that are linked to this template.
7.
When you are finished, click Save.
If you have the appropriate permissions, you can now distribute the profile or
template to Exceed TurboX users and user groups. See “Distributing profiles to
users or user groups” on page 190 for more information.
To edit a profile or template:
188
1.
In the Profiles and Templates pane, move the pointer to the Actions column for
the template or profile you want to edit.
2.
Click the Properties button
3.
Make the required and permissible changes in relevant categories, and click
Save. See “Customizing profiles in Advanced mode” on page 194 for
information about each tab and field.
.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.3. Creating and managing profiles and templates
Note: Some options in default templates are locked and cannot be
modified.
3.3.4
Exporting and importing a profile or template
This section describes how to export and import a profile and its associated template
in XML format. Exporting a profile allows you to import the profile into another
Exceed TurboX instance or to provide the information to OpenText Global Technical
Services.
Note: You can export or import only one profile or template at a time.
To export a profile or template:
1.
In the Profiles and Templates pane, move the pointer to the Actions column for
the template or profile to export.
2.
Click the Export
3.
When prompted, confirm whether you want to open or save this template or
profile.
icon.
To import a profile or template:
icon in the top-right
1.
In the Profiles and Templates pane, click the Import
corner.
2.
When prompted, choose the XML file to import, then click Open to import the
file into Exceed TurboX.
Note: You can import profiles created from Exceed TurboX version 11.5.5
and later into Exceed TurboX version 12 and later. An error message is
displayed if you try to import an export file created from an unsupported
Exceed TurboX version.
3.
Click Close.
The XML file is uploaded to Exceed TurboX and the new profile or template
appears in the Profiles and Templates pane. The access rights to the XML file
are assigned to you, as the person who imported the file.
You can now distribute the profile or template to Exceed TurboX users. For
more information, see “Distributing profiles to users or user groups”
on page 190.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
189
Chapter 3 Working with Profiles
3.3.5
Distributing profiles to users or user groups
This section describes how to distribute profiles to users or user groups.
Exceed TurboX administrators can create profiles and make them available
(distribute them) to specific users or user groups in Exceed TurboX Dashboard.
Distributed profiles are visible only to the users or user groups to which they have
been distributed.
Note: New installations of Exceed TurboX contain Group Profiles, which are
distributed to all users. You may delete these profiles or distribute them to
different user groups.
If you plan to distribute a profile to an Exceed TurboX user group, you must
first create the user group in Exceed TurboX Server Manager. For more
information about creating, naming, and deleting users and user groups, see
“Managing users” on page 70 and “Managing user groups” on page 86.
The All Users group is a special group that includes all Exceed TurboX users.
Profiles distributed to the All Users group are available to all Exceed TurboX
users, including user accounts created after the profile is distributed.
To distribute a profile:
1.
In the Profiles and Templates pane, position the pointer in the Actions column
of the profile you want to distribute.
2.
Click the Distribute button
.
The Distributing profile dialog box opens.
3.
To search for a user or user group:
a.
Select one of the following options below the Candidates box to define the
scope of your search:
• All: Include users who have set up their Exceed TurboX user settings
and, if applicable, groups defined on an LDAP or OTDS server. This
option is selected by default.
• Users: Include only users who have set up their Exceed TurboX user
settings.
• User Groups: Include only user groups.
b.
In the Candidates box, type the full or partial name of the user or user
group you want to locate.
c.
Click the Search button
beside the Candidates box.
The search results are displayed in the left pane.
You can sort the results according to the Username/Group or Full name
column.
190
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.3. Creating and managing profiles and templates
Note: To clear the search results from the pane and perform another
search, click the Clear button
beside the Candidates box.
4.
In the left pane, select the names of the users or groups to distribute the profile
to. You can select multiple entries by left-clicking them.
5.
Click the Add user to group button
6.
Optional To delete the original profile after it has been distributed, clear the Keep
original profile check box.
.
Note: If this option is enabled, a copy of the profile that does not preserve
custom user settings is created.
If this option is not enabled, and if Customize group profiles is selected in
the user permissions, custom user settings will be preserved. See
“Configuring user permissions” on page 79 for more information.
7.
Optional To reuse the original profile template, select the Re-use existing
template check box.
Note: A single instance of a template is created when a profile is imported
from an older version of Exceed TurboX. This template is re-used when
profiles based on this template are distributed. If the Re-use existing
template check box is selected when a profile is distributed, and before the
template is cloned, the system will compare the profile’s template against
all existing templates (in order) until a matching template is found. All
settings, including the template name, must be identical for it to be
considered a match. If a match is found, the profile will reference the
existing template. If no match is found, or if the matching template is a
private template, a new template will be created and the new profile will
reference the new template.
8.
Click OK.
Note: If a profile has been distributed to a group of users, it is listed as a
Group Profile in the Profiles and Templates pane. For more information,
see “Viewing profile and template information” on page 185.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
191
Chapter 3 Working with Profiles
3.3.6
Publishing templates to all users
This section describes how to publish templates to all users.
Administrators can create templates and make them visible and available to all users
of Exceed TurboX Dashboard.
To publish a template:
1.
In the Profiles and Templates pane, position the pointer in the Actions column
of the template to publish.
2.
Click the Publish
icon.
The Publishing a template dialog box opens.
3.
3.3.7
To confirm publishing the template to All users, click Yes.
Copying or deleting a profile or template
This section describes copying or deleting a profile or template. You can create a
copy of a profile or template if, for example, you want to use it as the basis to create
another. You can also delete profiles or templates.
Note: To delete a template, you must first ensure that it is not linked with a
profile that is currently in use. A template cannot be deleted if it is linked with
a profile. If a template is linked, you can use the message feature to ask users to
delete any profile that links to the template you want to delete. They can create
a copy of the profile first.
To copy a profile or template:
1.
In the Profiles and Templates pane, position the pointer in the Actions column
of the profile or template to copy.
2.
Click the Copy
icon.
When you copy a profile, the Copy a profile dialog box opens.
When you copy a template, the Duplicating a template dialog box opens.
3.
In the dialog box, type a unique name for the new profile or template.
4.
Click Save.
A new entry appears in the Profiles and Templates pane.
You can now configure the parameters and/or permissions of the profile or
template you duplicated. For more information, see “Customizing profiles in
Advanced mode” on page 194.
192
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.3. Creating and managing profiles and templates
To delete a profile or template:
3.3.8
1.
In the Profiles and Templates pane, position the pointer in the Actions column
of the profile or template entry to delete.
2.
Click the Delete
3.
When prompted, click Yes to confirm that you want to delete this template or
profile. A template may not be deleted if it is linked to an existing profile.
icon.
Viewing linked profiles
This section describes how to view the list of profiles linked to a template.
To view the list of linked profiles:
1.
In the Profiles and Templates pane, position the pointer in the Actions column
of the template you want to view.
2.
Click the Properties
3.
In the template dialog box, click the Linked profiles tab.
icon.
The following information is displayed on the Linked profiles page:
Name
The name of the linked profile.
Type
The item’s type, either Group profile or User profile:
A Group profile has been distributed to a user group by an
administrator. The name of the group to which the profile was
distributed is displayed in the Access column.
A User profile is one of the following types:
• A profile that was created by a user in Exceed TurboX Dashboard.
The name of the user who created the profile is displayed in the
Access column.
• An administrator-defined profile that has been distributed to an
individual user, but not to any groups. The name of the user to
which the profile was distributed is displayed in the Access
column.
• An administrator-defined profile that has not yet been distributed
to any users or groups. The name of the administrator who
created the profile is displayed in the Access column.
Access
4.
The name of the user or group who has access to the profile or
template.
To update the contents of the pane, click the Refresh
corner of the pane.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
button in the top-right
193
Chapter 3 Working with Profiles
3.3.9
Using the profile toolbar in Exceed TurboX Server
Manager
This section describes the action icons included on the toolbar when editing a profile
in Exceed TurboX Server Manager.
Copy
Export
Delete
Help
Create a copy of the profile.
Export the profile and its associated template in XML format.
Delete the profile.
Access the Exceed TurboX Help. This icon is also available when creating
a profile.
3.4 Customizing profiles in Advanced mode
This section describes the profile settings.
Profile settings enable you to fine-tune Exceed TurboX performance and behavior to
suit specific network, security, application, and application host operating system
requirements.
To access these settings, edit or create a profile in the Server Manager Profiles and
Templates pane.
3.4.1
Configuring General settings in Advanced mode
This section describes the settings available on the General tab when you configure
profiles in Advanced mode.
The profile General tab lets you set the runtime version, icon, and privacy options
for the profile.
Select Show REST API tooltips to enable tooltips when you hover over options
displayed in this tab. REST API tooltips show the attribute name and a list of valid
and current values for the option. For some fields, the tooltip also includes the
attribute description . You can copy and paste the content of the tooltips.
194
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
You can configure the following settings on the General tab:
Runtime
version
If multiple versions of Exceed TurboX runtime are available, they are
shown in this drop-down list. Select the one for sessions launched from
this profile to use. Selecting Default uses the runtime version designated
by the administrator as the default.
To designate the default runtime version, see “Managing runtimes”
on page 154.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
195
Chapter 3 Working with Profiles
Client type
Select one of the following options to determine which Exceed TurboX
client sessions started with this profile will use:
• User preference: Use the client preference in the user’s settings to
select the client. See “Configuring your user settings” on page 18 for
more information.
• Native client: Use the Native Client.
• Web client: Use the Web Client.
Note: The Native Client includes more features than the Web
Client, and in many configurations also offers better performance.
In most cases, we recommend you use the Native Client, if possible.
However, it does require you to install the Client Launcher on your
local system. If you do not want to install any software locally, for
devices where the Native Client is not supported, or if for any other
reason you do not want to use the Native Client, use the Web Client.
Profile icon
The image you select will be used as the profile icon in the Dashboard.
The icon helps users easily identify a profile.
Allow
administrators
to view session
snapshot
Select this option to permit administrators to view snapshots of your
session.
Allow
administrators
to reassign
session to a
different user
Select this option to allow administrators to reassign a session started with
this profile to another user while the session is active or suspended.
Optional
settings
Enter string/value pairs for supported, but undocumented, flags. To
specify multiple flags, enter them on separate lines.
Note: If desired, you can lock this feature in the profile template so
that it cannot be modified by users.
Note: You can enter up to 4000 KB of text. All of the flags you enter
are listed in the proxy log if one is generated for troubleshooting
purposes.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.2
Configuring Input settings in Advanced mode
This section describes the settings available on the Input tab when you configure
profiles in Advanced mode.
The Input tab lets you configure keyboard input, mouse input, and touchscreen
settings. You can specify keyboard mapping files and configure the behavior of
modifier keyboard keys, such as ALT and CTRL.
196
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Note: Exceed TurboX provides a Keyboard Utility which allows administrators
to modify keyboard files provided with the product. This utility is available in
the Utilities\Keyboards\Xkeys folder on the installation DVD. For detailed
information about editing a keyboard file (.kbf), see the readme.txt file included
in the Utilities\Keyboards folder.
You can configure the following settings on the Input tab:
• Keyboard
Primary
keyboard file
CONETX120501-AGD-EN-3
Select Auto-select to let Exceed TurboX attempt to detect the type of
keyboard used on the client machine and use the corresponding
Keyboard Definition File, if it exists on the server. Alternatively, select
a keyboard definition file.
Server Manager Administration Guide
197
Chapter 3 Working with Profiles
Synchronize
with Windows
IME
Synchronizes the primary Exceed TurboX keyboard with the selected
Windows keyboard. This option also enables users to switch the
keyboard input language through keyboard shortcuts, without
accessing the Exceed TurboX Client menu.
If this option is enabled, when a session is started, resumed, or joined,
Exceed TurboX automatically selects the active Windows keyboard. If
Exceed TurboX does not have a keyboard that matches the new locale,
the keyboard switch is ignored. If the session is started or resumed
with an unknown keyboard, Exceed TurboX sets the English US
keyboard by default.
Note: This option is available if Primary keyboard file is set to
Auto-select.
If Synchronize keyboard with Windows IME is enabled in the
Client menu, the Exceed TurboX keyboard input is updated to
match any changes to the Windows IME.
198
Alternate
keyboard file
Switches easily between active keyboards inside a remote session. To
make a different keyboard language or layout available, select the
language or layout. Use the Input > Switch to Alternate Keyboard
command in the Windows Client menu to change languages.
Allow X clients
to modify
keyboard
mapping
Lets an X Window application modify the keyboard mapping.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Modifier keys
Alt Key, Windows/Cmd Key, Shift Key, Ctrl Key
For keyboards that contain two of a specific modifier key (such as
ALT, CTRL, and SHIFT), you can use the options to map the keys on
the left- and right-hand side of the keyboard separately. You can, for
example, map one modifier key to be processed by your local
Windows computer and the other modifier key to be processed by
your session (remote).
For Alt Key, Windows/Cmd Key, and Ctrl Key, you can select from
the following options:
– Left local, right remote—The left modifier key communicates with
your local computer and the right modifier key communicates with
your session.
– Right local, left remote—The right modifier key communicates
with your local computer and the left modifier key communicates
with your session.
– Both local—Both modifier keys communicate with your local
computer.
– Both remote—Both modifier keys communicate with the session.
For Shift Key, you can select from the following options:
– Map both left and right—The left and right SHIFT keys are
treated and interpreted separately.
– Map left as right—When you press either the left or right SHIFT
key, it is treated as a right shift.
– Map right as left—When you press either the left or right SHIFT
key, it is treated as a left shift.
Send Windows
keyboard
shortcuts to
remote host
Enables Exceed TurboX to send key sequences such as ALT-TAB to
the remote host.
Simulate AltGr Lets Exceed TurboX emulate the behavior of the ALTGR key. This is
with Right Alt useful when using European keyboards.
key
Suppress
NumLock
when
XKEYBOARD
extension
enabled
Suppresses the NumLock state when the XKEYBOARD extension is
enabled. This option is useful for some X applications that may not
accept keyboard and mouse events carrying NumLock states correctly
when NumLock is turned on.
• Mouse and touch
Middle button
emulation
Lets a two-button mouse emulate a three-button mouse in an
application window. When this option is enabled, simultaneously
clicking the left and right mouse buttons emulates a middle button.
Click interval
[n]
milliseconds
The maximum amount of time (in milliseconds) allowed between the
clicking of the left and right mouse buttons for the middle-button
emulation to occur. If you do not click the two buttons within this time
interval, the clicks are treated as two separate events.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
199
Chapter 3 Working with Profiles
Wheel
movement
sends button
4/5 event
Sends ButtonPress and ButtonRelease events to applications
when the mouse wheel is used to scroll up or down. If this option is
enabled, scrolling up sends Button4Pressand Button4Release
events. Scrolling down sends Button5Press and Button5Release
events.
Send touch
events to
remote host
Sends touch-screen events on the user’s device to the remote X host. If
this option is not enabled, touch-screen events are interpreted by the
local device.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.3
Configuring Startup settings in Advanced mode
This section describes the settings available on the Startup tab, when you configure
profiles in Advanced mode.
The Startup tab allows you to select the startup mechanism for sessions. There are
several types of startup modes:
Custom startup Launches a session and executes any Xstarts (applications or commands)
that you define. This mode can launch either X Window or Windows
applications or commands.
Unlike XDMCP modes, the Custom startup mode does not connect you to
an application host by default. Without additional configurations, Custom
startup mode only starts the proxy on the Connection Node. To start
applications on remote application hosts, you can either add one or more
Xstarts to automatically run applications, or you can launch without
defining any Xstarts, connecting instead to the host using remote
communication protocols, such as Secure Shell or TELNET, and run
commands manually.
See “Configuring Custom startup mode” on page 250 for more
information about configuring this startup mode.
Published
application
Runs an application that has been shared by an Exceed TurboX
administrator.
See “Configuring Published application startup mode” on page 269 for
more information about configuring this startup mode, .
200
Windows
desktop Direct
Launches a remote Windows desktop session using a proprietary protocol
developed by OpenText.
Windows
desktop - RDP
Launches a remote Windows desktop session.
See “Configuring the Windows Desktop - Direct startup mode”
on page 271 for more information about configuring this startup mode.
See “Configuring the Windows Desktop - RDP startup mode”
on page 274 for more information about configuring this startup mode.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
XDMCP
Broadcast
Launches a session in XDMCP Broadcast mode.
XDMCP Query
Launches a session in XDMCP Query mode.
See “Configuring XDMCP Broadcast startup mode” on page 275 For
more information about configuring this startup mode.
See “Configuring XDMCP Query startup mode” on page 277 for more
information about configuring this startup mode.
Windows
application
Runs Windows applications in Direct mode.
See “Configuring Windows application startup mode” on page 270 f or
more information about configuring this startup mode.
The Startup page in a profile template also includes the Configure modes button,
which allows you to configure the startup modes available in the Startup mode
drop-down list. For details, see “Restricting available startup modes” on page 201
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.4
Restricting available startup modes
Exceed TurboX administrators can restrict the list of startup modes available in a
profile by modifying the base template. For example, administrators may want to
disable XDMCP Broadcast or Windows Desktop - RDP protocols across the
application by disabling these items in all templates.
This section describes how to configure which startup modes are available in a
template and in any profiles linked to this template. This functionality is available
when you create or edit a profile template on the Server Manager Users and Profiles
page.
To restrict the available startup modes:
1.
On the Startup page of a profile template, click Configure modes.
The Available startup modes dialog box opens.
2.
Select the check boxes for the startup modes that should be available in this
template and in any profiles linked to this template.
3.
Click OK.
The Startup mode drop-down list on the Startup page on the template and on
any linked profiles is updated to display only the selected startup modes.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
201
Chapter 3 Working with Profiles
3.4.5
Configuring Session settings in Advanced mode
This section describes the settings available on the Session tab when you configure
profiles in Advanced mode.
The Session tab allows you to configure settings related to reusing, closing, and
suspending sessions.
You can configure the following settings on the Session tab:
• General
202
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Node targeting
When you launch a session, the Connection Node provides the
connection between your workstation and applications that you run in
the session. Select one of the following options to specify the
Connection Node to use for sessions based on this profile:
– Any node: Use any available node. If this option is selected, you
can select Ask user to select node (node group) to prompt the user
to select the node to use for each session.
– Any node group: Use any available node group. If this option is
selected, you can select Ask user to select node (node group) to
prompt the user to select the node group to use for each session.
– Specific node: Use a specific connection node. When you select
this option, the Node/Group name box is enabled. Click the Node/
Group name box and select the node to use.
Administrators can use this option to define custom load
balancing. For details, see “Configuring custom load balancing”
on page 101.
Note: If you are configuring a Published Application profile
and have specified an application startup host, that setting
overrides the Node targeting setting defined here. See
“Configuring Published application startup mode”
on page 269 for more information.
– Specific node group: Use a node belonging to a specific Node
Group. When you select this option, the Node/Group name text
box is enabled. Click the Node/Group name box and select the
Node Group to use. Exceed TurboX uses load balancing to select a
node from the Node Group for each session.
Note: If a selected node is disconnected or deleted, the
hostname appears in italics, in a strikethrough font. If all of the
nodes in a specified Node Group are disconnected or deleted,
the Node Group name appears in italics in a strikethrough font.
When Node targeting is set to Any node or Any node group, if
the load balancer selects a node and the session fails to start, the
load balancer will select a different node for the next launch, to
improve the likelihood that a working node will be selected.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
203
Chapter 3 Working with Profiles
Ask user to
select node
(node group)
If this option is enabled, the user is prompted to select the node or
node group to use for each session. The Select session node or the
Select session node group dialog box is displayed when the user
launches a session, showing the list of compatible nodes or node
groups for the session.
– If Ask user to select node (node group) is enabled and Node
targeting is set to Any node, the Select session node dialog box
displays all compatible nodes.
To restrict the list of nodes displayed in the dialog box, set Node
targeting to Node group, and set Node/Group name to the desired
node group. Only compatible nodes in the defined group will be
displayed.
– If Ask user to select node (node group) is enabled and Node
targeting is set to Any node group, the Select session node group
dialog box displays a list of node groups containing compatible
nodes.
For more information, see “Selecting the session node” in the Exceed
TurboX Dashboard and Client Help.
Note: Ask user to select node (node group) is not available
when Node targeting is set to Specific node or Specific node
group.
204
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Reuse session
Determines how and when sessions are reused, and which options are
displayed in the Select session dialog box when a user launches a
session from the Dashboard or a desktop shortcut. Reusing a session
means that applications started by an Exceed TurboX profile will open
within an existing active or suspended session instead of starting a
new session.
Select one of the following options to specify whether you want the
profile to launch a new session or reuse an existing session:
– Auto-select:
○ If the user has an active session that is compatible with the
profile being launched, the profile launches within that active
session. If the user has no compatible active sessions, the profile
launches in a new session.
Session compatibility is determined as follows:
• XDMCP Broadcast, XDMCP Query, Windows Desktop –
RDP, and Windows Desktop – Direct profiles are not
compatible with other sessions.
• Published application profiles are compatible with sessions
running on nodes that support the published application.
• Custom startup profiles are compatible with sessions
running on hosts that support the startup methods
contained in the profile. REXEC, RSH, RLOGIN, and Telnet
commands are not supported on Windows nodes. Windows
applications are only supported on Windows nodes. Secure
Shell commands are supported on all nodes.
• Custom startup profiles that contain different startup
methods may auto-reuse a session running on a node that is
not compatible with some of the startup methods. In this
case, any incompatible commands will not be executed.
– Ask User:
○ If the user has an active or suspended session that is compatible
with the profile being launched, the Select session dialog box
asks the user whether they want to launch the profile in a new
session, or select a compatible existing session.
See the Auto-select option for a description of the compatibility
rules.
– Never:
○ The profile always launches within a new session.
Note: Users who have Always allow desktop shortcuts to
resume suspended sessions enabled in their user settings, and
who launch the profile from a desktop shortcut, are asked
whether to resume a suspended session instead of launching the
profile in a new session.
For more information about the Always allow desktop
shortcuts to resume suspended sessions option, see
“Configuring your user settings” on page 18.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
205
Chapter 3 Working with Profiles
Session title
In Single Window mode, the text entered here appears in the Exceed
TurboX Client title bar and in the taskbar. In Multiple Window mode,
the title is displayed only in the taskbar. You can use the following
macros to insert values in the title:
– @a: The IP address of the Connection Node.
– @c: The IP address of the Client machine as reported by the Client.
– @d: the display specification of the session in the format
–
–
–
–
<hostname>:<display#>.
@h: The application server hostname.
@i: The application server IP address.
@n: The hostname of the Connection Node.
@s: The words [Not Secure] if the administrator has disabled
TLS for data passed between the desktop and proxy.
– @u: The user ID.
– @x: The name of the Exceed TurboX profile used to run the session.
– @#: The display number of the session.
For example, if 123.45.67.88:9 is your display specification,
then 9 is the display number.
– @@: The @ character.
Note: If you leave Session title empty, Exceed TurboX uses the
following default title: @s @d - @x - @u
(<hostname>:<display#> - <profile name> <userid>).
Group session
windows in
taskbar
If this option is enabled, all Exceed TurboX sessions will be grouped
under one taskbar icon.
If this option is disabled, each Exceed TurboX session will display its
own icon in your taskbar.
Note: This option is only available for Exceed TurboX Clients
running on Windows.
• Session management
The options in the Session management area allow you to configure Exceed
TurboX to suspend sessions automatically based on specified triggers. You can
also suspend sessions manually using the Suspend option in the Client menu for
the session.
206
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
User closes
session
Controls what happens when the session owner closes the session.
Select one of the following options:
– Prompt: Exceed TurboX prompts the session owner whether to
suspend or terminate the session. The session owner can add a
description before suspending or terminating the session.
The confirmation dialog box displays the number of participants in
the session, if applicable.
If there are other participants in the session and suspended session
sharing is enabled, suspending the session does not kick the other
users out. The session continues in collaborative sharing mode for
those participants. If suspended session sharing is not enabled,
suspending the session ends the session for all participants.
Suspended sessions appear as Suspended on the session owner’s
Exceed TurboX Dashboard.
Terminating the session ends the session for all participants.
For more information about suspended session sharing, see
“Configuring Security settings in Advanced mode” on page 210.
– Suspend: Exceed TurboX suspends the session without displaying
a warning message.
If there are other participants in the session and suspended session
sharing is enabled, suspending the session does not kick the other
users out. The session continues in collaborative sharing mode for
those participants. If suspended session sharing is not enabled,
suspending the session ends the session for all participants.
For more information about suspended session sharing, see
“Configuring Security settings in Advanced mode” on page 210.
– Suspend with confirmation: Exceed TurboX displays a
confirmation dialog box before suspending the session. Users can
add a description before suspending the session.
The dialog box displays the number of participants in the session,
if applicable.
If there are other participants in the session and suspended session
sharing is enabled, suspending the session does not kick the other
users out. The session continues in collaborative sharing mode for
those participants. If suspended session sharing is not enabled,
suspending the session ends the session for all participants.
For more information about suspended session sharing, see
“Configuring Security settings in Advanced mode” on page 210.
– Terminate: Exceed TurboX terminates the session without
displaying a warning message.
– Terminate with confirmation: Exceed TurboX displays a
confirmation dialog box. The dialog box displays the number of
participants in the session, if applicable. Terminating the session
ends the session for all participants.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
207
Chapter 3 Working with Profiles
Last window
closed
Controls what happens with the session when the last (or only) remote
session window is closed. Select one of the following options:
– Keep session running: The session keeps running, waiting to
accept new X client connections.
– Terminate session: The session terminates without displaying a
warning message.
– Terminate with confirmation: A confirmation prompt is
displayed.
Note: The Terminate with confirmation setting applies to
Custom, Published application, Windows application, XDMCP
Broadcast, and XDMCP Query startup modes only.
Signing out, disconnecting, or shutting down a Windows
Desktop - RDP or Windows Desktop - Direct session from the
Windows Start menu terminates the session without prompts,
regardless of profile settings.
Signing out of or shutting down an XDMCP Broadcast or
XDMCP Query session terminates the session, without prompts,
for the Terminate session and Terminate with confirmation
options, and keeps the session running when Keep session
running is selected.
Local system
logout
Select one of the following options to control what happens on the
user’s local system when the session closes in response to a system
shutdown or restart on a client sign-out:
– Suspend session: The session is suspended without a warning
message.
– Terminate session: The session terminates without a warning
message.
User is idle
Select one of the following options to control what happens with the
session when the user is idle:
– Keep session running: The session continues to run.
– Suspend session: The session is suspended without a warning
message.
– Terminate session: The session terminates without a warning
message.
After [n]
minute(s)
This field is available when User is idle is set to Suspend session or
Terminate session. The default value is 30 minutes.
The behavior of this value depends on the User is idle setting:
– When User is idle is set to Suspend session: Specifies how long
Exceed TurboX should wait in the absence of user input (mouse or
keyboard) before it suspends a session. For example, during
processes where there is no user input (such as data compiling or
video file playback), the lack of input could trigger a suspension.
– When User is idle is set to Terminate session: Specifies the time
Exceed TurboX waits before terminating a session if there is no
activity between the proxy and Exceed TurboX Client.
208
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Only if
contents
unchanged
This option is available when User is idle is set to Suspend session or
Terminate session.
If this option is enabled, Exceed TurboX suspends a session only when
the application is not generating output. This can be used to prevent
auto-suspend when running a simulation or other application that is
updating the screen.
Give a [n]
This field is available when User is idle is set to Suspend session or
second warning Terminate session.
If this option is enabled, Exceed TurboX displays a dialog <n> seconds
before the session suspends or terminates due to timeout. The default
is 30 seconds.
During
collaborative
sharing
This option is available when User is idle is set to Suspend session or
Terminate session.
Terminate
suspended
session after [n]
[units]
A suspended session will be terminated automatically after the
defined time period. The session owner will receive a message
indicating that the session has been terminated due to timeout.
Reconnect
automatically
when
connection is
broken
Defines whether Exceed TurboX Client will attempt to reconnect when
a lost server connection is restored.
Sign out of
Windows hosts
when session
terminates
Determines what happens to the remote Windows desktop when the
user closes the session window or terminates the session.
This option controls whether the idle timeout is active during
collaborative sharing. By default, this functionality is disabled. When
enabled, the idle time is only counted for the session owner, not for
the user(s) who take control of the session.
If you define a timeout value here , and if your administrator has
defined a timeout value in your user settings, the smaller of the two
values is used by default.
If this setting is enabled, the user is signed out of the remote Windows
desktop. Future connections to the same desktop will start from a
fresh sign-in session.
If this setting is disabled, terminating a Windows RDP or Windows
Direct session disconnects the user from the remote Windows host,
but leaves the Windows session running. If you later launch a new
Windows Direct session on the same host and using the same user,
Exceed TurboX reconnects you to the original session, with its
programs still running. Exceed TurboX also reconnects you to
Windows sessions that were closed by selecting Disconnect from the
Windows Start menu, if you launch a new session on the same host
and using the same user.
This option is enabled by default.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
209
Chapter 3 Working with Profiles
Lock screen for
suspended
Windows
console session
If this option is enabled, the session is locked once it is suspended.
Users with physical access to the remote host (such as the monitor,
mouse, or keyboard) will not be able to view or control the session
without authentication. This option is enabled by default. If the
remote host is physically secure, you may deselect this option to
prevent suspended sessions from automatically locking. This allows
for live thumbnail updates of applications running on the suspended
session.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.6
Configuring Security settings in Advanced mode
This section describes the settings available on the Security tab when you configure
profiles in Advanced mode.
You can configure the following settings on the Security tab:
210
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
• General: General security settings for the profile.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
211
Chapter 3 Working with Profiles
Show session
watermark
Displays a watermark in the session. Click Configure to configure the
watermark. The watermark is tiled, and displays at a 45 degree angle,
ascending to the top-right corner of the screen.
Note: This feature is available for Mac and Windows platforms
only. It works only in the Native Client, not the Web Client.
You can configure the following watermark settings in the Session
watermark dialog box:
– Watermark text: The text to display as the watermark. The
following macros are supported:
○
○
○
○
○
○
○
○
○
○
@a: Node IP address.
@n: Node host name.
@c: Client IP address, as seen by the Client.
@s: Client IP address as seen by the Node.
@h: Host name. If there are multiple hosts, the watermark
expands to include them.
@I: Host IP address. If there are multiple hosts, the watermark
expands to include them.
@d: Current Server date, in text format. For example, November
15, 2020. This value is sent by the proxy.
@D: Current Server date, in YYYY-MM-DD format. For
example, 2020–11–15. This value is sent by the proxy.
@t: Server time, in 12–hour format. For example, 4:36 PM. This
value is sent by the proxy.
@T: Server time, in 24–hour format. For example, 16:36. This
value is sent by the proxy.
@u: User ID.
○
○ @x: Profile name.
○ @@: @ character.
– Tile size: Together with your monitor’s DPI, defines the width and
height of the watermark tiles. Select one of the following options:
○
○
○
○
Small: Displays eight tiles, horizontally.
Medium: Displays six tiles, horizontally.
Large: Displays four tiles, horizontally.
Extra Large: Displays two tiles, horizontally.
If you have multiple monitors, adjust the tile size as follows:
○ If the session window is floating, adjust the tile size based on
the monitor that contains the majority of the window.
○ If the session window or desktop background is in full-screen
mode on one screen, use the DPI for that screen.
○ If the session window or desktop background is spread across
multiple monitors, adjust the tile size based on the monitor
with the highest DPI.
– Text color: Color for the watermark text.
212
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
– Opacity: The percent opacity for the watermark text. The value
must be between zero and 100. If you enter an invalid value or no
value and try to close the Session watermark dialog box, an error
message displays.
On the Session watermark dialog box, click OK once you have
configured the watermark.
Note: Resizing a window containing a watermark does not
change the size of the watermark.
In Single Window mode, the watermark is drawn on the root
window, and draws on top of all Client windows. The scaling
mode does not affect the watermark. The size of the watermark
is fixed.
In Multiple Window mode, the watermark is drawn over the
desktop background, separately inside each window, for both
Native and X Window modes.
For more information, see “Configuring Window mode settings
in Advanced mode” on page 222.
• Access control: Controls the access to sessions using this profile.
Use dynamic
Xauthority
Use user-level security. While in this security method, Exceed TurboX
generates a cookie (MIT-MAGIC-COOKIE) and passes this cookie to X
applications. Only those X applications that have the cookie generated
by Exceed TurboX are allowed to make connections to Exceed TurboX.
Note: Any custom host Access Control List (ACL) is ignored
and treated as an empty list.
This setting is always enabled for Windows Desktop – Direct sessions,
whether this option is selected in the profile or not. A message is
printed in the Proxy log, indicating this profile change.
Allow any host
Terminates the use of the host Access Control List (ACL) and grants
unrestricted access to all hosts on the network.
Use custom
host ACL
Limits access to the session to hosts in the custom host ACL. Enter the
name or IP address of each host you want to have access rights.
To specify multiple hosts, enter one name or IP address per line with
no separator punctuation. Lines beginning with # are ignored.
Allow X
applications to
modify host
ACL
Select to allow X applications to add or remove hostnames from the
ACL.
• Session sharing: Allows you to control session sharing.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
213
Chapter 3 Working with Profiles
Allow
collaborative
sharing
Collaborative sharing mode allows session participants to take control
of the mouse and keyboard input when the soft cursor of the session is
not moving.
This option is enabled by default. Clear this check box to disable
collaborative sharing mode.
If this option is disabled, the Collaborative sharing check box in the
Share Manager is cleared and unavailable, so the session owner cannot
enable collaborative sharing. The session owner can still explicitly give
control of a session to a participant.
For more information about Share Manager, see Exceed TurboX
Dashboard and Client Help.
Allow
This option is available when Allow collaborative sharing is enabled.
suspended
When Allow suspended session sharing is enabled, Share Manager
session sharing displays an option for owners to share the session with users even
after the session has been suspended. For example, a session owner
may want to pass control of their session to another user or user group
in a different time zone, so they can continue working with
applications in that session.
See Exceed TurboX Dashboard and Client Help for more information
about Share Manager.
Enable
suspended
session sharing
by default
If this option is selected, Suspended session sharing is automatically
selected in the Share Manager, and suspended session sharing is
automatically enabled in the shared session.
This option is available when Allow suspended session sharing is
enabled.
See Exceed TurboX Dashboard and Client Help for more information
about Share Manager.
Allow
participants to
invite / remove
users
If this option is enabled, session participants with permission to
participate (not View only) in the session are able to invite users to
join the session, and remove existing users from the session.
Participants are able to remove all users except the session owner and
themselves.
This setting is not enabled by default. If this setting is enabled, it
cannot be disabled while the session is active.
This option is available when Allow collaborative sharing is enabled.
Restrict sharing If this option is disabled (default), the session can be shared with all
to user groups
users.
If this option is enabled, session sharing is restricted to users who are
members of groups listed in the Restrict sharing to user groups field.
After selecting this option. follow the instructions in “Sharing user
groups” on page 215 to add, edit and delete user groups in the
Restrict sharing to user groups field.
Note: If this option is selected but the Restrict sharing to user
groups field is empty, a warning is displayed when you try to
save the profile settings. Select at least one user group or remove
the sharing restriction before saving the profile settings.
214
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Prompt session
owner to join
session
If this option is selected, the session owner is prompted to approve or
reject user attempts to join a shared session. If the session owner
approves the request, the user joins the session as a participant. If the
session owner denies the request, the user receives a message
informing them that their request has been denied. If a user attempts
to join a suspended session, the user receives a message informing
them that the session cannot be joined.
This option is disabled by default.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.6.1
Sharing user groups
To select the groups for session sharing:
1.
In the Session sharing pane, select Restrict sharing to user groups.
2.
Click Edit.
The Sharing user groups dialog box opens.
3.
To search for a user group, do the following:
a.
In the Candidates box, type all or part of the name of the user group you
want to find.
b.
Click the Search
icon beside the Candidates box.
The search results are displayed in the left pane.
Tip: To clear the search results from the pane and perform another
search, click the Clear
icon beside the Candidates box.
4.
In the left pane, select the name(s) of the user group(s) that you want to restrict
session sharing to. You can select multiple entries by clicking them.
5.
Click the Add user groups
icon.
The selected user group names are moved to the right pane.
6.
In the right pane, select the name(s) of any user group(s) that should be
removed from the sharing. You can select multiple entries by clicking them.
7.
Click the Remove user groups
icon.
The selected user group names are moved to the left pane.
Tip: To clear all groups from the right pane, click Clear.
8.
Click OK.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
215
Chapter 3 Working with Profiles
The text box at the bottom of the Session sharing pane displays the list of user
groups that session sharing is restricted to.
3.4.7
Configuring Protocol settings in Advanced mode
This section describes the settings available on the Protocol tab when you configure
profiles in Advanced mode.
The Protocol tab lets you configure settings that affect the use of the X protocol. You
can enable X server protocol options and specific extensions.
You can configure the following settings on the Protocol tab:
• X server protocol
Custom vendor If an application requires a specific vendor string, select this option
string
and specify the string.
• Extensions
216
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
BIGREQUESTS
Permits large X protocol requests. The core X protocol restricts the
maximum length of a protocol request to 262,140 bytes. This can be a
problem when joining large numbers of lines or arcs, because these
requests cannot be divided into smaller requests without disturbing
the rendering of join points.
Composite
Lets clients request that all drawing to window is redirected to an offscreen buffer. Through the DAMAGE extension, the client (called a
“compositing manager”) can know which areas of a window are
modified and render the windows on screen. By using the drawing
requests from both the core protocol and the RENDER extension, the
compositing manager can create special effects, such as translucent
windows.
Disable with Multiple Window mode: Select this option to disable
compositing when Exceed TurboX runs in Multiple Window mode.
DAMAGE
Notifies clients whenever something is drawn to a window. This
feature is useful for virtual network computing (VNC) servers, for
screen magnifiers, and for clients using the Composite extension to
update the screen.
DOUBLEBUFFER
Lets applications draw images to a back buffer. When the image is
completely rendered there, it can be swapped into the role of the front
buffer, which makes the image. Thus, only completely rendered
images are shown and remain visible during the entire time it takes to
render a new frame. The result is flicker-free animation.
MIT-SHM
Lets local applications store ximage data in a memory segment that is
shared with the proxy. This precludes having to send the ximage over
the Xlib interprocess communication channel. This extension provides
minimal performance gain in client/server environments such as
Exceed TurboX. By default, this option is not selected.
Regardless of how you configure this setting in a Windows Desktop –
Direct profile, this extension is automatically enabled when you
launch the profile. A message is printed in the Proxy log, indicating
this profile change.
RANDR
Lets clients modify the size, accelerated visuals, and rotation of an X
screen. It also informs clients when screens were resized or rotated,
and it lets them discover which visuals have hardware acceleration
available.
RECORD
Enables support for the recording of core X protocol and arbitrary
extension protocol within the X Server. When the extension is
requested to intercept a specific protocol by one or more applications,
the protocol data is formatted and returned to the recording
application. The extension provides a mechanism for capturing all
events, including input device events that do not go to applications.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
217
Chapter 3 Working with Profiles
RENDER
Enables anti-aliased text and alpha-blending on the Exceed TurboX
server. Newer desktop environments (such as the latest versions of
KDE, GNOME and Open Office) use this extension for anti-aliased
text.
Disable with PseudoColor —Disables the use of the RENDER
extension when the root visual is PseudoColor. Because the extension
allocates colors on the root colormap, disabling PseudoColor support
means more color cells are available for applications.
SHAPE
Permits arbitrary window and border shapes. This extension reports
the SHAPE extension when queried by a client for the list of
supported extensions.
Drawing operations on non-rectangular windows are slower than on
rectangular windows. Certain applications will use non-rectangular
windows instead of rectangular windows if the SHAPE extension is
present. You can improve the performance of these applications by
disabling the SHAPE extension before starting the client.
SYNC
Enables the synchronization extension. This extension provides
primitives that let synchronization between applications take place
entirely within the X server. It removes any error introduced by the
network and makes it possible to synchronize applications on
different hosts running different operating systems.
The synchronization extension is important for multimedia
applications where audio, video, and graphics data streams are
synchronized. This extension also provides internal timers within the
X server for synchronizing client requests. This implements simple
animation applications without any round-trip requests and makes
the best use of buffering within the application, network, and X server.
XFIXES
A collection of improvements for deficiencies in the core protocol,
including:
–
–
–
–
–
XINERAMA
218
Save Set processing changes
notification when a selection changes
server-side region objects
cursor tracking
cursor names (labels)
Allows applications and window managers to use two or more
physical displays as one display. The display behavior may differ
depending on the window manager used. If you enable this extension,
ensure that the Use monitors setting in the profile Window mode tab
for screen 0 is set to All.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
GLX (OpenGL) Enables OpenGL rendering support. Rendering can be Direct, done in
the application process space, or Indirect, with instructions sent across
local or network sockets via the X protocol, so that rendering can
occur on the Connection Node or client desktop.
Direct OpenGL rendering is controlled in the application environment
via ssrun.
Indirect OpenGL rendering is controlled by the Render on Node and
Hardware acceleration options. These options control whether
Indirect rendering occurs on the Connection Node (Indirect Serverside Rendering (ISSR)) or on the client desktop (Desktop-Side
Rendering (DSR)). These options can be used in the following ways:
– If Render on Node is not selected, Desktop-side Rendering (DSR)
is used. OpenGL is passed from the application to the desktop
client and rendered by the desktop GPU. To force software-based
rendering (slow, OpenGL 1.1 only), open the General tab and, in
the Optional settings box, add:
proxy.DesktopSideHardwareAcceleration=0
– If Render on Node is selected and Hardware Acceleration is not
selected, Software-based Indirect Server-side Rendering (SISSR) is
used. OpenGL is passed from the application to the node and
rendered by the node using the CPU.
– If both Render on Node and Hardware Acceleration are selected
and the Node has a GPU, then Hardware-based Indirect Serverside Rendering, (HISSR) is used. OpenGL is passed from the
application to the node and rendered by the node using a local
GPU. This falls back to software rendering if no GPU is available to
the node.
See “Configuring OpenGL Rendering modes” on page 221 for more
information about rendering modes.
The Desktop overlay support option advertises hardware overlay
plane support. This applies when Render on Node is cleared.
Some applications use hardware overlay planes to draw parts of the
UI.
This option is disabled by default because most applications do not
require overlay support, and because disabling this option prevents
careless applications from accidentally selecting an overlay visual. To
function, this option requires hardware support in the GPU and
overlay support enabled in the video driver. Typically only
workstation-class GPUs support hardware overlays.
OpenText recommends leaving Desktop overlay support disabled
XFree86VidModeExten
sion
Allows an application to query various video mode settings, such as
the refresh rate of the monitor.
XFree86-Misc
Allows an application to query various keyboard and mouse settings,
such as the keyboard repeat rate or the middle-button mouse
emulation setting.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
219
Chapter 3 Working with Profiles
XFree86Bigfont
Improves performance when working with big fonts such as CJK or
Unicode by using shared memory.
Note: This extension does not apply to Windows nodes.
X-Resource
Lets clients query the X server about its usage of various resources.
This tool assists developers with making server resource usage more
efficient and in debugging server-side resource “leakage”.
XTEST
Lets applications generate user input actions in the X server without
requiring the presence of a user. It also lets an application control the
handling of user input actions by the server.
XKEYBOARD
Extends keyboard-control capabilities for modifiers, key groups,
sounds, indicators (LEDs), parameters, and quick keys.
XInputExtensio Accommodates new types of input devices. Keyboard and mouse
n
input extensions are currently supported. You must select this
extension to use a SpaceBall 3D mouse. This extension applies to
Exceed TurboX Client for Windows only.
XVideo
Uses hardware capacities to speed up video playback and reduce total
CPU time on both systems running Exceed TurboX and the X client. It
also provides server-side video adjustment for brightness, contrast,
and hue if the hardware supports it.
The XVideo extension supports image playback—depending on the
capacities of the system video card, Exceed TurboX can use the color
space conversion or hardware scaling provided by the video card to
play back video frames of certain formats and to rescale video frames
to the desired size.
Note: To successfully use XVideo functionality, ensure that the
following is true:
– Your hardware provides the required capacities.
– XVideo support is available and enabled in the video
playback software (the X client).
– As X applications typically run on a remote host, XVideo
shared memory should not be used. Refer to the X
application’s documentation for more information.
MIT-SCREENSAVER
Allows X applications to coordinate with Exceed TurboX and each
other to detect idle states and enable the screen saver within the
Exceed TurboX session. This extension applies to the screen saver that
runs inside the Exceed TurboX session. It does not affect the screen
saver of any machine that the Exceed TurboX Client may be running
on.
Note: This extension does not modify the MIT-SCREEN-SAVER
settings of the Operating System that Exceed TurboX is running
on. It only affects applications running inside the Exceed
TurboX session.
220
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
DPMS
Silences X Client warnings that the DPMS extension is not present.
Note: This extension does not modify the DPMS settings of the
Operating System that Exceed TurboX is running on. It only
affects applications running inside the Exceed TurboX session.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.7.1
Configuring OpenGL Rendering modes
You can configure the following OpenGL rendering modes:
Direct Serverside Rendering
(DSSR)
OpenGL instructions go directly from the application to a local GPU. This
mode provides the best performance and OpenGL features, but requires a
GPU on the application host, and requires you to run all OpenGL
applications with the ssrun utility provided with the node installation.
This can be done manually (for example, /opt/etxcn/bin/ssrun/
<path to application>) or by enabling the Use direct server side
rendering option in Xstart.
Hardwarebased Indirect
Server-side
Rendering
(HISSR)
OpenGL instructions are sent from the application host to the Exceed
TurboX Connection Node, and rendered on the node using hardware
rendering. This mode is generally slower than Direct Server-side
Rendering (DSSR), and has fewer OpenGL capabilities.
To enable HISSR, in the Protocol tab of the profile, select Render on node
and Hardware acceleration.
Note: HISSR requires a Linux x64 or Solaris x64 node. Nodes on
other platforms, such as Windows and AIX, do not support HISSR.
Software-based
Indirect Serverside Rendering
(SISSR)
OpenGL instructions are sent from the application host to the Exceed
TurboX Connection Node, and rendered on the node using software
rendering. This mode is generally slower and has fewer OpenGL
capabilities than Direct Server-side Rendering (DSSR). This mode is used
if no GPU is available on the node.
To enable SISSR, in the Protocol tab of the profile, select Render on node,
and ensure Hardware acceleration is not enabled.
Note: SISSR requires a Linux x64 or Solaris x64 node. Nodes on
other platforms, such as Windows and AIX, do not support SISSR.
This mode is slower than modes that use a GPU.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
221
Chapter 3 Working with Profiles
Desktop-side
Rendering
(DSR)
OpenGL instructions are passed from the application to the Connection
Node, and then to the user's device. Applications are rendered using the
GPU or software on the user's device. DSR is used if ssrrun (DSSR) and
Render on node (ISSR) are not enabled.
Except for uncommon OpenGL applications specifically written with this
rendering mode in mind, DSR is far slower than other rendering modes. It
also disables session sharing and suspending/resuming sessions. For these
reasons, OpenText discourages the use of DSR.
• To enable DSR with GPU rendering, in the Protocol tab of the profile,
select Hardware Acceleration. Ensure that Render on Node is cleared.
• To enable DSR with CPU rendering, in the Protocol tab of the profile,
clear Render on Node and Hardware Acceleration.
For more information about configuring rendering modes in the profile, see
“Configuring Protocol settings in Advanced mode” on page 216.
3.4.8
Configuring Window mode settings in Advanced mode
This section describes the settings available on the Window mode tab when you
configure profiles in Advanced mode.
The profile Window mode tab lets you configure monitor and window settings.
222
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
The Window mode tab allows you perform the following tasks:
• “Selecting the window mode for working with applications (Advanced mode)”
on page 224
• “Configuring Monitor settings for Multiple or Single Window mode (Advanced
mode)” on page 225
• “Configuring Multiple window mode (Advanced mode)” on page 226
• “Configuring Single window mode (Advanced mode)” on page 229
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
223
Chapter 3 Working with Profiles
3.4.8.1
Selecting the window mode for working with applications
(Advanced mode)
You can view and work with an application in the following window modes:
• Multiple Window mode: In this mode, the Exceed TurboX root window is not
displayed when you start applications. Instead, each application runs inside its
own application window, as if the application was running natively on your
machine. The menus and information provided by Exceed TurboX are available
in the Client menu.
Note: If a user shares a session that uses Multiple Window mode, the
session switches to Single Window mode for as long as it is shared.
If you are working on a supported Microsoft Windows platform, you can
set additional viewing options from within the running session.
• Single Window mode: In this mode, every application appears in a single root
window on the desktop. The window serves as the primary work space where
you start and display applications during a session. By default, Single Window
mode uses a single (primary) monitor, and Fixed resizing.
A local or a remote X Window Manager controls all window functions. You can
also specify the root window size. You may need to make it larger than the
screen for certain applications to run. In this case, you can enable scroll bars to
view the entire window more easily.
You can enable the auto-scrolling functionality by:
–
Selecting the Scrolling > Automatically scroll near window edges option in
the profile (for details, see “Configuring Single window mode (Advanced
mode)” on page 229).
–
Clicking the Auto-scroll icon in the lower right corner of the Single Window
mode session. This toggles the auto-scroll functionality on and off.
When auto-scroll is on, moving the mouse near the edge of the main window
(when the root size is bigger than the main window), automatically scrolls the
window to reveal the hidden area.
When middle mouse button scrolling is enabled, clicking the middle button
displays a floating icon.
224
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
3.4.8.2
Configuring Monitor settings for Multiple or Single Window mode
(Advanced mode)
The Use monitor(s) settings apply to both Multiple and Single window modes.
If you have more than one monitor attached to your machine, you can use all the
monitors to display a session, or specify the monitor(s) to use. In the Window mode
tab, select the preferred option from the Use monitor(s) list:
All
Use all available monitors.
Only primary
Use only your primary monitor.
All nonprimary
Use all non-primary monitors.
Specified
Use one or more specific monitors. Type the monitor number(s) in the text
box beside the Use monitor(s) list. Up to 32 adjacent monitors are
supported. To specify multiple monitors, separate the monitor numbers
with commas.
To use multiple monitors, you must install multiple video cards or a video
card that supports multiple monitors, on your computer.
Note: To find out your monitor properties, refer to the documentation
provided by the manufacturer of the platform you are using. For example, if
you are using Windows 10, right-click your Windows desktop and select
Display settings.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
225
Chapter 3 Working with Profiles
3.4.8.3
Configuring Multiple window mode (Advanced mode)
The following settings are available in Multiple window mode, in the Window
options area:
Window
manager
A window manager is a special application which you can use to move,
size, and arrange application windows. Window managers also frequently
provide menus with commands you can use to start other applications.
These menu commands are preconfigured with the command lines
required to start up their respective X applications. You can run one
window manager at a time in your Exceed TurboX session. For
information about starting a window manager, see “Starting a window
manager” on page 228.
Select one of:
• Native: Use the window manager on the operating system on which
Exceed TurboX Client is running. You can reduce network traffic by
using the native window manager.
Note: Do not select the Native option if you are using desktop
environments, such as the Common Desktop Environment
(CDE), from UNIX hosts. These environments do not support the
native window manager.
• X: Use any local or remote X window manager. You must start the
window manager. It does not start by default.
Focus policy
Selects the focus policy for your application window.
Note: This option is available only when running a native Window
manager.
Select one of:
• Click: A window is given focus when you click in the window.
• Pointer: A window is given focus when you point at the window.
• System default: A window is given focus according to the settings in
the operating system you are using. By default, this option is used if
you do not specify a native window manager focus policy.
Note: This option is available only for Exceed TurboX Clients
running on Windows or Mac platforms. This functionality is
supported on Linux platforms, but is controlled through a
Linux-specific focus policy.
226
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Window title
The text entered in this field appears in the Exceed TurboX Client taskbar.
It can be used to differentiate between Exceed TurboX window icons
based on the Exceed TurboX server connection.
By default, Window title is empty. In this case, Exceed TurboX displays
the X window title. You can include the X window title in the window
title by using the @w macro. For a list of additional macros you can use in
the window title, see “List of Window title macros” on page 229.
Note: This option is available only when running a native Window
manager.
Show
confirmation
on window
close
Displays a warning message when you try to close an X application
window. The message allows you to confirm or cancel closing the
window.
Note: This option is available only when running a native Window
manager.
Shrink window Sends a request to any X client that creates a window larger than the size
to fit display
of your screen, making the window the size of your screen.
Cascade
windows
Tells the proxy to cascade all top-level client windows when the X client
does not specify a hint position. This option is enabled by default.
Pan near screen Pans X application windows that extend beyond the edge(s) of the screen
edges
onto the screen when the user moves the mouse pointer inside the
window near the screen edge. The X application window must have focus
to trigger this behavior, and you must be using a native window manager.
This feature may be useful when working with X applications that are
taller or wider than the user’s screen.
Show desktop
backdrop
Hides or shows the X Window desktop background in Multiple Window
mode.
If this option is selected, the remote desktop backdrop covers the local
desktop background. If this option is cleared, you can see the local
desktop.
Note: This option is available only for XDMCP profiles in Multiple
Window mode.
During a session, you can use the Show Desktop Backdrop command in
the Client menu to toggle between displaying or hiding the X window
desktop background in Multiple Window mode.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
227
Chapter 3 Working with Profiles
Send desktop
mouse actions
to X
Specifies whether mouse actions on the user’s desktop are processed by
the local operating system or the remote X Window Manager.
This option requires the following session configuration:
• Window mode must be set to Multiple.
• Window mode > Use monitor(s) must include the monitor from where
you want to send mouse actions.
• There must be an X Window Manager running (this can be
accomplished by launching an XDMCP profile, or by launching an X
window manager in a Published Application or Custom Startup
profile).
• The remote desktop backdrop should be disabled, since mouse actions
on the remote host’s X desktop backdrop are always sent to the remote
host.
Note: You can switch between local and remote desktop mouse
actions in a running session by toggling the Send Desktop Mouse
Actions to X option in the Client menu.
The following setting is available in Multiple window mode (Advanced mode), in
the Monitors area:
• Use monitor(s): For information, see “Selecting the window mode for working
with applications (Advanced mode)” on page 224.
3.4.8.3.1
Starting a window manager
You can start a window manager the same way you start any application. If you use
XDMCP, you can specify a window manager in the XDM session file on the host.
You can also start a window manager from any command prompt on your host.
The following are typical window manager startup commands:
• DEC (UNIX): [<path>/]dxwm&
• Motif (UNIX):– [<path>/]mwm&
• OpenLook: [<path>/]olwm&
• AIX: [<path>/]aixwm&
• DEC (VMS): spawn/nowait run sys$system:decw$winmgr
• Motif (VMS): spawn/nowait run sys$system:decw$mwm
• KDE (Linux): [<path>/]startkde&
• Gnome (Linux): [<path>/]gnome-session&
• CDE: [<path>/]dtwm&
Note: You must specify the display specification so the window manager
knows which X display server to use. GNOME/KDE starts the default window
manager, if one is not specified. The settings for the window manager are
configurable within GNOME.
228
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
3.4.8.3.2
List of Window title macros
You can use the following macros in the window title:
• @a —IP address of the Connection Node.
• @c —IP address of the Client machine as reported by the Client.
• @d —Display specification of the session in the format:
<hostname>:<display#> .
• @h —Application server hostname.
• @i —Application server IP address.
• @n —Hostname of the Connection Node.
• @s —IP address of the Client machine as reported by the Connection Node.
• @u —User ID.
• @w —Name of the X window title (X client/application).
• @x —Name of the profile used to run the session.
• @# —Display number of the session.
• @@ —@ character.
3.4.8.4
Configuring Single window mode (Advanced mode)
The following settings are available in Single window mode (Advanced mode):
• Root window size: The width and height of the root window. Select one of the
following sizing methods:
Fit window to
screen
Calculate the root window size based on the selected monitor(s). The
root window area is the combination of the working areas of the
selected monitors, excluding the window taskbars.
Note: When using Fit window to screen with Windows
Desktop - Direct console mode, if the remote display driver does
not support the specified resolution, the window is resized
down to the next largest supported resolution.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
229
Chapter 3 Working with Profiles
Full screen
Select this option to enable the window to occupy the primary monitor
fully, including the Windows taskbar. You can add monitors or use all
monitors. Full screen mode can occupy more than one monitor, but
the default is to occupy the primary monitor only. The root window
size adjusts to the primary monitor’s resolution.
Note: You can set Full screen mode on monitors that use
different resolutions (different sizes). In this case, Exceed
TurboX uses the largest rectangle found on any of the selected
monitors. If the largest rectangle spans two or more monitors,
that rectangle is used in its entirety. To achieve optimum results
with multiple monitor configuration, set all monitors to the
same resolution. For example, if one monitor is set to 1920 x
1080 pixels, all other monitors should be configured the same
way.
In Windows Desktop - Direct mode, with Use console on
Windows Server enabled, using Full screen may show black
around the edges if the remote display does not support the
resolution on the client-side monitor.
If the Auto-hide option in the Scrolling area is enabled
(Advanced mode), the Exceed TurboX menu bar is displayed in
its default position, or the last used position, for a moment
before it auto-hides.
Pre-defined
Use a pre-defined root window size. Choose a resolution from the
available options.
Note: When using Pre-defined with Windows Desktop - Direct
console mode, if the remote display driver does not support the
specified resolution, the window is resized down to the next
largest supported resolution.
Custom
Use a custom root window size. Enter the Width and Height in pixels.
The maximum size is 8192 x 8192. A width or height of zero makes the
root window size equal to the size of your screen.
If you have two monitors next to one another, each with a resolution
of 1280 x 1024 pixels for a combined resolution of 2560 x 1024, setting
the width to 2560 and the height to 1024 sets the root window to
display across both monitors as if they were one.
• Show full screen toolbar: Show the full screen bar when the user positions the
pointer over the trigger area at the top of the screen. Enter the text for the toolbar
title in Full screen toolbar title.
• Resizing: The following options are available:
–
230
Resizing policy: The resizing policy for the root window and its contents.
The following policies are available:
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Fixed
A user (or the system) defines the size of the root window. Once a
session has started, the root window size will not change. If you
click the Maximize button in the bar, the main window is restored
to its original position and size. The number and size of all
monitors is also fixed. Scroll bars appear when the root window
size is larger than session window size.
This is the default resizing policy for Single window mode.
Note: If Fixed resizing is selected, you can change the root
window size of an active session in Quick settings.
See Dashboard and Client User Guide for more information.
Full screen viewing is available when the root window size
matches the size of the monitor where the session is running.
Dynamic
Allows you to resize the Exceed TurboX root window
dynamically. The application (such as the KDE environment) will
reflect this and fit in the new window. For example, you may
switch from Single to Multiple monitor mode, or vice-versa. The
applications will renegotiate the new root window size and be
redrawn appropriately based on the new information. They will
not be distorted, as may occur in Scaled mode.
The minimum size of the window is 800x600. You cannot resize
the window to be smaller. When the window is maximized, the
window and root window will cover the work area.
Note: A shared session may not use Dynamic resizing. If a
session using Dynamic resizing is shared, it switches to
Fixed resizing. Once the sharing is stopped, the session
reverts to Dynamic resizing.
Windows Desktop - RDP and Windows Desktop - Direct
profiles do not support Dynamic resizing . This option is
visible in the interface, but is unavailable in the quick
settings. You can change the resizing policy to either Scaled
or Fixed in the quick settings for an active session. Once the
session is terminated, the profile setting reverts to Dynamic
resizing.
Scaled
When the window is resized, the size of the root window does not
change, but the contents of the session scale up or down
accordingly. For example, if multiple sessions are running, the
user may view them as thumbnails. Scaling does not affect the
behavior of UNIX applications, because the root window size
remains the same.
Note: For Linux clients, Scaled resizing requires that the
host Xserver supports Composite extension version 1.4 and
up and RENDER extension. Scaled resizing is not supported
on RedHat 5.10 or 6.0-6.3.
You cannot switch directly from a Scaled to Dynamic
policy, or Dynamic to Scaled. You must switch to and apply
Fixed resizing before choosing Scaled or Dynamic.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
231
Chapter 3 Working with Profiles
–
Maintain aspect ratio: Available only with Scaled resizing. Enable this option
to avoid distortion while scaling by maintaining the width-to-height ratio of
the window’s contents.
–
Save geometry on exit: Exceed TurboX saves the Client window position,
size, and state when you exit the session and restores it when you start the
session and enter Single Window mode.
• Scrolling: The following options are available:
–
Automatically scroll near window edges: (Fixed resizing only) Activates autoscrolling when the mouse cursor is near the edge of the window. This sets the
default toggle state. See the description of Single Window mode > Autoscrolling in “Selecting the window mode for working with applications
(Advanced mode)” on page 224.
–
Middle mouse button scrolling: (Fixed resizing only) Enable setting an anchor
point for scrolling with the middle mouse button.
–
Show scrollbars: Select one of the following values to specify when you want
to display scroll bars in a Single Window mode session.
Note: This feature is supported on Windows only.
○ Always: Always displays scroll bars. This is the default.
○ Auto-hide: Show scroll bars only when pointer is near the edge of the
window. Hide scroll bars at all other times.
○ Never: Never display scroll bars.
• Monitors: These settings are the same for Multiple and Single Window mode.
For more information, see “Selecting the window mode for working with
applications (Advanced mode)” on page 224.
3.4.9
Configuring Screen settings in Advanced mode
This section describes the settings available on the Screen tab when you configure
profiles in Advanced mode.
The profile Screen tab lets you define the color, screen size, and resolution settings
in your profile.
232
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
You can configure the following settings on the Screen tab:
• Color
CONETX120501-AGD-EN-3
Server Manager Administration Guide
233
Chapter 3 Working with Profiles
Server visual
Defines the color characteristics for the specified screen of your X
display. Use this setting to specify the default server visual:
– Auto-select—Exceed TurboX automatically selects the Server
Visual setting. If the video driver setting is High Color or
TrueColor, Exceed TurboX selects the TrueColor setting. If the
video driver settings is 256 color, Exceed TurboX selects
PseudoColor.
– PseudoColor—Supports dynamic colormaps of 256 colors. Under
normal circumstances, the PseudoColor setting is appropriate. By
default, the X server allocates the color black to cell zero, and white
to cell one when PseudoColor is enabled. However, you can
reverse this allocation by enabling Sun Microsystems Compatible
Colormap. PseudoColor mode is supported with a high color or
true color video driver.
– TrueColor—Use with display drivers that support 256,768 or more
simultaneous colors on your video adapter.
Note: An application can still create windows of TrueColor,
PseudoColor, or of both types unless the Multiple color depths
support setting (described in this table) is disabled.
Sun
Microsystems
compatible
colormap
Enables Sun Microsystems-compatible colors and affects the default
settings of the PseudoColor server visual. Selecting this option
reverses the default allocation: it allocates black to cell one and white
to cell zero.
Multiple color
depths support
Enables advertisement of all supported visuals. This lets certain
X applications display correctly (for example, if 8-bit PseudoColor or
24-bit TrueColor is the default visual on a high-color video device).
If you clear this option, Exceed TurboX advertises only the default
visual.
This option is disabled by default.
• Screen size
Use local
system settings
Instructs Exceed TurboX to calculate the screen size based on the
system settings.
Specify in mm
Specify the screen Width and Height in millimeters.
Compute based Instructs Exceed TurboX to calculate the screen size based on the
on monitor DPI monitor’s DPI. Enter the monitor DPI as a value between 1 and 2000.
Use DPI-aware
resolution for
remote
applications
Enables the DPI awareness for the Exceed TurboX client running on
Windows platforms (versions 8.1 and later). Support for other
platforms will be added in a future release.
Note: You can set this option only once each time the client is
started. You cannot toggle it after the client has started.
Disable this option when you are working with X applications that are
not DPI-aware, to allow the display to be scaled up.
234
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.10
Configuring Performance settings in Advanced mode
This section describes the settings available on the Performance tab when you
configure profiles in Advanced mode.
The Performance tab allows you to optimize Exceed TurboX for use in your
environment and applications. In some cases, adjustments are necessary for
troubleshooting purposes.
You can configure the following settings on the Performance tab:
• General:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
235
Chapter 3 Working with Profiles
Show
performance
icon
Shows the Performance icon in the system tray for the session owner.
• Performance panel:
Open from
performance
icon
Gives the session owner the ability to open the Performance panel for
a session by clicking the Performance icon in the system tray.
Open from
client menu
Gives the session owner the ability to open the Performance panel
from the View section of the Client menu for a session.
Use cgroups
limits for node
CPU/memory
Controls how the Node CPU and memory limits are displayed in the
Performance Panel.
If this option is enabled and etxproxy is running in a session slice,
the tooltips for the Node CPU usage (%) and the Node memory usage
graphs in the Performance Panel display the memory and CPU limit
for the etxproxy slice.
If this option is not enabled, the tooltips display the system hardware
total memory and CPU limit.
This option is enabled by default.
• Tuning settings:
Quality vs. FPS Select a value to set the balance between the image quality and the
frame rate at which Exceed TurboX draws the session. You can modify
this value in the Optimize for setting in the Performance Panel.
Target
bandwidth
If desired, select the check box and define the target bandwidth in
megabits per second (Mbps). For example, to limit the session to half a
megabit per second, enter 0.5, or to set the limit to 10 Mbps, enter 10.
You can modify this value in the Target bandwidth setting in the
Performance Panel.
Notes
– The target bandwidth you set is only a soft limit; it may be
exceeded if required by the session proxy.
– Exceed TurboX automatically and dynamically scales its
bandwidth use to current conditions. To control the total
bandwidth used, you should use Quality of Service in your
router.
For details, see “Configuring Exceed TurboX Server settings”
on page 164.
236
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Allow GPUEnables or disables hardware video decoding. This option is enabled
accelerated
by default.
video decoding Disabling this option may be useful for troubleshooting purposes. For
example,
Note: Exceed TurboX Client uses hardware video decoding by
default. Disabling this option may be useful when
troubleshooting sessions suspended by faulty video drivers.
• Drawing settings: Configure these settings to reduce network traffic and
improve window refresh speed (at the expense of window drawing speed and
memory).
Draft mode
Improves performance with a slight and generally unnoticeable
reduction in drawing accuracy.
Backing store
Determines the conditions under which the backing store is used:
– None: Never saves the contents of the application window. This is
the default.
– When mapped: Backing store is provided to all mapped windows
if the application requests it. Window content is saved only when
the application is drawing to the window when it is mapped.
– Always: Always attempts to preserve the contents of any window,
whether or not it is mapped, if the application requests it.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.4.11
Configuring Fonts settings in Advanced mode
This section describes the settings available on the Fonts tab when you configure
profiles in Advanced mode.
The profile Fonts tab lets you specify the default text font for a session. You can also
enable or disable local fonts for a session and add an X font server.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
237
Chapter 3 Working with Profiles
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
To specify the default text font for sessions:
1.
In the Default font box, type the name of the font to use for text. The font must
reside in one of the servers/directories in the Font database list.
2.
Click Save.
To specify the font server/directory search order and substitution options:
When an application requests a font, the X server searches each font directory or
X font server in the font database, in the order that they are listed in the Font
238
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
database area, until it finds the requested font. To reduce the amount of time it takes
to find a match, place the font directories and/or X font server(s) containing the most
commonly requested fonts at the top of the list.
1.
Change the search order by dragging a database entry using the Reordericon
beside it.
2.
If you do not want to automatically substitute missing fonts, clear the
Automatic font substitution check box.
3.
Click Save.
To add, edit, or delete a custom font server:
1.
Do one of the following:
• To add a custom font server, click the Add (+) icon.
• To edit a custom font server, locate the entry in the Font Database list and
click its Edit
icon.
• To delete a custom font server, locate the entry in the Font Database list and
click its Delete
icon. No further steps are required.
2.
In the Font server host box, type the hostname or IP address of the machine
running the X font server(s).
3.
In the Port box, type the font server port.
4.
Click the Apply
5.
Click Save.
icon or click the Cancel
icon.
Font directories and servers are added dynamically and do not require a server
reset.
3.4.12
Configuring Troubleshooting settings in Advanced
mode
This section describes the settings available on the Troubleshooting tab when you
configure profiles in Advanced mode.
The profile Troubleshooting tab lets you provide several methods for
troubleshooting session issues.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
239
Chapter 3 Working with Profiles
You can configure the following settings on the Troubleshooting tab:
• Log: Configures the type of information that the Exceed TurboX Proxy logs for
your session. The specified information is recorded in a proxy log file
(etxproxy.log) on the Exceed TurboX Connection Node. You can access the
proxy log file using the desktop menu.
240
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Proxy
information
Enables the option to create log files and lets you specify the following
types of information to be logged:
– Font opens: All font requests. This setting is applied dynamically
and does not require a server reset.
– Window and command names: The initial setting of the
WM_COMMAND and WM_NAME properties on the InputOutput
root level window. This is useful when you are trying to determine
which client is associated with a particular network socket. This
setting is applied dynamically and does not require a server reset.
GLX
Information: All OpenGL-related information. This setting is
–
applied dynamically and does not require a server reset.
– Connection Information: All security-related information.
• Traces: Configures the trace settings for your session. You can trace the events,
requests, and dialogs that occur between the X server and the application.
Allow trace
Permits users to perform traces.
– Trace initially on: Traces dialog between the X server and the first
application. When you select this option, the trace starts along with
the X server. All dialog between the X server and the first
application, including XDM, is traced. You must restart the Exceed
TurboX Connection Server for this setting to take effect. The trace
file is saved on the server in the corresponding session directory
with a .trx extension.
– Slow trace: Traces all events and requests between the X server
and the application. You can use this functionality for
troubleshooting purposes should the X server hang.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
For information on other troubleshooting-related tasks, see:
Dashboard
“Deleting data cached by Exceed TurboX” in the Exceed TurboX Dashboard
and Client Help
Profiles
• “Configuring Performance settings in Advanced mode” on page 235
• “Configuring startup settings on the General tab” on page 279
Sessions
“Generating and downloading a trace package” in the Exceed TurboX
Dashboard and Client Help
CONETX120501-AGD-EN-3
Server Manager Administration Guide
241
Chapter 3 Working with Profiles
3.4.13
Configuring File and print settings in Advanced mode
This section describes the settings available on the File and print tab when you
configure profiles in Advanced mode.
The File and print tab allows you to enable file transfer and remote printing and
configure the settings for printing from an application running in your session.
You can configure the following settings on the File and print tab:
242
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Enable File and Enables the File and Print Manager command in the Exceed TurboX
Print Manager Client menu and the file transfer settings on that page.
Note: The File and Print Manager is available for Windows
Desktop - RDP and Windows Published Application profiles only if
the Exceed TurboX Connection Node is installed on the RDP host. If
the node and RDP hosts are different systems, the File and Print
Manager option is unavailable; however, you can enable file
transfer and printing by configuring RDP printer and drive
redirection for Windows clients (see “Configuring startup settings
on the ETX RDP tab” on page 286).
Enable file
download
Enables the Download button in the Exceed TurboX Client > File and
Print Manager dialog box, as well as the Print command for remote files.
Enable file
upload
Enables the Upload button in the Exceed TurboX Client menu > File and
Print Manager dialog box.
Initial remote
path
The default remote path for file transfers. This field accepts multiple
paths, separated by commas. Paths are checked in order; the first path that
exists will be used to set the initial path in the File and Print Manager
remote file browser. The following macros are supported:
@u = Exceed TurboX Dashboard signed-in user name
@s = The proxy process owner when etxft is launched by the proxy, or
the user who launched etxft when etxft is launched by the user
@c = The cached remote path. When the user closes the File and Print
Manager, the current remote path is saved to a cache file on the user’s
system. The next time the File and Print Manager is opened on that
system, the @c macro expands to the cached path. The cached path is
unique to each remote host, so that the File and Print Manager
remembers the most recently accessed path on multiple remote hosts.
@w [<path>] = Resolves the path on Windows host only
@x [<path>] = Resolves the path on X host only
For example, if you configure the path as follows:
@c,@x ~,@x $HOME,@x /usr/@u,@w %HOMEPATH%,@w c:\users\@u
the File and Print Manager will try to set the initial remote path in the
following order:
1. @c = last cached path for the host
2. @x ~ = cd ~ on X hosts only
3. @x $HOME = cd $HOME on X hosts only
4. @x /usr/@u = cd /usr/username on X hosts only
5. @w %HOMEPATH% = cd %HOMEPATH% on Windows hosts only
6. @w c:\users\@u = cd c:\users\username on Windows hosts only
CONETX120501-AGD-EN-3
Server Manager Administration Guide
243
Chapter 3 Working with Profiles
Initial local
path
The initial path in the local file browser when the File and Print Manager
opens. This field accepts multiple paths, separated by commas. Paths are
checked in order; the first path that exists on the user’s system will be
used. The following macros are supported:
@u = Exceed TurboX Dashboard signed-in user name
@s = The signed-in user on the Client system
@w [<path>] = Resolves the path on Windows host only
@x [<path>] = Resolves the path on X host only
For sample paths, see the description of Initial remote path.
Enable remote
printing
Enables printing support in the remote session. You can print inside an
Exceed TurboX session using one of these methods:
• Invoking the etxft -print command on a remote X host.
• Printing to the Exceed TurboX CUPS printer driver on a remote X host.
• Right-clicking a printable file format in the remote or local areas of the
File and Print Manager and selecting Print.
If a printable file is printed using one of these methods, Exceed TurboX
forwards the print job to your client device. The When print job available
option defines the behavior of the Exceed TurboX Client when the print
job arrives at the client device.
When print job
available
What happens when a print job arrives at the user’s device. The print job
may arrive via command line (etxft -print) or may be launched from
the File and Print Manager using the Print menu option.
Print to default printer: Print automatically to the default printer, as
defined by the local operating system.
Show system print dialog: Display the system print dialog so the user can
select the destination.
This setting is applied dynamically and does not require a Server reset.
Maximum print The maximum allowable job size in kilobytes (KB). Enter 0 to indicate that
job size
there is no job size limit.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
244
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
3.4.14
Configuring Devices settings in Advanced mode
This section describes the settings available on the Devices tab when you configure
profiles in advanced mode.
The profile Devices tab allows you to:
• Enable or disable audio rendering.
• Enable or disable redirection for audio and other devices.
You can configure the following settings on the Devices tab:
• Audio redirection
Play on this
computer
Redirect audio from the remote Windows host to speakers or
headphones connected to the user's local computer. This option is
enabled by default.
• Drives redirection
CONETX120501-AGD-EN-3
Server Manager Administration Guide
245
Chapter 3 Working with Profiles
– To share all available drives with the remote computer, select the
Drives
Drives check box and leave the text box blank.
– To share one drive only, select the Drives check box and type the
drive letter in the text box. For example, to share drive c, type c
– To share multiple drives, select the Drives check box and type the
drive letters in the text box, separated by commas. For example, to
share drives c and d, type: c,d
Note: This feature does not support Plug and Play (PnP) drives.
To map a USB drive, the device must be plugged in and
assigned a local drive before launching the session.
Removable
drives
Allows users to access (from a remote computer) an external drive
plugged in to a USB port.
Home directory Shares the Windows home directory (the entire user directory under
the user account, such as C:\Users\user1) to the remote session.
• Other redirection
Smart cards
Allows users to sign on to the RDS session using only a PIN.
Printers
Shares local printers with a remote Windows session. The printers
appear in the remote session as redirected printers. When this option
is enabled, all local printers are redirected to the remote Windows
session.
To redirect a specific local printer, clear the Printers check box and
specify the printer in the Options text box. For more information, see
“Configuring redirection for a specific printer” on page 289.
3.4.14.1
Redirected device support
Using a redirected device requires support from the Client OS, where the user runs
the Exceed TurboX Client, and the Node OS, where the remote session is running
via the Exceed TurboX node. The following table shows current device support:
Client OS
Printers
Drives
Audio Playback
Smart Cards
Windows
✓
✓
✓
✓
Linux x64
✓
Linux ARM64
✓
Mac
✓
Web
✓
Node OS
Printers
Windows
(Direct
Console)1
246
Drives
Audio Playback
Smart Cards
✓
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Windows
(Direct RDS)2
✓
✓
✓
Linux x64
✓
Linux ARM64
✓
Solaris x64
✓
Solaris SPARC
AIX
1Windows Desktop and Windows Server.
2Windows Server.
3.4.15
Configuring Copy and paste settings in Advanced mode
This section describes the settings available on the Copy and paste tab when you
configure profiles in Advanced mode.
These settings apply only if you are accessing an X Window host using a Windows
or a Mac client. A Linux client can use only automatic copy and paste operations.
Other host/client combinations either do not require or do not offer such
configuration options.
The profile Copy and paste tab allows you to:
• Hide or show the Exceed TurboX Client menu > Edit options.
• Automate copy/paste functions between Windows and X applications.
• Specify the X selection used for copy and paste operations.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
247
Chapter 3 Working with Profiles
You can configure the following settings on the Copy and paste tab:
• General
Hide window
contents in
screenshots
For Windows clients, blacks out the Exceed TurboX window content
when Windows print screen key combinations are used.
For Mac clients, causes the Exceed TurboX window content to appear
as transparent when Mac print screen key combinations are used.
Session snapshots including the full screen view and thumbnail
appear as black for sessions where this check box is enabled.
Note: If you select this option, the Copy All and Copy
Rectangle commands are unavailable on the Exceed TurboX
Client menu even if the menu is enabled in the profile.
• Edit menu items
248
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.4. Customizing profiles in Advanced mode
Copy X
selection
Displays the Copy X Selection option on the Exceed TurboX Client >
Edit menu. Users can use this option to copy text or images to their
local clipboard, save the X selection to a file, or print it on their local
printer.
Note: This option is available only if you are accessing an X
Window host using a Windows client.
This option has no effect when connecting to Windows hosts.
Paste to X
selection
Displays the Paste to X Selection option on the Exceed TurboX Client
> Edit menu. Users can use this option to paste text or images from the
local operating system clipboard or a file on their computer to an X
selection.
Note: This option is available only if you are accessing an X
Window host using a Windows client.
This option has no effect when connecting to Windows hosts.
Clear X
selection
Displays the Clear X Selection option on the Exceed TurboX Client >
Edit menu. Users can use this option to clear the X selection on the
remote host.
Note: This option is available only if you are accessing an X
Window host using a Windows client.
This option has no effect when connecting to Windows hosts.
Copy
rectangle /
Copy all
Displays the Copy Rectangle and Copy All options on the Exceed
TurboX Client > Edit menu. Users can use these option to capture
images during local sessions.
Note: This option is available only if you are accessing an X
Window host using a Windows client.
Menu is visible Makes the Edit menu visible to the user in control of a shared session.
to controller of This includes users who have the presenter role and users who take
shared sessions focus in a collaborative session. The session owner can always see the
Edit menu, whether or not they are the current presenter.
Note: If all the check boxes in the Edit menu items pane are cleared, the
Exceed TurboX Client > Edit menu is hidden.
• Clipboard synchronization
Automatically
synchronize
local to remote
Automatically copies the content of the local Clipboard to the remote
Clipboard when the local Clipboard changes. This enables effortless
pasting of content to remote X applications.
This setting is enabled by default. If you change this setting, it is
applied dynamically and does not require an X server reset.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
249
Chapter 3 Working with Profiles
Remote X
selection to
overwrite
This option is available when Automatically synchronize local to
remote is enabled. It selects which X selection is overwritten when
data is transferred from the user’s local clipboard to the remote host:
– All: Overwrite all X selections (PRIMARY, SECONDARY, and
CLIPBOARD) on the remote host.
– PRIMARY: Overwrite the PRIMARY X selection on the remote
host.
– SECONDARY: Overwrite the SECONDARY X selection on the
remote host.
– CLIPBOARD: Overwrite the CLIPBOARD X selection on the
remote host.
Automatically
synchronize
remote to local
Copies the remote selection to the local Clipboard automatically when
the remote host window loses focus (for example, when the focus
changes to a local system window where the clipboard data may be
pasted).
This setting is enabled by default. If you change this setting, it is
applied dynamically and does not require an X server reset.
Remote X
selection to
read from
This option is available when Automatically synchronize remote to
local is enabled. It specifies which remote X selection is copied to the
user’s local clipboard:
– Last updated: Copies the most recently updated X selection
(PRIMARY, SECONDARY, or CLIPBOARD) to the user’s local
clipboard. This is the default setting, which works with all X
applications, no matter which X selection the application writes to.
– PRIMARY: Transfers only the PRIMARY X selection to the local
clipboard.
– SECONDARY: Transfers only the SECONDARY X selection to the
local clipboard.
– CLIPBOARD: Transfers only the CLIPBOARD X selection to the
local clipboard.
For information about the action icons available on the profile toolbar, see “Using
the profile toolbar in Exceed TurboX Server Manager” on page 194.
3.5 Configuring Custom startup mode
This section describes how to configure session startup in a profile using Custom
startup mode.
250
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
You can configure custom startup mode in two ways:
• Without a startup configuration (Xstart): In this case, a session proxy will be
started on the Exceed TurboX Connection Node, but no applications will be
launched. You can display graphical applications in the session in two ways:
–
Connecting to an X Window host (for example, via TELNET or SSH),
exporting the DISPLAY on that host to point to the running session display,
then launching a graphical X Window application.
–
Launching an Exceed TurboX profile that has Reuse session enabled. If the
profile is compatible with the running session, the profile will launch any
graphical windows using the already running session
• With one or more startup configurations (Xstarts) defined: In this case, a session
proxy will be started on the Exceed TurboX Connection Node, and the command
defined in the Xstart will be executed on the specified host. If the command
launches a graphical application, the application will display its windows inside
CONETX120501-AGD-EN-3
Server Manager Administration Guide
251
Chapter 3 Working with Profiles
the session. Additional commands (and associated graphical applications) can be
displayed in this session using either of the two ways listed in the previous
bullet.
For information on starting a session in this mode, see “Launching sessions in
Custom startup mode” in the Exceed TurboX Dashboard and Client Help.
3.5.1
What is a startup configuration (Xstart)?
A startup configuration (Xstart) automates the process of connecting to a host and
starting applications that reside on it. You can configure, name, and save one or
more Xstarts within a profile. You also specify a startup method. For a list of
supported startup methods, see “Supported Custom startup methods” on page 257.
You can create multiple Xstarts in a single profile. When you launch a session with
the profile, the Xstarts are executed in the order in which they appear in the profile.
Profiles and templates created by the administrator can also include preconfigured
Xstarts.
For example, when a session is started, an Xstart can run one or more applications
on the host automatically, saving you the time of manually starting the applications
for the session.
Caution
If you choose Windows application startup method and select Run on local
node, the Xstart will only be able to run on a Windows node. Similarly,
when you select X Window Host Application, the Xstart will only be able to
run on an X Window node. This means that if your profile contains both
Local Windows and Local X Window Xstarts, some of them will fail to run
because the selected node will be incompatible.
3.5.2
Adding Xstarts to a Custom startup profile
To add Xstarts to a Custom startup profile:
1.
Create a new profile or edit an existing profile.
See “Creating and editing profiles and templates” on page 188 for more
information.
2.
In the profile Startup tab, change the startup mode to Custom startup.
Note: If you are editing a profile, the ability to change the startup mode
may be locked in the underlying template. Instead of unlocking the
Startup mode in the template, create or edit a profile based on the Default
Custom Startup template or a copy of that template. This ensures that the
profile uses settings optimized for launching Xstarts.
3.
252
Do one of the following:
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
• To create a new Xstart, click the Add Xstart button
.
• To use an existing Xstart as the basis for a new one, click the Copy button
of the desired Xstart. Then, click the Edit button
configure the copy.
• To modify an existing Xstart, click the Edit button
want to edit.
of the copy to
of the Xstart that you
Whether you are editing or creating an Xstart, an Xstart dialog box opens. For
example, when you click Add Xstart, the New Xstart dialog box opens.
4.
In the Xstart dialog box, modify the Xstart settings, as necessary. For a list of
settings you can customize, see “Configuring Xstart settings” on page 254.
5.
To configure additional options, click Advanced Settings in the Xstart dialog
box.
The Advanced settings dialog box opens.
This dialog box allows you to configure settings for session use, security, how
startup should handle connection and sign-in prompts, and the remote desktop
session. For more information about the Advanced settings you can configure,
see:
• “Configuring startup settings on the General tab” on page 279
• “Configuring startup settings on the Prompts tab” on page 284
• “Configuring startup settings on the ETX RDP tab” on page 286
Note: The tabs available and the settings you can customize depend on the
startup method.
6.
When you are finished configuring the advanced settings, click OK to return to
the Xstart dialog box.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
253
Chapter 3 Working with Profiles
7.
Click OK to return to the profile dialog box.
8.
Click Save to save the Xstart you just created or edited.
The newly created Xstart is listed in the Startup tab of the profile.
9.
If there are multiple Xstarts associated with the profile, Exceed TurboX executes
them all at launch time, in the order in which they appear in the Startup tab.
To change the order in which the Xstarts run, use the Reorder icon
and drop each Xstart to its new position.
10. To delete an Xstart, click its Delete button
to drag
.
11. To create more Xstarts that perform other tasks (such as launching other
applications), repeat the process.
12. In the profile dialog box, click Save.
The profile is ready to launch a session in Custom mode.
Note: If you are not using a local window manager (HWM, MWM, or
native window manager), you must start a remote X window manager.
3.5.3
Configuring Xstart settings
The Xstart dialog box allows you to specify the startup method, the host that you
want to connect to, and the sign-in credentials to use. If necessary, you can also
access the Xstart Advanced settings dialog box, which lets you configure more
advanced options (See “About Advanced settings for select startup modes”
on page 278 for more information).
You can configure the following settings in the Xstart dialog box:
Xstart name
(title bar)
254
Click the Edit button in the title bar and enter a name for the Xstart.
Typically, this name refers to the host and/or application that the Xstart
will connect to.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
Startup method Specify the startup method to use to establish communication with the
application host.
Xstart supports the following startup methods:
• Secure startup methods: Secure Shell, X Window Host Application,
and Windows application.
• Insecure startup methods: REXEC, RSH, RLOGIN, and TELNET.
These startup methods send information over the network in plain
text. For security reasons, these startup methods are not shown by
default. To show insecure startup methods in the Startup methodlist,
you must change the Exceed TurboX site settings.
See “Configuring general site settings” on page 95 for more
information.
See “Supported Custom startup methods” on page 257 for more
information about each startup method.
Run on local
node
This option is available for the Windows application and X Window Host
Application startup methods.
If you choose the Windows application startup method and select Run on
local node, the Xstart will only be able to run on a Windows node. It will
not be able to run on a remote node. Similarly, when you select X Window
Host Application, the Xstart will only run on an X Window node. This
means that if your profile contains both Local Windows and Local X
Window Xstarts, some of them will fail to run due to the selected node
being incompatible.
Application
Host / X
Application
Host
Credentials
Type the name or IP address of the host to connect to.
This field is not available if you are using the X Window Host
Application startup method, as this method runs on the local host only.
The same is true when you use the Windows application startup method
with Run on local node selected.
Select one of the following options to specify the credentials to use:
• Use session credentials: Use the currently logged in Exceed TurboX
credentials to authenticate against the remote host.
If the server administrator has specified a Default domain in the
general site settings, the domain may be added automatically to your
user name. See Add domain to username in “Configuring startup
settings on the General tab” on page 279 for more information.
• User specified: Exceed TurboX authenticates on the remote host using
the entered Usernameand Password.
Unlike the Use session credentials setting, the domain is never added
to the user name in this mode. If your environment requires you to
specify a domain as part of your user name, you must include the
domain in the Username field.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
255
Chapter 3 Working with Profiles
Command
Type the command line to start the application you want. The type of
command depends on the host system and configuration.
For example, some typical window manager startup commands include:
•
•
•
•
•
•
Motif (UNIX): [<path>/]mwm&
OpenLook: [<path>/]olwm&
AIX: [<path>/]aixwm&
KDE (Linux): [<path>/]startkde&
Gnome (Linux): [<path>/]gnome-session&
CDE: [<path>/]dtwm&
See “Command syntax for starting applications” on page 259 for more
information about commands you can use.
The Command box may also include macros, which can customize the
startup command based on criteria such as current user, display number,
hostname, or parameters passed via URL. See “Using Xstart Macros”
on page 262 for information about macros.
Note: The Command box is not available for the Windows
application startup method.
Application
Use this field to specify the path to the executable. For example:
C:\Windows\notepad.exe
This field may also include macros, which can set the application path
based on information only available at runtime. (Such as the current
username, or launch parameters passed via URL.) See “Using Xstart
Macros” on page 262. for information about macros.
Note: This field is only available for the Windows application
startup method.
See “Launching Windows applications” on page 268 for more
information about supported methods for launching Windows
applications.
Parameters
Use this field to specify the command parameters. For example:
-f filename.txt
This field may also include macros, which can pass dynamic startup
parameters to an application, such as the current user, display number,
hostname, or parameters passed via URL. See “Using Xstart Macros”
on page 262 for more information about macros.
Note: This field is only available for the Windows application
startup method.
256
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
3.5.4
Supported Custom startup methods
Xstart supports the following secure startup methods:
• Secure Shell: Uses the Secure Shell protocol (SSH) to establish the connection with
the specified host. This method offers added security by encrypting user
credentials and X11 traffic (if enabled). The remote system must be running an
SSH server which listens for SSH commands (for example, sshd on UNIX
systems). The Secure Shell protocol operates on the default TCP port 22. You can
change the port number by including the -p <port> option in the secure shell
parameters.
• X Window Host Application: Starts an X application on behalf of an authorized
user. Requires a user ID and password. Additional authentication options are
available in the Advanced settings dialog box (for details, see “About Advanced
settings for select startup modes” on page 278). When sign-in information is
validated, the command specified in the Command box is executed directly on
the Connection Node. Requires the Exceed TurboX Connection Node software to
be installed on the application host.
• Windows application: Starts a Windows application within your Exceed TurboX
session. Requires a user ID and password. When sign-in information is validated,
the application specified in the Application box is launched, using the
parameters defined in the Parameters box.
The Windows application startup method uses the RDP protocol, which
operates on TCP port 3389 and UDP port 3389.
To successfully launch a Windows application, the target host must meet the
following criteria:
–
It must be a supported Windows Server Operating System.
–
The Exceed TurboX Connection Node software must be installed.
–
The Remote Desktop Services role must be enabled.
–
Group policy on the host must allow running unlisted applications.
–
Group policy on the host must allow running multiple applications per user.
–
RDS connections must be allowed.
Note: The Connection Node installer for Windows operating systems
checks if these conditions have been met. If they are not met, you are
prompted to change these settings.
Xstart supports the following insecure startup methods:
Note: These startup methods send information over the network in plain
text. For security reasons, these startup methods are not shown by default.
To show insecure startup methods in the Startup method list, you must
change the Exceed TurboX site settings.
See “Configuring general site settings” on page 95for more information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
257
Chapter 3 Working with Profiles
• REXEC: Uses the REXEC protocol to run non-interactive programs on a remote
system. The remote system must be running an REXEC server, which listens for
REXEC commands (for example, rexecd on UNIX systems). The REXEC protocol
operates on the default TCP port 512.
• RSH: Uses the RSH protocol to establish the connection with the specified host.
This startup mode does not require a password. However, the Exceed TurboX
Connection Node must be authorized for RSH access on the host to which you
connect. Exceed TurboX sends the specified sign-in name to the RSH daemon on
the host. If you are using an .rhosts file to allow access to your host, use the
exact spelling and letter case of your sign-in name as specified in the file, because
RSH is case sensitive.
The RSH protocol operates on the default TCP port 514.
Note: When running in RSH startup mode, Exceed TurboX sends the signin name you used on the Exceed TurboX Server sign-in page to the host’s
RSH daemon. If you use an .rhosts file to allow access to your host, you
must use the name of the Exceed TurboX node as the remote host name,
and your Exceed TurboX sign-in name as the remote user name.
The host RSH daemon will not accept user names longer than 14 characters.
To avoid error, Exceed TurboX passes only the first 14 characters of a user
name. If a user name is longer than 14 characters, truncate it when
including it in the .rhosts file.
• RLOGIN: Uses the RLOGIN protocol to establish a remote connection to run X
applications. It allows an authorized user to sign in to hosts on a network and to
interact as if the user were physically at the host computer. Requires a user ID
and password. The remote system must be running an RLOGIN server (for
example, rlogind on UNIX systems). The RLOGIN protocol operates on the
default TCP port 513.
• TELNET: Uses the TELNET protocol to connect a PC to a host on the network. An
authorized user can enter commands through TELNET and they will be executed
as if the user were entering them directly on the server console. Requires a user
ID and password. The remote system must be running a TELNET server (for
example, telnetd on UNIX systems). The TELNET protocol operates on the
default TCP port 23.
For detailed information about commands and macros you can use for sign-in and
application startup, see “Command syntax for starting applications” on page 259.
For advanced settings available for select Custom startup methods, see “About
Advanced settings for select startup modes” on page 278.
258
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
3.5.5
Managing startup configurations (Xstarts) in Custom
profiles
This section describes the tasks you can perform when managing startup
configurations (Xstarts) within a profile.
If you edit or create a profile to use Custom startup mode, and you have created
Xstarts within it, they are displayed as a list.
If you are creating a new profile from scratch, no Xstarts are included by default.
When creating and working with Xstarts, the following actions are available on the
Startup tab for the profile:
Add Xstart
Lets you create and configure an Xstart.
If an X profile contains multiple Xstarts, when you launch a session
Exceed TurboX runs them in the order in which they appear in the list.
Drag this icon to move an Xstart in the list.
Copy
Edit
Delete
3.5.6
Copies the Xstart. You can use the copy as the basis for a new Xstart.
Edits the Xstart.
Deletes the Xstart.
Command syntax for starting applications
This section describes the commands and macros you can use for sign-in and
application startup.
The command line syntax you use to start an application depends on:
• The application host operating system (typically, UNIX/Linux or VMS).
• Whether you have defined certain environment variables on your application
host.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
259
Chapter 3 Working with Profiles
3.5.6.1
Command Line Syntax for UNIX/Linux Hosts
This section describes the syntax of the Xstart > Command field for the following X
Window startup modes:
• Secure Shell
• Plain text shell (TELNET, REXEC, RSH, RLOGIN)
• X Window Host Application
The Windows application startup mode uses a different syntax. See “Launching
Windows applications” on page 268 for more information.
Use the following command line syntax to start an application:
[<install_path>/]<application> [<parameters>] [-display <displayspec>]
[&]
where:
install_path
The directory where the application is located.
If you have pre-configured the PATH environment variable on your host,
you may not need to enter the path on the command line. For more
information, see “Setting Environment Variables on UNIX/Linux Hosts”
on page 265.
application
The executable name of the application to run.
parameters
Any command line parameters for the application.
displayspec
The display specification of your Client Desktop, in one of these formats:
<hostname>:<display#> or <ipaddress>:<display#>
For example, ewebhost:2 or 123.45.67.89:1. You can determine the
hostname, display number, and IP address to use by using information
displayed in the Desktop title bar.
In most cases, you can use @d to specify your displayspec.
&
Run the application in the background.
When starting applications, you should start them in background mode.
For example, you can type the following to start the xterm application:
/usr/bin/X11/xterm -sb -ls -fg blue -bg lightgrey -display etxhost:2 &
With any startup method, you can specify the following command to start xterm
and display the user ID and hostname in the title bar of the application in the form
<userID>@<hostname>:
/usr/bin/X11/xterm -sb -ls -fg blue -bg lightgrey -display @d -name
“@u@@@h”&
260
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
For more information on using macros, such as @d and @u, see “Using Xstart
Macros” on page 262.
If you have pre-configured the DISPLAY environment variable for the host, you can
omit the -display <displayspec> parameter when starting an application from
that shell and just use the following command line syntax:
[<install path>/]<application> [<parameters>] &
For example:
/usr/bin/X11/xterm -sb -ls -fg blue -bg lightgrey &
3.5.6.2
Command Line Syntax for VMS Hosts
This section describes the command line syntax you use to start X applications on
VMS hosts.
If your VMS system supports REXEC, RSH, TELNET, or Secure Shell, and is running
version 5.0 or higher of the PCX$SERVER command processor, you can specify a
command with the following syntax to start an application using the REXEC, RSH,
TELNET, or Secure Shell startup methods:
@@sys$system:pcx$server 4,@#,0,tcpip,@a <application>
where <application> is the command line executable required to run the
application.
For example, to start the xterm application:
@@sys$system:pcx$server 4,@#,0,tcpip,@a DECW$TERMINAL
You must use the @# and @a macros because the display number and IP address are
not necessarily the same for each session.
If you selected the Custom startup mode in the profile, and you want to specify the
X display server to which the application should connect, you must define the
DISPLAY environment variable before starting applications.
Note: You do not need to define the DISPLAY environment variable when
using the REXEC, RSH, TELNET, or Secure Shell startup method, because PCX
$SERVER sets the DISPLAY variable.
Do not specify the DISPLAY environment variable in your host sign-in file
because the IP address and display number are not necessarily the same in
each session.
Use the following syntax example to set the DISPLAY environment variable:
set display/create/node=123.183.33.17/transport=tcpip/server=2
When setting the DISPLAY environment variable, keep the following in mind:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
261
Chapter 3 Working with Profiles
• You can determine the IP address and display number from the information
displayed on the Client title bar.
• Do not put spaces before or after the equal (=) sign.
Once the DISPLAY environment variable is set correctly for a sign-in session, you
can start an application from that session using the following command line syntax:
run sys$system:decw$<application>
For example:
run sys$system:decw$clock
3.5.6.3
Using Xstart Macros
Xstart macros are reserved symbols that are replaced at runtime with specific values,
such as the user name or display number. For a list of supported Xstart macros, see
“List of Xstart Macros” on page 262.
You can use macros and commands in the following locations:
• The Username and Password fields when configuring an Xstart.
• The Command field available when you configure Custom startup mode in a
profile for any startup method other than Windows application.
• The Application and Parameters fields available when you configure Custom
startup mode in a profile for the Windows application startup method.
• The Reply field on the Prompts tab of the Xstart Advanced settings dialog box.
• The Connection Parameters and Enter Reply for Prompt dialog boxes that can
be opened when starting in Custom mode.
3.5.6.4
List of Xstart Macros
This section describes the available Xstart macros. Letters in macros can be upper or
lower case.
@a
The IP address or hostname of the Connection Node.
When running applications directly on a node, @a inserts the node
hostname. For remotely running applications, such as SSH and TELNET,
@a inserts the IP address of the Connection Node, as seen by the remote
application host. This is done to support nodes that have multiple IPs.
For example, if 123.45.67.89:5 is the display specification, then 123.
45.67.89 is the IP address of the Connection Node.
262
@b
The user ID of the user who runs the Xstart child process on the target
node.
@%c%
The IP address of the Client machine as reported by the Client.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
@d
The display specification of the session in the format:
address:display#.
For example, 123.45.67.89:1.
For applications running remotely (for example, SSH and TELNET), the
address portion of the display is the IP of the Connection Node.
For applications running directly on a node, the address portion of the
display specification is blank. For example, :1.
@h
The host value, as required by the selected startup method, specified in
the Host box of the Xstart dialog box.
@i
The host-specified IP address in the profile.
@k
Kerberos credential file.
@m
The default domain name.
@n
@s or the looked-up host name of @s, depending on the configuration.
@p
The user's remote command password.
@s
The IP address of the user workstation as reported by the Connection
Node.
@t
The Exceed TurboX profile name.
@u
The user name specified on the Startup page when you configure a
profile.
@w
The user’s Exceed TurboX sign-in information.
@x
The dynamic Xauth cookie string.
@y
The Xauth file location. This location depends on the xstart.
XauthFile setting in the Exceed TurboX profile.
@~
The user’s home directory.
@@
The @ character.
@#
The display number of the session.
For example, if 123.45.67.89:1 is your display specification, then 1 is
the display number.
@%ENVVAR%
The value of the corresponding environment variable on the client
machine, if that variable is defined. If the value of the client machine
environment variable is undefined, %ENVVAR% is not substituted and
the startup profile may fail.
@{ }
Parameter values from a URL. For more information, see “Passing URL
Parameters via Xstart Macros” on page 264.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
263
Chapter 3 Working with Profiles
3.5.6.5
Passing URL Parameters via Xstart Macros
This section provides information about how you can pass URL parameters via an
Xstart macro. Exceed TurboX enables users to launch profiles by accessing a URL
that includes the ID of the profile to launch. For example:
https://myserver.example.com/etx/#profile=
1e8dc82a-596f-623c-8bc5-500000000130
This launches profile 1e8dc82a-596f-623c-8bc5-500000000130 on behalf of the
user.
Note: Users need to sign in to Exceed TurboX if they do not already have an
active session.
In addition, profiles that use the Custom startup mode with one or more Xstarts
defined may also accept parameters from the URL via a special query string. This
uses the following format:
https://myserver.example.com/etx/#profile=
1e8dc82a-596f-623c-8bc5-500000000130&commandmacro=<param1>=<value1>,<
param2>=<value2>,...,<paramN>=<valueN>
The commandmacro flag is a reserved keyword, which indicates that the URL
contains parameter name and value pairs. These values can then be referenced
inside an Xstart Command box using the @{} macro. For example:
xterm -title=@{<param1>} -geometry=@{<param2>} -fn @{<paramN>}
When the profile is launched by a user, @{<param1>} in the shell command will be
replaced by <value1> from the URL, @{<param2>} will be replaced by <value2>
from the URL, and so on.
Parameter names must contain alphanumeric characters only. Parameter values may
contain alphanumeric characters and/or percent-encoded symbols.
If your values contain special characters—such as comma ( , ), the equal sign ( = ), or
backslash ( \ )—that are reserved for the URL query string, then they must be
escaped with a backslash. For example, if a value string is:
report=Jan,Feb\expired
then it must be encoded as:
report\=Jan\,Feb\\expired
If your values are URLs and the URL will be used as a URL, use an online URL
encoder (such as https://www.urlencoder.org/) to encode them into URL-safe
parameters.
264
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
3.5.6.6
Setting Environment Variables on UNIX/Linux Hosts
This section describes how you can simplify the startup of an application by setting
environment variables. To simplify the startup of applications on UNIX/Linux hosts,
define the following environment variables on your host:
• DISPLAY
• PATH
If you would like to start X applications on a Sun host running OpenWindows, you
may also need to specify the following environment variables on your host:
• OPENWINHOME
• LD_LIBRARY_PATH
3.5.6.6.1
DISPLAY Environment Variable
You can define the DISPLAY environment variable for your current sign-in session
on a UNIX/Linux host. Many applications use this variable to determine the X
display that they should use.
Note: The syntax you use to specify the DISPLAY environment variable
depends on whether you are using the C shell (displays a percentage “%”
prompt by default) or the Bourne or Korn shell (displays a dollar sign “$”
prompt by default).
To set the DISPLAY environment variable, you need to type the following command
at the command prompt for each shell:
• For a C shell (%):
setenv DISPLAY <displayspec>
Example: setenv DISPLAY etxhost:2
• For a Bourne/Korn shell ($):
DISPLAY=<displayspec>
export DISPLAY
Example:
DISPLAY=etxhost:2
export DISPLAY
Note: Do not specify the DISPLAY environment variable in your hostlogin file
because your displayspec is not necessarily the same in each session.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
265
Chapter 3 Working with Profiles
3.5.6.6.2
PATH, OPENWINHOME, and LD_LIBRARY_PATH Environment Variables
You may specify the PATH, OPENWINHOME, and LD_LIBRARY_PATH environment
variables on UNIX/Linux hosts.
Note: The OPENWINHOME and LD_LIBRARY_PATH environment variables are
needed only for Sun OpenWindows hosts.
Using these environment variables, you can add directories to your path
specification. If you enter a command without specifying its full path, the shell
searches each directory listed in the PATH, OPENWINHOME, and LD_LIBRARY_PATH
environment variables for the application executable and executes the first one it
finds. Consider specifying these environment variables in your host login file
(described in the procedure in this section) so they are set each time you log on to
the host.
The following list provides the commands required by each shell to set the PATH
environment variable, where path is a directory that you want to include on your
host path. Separate multiple paths with colons (:).
• For a C shell (%):
setenv PATH
<path>:<path>:<path>
Example:
setenv PATH
/usr/bin/X11:/usr/b in/jsmith
• For a Bourne/Korn shell ($):
PATH=<path>:<path>:<path>
export PATH
Example:
PATH=/usr/bin/X11:/ usr/bin/jsmith
export PATH
The following list provides the commands required by each shell to set the
OPENWINHOME and LD_LIBRARY_PATH environment variable, where usr is the
directory on the host where the X Window system files reside.
• For a C shell (%):
setenv OPENWINHOME /usr/openwin
setenv LD_LIBRARY_PATH /usr/openwin/lib
• For a Bourne/Korn shell ($):
OPENWINHOME=/usr/openwin
LD_LIBRARY_PATH=/usr/openwin/lib
266
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.5. Configuring Custom startup mode
export OPENWINHOME LD_LIBRARY_PATH
To determine which environment variables are defined and their values, type the
following commands at the shell prompt:
• For a C shell (%):
setenv
printenv
• For a Bourne/Korn shell ($):
env
export
printenv
To determine if a specific environment variable is defined and to determine its
value, type the following command at the shell prompt:
echo $<variablename>
where <variablename> is the name of the environment variable.
If the environment variable is not defined, or is incorrectly defined, define it
properly in your startup configuration.
To define the environment variable in your host startup login file:
1.
Open your host startup login file in a text editor. If you are using the C shell,
the .cshrc file in your home directory is the login file. If you are using the
Bourne or Korn shell, the .profile file in your home directory is the host login
file.
2.
Find the environment variable in the file and enter the correct command as
specified in this section.
Note: If the environment variable is not defined, specify the environment
variable by typing the command at the end of the file.
3.
Save the file and exit the text editor.
The next time you start a shell session, your environment variable will be set
according to your host startup login file. To verify this, start a new login/shell
session and use the commands described above to determine the current value of
these environment variables.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
267
Chapter 3 Working with Profiles
3.5.7
Launching Windows applications
There are two ways to launch Windows applications:
• RemoteApp
• Specifying the path to the executable. For example:
C:\Program Files\MyApplication\app.exe
Note: Under Windows RDP 2008, the Windows PATH environment variable
is respected. You can enter an application filename without its full path, as
long as that directory is defined in the variable.
Windows 2012 does not support PATH. This requires you to enter the full
path of a command. To work around this restriction, you can configure a
system environment variable to point to the appropriate directory. For
example, configuring windir as the environment variable pointing to the
applicable directory allows you to enter %windir% \system32\mspaint.
exe as a valid command. This method ensures that such commands will
work on any Windows RDP host, even if the Windows operating system is
not installed on a C: drive. Windows system environment variables can be
used for Application, Parameters, and Working Directory settings.
To launch a RemoteApp application from an Exceed TurboX profile:
You can launch RemoteApp programs, which have been published in supported
Windows nodes for use over RDP, from an Exceed TurboX profile.
1.
Create a profile using the Default Custom Startup template.
2.
On the Startup tab click Add Xstart.
3.
Select the Windows application startup method.
4.
In the Parameters box, type a double pipe (||) followed by the alias of the
published application name. For example, if the name of the RemoteApp is
MSWord, enter:
|| MSWord
5.
Click OK, then click Save.
When you launch the profile, it will start the RemoteApp.
To launch an application using the path to the executable:
Note: To launch applications using the executable path, the group policy on
the host must allow unlisted (that is, not RemoteApp) applications. Otherwise
you can only run RemoteApp applications using the double pipe notation
described in “To launch a RemoteApp application from an Exceed TurboX
profile:“ on page 268. This group policy setting is configured during
installation of the Windows Connection Node. See “Installing Exceed TurboX
268
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.6. Configuring Published application startup mode
Connection Nodes” in the Exceed TurboX Installation and Configuration Guide for
more information.
1.
Create a profile using the Default Custom Startup template.
2.
On the Startup tab, click Add Xstart.
3.
Select the Windows Application startup method.
4.
In the Application box, enter the path to the application. For example:
C:\Windows\winword.exe
5.
Click OK, and then click Save.
When you launch the profile, it will start the application.
3.6 Configuring Published application startup mode
Published application mode allows you to launch an application that was published
by an Exceed TurboX administrator. This section describes how to configure session
startup using Published application mode.
For detailed information about published applications, see “Managing published
applications” on page 92.
The Advanced settings dialog box allows you to configure advanced settings such
as session use, security, how startup should handle connection and sign-in prompts,
and remote desktop session settings.
You can configure the following Published application settings on the Startup tab
in Advanced mode:
Application
From the list of available applications, select the application to launch
when a session starts. If the list is dimmed, then there are no published
applications available on this server.
Host
Select Auto-select to allow Exceed TurboX to choose an available host, or
select one from the list.
Note: Host selection is subject to session reuse and load balancing.
Run Windows
application in
Direct mode
This option is available only for Windows-based published applications.
Select this option to have Exceed TurboX connect to the remote Windows
host using direct mode instead of RDP mode.
Choosing direct mode disables the Advanced settings button, as the
advanced settings apply to RDP connections only.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
269
Chapter 3 Working with Profiles
Credentials
Select the credentials to use to connect to the remote host:
• Use session credentials: Use the credentials that you used to sign in to
Exceed TurboX.
If the server administrator has specified a Default domain in the
General site settings, the domain may be automatically added to your
user name. See Add domain to username in “Configuring startup
settings on the General tab” on page 279 for more information.
User
specified: Use the Username and Password that you enter on
•
this tab.
Unlike the Use session credentials setting, the domain will never be
prepended to the user name in this mode. If your environment
requires you to specify a domain as part of your user name, you must
include the domain here.
To configure the Advanced settings:
1.
On the profile Startup tab (Advanced mode), click Advanced settings.
The Advanced settings dialog box opens, showing the General, Prompts, and
ETX RDP tabs.
2.
For a list of settings you can configure on each of these tabs, see:
• “Configuring startup settings on the General tab” on page 279
• “Configuring startup settings on the Prompts tab” on page 284
• “Configuring startup settings on the ETX RDP tab” on page 286
3.
When the advanced settings configuration is complete, click OK to return to the
Startup tab.
4.
Click Save to save the profile.
3.7 Configuring Windows application startup mode
This section describes how to configure the Windows application startup mode in a
profile.
To configure the Windows application startup mode
1.
Open the profile you want to configure.
2.
In the profile dialog box, on the Startup tab, enter the following information:
• In the Application box, specify the path to the executable. For example:
C:\Windows\notepad.exe
• In the Parameters box, enter the command parameters. For example:
-f filename.txt
3.
270
To configure additional Startup settings, click Advanced mode.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.8. Configuring the Windows Desktop - Direct startup mode
4.
On the Startup tab in Advanced mode, configure the following settings:
• The Application and Parameters fields will be populated with the
information you entered in Basic mode.
• At Credentials, select one of the following options to specify the credentials
to use:
5.
–
Use session credentials: Use the Exceed TurboX credentials of the user
who is currently signed in to authenticate against the remote host.
–
User specified: Exceed TurboX authenticates on the remote host using
the Username and Password you enter.
Click Save to save your settings.
3.8 Configuring the Windows Desktop - Direct
startup mode
This section describes how to configure a profile to launch a direct Windows
desktop session.
Windows Desktop - Direct mode (referred to here as “Direct” mode) uses a
proprietary protocol to connect to and display remote Windows desktops. This
means that each Windows host you are connecting to must have the Exceed TurboX
Connection Node software installed. Direct mode provides better performance than
Windows Desktop - RDP mode by eliminating extra protocol layers and by
supporting additional hardware capabilities, such as direct frame buffer capture.
Direct mode can operate in two different ways (console mode and multi-user mode),
depending on the Windows host and profile settings you are using:
• Console mode: This mode is supported on Windows Desktop operating systems
(Windows 7, 8, and 10) and Windows Server operating systems (Windows 2008
R2 and later). In console mode, the Windows “physical” console session is
captured and sent to the remote user. The Windows console session is the same
desktop session which is shown on the physical monitor that is connected to the
host. For this reason, console mode is only recommended for virtual machines or
“headless” (no monitor connected) physical machines deployed in secure server
rooms. Using console mode to connect to a physical machine in a publicly
accessible location is not recommended, because anyone with physical access
could attach a display to the machine and observe the user’s remote session.
• Multi-user mode: This mode is supported only on Windows Server operating
systems (Windows 2012 R2 and later). In multi-user mode, multiple users can
connect to a shared Windows Server host and create their own private desktop
sessions. This mode supports greater scalability by enabling a single host to serve
many users. Multi-user Direct desktop mode provides the same optimizations as
console mode, and is safe to use with physical machines that have connected
displays. The Windows Server hosts may be either physical or virtual.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
271
Chapter 3 Working with Profiles
Refer to the following table for a quick reference to functionality available in
Windows Desktop - Direct console mode and multi-user mode.
Console mode
Multi-user mode
Supports only a single user session.
Supports multiple user sessions.
Supported on any Windows version
supported with Exceed TurboX.
Requires Windows Server 2012 R2 and later
versions.
Supports multiple monitors.
Supports multiple monitors.
Note: If using an NVAPI-capable GPU
(GRID or mid-range NVIDIA Quadro,
K2000+), it connects virtual monitors
and can run headless. Otherwise, it
requires multiple physically-connected
monitors. The maximum number of
supported monitors is limited by the
GRID profile type for GRID VMs
(typically 1-4), or the number of
outputs on the GPU for physical
machines (typically 3-4).
Supports standard resolutions up to UHD on Supports any resolution.
NVAPI-capable GPUs. For other GPUs, the
resolution is restricted to the output
resolutions supported by the GPUs and/or
monitors physically connected to the remote
host.
Provides access to the same desktop session
that is seen when physically accessing a
machine.
Creates a virtual session.
Provides full 3D support with any GPU
vendor.
Requires NVIDIA hardware (Tesla, GRID,
Quadro K2000, or higher GPU) to support 3D
accelerated sessions. For information about
tested GPUs, contact OpenText support.
Note: If NVIDIA hardware is not
available on the Windows Server host
and you require 3D acceleration, you
must force the session to start in
console mode by selecting the Use
console on Windows Server check box
in the profile Startup tab.
To make sure that the profile is configured properly for Windows Desktop - Direct
mode, ensure that a Windows Connection Node or Node Group is selected in the
Node targeting box on the Session tab. For more information about the Node
targeting options, see “Configuring Session settings in Advanced mode”
on page 202.
You can configure the following Windows desktop - Direct settings on the Startup
tab in Advanced mode:
272
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.8. Configuring the Windows Desktop - Direct startup mode
Run on node
This option is read-only and pre-selected, to remind users that this startup
mode launches a desktop locally on the Windows node.
Use console on
Windows
Server
Forces the session to start in console mode on Windows Server. If a
session is already running on the selected host, the session will
automatically start in multi-user mode.
If this check box is cleared, the session starts in multi-user mode. If multiuser mode is unavailable on the selected host, an error message is
displayed.
Note: This check box has no effect when connecting to a Windows
desktop edition host (Windows 7, 8.1, or 10), as these hosts support
only console sessions.
Host
This option is read-only and is set to Run on node, to remind users that
this startup mode runs on the Windows Connection Node or Node
Group.
Note: This setting is not available when creating or editing
Windows Desktop – Direct templates.
Credentials
Select the credentials to use to connect to the remote host:
• Use session credentials: Uses the credentials that you used to sign in
Exceed TurboX.
If the server administrator has specified a Default domain in the
General site settings, the domain may be automatically added to your
user name. For more information, see Add domain to username in
“Configuring startup settings on the General tab” on page 279.
• Windows sign-in screen: Supported only in multi-user mode, on
Windows Server 2012 R2 and later. Prompts you to enter your
credentials at the Windows sign-in prompt.
• User specified: Uses the Username and Password that you enter on
this tab.
Note: Unlike the Use session credentials setting, the domain
will never be prepended to the user name in this mode. If your
environment requires you to specify a domain as part of your
user name, you must include the domain in the Username.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
273
Chapter 3 Working with Profiles
3.9 Configuring the Windows Desktop - RDP startup
mode
This section describes how to configure a profile to launch a Windows Desktop RDP session. The Windows Desktop - RDP startup mode launches a remote
Windows Desktop session.
You can configure the following Windows desktop - RDP settings on the Startup
tab in Advanced mode:
Run on local
node
Launches an RDP desktop session directly on the Connection Node, as
opposed to starting an RDP session between the node and a remote
Windows RDP host.
Host
Enter the hostname or IP address of the RDP server to connect to, or leave
blank to have the user enter or select the server name or address when
they start a session. By default, the user is prompted for the server
information only if you leave this field blank. You can change this
behavior by changing the Host prompt setting on the Prompts tab of the
Advanced Settings page. See “Configuring startup settings on the
Prompts tab” on page 284 for more information.
If Run on node is selected, the Host field is not available.
Credentials
Select the credentials to use to connect to the remote host:
• Use session credentials: Use the credentials that you used to sign in to
Exceed TurboX.
If the server administrator has specified a Default domain in the
General site settings, the domain may be automatically added to your
user name. For more information, see Add domain to username in
“Configuring startup settings on the General tab” on page 279.
• Windows sign-in screen (no NLA support): Prompt for Windows
credentials when the connection is established.
Note: Because Network Level Authentication (NLA) does not
allow you to sign in from the Windows sign in screen, this
authentication mode will fail in environments where NLA is
enabled.
• User specified: Use the Username and Password that you enter in this
tab.
Note: Unlike the Use session credentials setting, the domain
will never be prepended to the user name in this mode. If your
environment requires you to specify a domain as part of your
user name, enter the domain manually here.
The Advanced settings dialog box allows you to configure advanced settings, such
as session use, security, how startup should handle connection and sign-in prompts,
and remote desktop session settings.
274
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.10. Configuring XDMCP Broadcast startup mode
To configure the Advanced settings:
1.
On the profile Startup tab (Advanced mode), click Advanced settings.
The Advanced settings dialog box opens, showing the General, Prompts, and
ETX RDP tabs.
2.
For descriptions of the settings you can configure on each tab, see the following
sections:
• “Configuring startup settings on the General tab” on page 279
• “Configuring startup settings on the Prompts tab” on page 284
• “Configuring startup settings on the ETX RDP tab” on page 286
3.
When the advanced settings configuration is complete, click OK to return to the
Startup tab.
4.
Click Save to save the profile.
3.10 Configuring XDMCP Broadcast startup mode
This section describes how to configure a session startup using X Display Manager
Control Protocol (XDMCP) Broadcast mode.
When you launch a session in XDMCP Broadcast mode, Exceed TurboX broadcasts
to each available application host on the network to determine which are available to
manage your X display.
Note: You can broadcast/multicast requests to the hosts you list in the custom
host list and/or those referenced by the Broadcast/Multicast Address. You
specify the IP address to send broadcast/multicast packets to. By default, the
Broadcast/Multicast Address is 255.255.255.255. This address represents a
broadcast to the entire network. Most TCP/IP transport implementations
support this address.
To broadcast on your local network, the Broadcast/Multicast Address must
consist of the network portion of your IP address with a host portion set to all
1s (in binary). For example, if your IP address is 192.9.200.6 (a Class C address),
the network portion of the address is 192.9.200. To use this as the local network
broadcast address, type 192.9.200.255 or 255.255.255.255. Multicast addressing
limits the sending of packets to a specific group of application hosts. This
avoids a broadcast to every host on the network. For example, IPv4 addresses
between 224.0.0.0 and 239.255.255.255 are reserved for Class D addresses.
For more information about Broadcast/Multicast Address specifications,
consult your TCP/IP network software documentation.
You can configure the following XDMCP Broadcast settings on the Startup tab in
Advanced mode:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
275
Chapter 3 Working with Profiles
Select first
display
manager
Connect to the first display manager that responds to the broadcast. The
sign-in information page prompts you to sign in to the host.
Enable
broadcast /
multicast
Use the Broadcast/Multicast Address to determine the hosts to send
packets to.
Address
The Broadcast/Multicast Address: the IP address to send the broadcast
packets to. By default, the broadcast address is 255.255.255.255. This
represents a broadcast to the entire network. Most TCP/IP transport
implementations support this broadcast address. For more information,
see the note at the beginning of this section.
Keep alive
Enable this option only if your host supports TCP/IP keep-alive.
Use custom
host list
Broadcast requests only to the hosts you enter. Enter the name or IP
address of each host that you want to send the broadcast to.
If you disable this setting, the XDMCP Display Manager Chooser
window prompts you to select an available host to manage the display.
After you make a selection, the sign-in information page prompts you to
sign in. Once you sign in to the host, it starts the X applications specified
in the XDM session file (script).
Note: To specify multiple hosts, enter one hostname or IP per line
with no separator punctuation, such as commas or semicolons.
Lines beginning with # are ignored.
Display class
Display groups or classes of XDM nodes. The Display class field is
applicable only when XDM-AUTHENTICATION-1 or XDMAUTHORIZATION-1 is enabled on the XDM host.
Note: Do not modify this value unless requested by your system
administrator.
Use XDM
authentication
Use XDM Authentication. Enter the display key for the authentication in
XDM Authentication key,
XDM
authentication
key
The display key to use in XDM authentication. The authentication key is
applicable only when AUTHENTICATION-1/AUTHORIZATION-1 is
enabled on the XDM host. If it is enabled, your system administrator
requires your Display Class and XDM Authentication Key.
Note: Do not modify this value unless requested by your system
administrator.
For information on starting a session in this mode, see “Launching sessions in
XDMCP Broadcast startup mode” in the Exceed TurboX Dashboard and Client Help.
276
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.11. Configuring XDMCP Query startup mode
3.11 Configuring XDMCP Query startup mode
This section describes how to configure a session startup using X Display Manager
Control Protocol (XDMCP) Query mode.
You can configure the following XDMCP Query settings on the Startup tab in
Advanced mode:
Run on node
Launches an XDMCP session directly on the node, as opposed to starting
an XDMCP session from the node to a remote X desktop host.
XDMCP Query
host
The name or IP address of the host to connect to.
If this box is blank, the user will be prompted to specify the host when
launching the session.
When Run on node is selected, this field is unavailable and set to Run on
node.
This box may include macros, which can provide startup customizations
(for example, based on the current user). For information on macros, see
“List of XDMCP Query macros”.
Display class
Display groups or classes of XDM nodes. The Display Class box is
applicable only when XDMAUTHENTICATION-1 or
XDMAUTHORIZATION-1 is enabled on the XDM host. Do not modify
this value unless requested by your system administrator.
Use XDM
authentication
Enables XDM authentication. Enter the display key for the authentication
in XDM Authentication key,
XDM
authentication
key
The display key used in XDM authentication. The authentication key is
applicable only when AUTHENTICATION1/AUTHORIZATION-1 is
enabled on the XDM host. If it is enabled, your system administrator
requires your Display Class and XDM Authentication Key. Do not modify
this value unless requested by your system administrator.
List of XDMCP Query macros
The following is a list of macros you can use when configuring XDMCP Query
startup mode, in the XDMCP Query host (in Advanced mode) or Host (in Basic
mode) field. Using a macro dynamically selects the host based on the value of the
macro when the session is launched. Letters in macros can be upper or lower case.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
277
Chapter 3 Working with Profiles
@u
User name .
Example: When you enter the following value in the XDMCP Query host
box:
ws-@u.example.com
the @u macro is replaced with the Exceed TurboX login user name,
resulting in the host string:
ws-<username>.example.com
If the user esmith launches this profile, an XDMCP query session will be
launched on the host:
ws-esmith.example.com
For information on launching a session in this mode, see “Launching sessions in
XDMCP Query startup mode” in the Exceed TurboX Dashboard and Client Help.
3.12 About Advanced settings for select startup
modes
This section describes the advanced settings you can configure in Custom startup for
the startup modes Published Application, Windows Desktop - RDP, and Xstart
applications.
To access the advanced settings for Published Application and Windows
desktop - RDP profiles:
1.
On the profile Startup tab (Advanced mode), click Advanced settings.
The Advanced settings dialog box opens, showing the General, Prompts, and
ETX RDP tabs.
2.
Configure the settings in each tab, as needed:
• “Configuring startup settings on the General tab” on page 279
• “Configuring startup settings on the Prompts tab” on page 284
• “Configuring startup settings on the ETX RDP tab” on page 286
To access the advanced settings for Custom startup profiles:
1.
On the profile Startup tab (Advanced mode), add or edit an Xstart application.
The New Xstart or Xstart dialog box opens.
2.
Click Advanced settings.
The dialog box is updated to display the General, Prompts, and ETX RDP tabs.
3.
Configure the settings in each tab, as needed:
• “Configuring startup settings on the General tab” on page 279
278
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.12. About Advanced settings for select startup modes
• “Configuring startup settings on the Prompts tab” on page 284
• “Configuring startup settings on the ETX RDP tab” on page 286
3.12.1
Configuring startup settings on the General tab
This section describes the startup settings available on the General tab of the
Advanced settings and Xstart dialog boxes.
The General tab allows you to configure settings for session use, network timeouts,
troubleshooting, Secure Shell security, and server-side rendering.
To access the General tab:
• For Published application and Windows Desktop - RDP startup modes:
1. On the Startup tab of the profile or template, click Advanced mode.
2. On the Advanced mode Startup page, click Advanced settings.
3. In the Advanced settings dialog box, click the General tab.
• For Custom startup modes:
1. On the Startup tab of the profile or template, select whether to add or edit an
Xstart.
2. In the dialog box for the Xstart, click Advanced settings.
3. Click the General tab.
You can configure the following settings on the General tab:
Note: If a described setting is unavailable or not present in the interface, then
the setting does not apply to the startup mode and startup method you
selected.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
279
Chapter 3 Working with Profiles
• X Window Host Application: These settings are enabled only with the X
Window Host Application startup method.
Run command
in shell
Runs a specified command. To specify how to run a command, select
one of the following options:
– Use login shell
Start the Xstart commands in a login shell.
– Run in user’s shell
Use the shell defined in the user account.
– Run command in background
Append an ampersand (&) to the command. This causes the
command to run as a background command from the XStart shell.
If more than one XStart command is specified, XStart appends an
ampersand to the last command only.
Running commands in the background can prevent applications
from terminating when the XStart shell closes after the Close
timeout is reached.
Some applications, such as gnome-terminal and gnome-session,
will terminate if they are run in the foreground (that is, without an
ampersand) and the parent process (etxstart) is closed. In cases
such as these, adding an ampersand helps prevent gnome-terminal
from exiting after the parent process closes.
Note: You set the Close timeout in the Network timeouts
section of the New Xstart > Advanced settings dialog box, >
General tab, as described later in this section.
Disable this option only if you selected X Window Host
Application as the startup method on the profile Startup page.
When this option is disabled, the specified command is not run in a
shell. As a result, many shell variables are not available, the path is
the default path, and you cannot run shell scripts. If you disable
the option, you can still run the shell by specifying it as part of the
command.
Run command
using
Determines how the Xstart commands will start.
– execve: Start Xstart commands without loading the user’s
environment.
– su: Start Xstart commands in a login shell with all the environment
variables.
Note: If Use login shell is selected under Run command in
shell, the su option starts Xstart commands in a login shell.
However, if Use login shell is not selected, the su option
does not start Xstart commands in a login shell.
280
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.12. About Advanced settings for select startup modes
DISPLAY uses
local socket
For the X Window host application startup method, determines
whether the X application uses a local UNIX socket or a TCP
connection to connect to the remote host. It does this by setting the
value of the DISPLAY variable for the local host application:
– Select the check box to set the DISPLAY environment variable to
just the display number. This causes the X application to use a local
UNIX socket. Local sockets provide better performance for local
applications and desktops that send a lot of X11 commands.
– Clear the check box to set the DISPLAY environment variable to
the Connection Node hostname or IP address followed by the
display number (<node_address>:<n>). This causes the X
application to use TCP.
This option is enabled by default.
• Add domain to username
For Windows
applications
Adds the default domain, as defined in the general site settings, to the
user name for Windows applications. For example, user name JSMITH
would render as MYDOMAIN\JSMITH. See the description of Use
session credentials in “Configuring Xstart settings” on page 254
For X Window
applications
Adds the default domain, as defined in the general site settings, to the
user name for X Window applications. For example, user name
JSMITH would render as MYDOMAIN\JSMITH.
• Server side rendering: Specifies startup configuration settings related to
OpenGL applications. If Exceed TurboX Connection Server is installed on a
UNIX machine, you can use server-side rendering features to support suspend/
resume of OpenGL applications and to improve performance of render-heavy
OpenGL applications.
Because graphics are rendered on the proxy, the proxy machine must have an
adequate 3D graphics card; however, because no rendering occurs on the client
side, a 3D graphics card is not required on the client machine. If the 3D
application uses overlays, the Client machine may require a 3D graphics card
that supports this feature.
Use direct
server side
rendering
All OpenGL rendering occurs on the Proxy host, which then sends a
compressed image of each frame to Exceed TurboX Client. You must
enable this option to support suspend/resume of OpenGL
applications.
Note: To get the best performance with Direct Server Side
Rendering, enable the MIT-SHM extension on the Protocol tab
in Advanced mode. See “Configuring Protocol settings in
Advanced mode” on page 216.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
281
Chapter 3 Working with Profiles
Options
Specify additional command line parameters required by third-party
3D rendering applications. Options in this box are automatically
appended to the command sent to the host. For more information on
commands that may apply to this feature, see the User’s Guide for
VirtualGL 2.1. If the Administrator selects GLP mode, you must use
the -d glp option.
Note: To use server side rendering features, the Administrator
must configure graphics device permissions by running the
following script:
<ECS_INSTALL_DIR>/bin/ssrconfig
See also “Command syntax for starting applications” on page 259.
• Secure Shell: Specifies when session information is secured.
Options
Additional command line parameters required by third-party Secure
Shell clients. For example, if you want to use a specific cipher, you can
type -c <ciphername>. Options in this box are automatically
appended to the command sent to the host.
If a session profile is configured to use the Secure Shell startup method
and the Use for Authentication Only option is disabled (the default),
you must ensure that the command does not contain any display
information.
Use interactive
shell
Runs the Secure Shell profile in interactive mode. By default, this
setting is disabled, and the Secure Shell profile runs in SSH execution
mode.
Note: If the Network timeouts > Close setting is greater than 10,
the Use interactive shell setting is automatically enabled.
• Network timeouts: Sets the timeouts for various processes that Exceed TurboX
will run on your network.
Connect
The number of seconds a connection process waits before timing out,
from 30 to 600. The default setting of 60 is normally adequate;
however, if network traffic is extremely high or if you have trouble
making a connection, increase this number.
Close
The number of seconds (from 0 to 999) the remote command socket
remains open after the host has acknowledged receipt of the
command. The default is 10 seconds. If the connection is established
before the client has started, set this interval to a higher value.
If you want the socket to stay open indefinitely (for example, if you
have enabled Show Host Reply and you want to track host messages
during the session), set this value to -1. This indicates that the socket
should remain open until the client is closed.
Note: If this setting is greater than 10, the Use interactive shell
setting is automatically enabled.
282
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.12. About Advanced settings for select startup modes
Response
The number of seconds (from 0 to 99) to wait for a password prompt
before assuming that one is not required for this account and the signin has been successful. The default is 4 seconds. This timeout applies
only to Secure Shell, RLOGIN, TELNET, and Windows application
startup methods.
Prompt
The number of seconds (from 0 to 99) to wait after logging onto the
application host before sending the command (gives the shell time to
start up). The default is 2 seconds. This timeout applies only to Secure
Shell, RLOGIN, TELNET, and Windows application startup methods.
• Troubleshooting: If you experience difficulty starting an application with a
session profile, you can enable and configure a remote command log to help you
with troubleshooting the problem. Customer Support may also request a log if
you require assistance.
Enable log
Exceed TurboX generates a log that records all remote command
settings. All logging information is recorded in the etxlog.txt file
for that session. Users can view this information by clicking View Log
on the Exceed TurboX Client menu.
Show host
reply
Lets you view host replies for remote commands. Host replies are
displayed in a separate dialog box.
Log extended
information
Select if you want the remote command log to contain more detailed
trace information in addition to the remote command settings.
Logging extended information can pose a security risk as sign-in
credentials are recorded in plain text. Enable this option only for
troubleshooting purposes.
If you have enabled X11 tunneling for Secure Shell, ensure that the
remote command you specify does not end with an ampersand (&).
For information on other troubleshooting-related tasks, see:
Dashboard
For more information, see “Deleting data cached by Exceed TurboX”
in the Exceed TurboX Dashboard and Client Help.
Profiles
– “Configuring Troubleshooting settings in Advanced mode”
Sessions
“Generating and downloading a trace package” in the Exceed TurboX
Dashboard and Client Help
CONETX120501-AGD-EN-3
on page 239
– “Configuring Performance settings in Advanced mode”
on page 235
Server Manager Administration Guide
283
Chapter 3 Working with Profiles
3.12.2
Configuring startup settings on the Prompts tab
This section describes the startup settings available on the Prompts tab of the
Advanced settings and Xstart dialog boxes.
The Prompts tab allows you to configure settings for handling connection and signin prompts.
To access the Prompts tab for Published application and Windows Desktop RDP startup modes:
1.
On the Startup tab of the profile or template (Advanced mode), click Advanced
settings.
2.
Click the Prompts tab.
To access the Prompts tab for Custom startup modes:
1.
On the Startup tab of the profile or template, add or edit an Xstart application.
2.
In the dialog box for the Xstart, click Advanced settings.
3.
Click the Prompts tab.
You can configure the following settings on the Prompts tab:
Note: If a described setting is unavailable or not present, then the setting does
not apply to the startup mode and startup method you selected.
284
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.12. About Advanced settings for select startup modes
• Connection prompts: Define what Exceed TurboX will do upon receiving a
prompt, and how to provide your connection information and credentials to the
application host (when required).
You can configure the following settings:
Host
The name or IP address of the host to connect to. If the remote
command service is not on a default port on the host, use the
following syntax:
<host>:<port>
Username
The user name used to log on to the host.
Password
The password used to log on to the host.
Command
The command to execute upon logging onto the specified host.
Custom host
list
(Optional) Define a list of host names that will be added to the host
history list and included in the Host list in the ETX Connection
Parameters dialog box during session launch. Enter each host name on
a separate line.
The Custom host list box is enabled if Host is set to Ask user or Ask
user if not set. If no host names are defined, the user is prompted to
enter a host name.
You can select one of the following options in the Host, Username, Password,
and Command fields:
–
Hide: Does not display or prompt for this information. Instead, it uses the
information specified in the startup configuration.
–
Show only: Displays the information specified in the startup configuration,
but does not let the user modify it.
–
Ask user: Displays the information specified in the startup configuration. The
user may modify this information before connecting.
–
Ask user if not set: Prompts for the information only if it has not been
previously specified. If all values have been specified, the Information dialog
will not appear at all.
For example, if you select Ask user for all prompts (Host, Username, Password,
and Command), you will be prompted to supply the required information when
you launch the session.
• Login prompts: These options inform Exceed TurboX of the prompts it can
expect from the remote host when it attempts to connect. These options are
available for RLOGIN, TELNET, Secure Shell, and X Window Host Application
startup methods.
You can configure the following settings:
Username
Password
CONETX120501-AGD-EN-3
User ID and Password prompts.
Server Manager Administration Guide
285
Chapter 3 Working with Profiles
Shell
The host shell prompt character(s). This lets Exceed TurboX know
when the shell is ready for a command. You can enter more than one
shell prompt in the Optional box.
If you cannot specify a matching rule for the remote Shell prompt (for
example, if you are not sure which remote shell will be used, or if
users customize their shell prompts), enable the Send command if
shell prompt not detected option. This wiil cause XStart to send the
command to the remote shell after the Prompt timeout is reached,
even if the shell prompt is not detected based on the specified
matching rules.
The Prompt timeout is configured in the Network timeouts section of
the Xstart > Advanced settings dialog box > General tab. For more
information, see “Configuring startup settings on the General tab”
on page 279.
Optional
Other prompt information if this option is available for the method
you selected (for example, TELNET). Some hosts prompt for
additional information, such as the terminal you are using. You can
specify the expected prompt (for example, TERM) and the intended
reply (for example, (hp)). You can use display and sign-in macros in
the reply.
To add an optional prompt, click the Add
icon, enter the Prompt
and Reply in those fields, then click the Apply
multiple optional prompts.
icon. You can add
For example, Exceed TurboX receives the prompt and replies, waits
for the shell prompt, then sends the command you specified in the
Command box.
For more information, see “Using Xstart Macros” on page 262.
3.12.3
Configuring startup settings on the ETX RDP tab
This section describes the startup settings available on the ETX RDP tab of the
Advanced settings and Xstart dialog boxes.
The ETX RDP tab allows you to configure remote desktop session settings for
Published Applications (with Windows application), Windows Desktop - RDP, and
Custom Startup (with Xstart using Windows application startup method) startup
methods.
286
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.12. About Advanced settings for select startup modes
Note: RDP redirection features are supported only when connecting from a
Windows client and are not supported on Mac, Linux, or iPad.
To access the ETX RDP tab for Published application (with a Windows
application) and Windows Desktop - RDP startup modes:
1.
On the Startup tab of the profile or template (Advanced mode), click Advanced
settings.
2.
In the Advanced settings dialog box, click the ETX RDP tab.
To access the ETX RDP tab for Custom startup mode:
1.
On the Startup tab of the profile or template, add or edit an Xstart application.
2.
Select Windows Application as the startup method.
3.
In the dialog box for the Xstart, click Advanced settings.
4.
Click the ETX RDP tab.
You can configure the following settings on the ETX RDP tab:
• Audio redirection:
Play on this
computer
Redirect audio from the remote Windows host to speakers or
headphones connected to the user’s local computer. This option is
enabled by default.
Do not play
Do not redirect audio from the remote session.
• Microphone redirection:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
287
Chapter 3 Working with Profiles
Record from
this computer
Allows users to use the microphone connected to the user’s local
computer inside a remote Windows session.
Do not record
Disables the use of a local microphone inside a remote Windows
session. This is the default.
• Other redirection:
– To share all available drives with the remote computer, select the
Drives
Drives check box and leave the text box blank.
– To share one drive only, select the Drives check box and type the
drive letter in the text box. For example, to share drive c, type c
– To share multiple drives, select the Drives check box and type the
drive letters in the text box, separated by commas. For example, to
share drives c and d, type: c,d
Note: This feature does not support Plug and Play (PnP) drives.
To map a USB drive, the device must be plugged in and
assigned a local drive before launching the session.
Removable
drives
Allows users to access (from a remote computer) an external drive
plugged in to a USB port.
Home directory Shares the Windows home directory (the entire user directory under
the user account, such as C:\Users\user1) to the remote session.
Printers
Shares local printers with a remote Windows session. The printers
appear in the remote session as redirected printers. When this option
is enabled, all local printers are redirected to the remote Windows
session.
To redirect a specific local printer, clear the Printers check box and
specify the printer in the Options text box. For more information, see
“Configuring redirection for a specific printer” on page 289.
• User experience settings:
Font smoothing Enables True Type fonts. This ensures optimized display of text in a
remote session. By default, this option is selected.
Desktop
background
Specifies whether the desktop wallpaper is shown when running a
remote session. By default, the option is disabled to ensure best
performance and the background is black.
Enhanced
visual
experience
Enables True Color support and tear-free screen updates. By default,
this option is selected.
• Other settings:
Working
directory
288
The working directory for Windows applications.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.12. About Advanced settings for select startup modes
Options
Additional RDP command parameters for configuring your profile.
Use case 1: Use the /w and /h parameters to customize the desktop
width and height.
For example, /w:1200 /h:900.
Use case 2: Use the /multimon parameter to configure how to treat
multiple monitors in single window mode for RDP connections. By
default, Exceed TurboX supports the XINERAMA extension for RDP
connections, for Windows Desktop - RDP and Published application
(with a Windows application) startup modes.
For example, to configure your profile to treat multiple monitors as a
single one, use /multimon:0. The information is passed to the RDP
server, and individual monitors are treated as one window.
You can also use this field to redirect a single printer. See
“Configuring redirection for a specific printer” on page 289 for more
information.
3.12.3.1
Configuring redirection for a specific printer
To configure a profile where only one local printer is redirected, clear the Printers
check box in the ETX RDP tab and add the following parameter in the Options text
box:
/printer:<printername>,(<drivername>)
where <printername> and <drivername> are the name of the local printer and
driver to use.
To locate your local printer:
1.
Open the Devices and Printers configuration on your local machine’s Control
Panel.
2.
Right-click the printer you want to redirect to the remote session and select
Printer Properties.
3.
Locate the printer name on the General tab and the driver name on the
Advanced tab.
Note: Exceed TurboX currently supports only printer drivers that use the
Windows native winprint print processors. If you try to use a printer driver
other than the supported one, the printer’s redirection will fail.
In most cases, you can switch to other Windows-provided printer drivers,
which are usually available for this specific printer.
If the redirection still does not work, you can redirect a printer using the MS
Publisher Imagesetter printer driver.
For example: /printer:<printername>,"MS Publisher Imagesetter"
CONETX120501-AGD-EN-3
Server Manager Administration Guide
289
Chapter 3 Working with Profiles
In this case, the printer driver name must also be changed to "MS Publisher
Imagesetter" in the Printer Properties dialog box.
For Windows 8 and later, no additional configuration steps are required.
Windows 7 and Windows Server 2008 users who want to use the printer redirection
features must install the MS Publisher Imagesetter printer driver on their machine,
as described below. This driver is required for Windows 7 and Windows 2008 Server
users to redirect their local printers to any remote Windows session.
Note: To install the printer driver, you need to have the local administrator
permissions.
To add MS Publisher Imagesetter printer driver:
1.
Open the Devices and Printers configuration via the Windows Control Panel.
2.
Right-click the printer you want to redirect to the remote session and select
Printer Properties.
3.
In the Advanced tab, click New Driver, then click Next.
4.
In the Manufacturer list, select Generic.
5.
Locate the MS Publisher Imagesetter option in the Printers list, and then click
Next.
6.
Click Finish.
A new printer driver, MS Publisher Imagesetter, is added to Driver list.
7.
From the Driver list, select MS Publisher Imagesetter, and then click OK.
3.13 Using the Client Launcher to launch profiles and
resume sessions
This section describes how to launch or resume Exceed TurboX sessions using the
Native Client Launcher. This is an alternative way to launch sessions via script files
or shortcuts without accessing the Dashboard. To use this feature, the Native Client
Launcher must be installed on the client system.
Native Client Launcher for Windows
On Windows, the default installation paths for the launcher are as follows:
• Per-User Installation: %appdata%\OpenText\
• Per-Machine Installation: %programfiles(x86)%\OpenText\
Scripts and shortcuts on Windows platforms should only reference executables in
the above locations. Updated launcher executables in the %homepath%\.etxcwebcache\ folder are cached files which are automatically downloaded and invoked
by the launcher as part of its self-update mechanism.
290
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.13. Using the Client Launcher to launch profiles and resume sessions
The Native Client Launcher for Windows includes the following binary files:
The executable launcher.
etxlauncher.exe
Invoke the executable using Windows shortcuts. If
invoked with missing parameters, the executable
launcher displays usage instructions in a GUI window,
and can also prompt the user to enter a username and
password.
The command line launcher.
etxlauncher.com
Invoke the command line launcher using Windows
scripts (.bat, .com, or .ps1). The .com version
provides usage instructions on the command line.
etxlauncher64.exe
The 64-bit version of the Windows executable launcher.
Only installed on 64-bit Windows platforms.
etxlauncher64.com
The 64-bit version of the Windows command line
launcher. Only installed on 64-bit Windows platforms.
Note: If you selected Allow third party libraries to be loaded in ETX Client
Launcher during installation, alternate versions of the binary files
(etxlauncherl.exe, etxlauncherl.com, etxlauncherl64.exe, and
etxlauncherl64.com) are used instead. See “Downloading and installing the
Client Launcher” on page 22 for more information.
Native Client Launcher for Mac
Starting with Exceed TurboX 12.0.1, the Exceed TurboX Client Launcher for Mac
contains an embedded console version that provides all functionality of Linux and
Windows console applications.
To locate the etxlauncher for Mac:
1.
In Finder, right-click to locate Exceed TurboX Client Launcher 12.app.
2.
Select Show Contents Inside the Contents.
3.
Locate the Applications folder, which contains the etxlauncher executable.
You can launch this executable from Terminal, using the same arguments as the
Windows and Linux etxlauncher.
Native Client Launcher for Linux
On Linux platforms, the launcher is provided as a .tar.gz package and contains a
single 64-bit binary, etxlauncher. You can display usage instructions for
etxlauncher on the command line, and it includes an interactive shell prompt when
invoked with missing parameters.
Using etxlauncher
You can view usage instructions by invoking etxlauncher without parameters.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
291
Chapter 3 Working with Profiles
Note: When you use etxlauncher with any -action parameter, including
using it to launch a session, the user account that provides the credentials for
the action must have the REST API enabled. If it does not, the action will fail.
To launch a session:
1.
To launch the profile on a specific server, enter the following command in the
etxlauncher command window:
etxlauncher -action launch <AUTH> <URL><PROFILEID> [<COMMANDMACRO>]
[<LID>]
If an LID is not provided, etxlauncher displays a list of nodes or sessions.
Tip: Parameters in square brackets are optional.
2.
If the profile you use has an active or suspended session, and if Reuse session is
set to Ask user, the Select a session to reuse dialog box opens. Click the session
you want to use, then click OK.
See “Configuring Session settings in Advanced mode” on page 202 for more
information about configuring session reuse settings.
To join a session:
•
To join a session that has been shared with you on a specific server, enter the
following command in the etxlauncher command window:
etxlauncher -action join <AUTH> <URL>[<SESSIONID>]
If a sessionID is not provided, etxlauncher displays a list of shared sessions.
292
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.13. Using the Client Launcher to launch profiles and resume sessions
Tip: Parameters in square brackets are optional.
To resume a session:
•
Enter the following command in the etxlauncher command window:
etxlauncher -action resume <AUTH> <URL>[<SESSIONID>]
If a sessionID is not provided, etxlauncher displays a list of suspended
sessions.
Tip: Parameters in square brackets are optional.
To check the installed launcher version:
•
Enter the following command in the etxlauncher command window:
etxlauncher -version
To check the cached launcher version:
•
Enter the following command in the etxlauncher command window:
etxlauncher -action cachedversion [<URL>]
Tip: Parameters in square brackets are optional.
The following <AUTH> parameters are available in the launcher commands:
<AUTH> parameter
Description
-k
Authenticate by passing the Kerberos ticket which was
issued to the user by the operating system. This
parameter is supported on Windows and Linux.
Note: Launcher versions prior to 12.0.1 do not
support the -k parameter. Scripts that use the -k
parameter with the old Launcher will not work
with old versions of the Launcher.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
293
Chapter 3 Working with Profiles
-keyauth <key>
Authenticate with an API key. You can list multiple
keys separated by a comma.
Note: If Ask user to select node (node group) is
enabled in the profile, one multiple-use token is
required, or three single-use tokens are required
to launch the session. If using three single-use
tokens, the first token is used to perform the
initial request, the second token is used to
generate the list of available nodes, and the third
token is used to launch the session using the
selected node.
See “Working with API keys” on page 26 for
information about creating API keys.
-username <username>
-password <password>
Authenticate with a username and password.
If authentication parameters (-keyauth -k or username and -password) are NOT specified:
• etxlauncher on Linux will prompt for a username
and password via interactive shell.
• etxlauncher.exe on Windows will prompt for a
username and password via GUI window.
• etxlauncher.com on Windows will prompt for a
username and password via interactive shell.
The following <URL> parameters are available in the launcher commands:
<URL> parameter
294
Description
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.13. Using the Client Launcher to launch profiles and resume sessions
-url <serverurl>
[-launcherproxyurl
<launcherproxyurl>]
[-proxyurl <proxyurl>]
The Exceed TurboX Server to use for the connection or
details about the HTTPS proxy Server connection, the
HTTP(S) proxy for the launcher to use to download
launcher updates and Client runtimes, and the HTTP(S)
proxy to be used between the client and the Connection
Node for remote session traffic.
• <serverurl>
– Exceed TurboX Server URL, including http(s)
schema, hostname, and port.
Example: https://my.etx.server:8443
• <launcherproxyurl>
– HTTP(S) proxy Server URL for communication
between the Client Launcher and the Exceed
TurboX Server. When a session is launched, the
Launcher communicates with the Server to
download Client Launcher updates and the
Client Runtime, and may also pass settings to the
Server. These connections are established during
the session launch, before the session connection
to the connection node.
This parameter includes the proxy schema and
proxy authentication, in the following format:
[schema://][<proxy_username>:<proxy_
password>@]<proxyhost>:<proxyport>
Example: https://
proxyuser:password123@124.124.124.
124:443
– Alternatively, to force the use of system proxy
settings and ignore the launcher HTTP(S) proxy
configuration sent by Exceed TurboX Server,
specify system://, as follows:
-launcherproxyurl system://
– Use the etxlauncher_proxy environment
variable to override server proxy settings and/or
to store proxy credentials in a separate
environment variable.
• {proxyurl}
– Required for the -action launch and -action
resume commands.
Optional for the -action cachedversion
command. If not specified, the launcher version
on the user’s machine is displayed. If specified,
the launcher version on the specified server is
displayed. If the user has a lower version
launcher on their machine and they launch a
session on the specified server, the launcher will
automatically update itself to the server version.
– Uses an HTTP or HTTPS proxy server for session
traffic between the end-user machine and the
CONETX120501-AGD-EN-3
Server Manager Administration Guide
295
Chapter 3 Working with Profiles
Connection Node. This parameter includes the
proxy schema and proxy authentication, in the
following format:
[schema://][<proxy_username>:<proxy_
password>@]<proxyhost>:<proxyport>
Example: https://
proxyuser:password123@124.124.124.
124:443
– Alternatively, to force the use of system proxy
settings and ignore the launcher HTTP(S) proxy
configuration sent by Exceed TurboX Server,
specify system://, as follows:
-proxyurl system://
– Use the etxlauncher_proxy environment
variable to override server proxy settings and/or
to store proxy credentials in a separate
environment variable.
Note: When configuring your Proxy Auto-Config
(PAC), include proxy entries for your Connection
Nodes if they are deployed behind a proxy. When
a session is established, the Client system needs to
return the correct proxy information for the
session node it is connecting to.
Tip: Parameters indicated in square brackets are
optional.
The proxy address can be any client-resolvable IP
address or hostname.
If the proxy does not require authentication, omit
[<proxy_username>:<proxy_password>@]
The following <PROFILEID> parameter is available in the launcher commands:
<PROFILEID> parameter
Description
-profileid <profile_id>
The ID of the profile to launch.
The following <SESSIONID> parameter is available in the launcher commands:
<SESSIONID> parameter
296
Description
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
3.13. Using the Client Launcher to launch profiles and resume sessions
-sessionid <session_id>
The ID of the session to join or resume.
If you use -action join without a <sessionid>, the
Launcher either dumps the list of sessions that have
been shared with the user to the shell, in the format
{id, userId, profileId, display, node, ...}
(command line app), or displays a dialog box listing the
sessions that the user can join (web UI).
If the -action resume command is used and a
<sessionid> is not provided, the Launcher either
dumps the list of sessions that have been suspended by
the user to the shell, in the format {id, userId,
profileId, display, node, ...} (command line
app), or displays a dialog box listing the sessions that
the user can resume (web UI).
Note: For the command line app, you must hse
the id value as the -sessionid argument.
The following <COMMANDMACRO> parameter is available in the launcher
commands:
<COMMANDMACRO>
parameter
Description
-commandmacro <macro>
An optional parameter for the -action launch
command, to pass parameters via Xstart macros. For
more information, see “Passing URL Parameters via
Xstart Macros” on page 264.
<macro> can include any letters, numerals, or special
characters except for the [space] character. If you
want to include the [space] character, you must
surround the macro with double quotes (“<macro>”).
Examples:
-commandmacro key1=value1,key2=value2
-commandmacro key1=abcd-!@#$%,key2=efgh)(*#
-commandmacro "key1=a b c d"
The <LID> parameter you use depends on the profile being launched:
• <NODEID>: Required when Ask user to select node is enabled in the profile.
• <NODEGROUPID>: Required when Ask user to select node group is enabled in the
profile.
• <REUSEID>: Required when the session reuse properties require the user to
specify the session to reuse.
See “Configuring Session settings in Advanced mode” on page 202 for information
about configuring session settings.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
297
Chapter 3 Working with Profiles
The following <LID> parameters are available in the launcher commands:
<LID> parameter
Description
<NODEID>
-selectednodeid <ETX_id>
<ETX_id>: The ID of the node to launch a new session.
This can be used with any profile to specify the target
node.
The node ID is only used when Ask user to select node
(node group) is selected in the launching profile. If this
option is not enabled, the session ignores the
selectednodeid setting. Instead, the session chooses
a session node based on the Node targeting and Reuse
session settings in the Session tab and the server load
balancing rules. For more information about the
Session tab, see “Configuring Session settings in
Advanced mode” on page 202.
<NODEGROUPID>
-selectednodegroupid
<ETX_id>
<ETX_id>: The ID of the node group to launch a new
session. This can be used with any profile to specify the
target node group.
The node group ID is only used when Ask user to select
node (node group) selected in the launching profile. If
this option is not enabled, the session ignores the
selectednodegroupid setting. Instead, the session
chooses a node group based on the Node targeting and
Reuse session settings, and the server load balancing
rules. See “Configuring Session settings in Advanced
mode” on page 202 for more information.
<REUSEID>
-resueid <ETX_id>
298
<ETX_id>: The ID of the session to reuse. to force a
new session, use new as the<ETX_id>.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Chapter 4
Getting started with Exceed TurboX REST APIs
This section provides an overview of the Exceed TurboX REST APIs web interface
and the Server REST APIs available to users. For detailed information about how to
use these REST APIs, see the Exceed TurboX REST API User Guide.
Exceed TurboX REST APIs provide many benefits to users and server
administrators, including:
• Performing server actions from a shell script or a custom application without
needing to sign in to the Exceed TurboX user interface.
• Developing front-end applications that rely on Exceed TurboX functionality.
• Automating repetitive administrative tasks.
The Exceed TurboX REST APIs interface allows users to navigate through and
interact with the Server REST APIs in the web browser, to better understand how
the APIs work. This interface is available to all Administrators, Session Managers,
and Tech Support users. It is available to users with the User role only if the Access
REST APIs setting is enabled.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
299
Chapter 4 Getting started with Exceed TurboX REST APIs
The REST APIs interface contains the following elements:
• Header bar
–
(1) Web application selector: Allows you to switch between the Dashboard,
Server Manager, and REST APIs.
Note: Some of these options may not be available on the drop-down
menu, depending on your user role and permissions.
–
–
300
(2) Read messages
: Opens the Messages dialog box and review messages
sent by the Exceed TurboX Server.
: Opens the User settings dialog box and configure your
(3) User settings
Exceed TurboX user settings.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
–
(4) Sign out
–
(5) Help
–
: Signs out of the Exceed TurboX web interface.
: Opens the Exceed TurboX Dashboard Help.
(6) User name area: Displays the name of the user logged in to the system.
• Content area: Lists the REST API functions available to the signed-in user.
Note: Depending on your user role, you may not see all REST APIs. For a
complete list of REST API permissions by user role, see Appendix B: REST
API Permissions in the Exceed TurboX REST API User Guide.
• Footer: Displays the Exceed TurboX version and build number, product
copyright and trademark information, and a link to additional legal information.
To access the Exceed TurboX REST APIs interface:
1.
Sign in to Exceed TurboX Dashboard or Server Manager.
2.
On the header bar, select REST APIs from the web application selector.
The REST APIs interface is displayed.
The REST APIs interface lists the REST API functions available to you.
REST APIs are grouped into sections based on the object that the API accesses. To
list the operations for a section, click the section name. Click the section name of an
expanded section to collapse it.
Each section includes the following standard REST operations:
GET
View one or more objects.
POST
Create an object or perform an action.
PUT
Modify an object.
DELETE
Delete an object.
Each API includes built-in REST API documentation and the following UI elements:
• REST API name and description.
• Parameters: Input parameters, used for passing information to the REST API.
• Responses: Information about the object structure and example values to be
passed to the REST API.
• Try it out, Execute, and Cancel buttons to interact with the API from the web
browser and test it prior to writing a script:
1. Click Try it out.
2. Enter the input parameters, as required. Mandatory parameters are marked
with a red asterisk.
3. Click Execute.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
301
Chapter 4 Getting started with Exceed TurboX REST APIs
The following information is displayed in the Responses area:
–
The Curl command that you can execute from command line to call this
REST API.
–
The Request URL syntax of the REST API call.
–
The Response body, which includes information about the result of the
REST API call. You can use the Download button to download the
Response body in JSON format.
4. To test the API with a different set of parameters, click Clear and return to
step 2.
5. When you are done testing the API, click Cancel.
Exceed TurboX REST APIs can be included in scripts that you can run from a
command shell, custom applications, or other websites. For detailed information and
usage examples, see the Exceed TurboX REST API User Guide.
When calling REST APIs via a script, you must provide your user credentials to the
Exceed TurboX Server in one of the following ways:
• By storing credentials directly in the script file. This method is not recommended
if the script file is stored in a public location.
• By storing an API key in the script file. Note that other users can still steal API
keys to perform actions on behalf of the user who generated the key, but this risk
can be mitigated further by setting a key expiry or usage limit.
You can create API keys on the API keys tab of the User settings dialog box. For
details, see “Working with API keys” on page 26.
You can also create an API key by calling the /apikeys/ APIs with your plain
text credentials. The call will generate an API key, which can be used with
subsequent calls to the API.
Note: Users with the User role can create API keys only when both the
Allow users to create API keys and the Access REST APIs settings are
enabled.
302
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Chapter 5
Managing Exceed TurboX Server from command
line
This section provides an overview of the tasks Exceed TurboX administrators can
perform via command line, to manage the Exceed TurboX Server (Linux and UNIX
platforms only).
• Start and stop the Server and check its status. Ssee “Starting and stopping Exceed
TurboX Server on a Linux platform” on page 303.
• Configure Server settings. See “Configuring Exceed TurboX Server settings”
on page 306.
• Manage the etxadmin account. See “Managing the etxadmin account”
on page 308.
• Manage the bootstart options. See “Managing the bootstart options”
on page 309.
• Backup or restore the Server settings. See “Backing up and restoring Server
settings” on page 309.
• Migrate to the latest version of the Server. See “Migrating to the latest version of
Exceed TurboX” in the Exceed TurboX Installation and Configuration Guide.
• Apply a staged patch to the Server. See “Applying a patch to the Server”
on page 310.
• Manage a cluster. See “Managing a cluster” on page 311.
• Check Server information. See “Checking Server information” on page 313.
5.1 Starting and stopping Exceed TurboX Server on
a Linux platform
This section describes tasks you can perform to maintain the Server for proper
operation on Linux or UNIX platforms.
You can perform the following tasks to maintain the Exceed TurboX Server:
• Check the status of the Server:
Exceed TurboX Dashboard and Server Manager are not accessible when the
Server is not running. You may need to check the status of the Server if you are
unable to access the Dashboard or Server Manager.
• Start the Server.
You can run the Exceed TurboX Server as an application or as a service. Starting
the Server as a service allows sessions to keep running, even if the session owner
CONETX120501-AGD-EN-3
Server Manager Administration Guide
303
Chapter 5 Managing Exceed TurboX Server from command line
signs off from the session where the Exceed TurboX Server is launched. It also
allows the Exceed TurboX Server to start when the machine starts (the computer
on which the Exceed TurboX Server is installed). Running the Server as an
application ties the state of the Dashboard and Server Manager with the user’s
session. However, running the Server as an application is useful for short-term
tests and configuration.
• Stop the Server.
The Server must be stopped before a patch can be applied.
To check the status of the server:
1.
Open a Terminal window by selecting Applications menu > System Tools >
Terminal.
2.
Change directory to the Exceed TurboX Server installation folder:
cd /opt/etxsvr/etxsvr-<version>
3.
Do one of the following:
• If the server is running as an application, enter the following command:
bin/etxsvr status
• If the server is running as a service, enter one of the following commands:
systemctl status otetxsvr
or:
systemctl status otetxsvr_n
To start the Server as a service:
1.
If the Server is running as an application, stop the Server before starting it as a
service.
2.
Open a Terminal window by selecting Applications menu > System Tools >
Terminal.
3.
Change directory to the Exceed TurboX Server installation folder:
cd /opt/etxsvr/etxsvr-<version>
4.
Enter the following command to create the systemd scripts:
bin/etxsvr bootstart enable
The command prints the name of the systemd service it created. For example,
otetxsvr.
If there is more than one instance of extsvr on the computer, the name of the
service has the format otetxsvr_n, where n is a unique identifying number. For
example, otetxsvr_2.
5.
Enter the following command to start the service:
systemctl start otetxsvr
304
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
5.1. Starting and stopping Exceed TurboX Server on a Linux platform
or:
systemctl start otetxsvr_n
6.
To open the Exceed TurboX Server Manager, type https://
<servername>:<port>/etx/admin into a web browser window.
Tip: If you start the Exceed TurboX Server as an application, the URL will
be displayed in the command prompt window. To get the URL, you can
start the Server as an application, stop it, and restart it as a service.
7.
If you are starting the Server for the first time, you will be prompted to review
the End User License Agreement. If you click Accept, you will be prompted to
create a password for the etxadmin user.
Once you create the password, you will be able to sign in to the ETX Server
Manager and continue with Server configuration. For more information, see
“Signing in to Exceed TurboX using the etxadmin account” and “Signing in to
Exceed TurboX Server Manager” in Exceed TurboX Server Manager Help.
To start the Server as an application:
1.
Open a Terminal window by selecting Applications menu > System Tools >
Terminal.
2.
Change directory to the Exceed TurboX Server installation folder:
cd /opt/etxsvr/etxsvr-<version>
3.
Enter the following command:
bin/etxsvr start
The Server starts and the URL to connect to the Server Manager is displayed.
4.
Copy the URL and paste it into a Web browser window to open the Server
Manager.
5.
If you are starting the Server for the first time, you will be prompted to review
the End User License Agreement. If you click Accept, you will be prompted to
create a password for the etxadmin user.
Once you create the password, you will be able to sign in to the ETX Server
Manager and continue with Server configuration. For more information, see
“Signing in to Exceed TurboX using the etxadmin account” and “Signing in to
Exceed TurboX Server Manager” in Exceed TurboX Server Manager Help.
To stop the Server:
1.
Open a Terminal window by selecting Applications menu > System Tools >
Terminal.
2.
Change directory to the Exceed TurboX Server installation folder:
cd /opt/etxsvr/etxsvr-<version>
3.
Do one of the following:
CONETX120501-AGD-EN-3
Server Manager Administration Guide
305
Chapter 5 Managing Exceed TurboX Server from command line
• If the Server is running as an application, enter the following command:
bin/etxsvr stop
• If the Server is running as a service, enter the following command:
systemctl stop otetxsvr
or:
systemctl stop otetxsvr_n
Note: When the server is stopped, the Dashboard and Server Manager are
not accessible. Any existing sessions will continue to run but users will not
be able to manage them using the Dashboard.
5.2 Managing the Exceed TurboX Server runtime
version
Administrators can manage the Exceed TurboX Server runtime version through the
command line using the following commands:
• bin/etxsvr runtime add <filename>: Adds a runtime file to the server.
• bin/etxsvr runtime remove <version>: Removes the specified runtime
version.
• bin/etxsvr runtime setdefault <version>: Sets the specified version as the
default runtime version.
5.3 Configuring Exceed TurboX Server settings
You can configure Exceed TurboX Server settings by running the bin/etxsvr
config <key>=<value> command.
This section provides a list of settings you can use to configure the Exceed TurboX
Server on Linux, UNIX, and Windows platforms.
306
Key
Value
dashboardHttpEnable
Set to 1 to enable communication using unencrypted
(non-TLS) HTTP connections for Exceed TurboX
Dashboard and REST APIs. Default value is 1.
dashboardHttpsEnable
Set to 1 to enable communication using TLS-encrypted
HTTPS connections for Exceed TurboX Dashboard and
REST APIs. Default value is 1.
adminHttpEnable
Set to 1 to enable communication using unencrypted
(non-TLS) HTTP connections for Exceed TurboX Server
Manager. Default value is 1.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
5.3. Configuring Exceed TurboX Server settings
adminHttpsEnable
Set to 1 to enable communication using TLS-encrypted
HTTPS connections for Exceed TurboX Server Manager.
Default value is 1.
dashboardHttpPort
When dashboardHttpEnable is set to 1, specify the port
number to be used by Exceed TurboX Dashboard and
REST APIs for unencrypted (non-TLS) HTTP
connections. Default value is 8080.
dashboardHttpsPort
When dashboardHttpsEnable is set to 1, specify the
port number to be used by Exceed TurboX Dashboard
and REST APIs for TLS-encrypted HTTPS connections.
Default value is 8443.
adminHttpPort
When adminHttpEnable is set to 1, specify the port
number to be used by Exceed TurboX Server Manager
for unencrypted (non-TLS) HTTP connections. Default
value is 8080.
adminHttpsPort
When adminHttpsEnable is set to 1, specify the port
number to be used by Exceed TurboX Server Manager
for TLS-encrypted HTTPS connections. Default value is
8443.
httpToHttpsRedirection
Set to 1 to redirect all HTTP requests (received on the
specified HTTP port) to HTTPS (to the specified HTTPS
port). This ensures that all connections to the Exceed
TurboX Server web interfaces are encrypted with SSL/
TLS, and that users who try to access the Server via
HTTP arrive at the secure HTTPS sign-in page, rather
than seeing a “404” error. Default value is 0.
Note: REST API HTTP connections are not
redirected to HTTPS, because some clients may
not handle them correctly, if redirected.
httpsCipherSuites
Overrides cipher suites used for HTTPS connections.
The default value is 0 (do not override). If 0 is used,
Exceed TurboX Server uses a default list defined by
Exceed TurboX Server and supported by Java.
The valid format is a comma-separated list of cipher
suites, listed in the order in which they will be used by
Exceed TurboX Server for all HTTPS connections.
logLevel
Specify the level of detail to be included in Exceed
TurboX Server logs. Possible values are: TRACE, DEBUG,
INFO (default value), WARN, and ERROR.
Note: Administrators can view and download the
Server logs on the Server Manager > Server
Settings > Server Logs page. See “Reviewing
Server logs” on page 170for more information.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
307
Chapter 5 Managing Exceed TurboX Server from command line
logFilter
Specify a log filter that the Exceed TurboX Server can
use to collect additional information for troubleshooting
server issues. You should set the log filter only at the
direction of OpenText customer support.
accessLogEnable
Set to 1 to instruct Exceed TurboX Server to collect
information about web access to the Server logs. Default
value is 0.
Note: You can view Server logs on the Server
Manager > Server Settings > Server Logs page.
See “Reviewing Server logs” on page 170for more
information.
accessLogRetainDays
Specify the number of days to keep access log files on
the Server. This setting determines the number of access
log files made available for review on the Server
Settings > Server Logs page. Default value is 7.
eulaAccepted
Set to 1 to accept the terms of the End User License
Agreement and bypass this page when signing in to the
Exceed TurboX Server web interface. Default value is 0.
maintenanceMode
Set to 1 to switch Exceed TurboX Server to maintenance
mode. Default value is 0.
maintenanceModeMessage
Specify the message to be displayed to Exceed TurboX
users while the Server is in maintenance mode.
maxJavaHeapSize
Specify the maximum size of the Java heap as a
percentage of total system memory. Default value is
50%.
etxdbShmSize
Specify the maximum value of the memory allocated for
the etxdb process, in MB. Default value is 128 MB.
5.4 Managing the etxadmin account
The etxadmin is the only user account with the Admin (Built-in) role defined on
Exceed TurboX Server. This account is configured during initial Server configuration
and cannot be added, modified, or deleted via the Exceed TurboX Server Manager
web interface.
You can use this user account to access the Server Manager, Dashboard, and most of
the content of the REST APIs interface. For example, if there is a problem with
authentication, you can use this account to sign in to the Server to fix authentication
settings, add new administrative users, and configure authentication nodes.
You can use the etxsvr command to enable, disable, or check the status of the
etxadmin account, to set or modify the password for this account, and to change its
access to certain REST APIs:
• bin/etxsvr etxadmin setpasswd [-p <password>]: Sets or modifies the
password for the etxadmin account. If you do not include -p <password>, it
prompts for the new password.
308
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
5.5. Managing the bootstart options
• bin/etxsvr etxadmin enable: Enables the etxadmin account.
• bin/etxsvr etxadmin disable: Disables the etxadmin account.
• bin/etxsvr etxadmin anyapikeys enable: Gives the etxadmin account access
to the REST APIs used to create and use API keys for another user ID.
Tip: You can use this command in a script to create API keys for an Admin
(Full Access)account. The script can then use that administrator account
to create or modify profiles, without having to know or include the
password for the account.
• bin/etxsvr etxadmin anyapikeys disable: Removes the REST API access
given to the etxadmin account by etxsvr etxadmin anyapikeys enable.
• bin/etxsvr etxadmin status: Checks the status of the etxadmin account.
• bin/etxsvr etxadmin anyapikeys status: Returns the status of the etxadmin
account’s permission for the REST APIs used to create and use API keys for
another user ID.
5.5 Managing the bootstart options
Administrators can control whether the Server should be automatically started when
the system is started. Exceed TurboX Server will not start with the system, unless
bootstart has been enabled using these commands.
bin/etxsvr bootstart enable: Enables the Server service to start at boot time.
bin/etxsvr bootstart disable: Prevents the Server service from starting at boot
time.
bin/etxsvr bootstart status: Checks the status of the Server service boot.
5.6 Backing up and restoring Server settings
Administrators can back up a system and later restore it from the backup file, via
command line, using the following commands:
• bin/etxsvr datastore init: Initializes or re-initialize the datastore.
• bin/etxsvr datastore backup <backup file>: Creates a backup of the
datastore to the specified file. The backup includes the datastore (etxdata folder)
and Server-specific settings, such as the server configuration file and SSL keys.
Note: This command is intended for taking “hot” backups against an active
Exceed TurboX Server. For “cold” backups, we recommend that you create
an archive of the Exceed TurboX Server installation directory.
• bin/etxsvr datastore restore <backup file>: Restores the backup file,
which includes the datastore (etxdata folder) and Server-specific settings.
A backup must be restored to the same Service Pack (SP) level, but may be
restored to a different Hotfix (HF) level within the same Service Pack. For
CONETX120501-AGD-EN-3
Server Manager Administration Guide
309
Chapter 5 Managing Exceed TurboX Server from command line
example, you can restore a 12.0.1.5881 version backup to a 12.0.1.6123 Server, but
not to a 12.0.2.7123 Server. If you attempt to restore a backup file to an older or
newer Exceed TurboX Server, an error message indicating a version mismatch
appears.
Note: Restoring Server settings requires the Server to be stopped.
The datastore must be empty. We recommend that you run this command
on a freshly-extracted server. If this is not possible, delete the %server_
root%/data/etxdata directory, then run the restore command.
Restoring a Server to a new host (with a different hostname) is supported.
The Server will automatically pick up the new hostname when it is started.
When a Server that is part of a cluster is restored, it becomes a stand-alone
server. Restoring the server to a cluster requires running the etxsvr
cluster create and etxsvr cluster join commands. See “Managing a
cluster” on page 311 for more information.
5.7 Applying a patch to the Server
To apply a patch to the Server:
1.
Copy the patch to the server folder.
2.
Run the script file.
To apply multiple patches at the same time:
1.
Extract multiple patches at the same time by using the --tar xpf argument to
the shell script.
2.
Apply the extracted patches to the server at the same by using the patch apply
command:
bin/etxsvr patch apply [-c <component(s)>], where:
<component(s)> is a comma-separated list of patch components to apply to the
current installation. Use this option when you want to apply only specific
patches.
5.8 Managing Server runtimes
Administrators can add, delete, and set default runtimes using the etxsvr runtime
command.
To add a runtime:
1.
Open a Terminal window by selecting Applications menu > System Tools >
Terminal.
2.
Enter the following command:
etxsvr runtime add <filename>
310
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
5.9. Managing a cluster
To delete a runtime:
1.
Open a Terminal window by selecting Applications menu > System Tools >
Terminal.
2.
Enter the following command:
etxsvr runtime delete <version>
To set a default runtime:
1.
Open a Terminal window by selecting Applications menu > System Tools >
Terminal.
2.
Enter the following command:
etxsvr runtime setdefault <version>
5.9 Managing a cluster
Exceed TurboX Servers support high availability configuration on Linux and Solaris
platforms only. In supported environments, you can use multiple Exceed TurboX
Servers to create an Exceed TurboX Server cluster for high availability (HA cluster),
load balancing, and scalability. All Exceed TurboX Servers in the cluster can be
configured to run as active servers. All Exceed TurboX users and administrators can
connect to any of the Exceed TurboX Servers in the cluster in order to access Exceed
TurboX Dashboard, Server Manager, and REST APIs. For detailed information about
how to install and configure the Exceed TurboX cluster, see Exceed TurboX High
Availability Configuration Guide, version 12 or later.
Note: Exceed TurboX License Servers (which host Exceed TurboX Licenses for
one or more Exceed TurboX Connected Sites) do not support configuration in
an HA cluster. For more information, see Exceed TurboX High Availability
Configuration Guide.
This section provides only a short list of commands that Exceed TurboX
administrators use to configure and manage a cluster:
bin/etxsvr cluster create [<parameters>]: Creates the initial Exceed TurboX
Server cluster with this Exceed TurboX Server. This command changes the Exceed
TurboX Server from a stand-alone server to a cluster server. The command must be
run against a currently running server.
The following parameters are available:
• -h <IP_address>: IP Address of this Exceed TurboX Server for remote
connections.
• -p <port>: TCP listen port number of this Exceed TurboX Server for remote
connections.
• -n <name>: A unique name for this Exceed TurboX Server in the cluster. This
name must be different for each member of a cluster.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
311
Chapter 5 Managing Exceed TurboX Server from command line
Note: If you do not include a parameter in the command, you will be
prompted to enter it. For a manual installation, you may run the command
without any parameters so that you can view the prompts and accept the
default values.
bin/etxsvr cluster join [<parameters>]: Adds this Exceed TurboX Server to an
existing Exceed TurboX Server cluster. This command requires that the Exceed
TurboX Server does not have an initialized database (which happens when the
Server starts). For detailed instructions, see Exceed TurboX High Availability
Configuration Guide, version 12 or higher.
The following parameters are available:
• -h <IP_address>: IP Address of this Exceed TurboX Server for remote
connections.
• -p <port>: TCP listen port number of this Exceed TurboX Server for remote
connections.
• -n <name>: A unique name for this Exceed TurboX Server in the cluster. This
name must be different for each member of a cluster.
• -r <remote_URL>: Base URL of the existing remote Exceed TurboX Server in the
Exceed TurboX Server cluster.
Example: https://etx.server.name:8443
• -a <remote_pass>: Password of the etxadmin account for the remote Exceed
TurboX Server.
Note: The Exceed TurboX Server joining the cluster must have the same
Service Pack and Hotfix version number as the Exceed TurboX Server that was
used to create the cluster. If the versions do not match, the join request is
rejected and an error message displays.
If you do not include a parameter in the command, you will be prompted to
enter it. For a manual installation, you may run the command without any
parameters so that you can view the prompts and accept the default values.
bin/etxsvr cluster remove: Removes this Exceed TurboX Server from the Server
cluster.
bin/etxsvr cluster delete <name>: Removes the named Exceed TurboX Server
from the Server cluster.
bin/etxsvr cluster status: Verifies the status of the Exceed TurboX Server
cluster and lists all Servers members of this cluster.
bin/etxsvr cluster resync: Automates the cluster resynch. This command pushes
all changes made on the Server that have not been sent to other Servers in the
cluster, and waits to ensure that all changes have been pushed successfully.
Note: Call this command only against a stopped server.
312
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
5.10. Debugging launch errors
We recommend that you call this command before taking the Server down for
maintenance, to ensure that any local changes are correctly synchronized to the
cluster.
5.10 Debugging launch errors
You can debug launching errors by enabling verbose logging in the launcher log file
(etxlauncher.log or etxlauncher64.log).
To enable verbose launcher logging on Mac and Linux:
•
Open a Terminal window and run the following command:
touch ~/.etxc-webcache/.etxlauncher-verbose
To enable verbose launcher logging on Windows:
•
Open a cmd window and run the following command:
%USERPROFILE%\.etxc-webcache\.etxlauncher-verbose 2>nul
Generating this file causes the launcher log file to log additional information, which
can be used for debugging.
Note: If the .etxc-webcache folder doesn’t exist in your directory, you will
need to create it before you enable verbose logging.
If you selected Allow third party libraries to be loaded in ETX Client
Launcher during installation, alternate versions of the log files
(etxlauncherl.log and etxlauncherl64.log) are used instead. See
“Downloading and installing the Client Launcher” on page 22 for more
information.
5.11 Checking Server information
Exceed TurboX provides a troubleshooting tool that allows administrators to collect
information about the Exceed TurboX Server. The tool is implemented via the
following shell command:
bin/etxsvr collect
This command collects all Exceed TurboX Server information, such as memory
traces, log files, and server settings, into a .zip package which you can send to
OpenText customer support to help resolve Exceed TurboX Server issues.
Administrators can view the Server version from the command line using the
following command:
bin/etxsvr version: Prints the Exceed TurboX Server version. For example: Exceed
TurboX Server Version 12.0.0.5354 (Git hash: 7d46080f, Build date:
2019-03-25 17:05:42)
CONETX120501-AGD-EN-3
Server Manager Administration Guide
313
Chapter 6
Appendix A: Understanding activity log events
This section describes the events that can appear on the Activity Log page in Exceed
TurboX Server Manager. Using activity logs, you can monitor events related to
sessions and the Exceed TurboX system. For more information, see “Monitoring
Exceed TurboX events” on page 172.
The activity events are grouped in the following categories:
• “Exceed TurboX Server Manager events” on page 315
• “Exceed TurboX License Server events” on page 318
• “Exceed TurboX Connection Node events” on page 318
6.1 Exceed TurboX Server Manager events
Exceed TurboX Server Manager can generate the following activity log events:
Message ID
(MID)
Description
100
A user with the User role has signed in to Exceed TurboX Dashboard.
101
A user with the User role has signed out from Exceed TurboX Dashboard.
102
A user with the Administrator role has signed in to Exceed TurboX Server
Manager or Exceed TurboX Dashboard.
103
A new user signed in to Exceed TurboX.
104
A new user was registered.
105
A new user was left unregistered.
106
The specified user account was deleted.
107
The sign-in for the specified user failed. It gives the reason for the failure.
108
Exceed TurboX detected a suspicious sign-in attempt using stored
credentials and the sign-in has failed for the specified user.
109
One of the specified user’s settings was changed.
110
The specified user’s role was changed.
111
The specified user account was disabled.
112
The specified user account was enabled.
113
The settings for a new user were changed.
114
A change to new user settings was applied to all users.
115
An API key was created.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
315
Chapter 6 Appendix A: Understanding activity log events
316
116
An API key was used.
117
An API key authentication failed.
118
Sign-in failed for an unregistered user.
120
A user group was created.
121
The settings for a user group were modified.
122
A user group has been deleted.
123
A node group was created.
124
The settings for a node group were modified.
125
A node group was deleted.
126
A single-use API key was created for the specified user.
127
A multiple-use API key was created for the specified user.
128
The specified API key was deleted for the specified user.
129
All API keys were deleted for the specified user.
130
Used and expired API keys were deleted for the specified user.
131
A single-use API key was created for the specified user.
132
A multiple-use API key was created for the specified user.
201
A user initiated session launch using the specified profile. The display
number is listed in the Display column.
202
A user initiated session termination.
203
A user initiated session suspension.
204
A user initiated session suspension.
205
A user initiated session join.
206
A user initiated session sharing with another user.
207
A user initiated passing control of a shared session to another user.
208
The user initiated paused of session sharing.
209
The user initiated stop of session sharing.
210
A profile attempted to launch a session using a disabled or deleted
runtime, so the default runtime was used instead.
211
A profile attempted to launch a session, but failed with error code from
node.
307
A specific node was registered.
308
A specific node was unregistered.
309
The node configuration update failed.
310
The node configuration update was rejected.
311
A specific node was enabled.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
6.1. Exceed TurboX Server Manager events
312
A specific node was disabled.
400
A specific Server was stopped for the reason shown.
401
Server settings were changed.
402
The Server was switched to maintenance mode.
403
The Server was switched to live mode.
404
The settings for the specified node have changed.
405
The notification settings changed.
406
A license key was added.
407
A license key was removed.
408
A profile was created.
409
A profile was updated.
410
A profile was deleted.
411
A profile was distributed to a group or user.
412
A template was created.
413
A template was updated.
414
A template was deleted.
415
A template was distributed to all users.
416
Exceed TurboX has reached its license limit.
417
A new runtime has been added.
418
A runtime was removed.
419
The default runtime has been changed.
420
A runtime was enabled.
421
A runtime was disabled.
422
A specific Server was started.
423
The settings for a node group have changed.
424
Automatic Force Server Setting have changed.
425
The datastore was created.
426
The datastore was initialized.
427
The Site settings were changed.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
317
Chapter 6 Appendix A: Understanding activity log events
6.2 Exceed TurboX License Server events
Exceed TurboX License Server can generate the following activity log events:
Message ID
(MID)
Description
500
The license mode was changed to use local licenses.
501
The license mode was changed to use a remote license server.
502
The Local license server role was enabled.
504
The connection to the license server was established.
505
The connection to the license server was lost.
506
The License request for the Server is approved. The Server is now
registered as a Connected Site.
507
The Site is now configured to use the dynamic license pool.
508
Zero, one, or more static license(s) have been allocated to the Site.
509
The License access was disabled for a site or server.
510
The site has been unregistered from the License Server.
511
The Site is connected.
512
The Site is disconnected.
513
The license service cannot initialize for the reason shown. Switched to use
local license keys.
514
A new Exceed TurboX user account was added to the license server.
515
An Exceed TurboX user account was imported to the license server.
516
The connection to the license server was re-established.
517
Exceed TurboX runtime deployment failed.
518
A profile icon was added.
519
A profile icon was deleted.
6.3 Exceed TurboX Connection Node events
Exceed TurboX Connection Node can generated the following activity log events:
318
Message ID
(MID)
Description
1100
A session was launched by the user listed in the Username column.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
6.3. Exceed TurboX Connection Node events
1101
Exceed TurboX automatically suspended a user session because that
user’s X screen saver was activated.
This event occurs only if the When X screen saver activated option is
enabled in a profile.
1102
A session was suspended by a user using an older version of Exceed
TurboX client.
1103
A session was suspended due to a request by the Exceed TurboX Native
Client.
1104
An administrator suspended a session owned by a specified user.
1105
A user suspended their own session.
1106
Exceed TurboX automatically suspended a user session because no mouse
or keyboard input occurred in the session for a specified period.
1107
Exceed TurboX automatically suspended a user session because of a
network failure.
1109
A session has been resumed.
1110
A session was terminated by the administrator.
1111
A session was terminated by the user.
1112
A session was terminated automatically by Exceed TurboX.
1113
A session was terminated for an unknown reason.
1114
A session was terminated due to a request from the Exceed TurboX Native
Client.
1115
A session could not be launched because the connection process timed
out.
1116
A session was forced to quit because the Proxy was not responding to
terminate command.
1117
A session failed to launched.
1118
A session was terminated due to reaching the maximum allowed age.
1119
A crash report was created for a session that has stopped responding.
1120
A session is not responding because the Proxy stopped communicating
with the Proxy Manager.
1121
A session that previously stopped responding is now running normally.
1122
A user has joined a shared session.
1123
An administrator has joined a shared session.
1124
An administrator shadows a session.
1125
A user has left a joined session.
1126
An administrator has left a joined session.
1127
An administrator has left a shadowed session.
CONETX120501-AGD-EN-3
Server Manager Administration Guide
319
Chapter 6 Appendix A: Understanding activity log events
320
1128
A session has been terminated forcefully because the proxy failed to
terminate.
1129
A session failed due to an error.
1130
A session has been terminated by the system due to idle mouse and
keyboard.
1131
A session has been suspended due to client system logout.
1135
A session has been terminated because the last application window
closed.
1136
A session has been terminated due to client system logout.
1137
A session has been terminated due to X desktop exit.
1138
A session has been suspended because access is disabled for the Client
platform in the profile.
1139
A session has been terminated because access is disabled for the Client
platform in the profile.
1140
A session has been suspended by Windows Direct because another
session took control of the Windows console.
1141
A session has refused a Client attempting to join a shared session from a
platform that is disabled in the profile.
1200
A runtime has been deployed successfully.
1201
Exceed TurboX Proxy Manager has been restarted.
1202
The node configuration settings have been reloaded.
1204
Exceed TurboX Proxy Manager is restarting because of an update to
packages.
1205
Exceed TurboX Proxy Manager is restarting because of an update to
settings.
1210
Exceed TurboX Proxy was started.
1211
Exceed TurboX Proxy was stopped.
1212
Exceed TurboX Proxy Manager created a crash report.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Chapter 7
Appendix B: Role Permissions
This section describes the permissions that are automatically assigned to the Exceed
TurboX standard user roles.
The following user roles are standard Exceed TurboX user roles that are available by
default:
• “Admin (Built-in)” on page 321
• “Admin (Full Access)” on page 324
• “Admin (Read Only)” on page 329
• “Session Manager” on page 331
• “Technical Support” on page 333
• “User” on page 335
Note: For information about creating, copying, modifying, and deleting user
roles, see “Configuring user roles” on page 149.
For information about assigning user roles, see “Modifying user settings, roles,
and permissions for individual users” on page 82.
7.1 Admin (Built-in)
The Admin (Built-in) user role has access to all Server Manager functionality, except
for the actions that require launching Client (for example, shadowing an active
session). This user role does not require authentication (such as with LDAP, PAM,
OTDS, etc.)
You cannot add, assign, copy, modify, or delete this role using the Server Manager.
The only user account with the Admin (Built-in) role is the etxadmin user. The
etxadmin user account is configured during initial Server configuration.
Use this user account to access the Server Manager, Dashboard, and most of the
content of the REST API interface. You can also use this account to sign in to the
Server if there is a problem with authentication. This account can be used to fix
authentication settings, add new administrative users, and configure authentication
nodes.
The Admin (Built-in) user role is granted the following permissions by default (62
permissions in total):
Permission
CONETX120501-AGD-EN-3
Description
Server Manager Administration Guide
321
Chapter 7 Appendix B: Role Permissions
APIApiKeysCr
eateOwned
Create an API key for the current user.
APIApiKeysDe Delete and API key for the current user.
leteOwned
APIApiKeysRe
adOwned
Retrieve a list of API keys or detailed information about an API key for
the current user.
APIAppearance Import site appearance settings from a zip file.
Create
APIAppearance Create a profile icon.
IconCreate
APIAppearance Delete a profile icon.
IconDelete
APIAppearance Retrieve a list of profile icons.
IconRead
APIAppearance Update large or small profile icons or make icons available or unavailable.
IconUpdate
APIAppearance Export site appearance settings as a zip file.
Read
APICoreSetting Retrieve a list of site settings, license data, license server information, a list
Read
of connected sites or retrieve summarized details on license usage.
APICoreSetting Update site settings, add or delete a license key, register or unregister a
Update
site with the license server or allocate a number of licenses to site from the
license server.
APILogsRead
Retrieve crash reports, server and connection node logs, activity logs, and
server statistics.
APINodeGroup Create a new node group.
Create
APINodeGroup Delete a specific node group.
Delete
APINodeGroup Retrieve a list of node groups.
Read
APINodeGroup Update a specific node group or add or delete a node group member.
Update
APINodeSessio Suspend, terminate, enable or disable a specific node.
nsUpdate
APINodesCreat Register or create a node.
e
APINodesDelet Delete a specific node.
e
APINodesRead Retrieve information about all nodes or a single node.
APINodesUpda Update a specific node.
te
322
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
7.1. Admin (Built-in)
APIProfilesRea Retrieve a list of Profiles, templates or icons.
d
APIReportsRea Retrieve license, session or top user reports.
d
APIRuntimesR
ead
Retrieve a list of runtimes or information about a specific runtime or the
default runtime.
APIRuntimesU
pdate
Install a new runtime, define a new default runtime, enable or disable a
runtime or delete a runtime.
APISessionsRe
ad
Retrieve a list of sessions, a single session or a session crash report.
APISessionsSu
spend
Suspend a specific session.
APISessionsTer Terminate a specific session.
minate
APIUserGroup
Create
Create a new user group.
APIUserGroup
Delete
Delete a specific user group.
APIUserGroup
Read
Retrieve a list of user groups.
APIUserGroup
Update
Update a specific user group or add and remove users to a user group.
APIUsersCreate Create a new user.
APIUsersDelet
e
Delete a specific user.
APIUsersRead
Retrieve a user list for all users, a single user or current user.
APIUsersUpdat Update a specific user.
e
DashboardAcce Permission to access dashboard.
ss
ManageAppear Manage appearance settings in Server Manager.
ance
ManageApplica Manage applications in Server Manager.
tions
ManageCoreSet Manage authentication settings in Server Manager.
tings
ManageDataRe Manage data retention options in general settings in Server Manager.
tention
ManageGenera
lSiteSettings
CONETX120501-AGD-EN-3
Manage security settings, message settings and general settings in Server
Manager.
Server Manager Administration Guide
323
Chapter 7 Appendix B: Role Permissions
ManageLicense Manage licenses, add or remove licenses or register/unregister a license
s
server in Server Manager.
ManageLogEve Review or download activity logs in Server Manager.
nts
ManageNode
Manage nodes in Server Manager.
ManageNotific
ations
Manage messages settings in Server Manager.
ManageRoles
Manage roles in Server Manager.
ManageRuntim Add, disable or delete runtimes.
es
ManageServer
Manage server settings and download server logs.
ManageUserGr
oups
Manage user groups from Server Manager.
ManageUserSet Manage new user settings from Server Manager.
tings
ManageUsers
Manage users from Server Manager.
ReadXApps
View details of profiles and templates.
RestApiAccess
Permission to access REST APIs page and view REST APIs documents.
SMAccess
Enable read only permission to Server Manager.
XDetails
Permission to view session detail.
XReassign
Permission to reassign sessions.
XSuspend
Permission to suspend sessions.
XTerminate
Permission to terminate sessions.
7.2 Admin (Full Access)
Users with the Admin (Full Access) user role can view and perform all actions in
both Exceed TurboX Dashboard and Exceed TurboX Server Manager. You can
assign, copy, modify, and delete this role.
The Admin (Full Access) user role is granted the Unrestricted permission by
default, which grants every available permission to this user.
The following permissions are granted with the Unrestricted permission (93
permissions in total):
324
Permission
Description
APIApiKeysCr
eate
Create an API key on behalf of a specified user.
APIApiKeysCr
eateOwned
Create an API key for the current user.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
7.2. Admin (Full Access)
APIApiKeysDe Delete an API Key on behalf of a specified user.
lete
APIApiKeysDe Delete and API key for the current user.
leteOwned
APIApiKeysRe
ad
Retrieve a list of API keys for a specific user or all users or detailed
information about a specific API key.
APIApiKeysRe
adOwned
Retrieve a list of API keys or detailed information about an API key for
the current user.
APIAppearance Import site appearance settings from a zip file.
Create
APIAppearance Create a profile icon.
IconCreate
APIAppearance Delete a profile icon.
IconDelete
APIAppearance Retrieve a list of profile icons.
IconRead
APIAppearance Update large or small profile icons or make icons available or unavailable.
IconUpdate
APIAppearance Export site appearance settings as a zip file.
Read
APICoreSetting Retrieve a list of site settings, license data, license server information, a list
Read
of connected sites or retrieve summarized details on license usage.
APICoreSetting Update site settings, add or delete a license key, register or unregister a
Update
site with the license server or allocate a number of licenses to site from the
license server.
APILogsRead
Retrieve crash reports, server and connection node logs, activity logs, and
server statistics.
APIMessageCr
eate
Send messages to specific users, user groups, nodes, node groups or
sessions participants.
APIMessageDe Delete all or a single message for the current user.
leteOwned
APIMessageRe
adOwned
Retrieve all messages for the current user.
APINodeGroup Create a new node group.
Create
APINodeGroup Delete a specific node group.
Delete
APINodeGroup Retrieve a list of node groups.
Read
APINodeGroup Update a specific node group or add or delete a node group member.
Update
CONETX120501-AGD-EN-3
Server Manager Administration Guide
325
Chapter 7 Appendix B: Role Permissions
APINodeSessio Suspend, terminate, enable or disable a specific node.
nsUpdate
APINodesCreat Register or create a node.
e
APINodesDelet Delete a specific node.
e
APINodesRead Retrieve information about all nodes or a single node.
APINodesUpda Update a specific node.
te
APIProfilesCre
ate
Create a new profile or template.
APIProfilesDel
ete
Delete a specific profile or template.
APIProfilesDel
eteOwned
Delete a specific profile or template for the current user.
APIProfilesDist Distribute a specific profile to a user or user group, or publish a template
ribute
to all users.
APIProfilesRea Retrieve a list of Profiles, templates or icons.
d
APIProfilesRea Retrieve a list of profiles, templates or icons for the current user.
dOwned
APIProfilesUp
date
Update a specific profile or template, or delete an xstart from a profile.
APIProfilesUp
dateOwned
Update a specific profile or template, or delete an xstart from a profile for
the current user.
APIReportsRea Retrieve license, session or top user reports.
d
APIRolesCreate Create a new role.
APIRolesDelet
e
Delete a specific role.
APIRolesRead
Retrieve a list of roles.
APIRolesUpdat Update a specific role.
e
326
APIRuntimesR
ead
Retrieve a list of runtimes or information about a specific runtime or the
default runtime.
APIRuntimesU
pdate
Install a new runtime, define a new default runtime, enable or disable a
runtime or delete a runtime.
APISessionsLa
unch
Launch a specific session.
APISessionsLa
unchOwned
Launch a specific session for the current user.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
7.2. Admin (Full Access)
APISessionsRe
ad
Retrieve a list of sessions, a single session or a session crash report.
APISessionsRe
adOwned
Retrieve a list of sessions, a single session or a session crash report for the
current user.
APISessionsRe
sume
Resume a specific session.
APISessionsRe
sumeOwned
Resume a specific session for your own user.
APISessionsSh
are
Add or remove users from session share, pass control to a user, start, stop,
pause or resume sharing or update session sharing settings.
APISessionsSh
areOwned
Add or remove users from session share, pass control to a user, start, stop,
pause or resume sharing or update session sharing settings to current user
sessions.
APISessionsSu
spend
Suspend a specific session.
APISessionsSu
spendOwned
Suspend a specific session for the current user.
APISessionsTer Terminate a specific session.
minate
APISessionsTer Terminate a specific session for the current user.
minateOwned
APIUserGroup
Create
Create a new user group.
APIUserGroup
Delete
Delete a specific user group.
APIUserGroup
Read
Retrieve a list of user groups.
APIUserGroup
Update
Update a specific user group or add and remove users to a user group.
APIUsersCreate Create a new user.
APIUsersDelet
e
Delete a specific user.
APIUsersRead
Retrieve a user list for all users, a single user or current user.
APIUsersRead
Owned
Retrieve their own user information.
APIUsersUpdat Update a specific user.
e
APIUsersUpdat Update their own user information.
eOwned
Broadcast
CONETX120501-AGD-EN-3
Permission to send message to users, user groups, sessions, nodes and
node groups in Server Manager.
Server Manager Administration Guide
327
Chapter 7 Appendix B: Role Permissions
DashboardAcce Permission to access dashboard.
ss
ManageAppear Manage appearance settings in Server Manager.
ance
ManageApplica Manage applications in Server Manager.
tions
ManageCoreSet Manage authentication settings in Server Manager.
tings
ManageDataRe Manage data retention options in general settings in Server Manager.
tention
ManageGenera
lSiteSettings
Manage security settings, message settings and general settings in Server
Manager.
ManageLicense Manage licenses, add or remove licenses or register/unregister a license
s
server in Server Manager.
ManageLogEve Review or download activity logs in Server Manager.
nts
ManageNode
Manage nodes in Server Manager.
ManageNotific
ations
Manage messages settings in Server Manager.
ManageRoles
Manage roles in Server Manager.
ManageRuntim Add, disable or delete runtimes.
es
ManageServer
Manage server settings and download server logs.
ManageUserGr
oups
Manage user groups from Server Manager.
ManageUserSet Manage new user settings from Server Manager.
tings
ManageUsers
Manage users from Server Manager.
ManageXApps
Manage profiles and templates from Server Manager.
ProfileExpImp
Permission to export and import profiles.
ReadXApps
View details of profiles and templates.
ReceiveAdmNo Receive admin notifications.
tification
328
RestApiAccess
Permission to access REST APIs page and view REST APIs documents.
SMAccess
Enable read only permission to Server Manager.
XDetails
Permission to view session detail.
XLaunch
Permission to launch sessions.
XReassign
Permission to reassign sessions.
XShadow
Permission to shadow sessions from sessions grid.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
7.3. Admin (Read Only)
XSuspend
Permission to suspend sessions.
XTerminate
Permission to terminate sessions.
7.3 Admin (Read Only)
The Admin (Read Only user role is for system auditors and other users who require
the ability to view administrative information, but do not need to change settings.
You can assign, copy, modify, and delete this role.
The Admin (Read Only) user role is granted the following permissions by default
(33 permissions in total):
Permission
Description
APIApiKeysCr
eateOwned
Create an API key for the current user.
APIApiKeysDe Delete and API key for the current user.
leteOwned
APIApiKeysRe
adOwned
Retrieve a list of API keys or detailed information about an API key for
the current user.
APIAppearance Retrieve a list of profile icons.
IconRead
APICoreSetting Retrieve a list of site settings, license data, license server information, a list
Read
of connected sites or retrieve summarized details on license usage.
APILogsRead
Retrieve crash reports, server and connection node logs, activity logs, and
server statistics.
APIMessageDe Delete all or a single message for the current user.
leteOwned
APIMessageRe
adOwned
Retrieve all messages for the current user.
APINodeGroup Retrieve a list of node groups.
Read
APINodesRead Retrieve information about all nodes or a single node.
APIProfilesCre
ate
Create a new profile or template.
APIProfilesDel
eteOwned
Delete a specific profile or template for the current user.
APIProfilesRea Retrieve a list of Profiles, templates or icons.
d
APIProfilesUp
dateOwned
Update a specific profile or template, or delete an xstart from a profile for
the current user.
APIReportsRea Retrieve license, session or top user reports.
d
CONETX120501-AGD-EN-3
Server Manager Administration Guide
329
Chapter 7 Appendix B: Role Permissions
APIRolesRead
Retrieve a list of roles.
APIRuntimesR
ead
Retrieve a list of runtimes or information about a specific runtime or the
default runtime.
APISessionsLa
unchOwned
Launch a specific session for the current user.
APISessionsRe
ad
Retrieve a list of sessions, a single session or a session crash report.
APISessionsRe
sumeOwned
Resume a specific session for your own user.
APISessionsSh
areOwned
Add or remove users from session share, pass control to a user, start, stop,
pause or resume sharing or update session sharing settings to current user
sessions.
APISessionsSu
spendOwned
Suspend a specific session for the current user.
APISessionsTer Terminate a specific session for the current user.
minateOwned
APIUserGroup
Read
Retrieve a list of user groups.
APIUsersRead
Retrieve a user list for all users, a single user or current user.
APIUsersUpdat Update their own user information.
eOwned
DashboardAcce Permission to access dashboard.
ss
ManageLogEve Review or download activity logs in Server Manager.
nts
ReceiveAdmNo Receive admin notifications.
tification
330
RestApiAccess
Permission to access REST APIs page and view REST APIs documents.
SMAccess
Enable read only permission to Server Manager.
XDetails
Permission to view session detail.
XLaunch
Permission to launch sessions.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
7.4. Session Manager
7.4 Session Manager
Users with the Session Manager user role can manage sessions and nodes, and
make changes to node-related settings. All other settings in Exceed TurboX Server
Manager are view-only. You can assign, copy, modify, and delete this role.
The Session Manager user role is granted the following permissions by default (44
permissions in total):
Permission
Description
APIApiKeysCr
eateOwned
Create an API key for the current user.
APIApiKeysDe Delete and API key for the current user.
leteOwned
APIApiKeysRe
adOwned
Retrieve a list of API keys or detailed information about an API key for
the current user.
APIAppearance Retrieve a list of profile icons.
IconRead
APICoreSetting Retrieve a list of site settings, license data, license server information, a list
Read
of connected sites or retrieve summarized details on license usage.
APILogsRead
Retrieve crash reports, server and connection node logs, activity logs, and
server statistics.
APIMessageCr
eate
Send messages to specific users, user groups, nodes, node groups or
sessions participants.
APIMessageDe Delete all or a single message for the current user.
leteOwned
APIMessageRe
adOwned
Retrieve all messages for the current user.
APINodeGroup Create a new node group.
Create
APINodeGroup Delete a specific node group.
Delete
APINodeGroup Retrieve a list of node groups.
Read
APINodeGroup Update a specific node group or add or delete a node group member.
Update
APINodeSessio Suspend, terminate, enable or disable a specific node.
nsUpdate
APINodesRead Retrieve information about all nodes or a single node.
APINodesUpda Update a specific node.
te
CONETX120501-AGD-EN-3
Server Manager Administration Guide
331
Chapter 7 Appendix B: Role Permissions
APIProfilesCre
ate
Create a new profile or template.
APIProfilesDel
eteOwned
Delete a specific profile or template for the current user.
APIProfilesRea Retrieve a list of Profiles, templates or icons.
d
APIProfilesUp
dateOwned
Update a specific profile or template, or delete an xstart from a profile for
the current user.
APIReportsRea Retrieve license, session or top user reports.
d
APIRolesRead
Retrieve a list of roles.
APIRuntimesR
ead
Retrieve a list of runtimes or information about a specific runtime or the
default runtime.
APISessionsLa
unch
Launch a specific session
APISessionsRe
ad
Retrieve a list of sessions, a single session or a session crash report.
APISessionsRe
sume
Resume a specific session.
APISessionsSh
are
Add or remove users from session share, pass control to a user, start, stop,
pause or resume sharing or update session sharing settings.
APISessionsSu
spend
Suspend a specific session.
APISessionsTer Terminate a specific session.
minate
APIUserGroup
Read
Retrieve a list of user groups.
APIUsersRead
Retrieve a user list for all users, a single user or current user.
APIUsersUpdat Update their own user information.
eOwned
Broadcast
Permission to send message to users, user groups, sessions, nodes and
node groups in Server Manager.
DashboardAcce Permission to access dashboard.
ss
ManageLogEve Review or download activity logs in Server Manager.
nts
332
ManageNode
Manage nodes in Server Manager.
RestApiAccess
Permission to access REST APIs page and view REST APIs documents.
SMAccess
Enable read only permission to Server Manager.
XDetails
Permission to view session detail.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
7.5. Technical Support
XLaunch
Permission to launch sessions.
XReassign
Permission to reassign sessions.
XShadow
Permission to shadow sessions from sessions grid.
XSuspend
Permission to suspend sessions.
XTerminate
Permission to terminate sessions.
7.5 Technical Support
Users with the Technical Support user role can affect sessions, nodes, profiles and
templates, user accounts, and groups. All other settings in Exceed TurboX Server
Manager are view-only. You can assign, copy, modify, and delete this role.
The Technical Support user role is granted the following permissions by default (50
permissions in total):
Permission
Description
APIApiKeysCr
eateOwned
Create an API key for the current user.
APIApiKeysDe Delete and API key for the current user.
leteOwned
APIApiKeysRe
adOwned
Retrieve a list of API keys or detailed information about an API key for
the current user.
APIAppearance Retrieve a list of profile icons.
IconRead
APICoreSetting Retrieve a list of site settings, license data, license server information, a list
Read
of connected sites or retrieve summarized details on license usage.
APILogsRead
Retrieve crash reports, server and connection node logs, activity logs, and
server statistics.
APIMessageCr
eate
Send messages to specific users, user groups, nodes, node groups or
sessions participants.
APIMessageDe Delete all or a single message for the current user.
leteOwned
APIMessageRe
adOwned
Retrieve all messages for the current user.
APINodeGroup Retrieve a list of node groups.
Read
APINodeSessio Suspend, terminate, enable or disable a specific node.
nsUpdate
APINodesRead Retrieve information about all nodes or a single node.
APIProfilesCre
ate
CONETX120501-AGD-EN-3
Create a new profile or template.
Server Manager Administration Guide
333
Chapter 7 Appendix B: Role Permissions
APIProfilesDel
ete
Delete a specific profile or template.
APIProfilesDist Distribute a specific profile to a user or user group, or publish a template
ribute
to all users.
APIProfilesRea Retrieve a list of Profiles, templates or icons.
d
APIProfilesUp
date
Update a specific profile or template, or delete an xstart from a profile.
APIReportsRea Retrieve license, session or top user reports.
d
APIRolesRead
Retrieve a list of roles.
APIRuntimesR
ead
Retrieve a list of runtimes or information about a specific runtime or the
default runtime.
APISessionsLa
unch
Launch a specific session.
APISessionsRe
ad
Retrieve a list of sessions, a single session or a session crash report.
APISessionsRe
sume
Resume a specific session.
APISessionsSh
are
Add or remove users from session share, pass control to a user, start, stop,
pause or resume sharing or update session sharing settings.
APISessionsSu
spend
Suspend a specific session.
APISessionsTer Terminate a specific session.
minate
APIUserGroup
Create
Create a new user group.
APIUserGroup
Delete
Delete a specific user group.
APIUserGroup
Read
Retrieve a list of user groups.
APIUserGroup
Update
Update a specific user group or add and remove users to a user group.
APIUsersCreate Create a new user.
APIUsersDelet
e
Delete a specific user.
APIUsersRead
Retrieve a user list for all users, a single user or current user.
APIUsersUpdat Update a specific user.
e
Broadcast
334
Permission to send message to users, user groups, sessions, nodes and
node groups in Server Manager.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
7.6. User
DashboardAcce Permission to access dashboard.
ss
ManageApplica Manage applications in Server Manager.
tions
ManageLogEve Review or download activity logs in Server Manager.
nts
ManageUserGr
oups
Manage user groups from Server Manager.
ManageUsers
Manage users from Server Manager.
ManageXApps
Manage profiles and templates from Server Manager.
ProfileExpImp
Permission to export and import profiles.
RestApiAccess
Permission to access REST APIs page and view REST APIs documents.
SMAccess
Enable read only permission to Server Manager.
XDetails
Permission to view session detail.
XLaunch
Permission to launch sessions.
XReassign
Permission to reassign sessions.
XShadow
Permission to shadow sessions from sessions grid.
XSuspend
Permission to suspend sessions.
XTerminate
Permission to terminate sessions.
7.6 User
Users with the User user role can sign in to, and perform all actions in, Exceed
TurboX Dashboard. This user role has no access to Exceed TurboX Server Manager.
You can assign, copy, modify, and delete this role.
The User user role is granted the following permissions by default (19 permissions
in total):
Permission
Description
APIApiKeysCr
eateOwned
Create an API key for the current user.
APIApiKeysDe Delete and API key for the current user.
leteOwned
APIApiKeysRe
adOwned
Retrieve a list of API keys or detailed information about an API key for
the current user.
APIMessageDe Delete all or a single message for the current user.
leteOwned
APIMessageRe
adOwned
CONETX120501-AGD-EN-3
Retrieve all messages for the current user.
Server Manager Administration Guide
335
Chapter 7 Appendix B: Role Permissions
APIProfilesCre
ate
Create a new profile or template.
APIProfilesDel
eteOwned
Delete a specific profile or template for the current user.
APIProfilesRea Retrieve a list of profiles, templates or icons for the current user.
dOwned
APIProfilesUp
dateOwned
Update a specific profile or template, or delete an xstart from a profile for
the current user.
APISessionsLa
unchOwned
Launch a specific session for the current user.
APISessionsRe
adOwned
Retrieve a list of sessions, a single session or a session crash report for the
current user.
APISessionsRe
sumeOwned
Resume a specific session for your own user.
APISessionsSh
areOwned
Add or remove users from session share, pass control to a user, start, stop,
pause or resume sharing or update session sharing settings to current user
sessions.
APISessionsSu
spendOwned
Suspend a specific session for the current user.
APISessionsTer Terminate a specific session for the current user.
minateOwned
APIUsersRead
Owned
Retrieve their own user information.
APIUsersUpdat Update their own user information.
eOwned
DashboardAcce Permission to access dashboard.
ss
XLaunch
336
Permission to launch sessions.
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Glossary
application host
The remote computer that hosts the applications with which you want to work.
An application host can be any supported platform type, such as Windows or
Linux.
application
The core purpose of Exceed TurboX is to allow users to launch applications and
desktops on a remote computer. When you launch a profile from Exceed TurboX
Dashboard, a session starts up. Depending on the profile configuration, one or
more applications or desktop sessions may launch. These applications are
running on a remote host but are designed to appear as if they are running on the
local client machine.
X Window applications can also be referred to as X clients.
Client Menu
The Client Menu is available after you use Exceed TurboX Dashboard to launch a
session.
The Client Menu allows you to perform tasks within the sessions you start. The
commands offered on the menu differ depending on the operating system of the
client workstation. In most cases, you can use the menu to perform such tasks as:
• sharing and suspending the session
• terminating the session
• generating a trace
Connection Node
The processing hub of Exceed TurboX. The connection node acts as an
intermediary between the client and the remote host and is responsible for
managing the session, compressing the remote display, and handling input and
other requests from the Exceed TurboX Client once a session has been established.
Also called a proxy host.
Dashboard
This web-based interface is your access point to Exceed TurboX and your
gateway to the remote applications you need to work with. You can use it to
configure, launch, and manage sessions.
ETX RDP protocol
The protocol or language used to transfer information between the proxy and the
Windows application or desktop host to which you connect. Windows
applications communicate with the proxy via the ETX RDP protocol. In turn, the
proxy communicates with your workstation via the Thin X Protocol (TXP).
CONETX120501-AGD-EN-3
Server Manager Administration Guide
337
Glossary
etxlog.txt
Log file generated by Exceed TurboX for each session, which records detailed
information about the session for troubleshooting purposes.
etxscan utility
The Exceed TurboX application scanner (etxscan) scans the connection node and
returns a list of installed applications to Exceed TurboX Server. These
applications can, in turn, be published. The etxscan utility provides information
about installed applications from the XDG standard menu system and Windows
Start menu, including the application path, parameters, and working directory.
This allows Exceed TurboX Server to launch those applications remotely. On
Windows, etxscan also supports a --syscheck argument to print GPU hardware
support.
Exceed TurboX Client
The Exceed TurboX Client consists of two parts—the Client Launcher and the
Client Runtime. The launcher downloads and executes the correct client runtime.
The runtime provides all client-side functionality, such as launching and
managing sessions, displaying the client-side menus, transferring files, and
communicating with the remote host.
Multiple Window mode
Application and desktop profiles can be configured to run in either Multiple
Window mode or Single Window mode. In Multiple Window mode, each
application runs inside its own application window, as if the application was
running natively on the user’s machine.
profile
Exceed TurboX profiles contain settings that define the look and behavior of
Exceed TurboX sessions. You launch sessions from profiles listed on Exceed
TurboX Dashboard. Administrators can create Group profiles to accommodate
different session requirements. Users cannot edit Group profiles, but they can
customize or copy and edit them for their own use.
proxy host
See Connection Node.
proxy
Each time a connection node receives a request to start a session, it starts a new
proxy with a unique display ID. The proxy is responsible for communicating
between your workstation and the remote application or desktop host. When you
terminate your session, the server closes the associated proxy.
published application
Applications installed on a Windows or X Window host can be published in
Exceed TurboX by means of an application scanner ( etxscan) that is installed on
the Exceed TurboX Connection Node. Exceed TurboX administrators can publish
scanned applications to make them available to users.
338
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Glossary
resizing policy
Defines how the root window is resized.
Fixed—A user or the system defines the size of the root window. If you click the
Maximize button in the bar, the main window is restored to its original position
and size. By default, the session uses Fixed resizing policy and is displayed on a
primary monitor.
Scaled—When you resize the window, the size of the root window does not
change, but the contents of the session scale up/down accordingly. For example, if
multiple sessions are running, you may view them as thumbnails.
Scaling does not affect the behavior of UNIX applications, because the root
window size remains the same.
Dynamic—Allows you to resize the Exceed TurboX window dynamically. The
application (such as the KDE environment) will reflect this and fit in the new
window. For example, you may switch from Single to Multiple Window Mode or
vice versa. The applications will renegotiate the new root window size and be
redrawn appropriately.
REST
Representational State Transfer (REST) is a software architectural style that
defines a set of constraints to use to create web services. Web services that
conform to the REST architectural style are called RESTful web services; they
provide interoperability between computer systems on the Internet. RESTful web
services allow the requesting systems to access and manipulate textual
representations of web resources by using a uniform and predefined set of
stateless operations. In a RESTful web service, the requests made to a resource’s
URI generate a response with a payload formatted in HTML, XML, JSON, or
some other format. The response can confirm that some chanage has been made
to the stored resource, and can provide hypertext links to other related resources
or collections of resources. When HTTP is used, the following operations are
available: GET, POST, PUT, DELETE, and other predefined CRUD HTTP
methods.
REXEC protocol
The REXEC (Remote EXECute) protocol launches applications on a remote host. It
requires a user ID, password, host address, and command to execute on the
remote host. You can select this startup method in Xstart.
RLOGIN protocol
The RLOGIN protocol establishes a remote connection to run X applications. It
allows an authorized user to sign in to hosts on a network and interact as if the
user were physically at the host computer. RLOGIN is similar to TELNET. You
can select this startup method in Xstart.
root window
The parent (container) window which opens when launching a Single Window
Mode profile. This root window contains either a remote desktop or multiple
CONETX120501-AGD-EN-3
Server Manager Administration Guide
339
Glossary
remote application windows. It keeps all session windows in a single container,
so that users can manage all windows as a single group and manage multiple
sessions more easily. By contrast, In Multiple Window mode, application
windows are opened directly on the user’s desktop as native windows, not within
a root window.
RSH protocol
RSH is a protocol for executing commands on a remote host, passing it input and
receiving its output. RSH communicates with a daemon on the remote host. A
benefit of RSH is its ability to reference a file called .rhosts, which resides on the
host and maintains a list of terminals allowed to sign-in without a password. You
can select this startup method in Xstart.
Secure Shell protocol
Secure Shell (SSH) is a TCP-based protocol that provides authentication,
encryption, and data integrity security features. In Exceed TurboX, SSH provides
a secure channel between the connection node and application host, for sending
and receiving user inputs and display protocol. You can select this startup
method in Xstart.
Server Manager
This is the web-based administration interface for Exceed TurboX.
session
A connection to another computer, established by Exceed TurboX, that moves
information (including keyboard input and screens, for example) between them.
You configure and launch these connections with Exceed TurboX to work with
one or more applications installed on the computer that you connect to.
You can use Exceed TurboX Dashboard to start, manage, and end sessions.
Single Window mode
Application and desktop profiles can be configured to run in either Multiple
Window mode or Single Window mode. In Single Window mode, each
application runs inside the root window, which is a single window that contains all
of the remote applications. Applications running inside the root window may
overlap each other and cannot be moved outside of the root window.
taskbar icon
This icon appears at the bottom in your Windows taskbar when you start a
session. You may have multiple icons in the taskbar, each representing a session
that you have started. Right-click this icon to access the Client Menu.
TELNET protocol
TELNET is a terminal emulation protocol for TCP/IP networks. You can use
TELNET to connect a PC to a host on the network. An authorized user can enter
commands through TELNET and they will be executed as if the user were
entering them directly on the server console. To start a TELNET session, you must
340
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3
Glossary
provide valid sign-in credentials for the host. You can select this startup method
in Xstart.
template
Administrators create and configure templates for users who need to create
profiles of their own. Users create profiles by copying existing templates. The
administrator-specified settings in the template are copied to the profile;
individual settings in the template can be marked as read-only so that they cannot
be changed by users. This provides the administrator with complete control over
which settings users can modify.
When an administrator modifies a template, the change is reflected in all profiles
that are based on that template.
Windows
The Microsoft Windows operating system should not be confused with the X
Window System. Exceed TurboX includes the capability to run remote sessions
by connecting to either an X Window (UNIX or Linux) or Microsoft Windows
remote desktop or application host.
X application
Any application that uses the X Window System to draw its graphical user
interface. Although X applications are written primarily on the UNIX and Linux
operating systems, it is possible to create X applications that run on other
platforms, such as Microsoft Windows.
X display
Each time you start an X Window session, an X server is launched on the host to
which you connect. The X display identifies this specific X server which will be
used to manage your session (for example, by transferring input from your
mouse and keyboard to the application). The applications you work with are
aware of which X display you are using.
An X display is referenced using the following notation: <HostIP>:<Display#>,
where <Display#> is incremented for each new session started on that host.
X protocol
One of the protocols used to transfer information between your computer and the
X Window application host that you connect to. In Exceed TurboX, applications
communicate with the proxy via the X protocol. In turn, the proxy communicates
with your workstation via the Thin X Protocol (TXP).
X selection
The text or other data, such as an outlined region of the screen, that you have
selected for copying and pasting to another open window in either the same
session, another session, or on your workstation.
X server
An intermediary component that Exceed TurboX launches to handle
communication such as key and data transfer (visual screens and windowing)
CONETX120501-AGD-EN-3
Server Manager Administration Guide
341
Glossary
between your workstation and the application host. The X server is composed of
both the software launched to handle your session and the hardware (mouse,
keyboard, monitors) used to communicate and display screens. The X server also
handles font rendering and resource management.
X Window Manager
An X Window Manager is a program that provides basic management commands
for application windows, including opening, closing, moving, and resizing
windows. Most window managers are installed with the operating system.
The X Window Manager handles all window functions and often provides a
menu from which you can select commands to start other applications. The
window manager you use can be installed on your workstation or on a remote
machine. You must start the window manager. It does not start by default. You
can set window manager options on the Display tab (Basic mode) and Window
mode tab (Advanced mode) when you create or edit profiles.
X Window
When running applications on a UNIX or Linux host, application windows are
rendered using X drawing primitives such as lines and rectangles. These
application windows are referred to as X Windows. Depending on the operating
system, a different X Window Manager may be used, which affects the
appearance and functionality of your application windows. An X Window can be
rendered on the host or on the client desktop.
Xstart
Custom startup profiles typically contain one or more applications or commands.
These applications or commands are called Xstarts. Xstarts allow you to specify:
• the application host to connect to
• your sign-in credentials for that host
• command line parameters for the application
• additional options such as user prompts and advanced flags
You can configure multiple Xstarts within a profile.
342
OpenText™ Exceed™ TurboX
CONETX120501-AGD-EN-3