Desktops User Guide

Overview

A Tehama Desktop is a shared or individual virtual computer hosted in a Room. It is a workspace from which you can securely work with assets of the connected organization for the Room. Tehama Desktop instances are generated from Desktop templates that are defined in a Room. A template describes both the configuration of the Desktop instances to be generated from it and the users that will be able to connect to them. A Room can have multiple Tehama Desktop templates defined. The maximum number of Desktops (Desktop instances) in a Room that can be in use concurrently is 75 when the Recordings Room feature is enabled and 200 when the Recordings Room feature is disabled. (See the Desktop Session Auditing/Recordings User Guide for more details.) The Room configures which assets are accessible from its Desktops through its encrypted secrets vault and firewall rules.

All work performed using a Tehama Desktop is recorded and auditable.

Tehama offers both Windows Desktops and Linux Desktops.

Note that, as a SaaS platform, all Tehama Windows and Linux Desktop license costs are built in to the cost of your Tehama Subscription Plan.


Desktop vs Workspace

The user may be confused by the use of the terms "Desktops" and "Workspaces" within Tehama.

Tehama offers three types of Desktops - "Tehama Windows Desktops" and "Tehama Linux Desktops", which are based on PCoIP infrastructure, and "Workspaces", which is based on AWS Workspace® bundles.

The documentation refers to all three types as Tehama Desktops.

All three types of Desktops contain Tehama's Desktop Agent, which is interchangeably referred to as the Workspace Agent.


Windows Desktops Types

Tehama currently offers two Windows-based desktop types. Each type is provided as a separate Room feature. They are the Tehama Windows Desktops feature and the Workspaces feature. A Tehama Room may have just the Workspaces feature enabled or both it and the Tehama Windows Desktops feature enabled. The Admin and Org Managers and Room Managers (who are members of the Room) of the Room's owner organization are able to create desktop templates of these types (whichever feature(s) are enabled, that is) from the WINDOWS DESKTOPS sidebar menu item on the Room's CONFIGURE tab.

How to Enable or Disable 'Tehama Windows Desktops' and 'Workspaces'

Tehama Windows Desktops: Contact Tehama Support to enable or disable this feature in your Room, or you may enable/disable this feature through the Room Settings interface. See the Enable/Disable Windows Desktop section in the Rooms User Guide.

Workspaces: Support for this feature is not controlled. All Tehama Rooms currently have access to this feature. However, in the Tehama development plan going forward, support for this feature will be withdrawn. Users are encouraged to use the Tehama Windows Desktop feature.
  • Tehama Windows Desktops
    This is Tehama's most recent Windows desktops type. This feature provides virtual Desktop environments connected via PCoIP to Windows-based servers. It also is offered with a range of hardware and software options similar to those offered by the 'Workspaces' feature. The Tehama Windows Desktops feature provides a fixed CPU performance level for all its options. The currently available Operating System is Windows Server 2019.

  • Workspaces
    Tehama Windows Desktops are built on Amazon WorkSpaces® bundles, which offer a range of hardware and software options. You can choose from a range of a Windows 10 (powered by Windows Server 2016) Desktop experiences. See Amazon WorkSpaces® - Features for more details.


Linux Desktops Types

Tehama currently offers one Linux-based desktop type. This is provided as a Room feature - the Tehama Linux Desktop Room feature. (A previously available Room feature, the Linux Legacy Desktop, is no longer offered or supported. Contact Tehama Support if you have any questions about the end-of-life of this legacy feature.) A Tehama Room may have the Tehama Linux Desktop feature enabled or disabled. The Admin and Org Managers and Room Managers (who are members of the Room) of the Room's owner organization, when the feature is enabled, are able to create desktop templates of this type of desktop from the LINUX DESKTOPS sidebar menu item on the Room's CONFIGURE tab. If the feature is enabled, then this sidebar menu will not be available.

How to Enable or Disable 'Tehama Linux Desktops'

Tehama Linux Desktops: Contact Tehama Support to enable or disable this feature in your Room, or you may enable/disable this feature through the Room Settings interface. See the Enable/Disable Linux Desktop section in the Rooms User Guide.

The Tehama Linux Desktop Room feature provides virtual Desktop environments connected via PCoIP to Linux-based servers. It also is offered with a range of hardware and software options similar to a Windows Desktop. The Linux Desktop provides a fixed CPU performance level for all its options. The currently available Operating System is Ubuntu Server 18.04.


Desktop Concurrency Limits

While a Room can contain as many as 500 Desktop instances and an unlimited number of Room members, to ensure optimum performance the maximum number of concurrent Desktop sessions per Room is limited to 75 when the Recordings Room feature is enabled and limited to 200 concurrent Desktop sessions when the Recordings Room feature is disabled. (See the Desktop Session Auditing/Recordings User Guide for more details.)

In other words, there can only be 75 (or 200 when Recordings are disabled) Desktop sessions active at one time, regardless of how many Desktop instances belong to the Room.

If, while looking at the entry for one of your Desktops, in either the DESKTOPS page or the My Desktops page in the Room's WORK tab, you see the word UNAVAILABLE next to the desktop's name instead of the CONNECT button, it means there are 75 sessions (or 200 sessions when Recordings are disabled) currently active in that Room and you will not be able to start another Desktop session until one of the currently active sessions ends.

If your organization requires more than the maximum concurrent active sessions (75 when Recordings are enabled and 200 when Recordings are disabled), you will need to create multiple Rooms. You are encouraged to contact Tehama Support if you would like assistance in optimizing your Room environment for performance and availability, taking your auditing/recording needs into consideration.


Multi-monitor Support

Multi-monitor support applies to all three available Desktop types: 'Tehama Linux Desktops', Tehama Windows Desktops', and 'Workspaces'.

Tehama supports multi-monitor Desktops, in which you enable full-screen and your full-screen setting spans multiple monitors, up to a maximum of two monitors for Desktops in Rooms that have session recording enabled (this is the default Room recording setting).

If three or more monitors are detected during a Desktop session that is being recorded, the Desktop user will be shown a warning to switch to two or one monitors within fifteen seconds, or their session will be terminated. If three or more monitors still remain after fifteen seconds has elapsed, the user will be logged out of their Desktop.

Three or more monitors are ONLY supported in the case where the Desktop's Room has session recording disabled.

NOTE: To toggle off full-screen in your 'Workspace' Desktop instance, use the AWS Workspace hotkey Ctrl-Alt-Enter.

Contact Tehama Support to discuss enabling/disabling the 'Session Recordings' Room feature, or you may enable/disable this feature through the Room Settings interface. See the Enable/Disable Recordings section in the Rooms User Guide.


Desktop Actions Overview

The actions you can perform on a Desktop Template or a Desktop Instance depend on your role in your organization and the role your organization has in the Room containing the Desktop.

Actions are roughly divided into those that can be done only by a privileged user and those that can be done by both a privileged user and a non-privileged user, where:

Privileged user:

The Admin user or Org Manager or Room Manager (who is a member of the Room) of a Room's owner organization (owner+connected or user+owner), that is, the organization that is paying the bills. Since each Desktop created incurs a cost to the organization that owns the Room, the Admin user and Org Managers and Room Managers (who are members of the Room) of this organization have the privilege of deciding whether or not a Desktop Template is created and how many instances of it there can be.

Non-privileged user: Every other member of the Room.

(See the Roles User Guide for information about user and organization roles.)

Actions Privileged user Non-privileged user
View Desktop templates assigned to a member in your Org
View Desktop templates assigned to a member in your Room
View your assigned Desktop templates in your Org
View your assigned Desktop templates in your Room
View all Desktop templates in your Org
View all Desktop templates in your Room
View in-use Desktop templates in your Organization
Add a Desktop template
Edit a Desktop template
Delete a Desktop template
Find Your Desktop in the Tehama Web UI
Download the Tehama Client onto Your Device
Connect to a Desktop (single click)
Connect to a Desktop (with credentials) via Teradici PCoIP Client
Connect to a Workspace (with credentials) via AWS Web Client
Connect to a Workspace (with credentials) via AWS Client
Force Logout of a Shared Workspace
Request a custom image of a Desktop template
Restart a Desktop
Start Desktop Agent
View a Desktop's status

Tehama Web UI Desktop action interfaces

Desktop template action interfaces:
Desktops templates are managed (added, edited, etc.) by the Admin user and Org Managers and Room Managers (who are members of the Room) of the Room's owner organization from the WINDOWS DESKTOPS and LINUX DESKTOPS pages under the Room's CONFIGURE tab in the Tehama Web UI.

Desktop instances action interfaces:
Users can connect to their Desktop instances, (and restart them etc) from the MY DESKTOPS page in the Room's WORK tab and also from the Tehama Web UI's DESKTOPS tab, which shows all the Desktops the user can access across all Rooms in the user's organization.


View Desktop templates assigned to a member in your Org

All members of an organization can view a list of the Desktops each member of their organization is assigned to from the MEMBERS tab for the organization.

You can view the Desktop templates that a member in your organization is assigned to from the organization's MEMBERS tab as follows:

  1. Log in to the Tehama Web UI.
  2. Click on the MEMBERS tab.
  3. Select the "All Members" option in the team-selector field. This provides a list of all the members in your organization.
  4. Locate the entry for the member you are interested in.
  5. Observe the Desktop templates that the member is assigned to, under the Desktops Assigned column.

Note: If there is more than one Desktop template assigned to the member, just the number of assigned Desktop templates is shown - click on the tooltip beside the number to see their names, up to the first five.


View Desktop templates assigned to a member in your Room

Admin users and Org Managers of organizations who have a stake in the Room, and Room Managers (who are members of the Room) and all members of the Room can view the 'assigned Desktop templates' column in the lists of members under the Room's MEMBERS tab.

You can view the names, up to the first five, of the Desktop templates that a member in your Room is assigned to from the Room's MEMBERS tab as follows:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the user interface for the Room. The Room tabs you will see depends on the role you have within your organization.
  4. Click on the Room's MEMBERS tab. You will see the list of organizations with access to the Room.
  5. Locate the organization that the member you are interested in belongs to.
  6. To the left of the organization name, Click the drop-down arrow dropdown-down-arrow-icon icon. You will see the list of members for in the Room from this organization.
  7. Locate the entry for the member you are interested in.
  8. Observe the Desktop templates that the member is assigned to, under the Desktops Assigned column.

Note: If there is more than one Desktop template assigned to the member, just the number of assigned Desktop templates is shown - click on the tooltip beside the number to see their names, up to the first five.

Alternative: If your want to see your own assigned Desktop templates in the Room, you can see a complete list under the Room's WORK -> MY DESKTOPS page. See the section View your assigned Desktop templates in your Room.


View your assigned Desktop templates in your Org

Any user in an organization can see the list of all their assigned Desktop templates in the DESKTOPS tab for the organization.

To see the list of your assigned Desktops in your organization, do the following:

  1. Log in to the Tehama Web UI.
  2. Click on the DESKTOPS tab.
  3. Click the My Desktops radio button at the top of the page. (NOTE: If you are a Staff member in the organization, you will not see this radio button. The list will be restricted to only your assigned Desktops by default.)

You will see a list of all the Desktop templates that you are assigned to in your organization.


View your assigned Desktop templates in your Room

Only a user assigned to a Desktop template can see that Desktop template in the Room's WORK -> MY DESKTOPS page.

To see the list of your assigned Desktop templates in a Room, do the following:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the Room's interface.
  4. Click the Room's WORK tab.
  5. Click on the MY DESKTOPS sidebar item.

You will see a list of all the Desktop templates in the Room you are assigned to.

Alternative: You can also see the names of your assigned Desktop templates, up to the first five, in your member entry in the Room's MEMBERS tab, under the Desktops Assigned column. See the section View Desktop templates assigned to a member in your Room.


View all Desktop templates in your Org

The Admin user and Org/Room Managers of an organization can view a list of all Desktops templates in Rooms that they are members of (Rooms within the organization).

To see the list of all Desktops in your organization (in Rooms that you are a member of), do the following:

  1. Log in to the Tehama Web UI.
  2. Click on the DESKTOPS tab.
  3. Click the All Desktops radio button at the top of the page. (NOTE: If you are a Staff member in the organization will not see this radio button. This feature is not available to you.)

You will see a list of all the Desktop templates in your organization.


View all Desktop templates in your Room

Only the Admin user and Org Managers and Room Managers (who are members of the Room) of a Room's owner organization (owner+connected or user+owner) can see the lists of the Desktops templates in the Room under the CONFIGURE -> WINDOWS/LINUX DESKTOPS pages.

To see a Room's Desktop templates:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the Room's interface.
  4. Click the Room's CONFIGURE tab.
  5. Select the appropriate sidebar item:
    • For Windows Desktop templates, click the WINDOWS DESKTOPS sidebar item.
    • For Linux Desktop templates, click the LINUX DESKTOPS sidebar item.
    You will see the list of Desktop templates that are available in the Room, for the selected Desktop OS-type.

To see Desktop template details:

  1. Click on the three vertical dots under the Actions column for an entry in the list.
  2. Select the "Edit" menu item. You will see the details for the template, including the list of Room members that are assigned to the template.

View in-use Desktop templates in your Org

The Admin user and Org/Room Managers of an organization can view a list of the Desktop templates that are in-use that are in Rooms that they are members of (Rooms within the organization).

To see the list of in-use Desktops in your organization (in Rooms that you are a member of), do the following:

  1. Log in to the Tehama Web UI.
  2. Click on the DESKTOPS tab.
  3. Click the In use radio button at the top of the page. (NOTE: If you are a Staff member in the organization will not see this radio button. This feature is not available to you.)

You will see a list of in-use the Desktop templates in the organization.


Add a Desktop template

Only the Admin user and Org Managers and Room Managers (who are members of the Room) of a Room's owner organization (owner+connected or user+owner) can add a new Desktop template to the Room directly.

Desktop templates represent a desktop configuration document from which Tehama Desktop instances are generated. They define the type ('Tehama Windows Desktops', 'Tehama Linux Desktops' or 'Workspaces'), specification (CPU/memory/apps: standard, pro, custom etc) and various other characteristics (multi-user etc). They also contain a list of assigned Room members. Each assigned Room member has a Desktop instance (in some cases shared) generated from the Desktop template to connect to.

add type:

NOTE: You can also add Desktop templates to your Room from the Room's MEMBERS tab. See section Assign members to Desktop Template in the Room Membership User Guide.


 • add Tehama Windows

The 'Tehama Windows Desktops' desktop type is one Tehama's Windows-based desktop offerings.

Note, 'Tehama Windows Desktops' may not be enabled for your Room. Contact Tehama Support to enable or disable this feature in your Room, or you may enable/disable this feature through the Room Settings interface. See the Enable/Disable Windows Desktop section in the Rooms User Guide.

To add a new Desktop template of type 'Tehama Windows Desktops', do the following:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the Room's interface.
  4. Click the Room's CONFIGURE tab.
  5. Click the WINDOWS DESKTOPS sidebar item.
  6. Click the ADD WINDOWS DESKTOP TEMPLATE button at the top right of the page. This will display the ADD WINDOWS DESKTOP TEMPLATE dialog.
  7. If your Room has enabled desktops of type 'Tehama Windows Desktop', then the first dialog you see will show you two choices:
    Tehama Windows Desktop
    Workspace
    Select 'Tehama Windows Desktop' and then click CHOOSE TEMPLATE. You will see the ADD WINDOWS DESKTOP TEMPLATE dialog with the fields required for desktops of type 'Tehama Windows Desktops'.
    • Note: If the first dialog you see is ADD WINDOWS DESKTOP TEMPLATE, then your Room only supports the 'Workspaces' type of Windows-based desktop. Desktops of the type 'Tehama Windows Desktops' are not enabled for your Room.
  8. Enter the name for your Desktop Template.
  9. In the Specification field, choose one of the supported CPU and memory configurations for your virtual machine.
    • Note also that the GPU memory configuration may not be available in your Room's region. See the list of regions offering GPU at the end of this user guide.
  10. Click on the CREATE DESKTOPS FOR MEMBERS button. The CREATE DESKTOP(S) dialog will appear. (Click on the arrow to the left of the dialog title to return to the previous dialog.)
  11. Click on the Users field to open the list of Room members that you can assign to this Desktop template.
  12. Select the name(s) of the Room members that you wish to assign to this Desktop template. A separate Desktop instance will be created for each user. (Tehama can create up to five Desktop instances at one time. You can edit the Desktop template after creation in order to add more. There must be at least one name specified. At this time, a template cannot be created without at least one Room member assigned to it.)
  13. Click CHOOSE DESKTOP OPTIONS. The ENABLE DESKTOP ADMIN RIGHTS dialog will appear. (Note, if your Room is a domain joined Room, then this dialog is skipped - your Tehama Windows Desktop will inherit its privileges from the domain.)
  14. Place a checkmark in the checkbox beside the sentence "Give desktop admin rights to desktop(s)" if you wish to allow the members the ability to install apps and modify system settings. Leave it unchecked otherwise.
  15. Click REVIEW. The REVIEW dialog will appear.
  16. Read the disclaimer (if any) and review the specification details. (Note, you may be required to accept terms and conditions.)
  17. Click CREATE. The SUCCESS dialog will appear.
  18. Click CLOSE. An entry for the new Desktop template will appear in the list of Desktop templates on the page. Room members that are assigned to the Desktop template will be able to connect to the Desktop instance built from this template for them from the MY DESKTOPS page under the WORK tab in the Room.

 • add Workspace

The 'Workspaces' desktop type is one Tehama's Windows-based desktop offerings.

To add a new Desktop template of type 'Workspaces', do the following:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the Room's interface.
  4. Click the Room's CONFIGURE tab.
  5. Click the WINDOWS DESKTOPS sidebar item.
  6. Click the ADD WINDOWS DESKTOP TEMPLATE button at the top right of the page. This will display the ADD WINDOWS DESKTOP TEMPLATE dialog.
  7. If your Room has enabled desktops of type 'Tehama Windows Desktop', then the first dialog you see will show you two choices.
    Tehama Windows Desktop
    Workspace
    Select 'Workspace' and then click CHOOSE TEMPLATE. You will see the ADD WINDOWS DESKTOP TEMPLATE dialog with the fields required for desktops of type 'Workspace'.
    • Note: If the first dialog you see is ADD WINDOWS DESKTOP TEMPLATE, then your Room only supports the 'Workspaces' type of Windows-based desktop. In that case, the dialog will have the fields required for desktops of type 'Workspace'. Continue to the next step.
  8. Enter the name for your Desktop template.
  9. The default mode for a new Desktop template is 'Individual'. If you see the Mode field, then you may opt to change the mode. If this field is visible, select
    EITHER
    Individual, – which gives each user Room access (a Desktop) that is uniquely available to them,
    OR
    Shared, – which requires you to specify the number of people who will have access to the Desktop, and provides Room access that can be pooled/shared among all users in the access list field, one at a time.
    (See "Note on Shared Desktops" below.)
  10. In the Number of Desktops field which is visible only if you have chosen a Shared mode, enter the number of Desktop instances that will be shared.
  11. In the Specification field, choose one of the supported CPU and memory configurations for your virtual machine.
    • Note also that the GPU memory configuration may not be available in your Room's region. See the list of regions offering GPU at the end of this user guide.
  12. Under Power Management, select
    EITHER
    On Demand, – which sets the behaviour of the Desktop instances built from this template such that they will be suspended when they are not in use.
    OR
    Always On, – which sets the behaviour of the Desktop instances built from this template such that they will not be suspended when they are not in use.
    (The Power Management selection is not available for the GPU specification for Workspaces.)
  13. Click on the CREATE DESKTOPS FOR MEMBERS button. The CREATE DESKTOP(S) dialog will appear. (Click on the arrow to the left of the dialog title to return to the previous dialog.)
  14. Click on the Users field to open the list of Room members that you can assign to this Desktop template.
  15. Select the name(s) of the Room members that you wish to assign to this Desktop template. (There must be at least one name specified. At this time, a template cannot be created without at least one Room member assigned to it.) A separate Desktop instance will be created for each user unless you have opted to create 'Shared' desktop instances.
    • Note that the user(s) assigned to this Workspace Desktop template will be given desktop admin rights on the Desktop instance built for them from the template only if the Room was created with "Desktop Administrator privileges" for Workspaces enabled.
  16. Click REVIEW. The REVIEW dialog will appear.
  17. Read the disclaimer (if any) and review the specification details.
  18. Click CREATE. The SUCCESS dialog will appear.
  19. Click on CLOSE. An entry for the new Desktop template will appear in the list of Desktop templates on the page. Room members that are assigned to the Desktop template will be able to connect to the Desktop instance built from this template for them from the MY DESKTOPS page under the WORK tab in the Room.

A Note on Shared Desktops
    (for the Windows-based 'Workspaces' Desktop type only)

An individual Workspace Desktop instance is accessed through a unique username for that Desktop. The username is NOT unique to the individual user (the user logging in to the instance). Multiple users who wish to access the same Windows Desktop instance will do so using a shared/common username. This will impose the following risks in the Windows environment:

  1. There is no user level local file space on the Desktop. All files, application settings and personalization configured within the windows host will be accessible to ALL individuals who access that Desktop. For Example:
    1. Application Specific Configuration, Including:
      1. Saved hosts/password settings entered into PuTTY or WinSCP
      2. Personal Details
      3. Browsing Data (Cookies, Cache, History)
    2. Saved usernames and passwords stored in the browser (e.g. Internet Explorer or Google Chrome)
    3. Windows Personalizations
    4. Files added/created
  2. No individual user logging/traceability. Windows log files will be unable to identify a specific individual logged into Windows when searching for a specific event. All user logs will appear from the shared username (unique to the Windows VM).
The Tehama platform DOES however offer the following individual user level feature:

  • Session Recordings. Stored session recordings are stored and associated to an individual Tehama user. For ease of playback, the recordings are marked with the individual usernames.
If a per-user Desktop experience is required, it is recommended to instantiate an Individual Desktop.


 • add Tehama Linux

The 'Tehama Linux Desktops' desktop type is one Tehama's Linux-based desktop offerings.

Note, 'Tehama Linux Desktops' may not be enabled for your Room. Contact Tehama Support to enable or disable this feature in your Room, or you may enable/disable this feature through the Room Settings interface. See the Enable/Disable Linux Desktop section in the Rooms User Guide.

To add a new Desktop template of type 'Tehama Linux Desktops', do the following:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the Room's interface.
  4. Click the Room's CONFIGURE tab.
  5. Click the LINUX DESKTOPS sidebar item.
    • Note, you will not see the LINUX DESKTOPS sidebar item, if your Room does not have the Tehama Linux Desktops feature enabled.
  6. Click on the ADD LINUX DESKTOP TEMPLATE button at the top right of the page. This will display the ADD LINUX DESKTOP TEMPLATE dialog.
  7. Enter the name of the Desktop (a friendly name used to identify the Desktop function or owner).
  8. Choose the operating system. Currently the only supported choice is Ubuntu 18.04.
  9. Choose the specification (Hardware specifications). Once a value has been selected, values for it will appear in the dialog.
    • Note that the GPU memory configuration may not be available in your Room's region. See the list of regions offering GPU at the end of this user guide.
  10. Click on the CREATE DESKTOPS FOR MEMBERS button. The CREATE DESKTOP(S) dialog will appear. (Click on the arrow to the left of the dialog title to return to the previous dialog.)
  11. Click on the Users field to open the list of Room members that you can assign to this Desktop template.
  12. Select the name(s) of the Room members that you wish to assign to this Desktop template. A separate Desktop instance will be created for each user. (Tehama can create up to five Desktop instances at one time. You can edit the Desktop template after creation in order to add more. There must be at least one name specified. At this time, a template cannot be created without at least one Room member assigned to it.)
  13. Click CHOOSE DESKTOP OPTIONS. The ENABLE DESKTOP ADMIN RIGHTS dialog will appear.
  14. Place a checkmark in the checkbox beside the sentence "Give desktop admin rights to desktop(s)" if you wish to allow the members the ability to install apps and modify system settings. Leave it unchecked otherwise.
  15. Click REVIEW. The REVIEW dialog will appear.
  16. Review the specification details.
  17. Click CREATE. The SUCCESS dialog will appear.
  18. Click CLOSE. An entry for the new Desktop template will appear in the list of Desktop templates on the page. Room members that are assigned to the Desktop template will be able to connect to the Desktop instance built from this template for them from the MY DESKTOPS page under the WORK tab in the Room.

Edit a Desktop template

Only the Admin user and Org Managers and Room Managers (who are members of the Room) of a Room's owner organization (owner+connected or user+owner) can edit an already approved Desktop template in the Room.

NOTE: You can also edit the users assigned to a Desktop template from the Room's MEMBERS tab. See section Assign members to Desktop in the Room Membership User Guide.

To edit an existing/approved Desktop template:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the Room's interface.
  4. Click the Room's CONFIGURE tab.
  5. Click on either the WINDOWS DESKTOPS sidebar item or the LINUX DESKTOPS sidebar item, depending on the type of Desktop template to be edited.
  6. Locate the Desktop template you wish to edit.
  7. Click on the three vertical dots under the Actions column in the entry you wish to edit, then select 'Edit'. This will display the EDIT WINDOWS DESKTOP TEMPLATE dialog for Windows-based Desktop templates, or the EDIT LINUX DESKTOP TEMPLATE dialog for Linux-based Desktop templates.
  8. Make your changes in the dialog. Note that only a subset of the fields in the dialog are editable. The Desktop Template name field and the Users field are editable, but the specification details are not.
  9. Click SAVE. Note that attempts to remove all users from a Desktop will result in an error.

Note: Tehama can create up to five Desktop instances at one time, so restrict the number of new members added to the Users field during each edit session to five.


Delete a Desktop template

The Admin users and Org Managers and Room Managers (who are members of the Room) of a Room's owner organizations (owner+connected or user+owner) can delete already approved Desktop templates in the Room.

To delete an existing/approved Desktop template:

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room you want to access. You will see the Room's interface.
  4. Click the Room's CONFIGURE tab.
  5. Click on the WINDOWS DESKTOPS or LINUX DESKTOPS sidebar item, depending on what type of Desktop you want to delete (Windows-based or Linux-based).
  6. Locate the Desktop template you wish to delete.
  7. Click on the three vertical dots under the Actions column in the entry you wish to delete, then select 'Delete'. The DELETE DESKTOPS dialog will appear.
  8. Read the warning message contained in the dialog. The warning will differ depending on the type of Desktop template you are deleting.
  9. Type the name of the Desktop template into the dialog to confirm deletion (case sensitive).
  10. Click DELETE.

Find Your Desktop in the Tehama Web UI

All members of a Room that have been assigned to a Desktop template in the Room will be able to view the Desktop instance generated for them from the template in the Tehama Web UI.

The Tehama Web UI provides lists of Desktop instances. You can perform actions on a Desktop from its list entry.

Desktops are identifiable by the combination of their names and the name of the Room they belong to.

Find your Desktop in the Tehama Web UI:

  1. Choose A or B.
    A: find the Desktop in the list of all your Desktops in the organization
    1. Log in to the Tehama Web UI.
    2. Click on the DESKTOPS tab.
    3. Click the My Desktops radio button at the top of the page. (NOTE: If you are a Staff member in the organization, you will not see this radio button. The list will be restricted to only your assigned Desktops by default.)
    4. Look for the entry in the list with your Desktop's name and your Desktop's Room's name.
    B: find the Desktop in the list of your Desktops in the Room it belongs to
    1. Log in to the Tehama Web UI.
    2. Click on the ROOMS tab.
    3. Click on the name of the Room to which your Desktop belongs. You will see the Room's interface.
    4. Click the Room's WORK tab.
    5. Click on the MY DESKTOPS sidebar item.
    6. Look for the entry in the list with your Desktop's name.

Once you have located the entry for your Desktop, in either the DESKTOPS page or the MY DESKTOPS page, you can begin working with it.


Download the Tehama Client onto Your Device

All members of a Room that have been assigned to a Desktop template in the Room will have access, through the Tehama Web UI, to the Tehama Client and the Teradici PCoIP Client downloads required to connect to Desktops from their devices.

The Tehama Client is required for launching a Desktop with a single-click. The Teradici PCoIP Client is used to launch a Desktop manually with credentials. (The Tehama Client uses Teradici PCoIP technology.)

Download and install the Tehama Client and the Teradici PCoIP Client on to your device before attempting to launch a Desktop from it.

This is a one time action per device.

Perform the download and installation as follows:

  1. Log in to the Tehama Web UI.
  2. Click on the DESKTOPS tab.
  3. Click on the INSTALL CLIENT button in the top right of the page. This will display the TEHAMA CLIENT page. This page provides you with information about the Tehama Client and ways to download it.
  4. Click the icon for your device's operating system (Linux, Windows or MacOS) to download the desktop clients onto your device.
  5. Follow any installation/configuration instructions that are provided in the downloaded artifact(s).
  6. Click on the X CLOSE button in the top right of the page to return to the DESKTOPS page.
  7. Ensure that your browser does not block the Tehama Client pop-up.

    When connecting to a Desktop, the Tehama Client is launched through a pop-up in your browser. Go into the settings for your chosen browser and make sure that the browser from which you intend to connect to your Desktop allows this pop-up from https://<your-org-subdomain>.tehama.io:443.

    Each browser configures pop-up controls differently. Query your browser's help to determine the correct procedure.

    If you attempt to connect to your Desktop using a browser that does not allow the Tehama Client pop-up, then the browser will block the Tehama Client pop-up, and it will not be able to launch.

    In some browsers, it is obvious when a pop-up is being blocked. In others, it is less obvious. For example:
    • In Firefox, a banner will appear at the top of the page stating that Firefox prevented the site from opening the pop-up. Click on the "Options" button on the banner to view your pop-up options.

    • In Google Chrome, the indication that a pop-up is being blocked is a small icon with a red X that appears in the browser's address bar. Click on that icon to allow pop-ups.

  8. You can test the single-click connect capability by clicking on the CONNECT button for any of your Desktops in the DESKTOPS page. This will launch your Desktop instance as a standalone application.

Other ways to get to the TEHAMA CLIENT page:

from the LAUNCH COMPLETE dialog:

You will find a link to the TEHAMA CLIENT page from the LAUNCH COMPLETE dialog that appears at the end of an attempt to connect to your Desktop via the single-click connect capability. (The dialog appears at the point it expects your Desktop to have launched, regardless of whether or not it has.) Click on the "install" link in the sentence "If your desktop has not loaded by now, be sure to install the Tehama Client or retry again" that is found on the dialog. This will take you to the TEHAMA CLIENT page.

From the CONNECT WITH CREDENTIALS dialog:

You will find a link to the TEHAMA CLIENT page from the CONNECT WITH CREDENTIALS dialog. Click on the "download and install" link in the sentence "To connect with credentials be sure to download and install the Tehama Client" that is found on the dialog. This will take you to the TEHAMA CLIENT page.


Connect to a Desktop (single click)

All members of a Room that have been assigned to a Desktop template in the Room can connect to their instance of the Desktop template (possibly a shared instance).

Connect (launch and log in to), with a single click, to a Desktop (an instance of a Desktop template to which you are assigned) in order to work with the assets of the connected organization for the Room. While you are connected to a Desktop, that Desktop is considered to be 'in use'.

To connect to a Desktop:

  1. Locate the entry for the Desktop to which you want to connect in the Tehama Web UI.

  2. Look for the CONNECT button in the entry.
    • Note: If you see the word UNAVAILABLE next to the template's name instead of the CONNECT button, it means there are too many Desktop instances currently in use within the Room the template belongs to, and you will not be able to connect. A maximum of 75 Desktops can be in use within a Room concurrently when the Room has the Recordings Room feature enabled and a maximum of 200 Desktops when the Room has the Recordings Room feature disabled. (See the Desktop Session Auditing/Recordings User Guide for more details.)

  3. Click on the CONNECT button in the entry.

    This will launch your Desktop instance as a standalone application.

    IMPORTANT Your Desktop will fail to launch unless you have downloaded the Tehama Client and the Teradici PCoIP Client to your device.

    Follow the steps in section Download the Tehama Client onto Your Device. This is a one time action per device.
    A sequence of dialogs will let you know the stage of your connection request.

    • Stage 1 - Desktop Preparation: The PREPARING YOUR DESKTOP... dialog will appear while your Desktop is preparing for launch (for example, your desktop may be starting or it may be coming out of hibernation). This dialog will remain visible until the Desktop is ready to launch.

      Note, if for some reason, your Desktop failed to prepare itself for the launch stage successfully, the PREPARATION FAILED dialog will appear. You can retry the connection through the "Retry" link found on this dialog.

    • Stage 2 - Desktop Launch: The LAUNCHING YOUR DESKTOP... dialog will appear. This dialog will remain visible for a number of minutes while your Desktop launches.

      If you attempt to connect to your Desktop using a browser that does not allow the Tehama Client pop-up, then the browser will block the Tehama Client pop-up, and it will not be able to launch.

      In some browsers, it is obvious when a pop-up is being blocked. In others, it is less obvious. For example:
      • In Firefox, a banner will appear at the top of the page stating that Firefox prevented the site from opening the pop-up. Click on the "Options" button on the banner to view your pop-up options, then allow the pop-up.

      • In Google Chrome, the indication that a pop-up is being blocked is a small icon with a red X that appears in the browser's address bar. Click on that icon to allow pop-ups.

    • Stage 3 - Desktop Ready-for-use: The LAUNCH COMPLETE dialog will appear. At this point, your Desktop should be launched and ready for you to use.

      Note, if for some reason your Desktop failed to launch, you can retry the connection from the for your desktop in the table entry or through the "Retry" link on the LAUNCH COMPLETE dialog. Alternately, you can try to connect to your Desktop by entering the login credentials for your Desktop into the Teradici PCoIP Client. You can copy the necessary credentials from the CONNECT WITH CREDENTIALS dialog that appears when you click on the "connect with credentials" link on the LAUNCH COMPLETE dialog. credentials. See section 'Connect to a Desktop (with credentials) via Teradici PCoIP Client'._

Important Notes about possible issues connecting your Workspace Desktop session:

  • Your Desktop may be restarting or rebooting. If so, wait a few minutes and try again.
  • For Windows users, if prompted to allow firewall access, click Allow Access.
    The connection can take a minute to be fully established.
  • Upon launch, your Desktop will begin initializing/starting. The Workspace Agent application (also known as the Desktop Agent) will start up in the background, but will not be shown. You can show the Workspace Agent by clicking on its icon in the tray or on the desktop. If the Workspace Agent detects an update, the update will be downloaded automatically and the Workspace Agent will restart. If it detects an update while the Desktop is restarting/rebooting, it will delay performing the update for two minutes.

Note: When logging off your Workspace Desktop, use the Start menu's "Log off" instead of X'ing out of the Desktop. This ensures that the virtual Desktop is properly logged out of and is available in a timely manner for re-login. This is particularly important in shared Workspaces.


Connect to a Desktop (with credentials) via Teradici PCoIP Client

All members of a Room that have been assigned to a Desktop template in the Room can connect to their instance of the Desktop template (possibly a shared instance).

If for some reason you have trouble connecting to your Desktop through the single-click CONNECT button for your desktop in the table entry or through the "Retry" link on the LAUNCH COMPLETE dialog, you can manually connect to your Desktop from the Teradici PCoIP Client's user interface with credentials.

IMPORTANT Your Desktop will fail to launch unless you have downloaded the Tehama Client and the Teradici PCoIP Client to your device.

Follow the steps in section Download the Tehama Client onto Your Device. This is a one time action per device.

  1. Attempt to Connect to a Desktop (single-click).
  2. When the LAUNCH COMPLETE dialog appears at the end of the launch sequence, click on the "connect with credentials" link. The CONNECT WITH CREDENTIALS dialog will appear. This dialog provides the credentials needed for manual connection.
  3. Launch the Teradici PCoIP Client in your device. You should see its user interface appear.
  4. Copy the Host Address/Registration Code field value from the CONNECT WITH CREDENTIALS dialog into the "Host Address or Code" field in the Teradici PCoIP Client.
    Note: For convenience, in Tehama, copy buttons are available that automatically place the Host Address/Registration Code, User Name or Password into the clipboard.
    Note: Desktop credentials are dynamic. The password is automatically rotated every five minutes.
  5. Enter a name for this connection in the Teradici PCoIP Client's "Connection Name" field.
  6. Click NEXT in the Teradici PCoIP Client.
  7. Copy the User Name field value from the CONNECT WITH CREDENTIALS dialog into the "Username" field in the Teradici PCoIP Client.
  8. Copy the Password field value from the CONNECT WITH CREDENTIALS dialog into the "Password" field in the Teradici PCoIP Client. (To view the Password value as plaintext, click on the 'eye' symbol in the field.)
  9. Click LOGIN in the Teradici PCoIP Client. This will launch your Desktop instance as a standalone application.

Connect to a Workspace (with credentials) via AWS Web Client

All members of a Room that have been assigned to a Desktop template in the Room can connect to their instance of the Desktop template (possibly a shared instance).

Another option for connecting to Workspace Desktops is through the Amazon Workspaces® Web Client with manually entered credentials.

(Note, this is ONLY available for Desktops of type 'Workspaces'.)

  1. Locate the entry for the Desktop (of type Workspace) to which you want to connect in the Tehama Web UI.
  2. Select the "Connect via AWS web client" menu item in the Actions menu for the entry. The Amazon WorkSpaces® Web Access interface will appear in a new browser tab.
  3. The CONNECT WITH CREDENTIALS dialog with credentials for your desktop will appear in the Tehama Web UI. Note the Host Address/Registration Code, the User Name and the Password values. (To view the Password value as plaintext, click on the 'eye' symbol in the field.)
    Note: Desktop credentials are dynamic. The password is automatically rotated every five minutes.
    Note: For convenience, in Tehama, copy buttons are available that automatically place the Host Address/Registration Code, User Name or Password into the clipboard.
  4. Copy the host address/registration code and paste it into the Amazon WorkSpaces® Web Access interface as indicated.
  5. Click Register.
  6. Copy the User Name and Password and paste them into the Amazon WorkSpaces® Web Access interface as indicated.
  7. Click Sign In. (If you are prompted with a Remember Me option, click No.) Your Workspace Desktop session will begin.

Connect to a Workspace (with credentials) via AWS Client

All members of a Room that have been assigned to a Desktop template in the Room can connect to their instance of the Desktop template (possibly a shared instance).

Another option for connecting to Workspace Desktops is through the Amazon Workspaces® Client with manually entered credentials.

(Note, this is ONLY available for Desktops of type 'Workspaces'.)

  1. Locate the entry for the Desktop (of type Workspace) to which you want to connect in the Tehama Web UI.
  2. Select the "Connect via AWS client" menu item in the Actions menu for the entry.
  3. The CONNECT WITH CREDENTIALS dialog with credentials for your desktop will appear in the Tehama Web UI. Note the Host Address/Registration Code, the User Name and the Password values. (To view the Password value as plaintext, click on the 'eye' symbol in the field.)
    Note: Desktop credentials are dynamic. The password is automatically rotated every five minutes.
    Note: For convenience, in Tehama, copy buttons are available that automatically place the Host Address/Registration Code, User Name or Password into the clipboard.
  4. Launch the Amazon WorkSpaces® Client in your device. You should see its user interface appear.
  5. Copy the host address/registration code and paste it into the Amazon WorkSpaces® Client's Registration Code field, then click Register. (If there is no field visible for this value, you may need to click the "Change Registration Code" link in order to enter/update this value.)
  6. Copy the User Name and Password and paste them into the Amazon WorkSpaces® Client's Username and Password fields, respectively.
  7. Click Sign In. (If you are prompted with a Remember Me option, click No.) Your Workspace Desktop session will begin.

Force Logout of a Shared Workspace

All members of a Room that have been assigned to a shared Workspace instance in the Room can force the logout of that Desktop.

The 'Workspaces' desktop type is one Tehama's Windows-based desktop offerings.

Occasionally a shared Workspace instance may remain in a logged-in state even though no user is actually using the Desktop. For example, a user may have neglected to log themselves out before leaving on vacation. Or a user may have closed the Workspace application window instead of explicitly logging out. To free up a desktop so it can be used again, follow these steps:

  1. Locate the entry for the Desktop (of type Workspace - shared) to which you want to connect in the Tehama Web UI.
  2. Click on the Log out current user ... button in the entry. The LOG OUT warning dialog will appear.
  3. Place a checkmark in the checkbox next to the "I understand" statement.
  4. Click LOG OUT.

Request a custom image of a Desktop template

Only the Admin user and Org Managers and Room Managers (who are members of the Room) of a Room's owner organization (owner+connected or user+owner) can request a custom image, and they must be a member of the Room and be assigned to the Desktop template whose instance the custom image is to be based off of.

Note that members of the Room who are Staff members of the Room's owner organization can see the option to request a custom image from Desktop templates they are assigned to, and they can attempt to do so, but will be denied permission when they attempt to make the request by clicking the request button.

For information on creating and using Custom Specifications, please review the Custom Specifications User Guide.


Restart a Desktop

All members of a Room that have been assigned to a Desktop template in the Room, can restart their Desktop instance from the Room's WORK tab or from the top navigation bar's DESKTOPS tab, with the exception that Staff members are unable to restart shared Desktop instances.

Admins, Org Managers and Room Managers (who are members of the Room) can restart other Desktop instances in the Room from the top navigation bar's DESKTOPS tab.

The steps to restart a Desktop vary by type:

Restart a Desktop from the top navigation bar's DESKTOPS tab

Restart a Desktop from the Tehama Web UI top navigation bar's DESKTOPS tab.

  1. Log in to the Tehama Web UI.
  2. Click on the DESKTOPS tab.
  3. To restart:
    • your own Desktop instance: Click the My Desktops radio button at the top of the page. (NOTE: If you are a Staff member in the organization, you will not see this radio button. The list will be restricted to only your assigned Desktops by default.)
    • a Desktop instance that is not yours: Click the All Desktops radio button at the top of the page. (NOTE: If you are a Staff member in the organization, you will not see this radio button. You are unable to restart Desktops that are not your own.)
  4. Locate the entry with the name of the Desktop which you want to restart and the name of the Room to which it belongs.
  5. Click on the three vertical dots under the Actions column in the Desktop's entry.
  6. Select "Restart Desktop". This will display the RESTART DESKTOP dialog.
    • Note: Staff members will not see the "Restart Desktop" option for their shared Desktop instances as they are not allowed to perform this action for those Desktops. Admins, Org Managers or Room Managers (who are members of the Room) can restart shared Desktop instances for Staff members from the DESKTOPS tab.
  7. Read the warning in the dialog: "Any currently connected users will be disconnected, and all unsaved work will be lost."
  8. If you wish to proceed with the restart (reboot) of your Desktop, select YES. Otherwise, select NO.

Note that the restart may take 5 - 10 minutes to complete.

Restart a Desktop from the Room's WORK tab

Restart a Desktop from the Tehama Web UI Room's WORK tab.

  1. Log in to the Tehama Web UI.
  2. Click on the ROOMS tab.
  3. Click on the name of the Room to which the Desktop you want to restart belongs. You will see the Room's interface.
  4. Click the Room's WORK tab.
  5. Click on the MY DESKTOPS sidebar item.
  6. Locate the entry with the name of the Desktop which you want to restart.
  7. Click on the three vertical dots under the Actions column in the Desktop's entry.
  8. Select "Restart Desktop". This will display the RESTART DESKTOP dialog.
    • Note: Staff members will not see the "Restart Desktop" option for their shared Desktop instances as they are not allowed to perform this action for those Desktops. Admins, Org Managers or Room Managers (who are members of the Room) can restart shared Desktop instances for Staff members from the DESKTOPS tab.
  9. Read the warning in the dialog: "Any currently connected users will be disconnected, and all unsaved work will be lost."
  10. If you wish to proceed with the restart (reboot) of your Desktop, select YES. Otherwise, select NO.

Note that the restart may take 5 - 10 minutes to complete.


Start Desktop Agent

All members of a Room that have been assigned a Desktop in the Room can start the Desktop Agent from the menu of a connected session for that Desktop.

The Desktop Agent will normally start up automatically in a Desktop session. If it is not running, you can start it from the session menu.

For Desktops of type 'Tehama Windows Desktops':

(See instructions to connect to a Desktop of type 'Tehama Windows Desktop' here: Connect to a Desktop (single click).)

From a connected session:

  1. Click on the Desktop Agent's icon in the desktop. (The icon's name is 'Workspace Agent', which is another name for the 'Desktop Agent'. See the section 'Desktop vs Workspace' above.)
    desktop agent icon
    That will bring up the Desktop Agent application.

Alternately:

  1. Type workspace-agent.exe in the search bar in the task bar. You will be presented with the command to run.
  2. Click on the command to run it.

For Desktops of type 'Workspaces':

(See instructions to connect to a Desktop of type 'Workspaces' here: Connect to a Desktop of type Workspace.)

From a connected session:

  1. Click on the Desktop Agent's icon in the desktop. (The icon's name is 'Workspace Agent', which is another name for the 'Desktop Agent'. See the section 'Desktop vs Workspace' above.)
    desktop agent icon
    That will bring up the Desktop Agent application.

Alternately:

  1. Type workspace-agent.exe in the search bar in the task bar. You will be presented with the command to run.
  2. Click on the command to run it.

For Desktops of type 'Tehama Linux Desktops':

(See instructions to connect to a Desktop of type 'Tehama Linux Desktop' here: Connect to a Desktop (single click).)

From a connected session:

  1. Click on the KDE menu icon (three dots of progressively larger size in a half-circle followed by a greater-than symbol) in the task bar to open the menu.
  2. Type workspace-agent to start a search. You will be presented with the command for the Desktop Agent to run.
  3. Click on the command to run it.

View a Desktop's status

All members of a Room that have been assigned a Desktop in the Room can view the status of that Desktop.

You need to be assigned to a Desktop to see its status.

  1. Locate the entry for the Desktop for which you want to view the status in the Tehama Web UI.
  2. Look for the status icon for the entry under the Status column.

For Desktops of type 'Tehama Windows Desktops' and 'Tehama Linux Desktops':

You can see the status icon in the Desktop's entry:

  • building: building status icon
    indicates the Desktop has not yet completed building
  • available: available status icon
    indicates you can connect to the Desktop
  • restarting: restarting status icon
    indicates the Desktop is restarting - note that if you are viewing the status at the time when the Desktop is restarted from a connected session, then you will need to reload the page in order to see the ‘restarting’ status
  • Error: error status icon
    indicates an error in the Desktop, the tooltip provides more info

For Desktops of type 'Workspaces':

You can see the status icon in the Desktop's entry:

  • in use: in use status icon
    for shared Desktops only, indicates someone is connected to the Desktop, the tooltip displays the user name(s)
  • available: available status icon
    indicates you can connect to the Desktop

Desktop Networking Requirements

VPN clients

Tehama does not provide support for third-party software running on a Tehama Desktop, such as VPN clients.

Each Tehama Desktop, under-the-hood, communicates to its Room infrastructure through a reserved subnet. (If you require specific details of this subnet, please contact Tehama Support).

Be aware that certain VPN configurations will interfere with this communication, interrupting Tehama communication and resulting in service degradation or worse.

If you have configured a VPN client, Tehama Support will only be given to Desktops in the state where the VPN client is not connected. All other VPN troubleshooting should be done between the users of the Tehama Desktop and the owner of the VPN endpoint.


Regions Offering the GPU Memory Configuration

Desktop specifications with the GPU memory configuration option are not available in all regions.

Regions that offer the GPU memory configuration for Windows-based Desktops:

  • US East (N. Virginia)
  • US West (Oregon)
  • EU (Ireland)
  • EU (Frankfurt)
  • Asia Pacific (Sydney)
  • Asia Pacific (Singapore)

Regions that offer the GPU memory configuration for Linux-based Desktops:

  • US East (N. Virginia)
  • US West (Oregon)
  • EU (Ireland)
  • Asia Pacific (Sydney)
  • Asia Pacific (Singapore)

Regions that do NOT offer the GPU memory configuration for Windows-based Desktops:

  • EU (London) - GPU not available for Windows Desktops here
  • Canada (Montreal) - GPU not available for Windows Desktops here

Regions that do NOT offer the GPU memory configuration for Linux-based Desktops:

  • EU (London) - GPU not available for Linux Desktops here
  • Canada (Montreal) - GPU not available for Linux Desktops here
  • EU (Frankfurt) - GPU not available for Linux Desktops here

You can view the region for a Room in the View a Room's region section of the Room Connection Status Monitoring/Management User Guide.