Getting started with Tehama Administration
Have you completed the Getting Started with Tehama Installation Guide? If not, please go back and do so before proceeding.
Tehama provides an intuitive user administration interface allowing an administrator (the user in an organization with the Admin role) to perform the tasks that are necessary for getting started with Tehama.
Purpose
So far you have joined Tehama, creating your own Tehama organization, and created and/or connected to or joined a Room.
Now this guide shows you the steps to carry out the following basic and necessary organization and Room set up:
- Step 1: Organization Member Administration
...- Step 2: Room Member Administration
...
- grant access to your new Room to organizations and organization members;
- Step 3: Room Administration
...
- configure the firewall rules and the secrets vault in your new Room;
- Step 4: Desktop Administration/Management
...
- learn how to customize your Desktops by requesting additional software be configured in the base Desktop images.
- create Desktops in your new Room;
- learn the ways Room members can connect to your Room's Desktops.
This guide also provides the steps for some additional organization and Room administration tasks that are commonly performed by organization Admin users and Org/Room Managers:
- Addendum: Additional Admin
...
- resend an invitation to become an organization member (organization administration);
- delete an organization member (organization administration);
- edit a Desktop (Desktop management); and
- delete a Desktop (Desktop management).
When you have completed all the steps and tasks outlined in this guide, Tehama will be operational, and Desktop users and service providers will have configured accounts.
Authorized Service Providers will be able to manage resources and customers will have full control over access to their data and their Room in Tehama, including Tehama Desktop session recordings (see Desktop Session Auditing).
For more information on:
- Organization Member Administration - see the Organization User Guide.
- Room Member Administration - see the Room Membership User Guide.
- Room Administration
- for Room Administration/Management: see the Room Connection Status Monitoring/Management User Guide.
- for Firewall Rules: see the Firewall Rules User Guide.
- for Secrets: see the Secrets Vault User Guide.
- Desktop Administration/Management - see the Desktops User Guide.
1. Organization Member Admin
After the installation and connection of a Tehama Room is completed, the first task is to create teams and add members to your Tehama organization.
• Create teams
Only the Admin user and Org/Room Managers of an organization can create teams in the organization.
Create a new team as follows:
- Log in to the Tehama Web UI.
- Click on the MEMBERS tab.
- Click the NEW dropdown menu to open it.
- Select New Team.
- Type in a name for the team (e.g., DB Admins).
- Select the members you want to be in the team.
- Click CREATE.
Repeat these steps for each team needed.
See the Create a Team section in the Organization User Guide for more details.
• Invite members
Only the Admin user and Org/Room Managers of an organization can invite members to the organization.
After creating one or more new teams, the next task is to invite new members to the organization.
- Log in to the Tehama Web UI.
- Click on the MEMBERS tab.
- Click the NEW dropdown menu to open it.
- Select Add New Member.
- Enter the member information:
- Name
- Email Address
- Role (Admin and Org Manager users can create Staff, Org Manager or Room Manager users. Room Manager users can create Staff or Room Manager users.)
- Room (Optional - select one or more Rooms from the list of Rooms the organization has access to
Note: You can, from here in the MEMBERS tab, assign additional rooms from this list after the member is created, or you can grant access to members directly from the interface for a Room (first ensuring the organization has access to the Room, of course.) - Team (Select one of the team created in the previous step or leave this blank)
- Click INVITE.
Repeat these steps for each member you need to invite.
Once invited, new members will receive an invitation email to the address specified. The invitation email contains a link which each new team member must action to gain access to Tehama. The user will also be added/proposed as a member in the selected Room(s) (if you selected one or more Rooms in the dialog).
Note: Org Managers have elevated privileges in Tehama. In addition to using the services available to 'Staff', Org Managers are also able to create policies, create and delete team member accounts and create additional Desktops. Room Managers have similar privileges to Org Managers, but for Room Managers these privileges are restricted to Rooms of which they are members.
See the Add Members section in the Organization User Guide for more details.
2. Room Member Admin
To begin using a Room, the next task will be to grant members and/or organizations access to the Room.
• Grant access to orgs
Only the Admin user and Org Managers and Room Managers (who are members of the Room) of a Room's connected organization can add an organization to the Room.
The Room's connected organization must handle this task.
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room where organization access will be granted.
- In the resulting screen (the Room interface), click MEMBERS.
From the 'members' screen, you will see a list of organizations that have access to the Room. (The initial setup will show only one organization.) - Click the ADD ORGANIZATION button at the bottom of the list or select Organization from the ADD dropdown menu in the top right corner of the page. You will see the ADD ORGANIZATION dialog.
- Select the desired Organization from the list in the dialog to invite to the Room.
- Select the desired Policy for the Organization.
- Click INVITE.
Note:
The list of organizations you see in the ADD ORGANIZATION dialog is a subset of existing Tehama organizations. This subset is composed of organizations that already have access to other Rooms in your organization. These organizations are considered to be 'authorized' by your organization.
If you wish to grant access to an existing organization that is not already authorized by your organization, select the option in the dialog to invite a new organization. The contact that you specify can choose to connect to your Room using their existing organization, or create a new one.
If you wish to grant access to a company that does not have a Tehama organization yet, select the option in the dialog to invite a new organization. The contact that you specify will create a new Tehama organization for their company.
See the Invite organizations to join a Room section in the Room Membership User Guide for more details.
• Grant access to members
Only the Admin user and Org Manager and Room Managers (who are members of the Room) of an organization in the Room can add/request members join the Room.
With members (and teams) now created, the next task is to grant member access to your Room.
If your organization is your Room's connected organization, then you can directly add members.
If your organization is not your Room's connected organization, then you can only propose members, and the connected organization will approve (or reject) your proposals.
Choose one method below to add members or teams to the Room.
Grant Access to Individual Members
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room for which member access is to be granted.
- In the resulting screen (the Room interface), click MEMBERS.
From the 'members' screen, you will see a list of organizations that have access to the Room. (The initial setup will show only one organization.) - To the left of the Organization name, Click the drop-down arrow
icon to show the list of members for the organization.
- At the top of the drop-down, click the + MEMBER button.
(or the + PROPOSE button if you are not part of the connected organization). - From the ADD dialog, choose Members.
(This dialog is the PROPOSE TEAM MEMBER dialog if you are not part of the connected organization.)
(You may also opt to choose Invite New Member instead of Members, which will allow you, following the steps to 'Invite New Members', to invite a member to join the organization and add them to the Room.) - Select the member (or multiple members) from the list to add to the Room.
- Click the ADD button.
- Close the list of members by clicking on the drop-down arrow.
icon.
Grant Access to an Entire Team of Members
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room for which member access is to be granted.
- In the resulting screen (the Room interface), click MEMBERS.
From the 'members' screen, you will see a list of organizations that have access to the Room. (The initial setup will show only one organization.) - To the left of the Organization name, click the drop-down arrow
icon to show the list of members for the organization.
- At the top of the drop-down, click the + MEMBER button
(or the + PROPOSE button if you are not a part of the connected organization). - From the ADD dialog, choose Teams.
(this dialog is the PROPOSE TEAM MEMBER dialog if you are not part of the connected organization). - Select the Team (or multiple teams) from the list to add to the Room.
- Click the ADD button.
- Close the list of members by clicking on the drop-down arrow
icon
See the Request Room access for users section and the Add Room access for users section in the Room Membership User Guide for more details.
Also, see the Assign members to one or more Rooms section in the Organization User Guide for details on how to assign a member to one or more rooms from the MEMBERS tab.
3. Room Administration
After assigning members (or whole teams) to the Room, the next task is to enable connectivity (through the creation of firewall rules) and add secrets/passwords for assets/resources in the connected network.
• Create firewall rules
Only the Admin user and Org Managers and Room Managers (who are members of the Room) of a Room's connected organization can create firewall rules in the Room.
The Room's connected organization must handle this task.
Before the Room's Desktops (workspaces) can communicate with network resources, you need to configure firewall rules. By default, all outbound traffic is restricted. (Note, configuring a secret (below) also allows the creation of a firewall exception.)
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room for which you want to add firewall rules.
- In the resulting screen (the Room interface), click CONNECTION.
- Click on the FIREWALL RULES sidebar item.
- Click ADD RULE.
- In the resulting screen, enter the following information:
- Rule Name (a friendly name for the firewall exception)
- IPv4 CIDR block (IP addresses to expose with Subnet Prefix). E.g.: 127.0.0.1/32)
- Protocol - the protocol supported by the rule (TCP or UDP).
- Port Single port, Port range or All ports (choose one).
- Port (enter the port number or port range required for the application).
- Click CREATE.
Note: Using the CIDR block of 0.0.0.0/0 will disable the firewall and expose the Room's Desktops to the internet. While this may be desirable to install software packages, it is not recommended to operate normally with this configuration.
See the Add custom firewall rule section in the Firewall Rules User Guide for more details.
• Add secrets/passwords
Only the Admin user and Org Managers and Room Managers (who are members of the Room) of a Room's connected organization can add secrets to the Room.
The Room's connected organization must handle this task.
To avoid sharing network resource credentials insecurely, Tehama provides access to an encrypted Secret Password store used to securely store, encrypt, and grant authorized members access to credentials and other sensitive information.
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room for which you want to configure secrets.
- In the resulting screen (the Room interface), click CONFIGURE.
- Click on the SECRETS sidebar item.
You will see a list of secret types, (Cassandra, Generic, MongoDB, etc) - Click the type of secret you wish to add.
The secret view is organized by:- asset (secret, e.g. Database credentials)
- folder (for logical storage of assets)
- Create a Folder to organize the secrets.
- (a) Click the ADD secret type FOLDER button.
- (b) In the resulting screen, enter the desired Folder name and fill in the required fields. e.g: a firewall exception may need to be specified. (See the Secrets Vault User Guide for more guidance.)
- (c) Click CREATE.
- Create an Asset.
- (a) Double-click the folder name where the Asset is to be filed.
If no folder is specified, the root folder will be used. - (b) Click the ADD ASSET button.
In the resulting screen, enter the following:- Asset Name (friendly name for your asset/secret) and fill in any required fields. (See the Secrets Vault User Guide for more guidance.)
- (c) Click CREATE.
- (a) Double-click the folder name where the Asset is to be filed.
Authorized members can click the asset name to access the asset under the SECRETS sidebar item within the Room's WORK tab. They may also access the asset from the 'Workspace Agent' application's SECRETS tab with one of the Room's Desktops.
See the Secrets Vault User Guide for more details.
4. Desktop Admin/Mgmt
Now that the configuration of your Room is completed, you need to you need to create your Desktop templates, from which your virtual Desktop instances are built. Once it is built, you will need to find its interface in the Tehama Web UI.
Now that you have (at least one) Desktop template in your Room along with its associated Desktop instances, you, and other members in your Room that are assigned to a Desktop template, are almost ready to use your new Desktops. First you and your members need to configure your devices to connect to your Desktops.
The last step is for you and your members to learn how to connect to their Desktops.
- d. Connect to a Desktop (single click) (recommended connection method)
- e. Connect to a Desktop (with credentials) (alternative to single click)
- f. Connect to a Workspace with Web Client (alternative for Workspaces only)
• Create desktop templates
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 and then assign Room members to it.
The Admin users and Org Managers and Room Managers (who are members of the Room) of a Room's non-owner organizations (user_only and connected_only) and members of the Room that are Staff members in their organizations can instead request a new Desktop template be added to the Room. (See the Request a Desktop Template section in the Desktops User Guide for more details.)
The Room's owner organization must handle this task.
The Room's other organizations can request Desktop templates instead. See the Request a Desktop Template section in the Desktops User Guide for more details.
Members require a Desktop instance to perform their functions. Create a Desktop template and assign members to it. Desktop instances will be built for the assigned members from the template.
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room for which you want to create a Desktop template.
- In the resulting screen (the Room interface), click on the CONFIGURE tab.
From the 'configure' screen you can see your Room's configuration details, add/remove secrets and, of interest to us here, add/edit/remove Desktop templates. - Click on the WINDOWS DESKTOPS or LINUX DESKTOPS sidebar item, depending on what type of Desktop template you wish to add (Windows-based Desktops or Linux-based Desktops, respectively). A list of previously configured Desktop templates will appear. On initial configuration, there will be no Desktop templates displayed.
- Note: If you do not see the LINUX DESKTOPS sidebar item, then your Room does not have a Linux-based Desktop feature enabled. See the note on "How to Enable or Disable 'Tehama Linux Desktops' and 'Linux Legacy Desktops'" in the Desktops User Guide for more information.
- Initiate the creation of a Desktop template as follows:
- For Windows-based Desktops:
Click the ADD WINDOWS DESKTOP TEMPLATE button in the top right corner of the page. - For Linux-based Desktop templates:
Click ADD LINUX DESKTOP TEMPLATE in the top right corner of the page.
- For Windows-based Desktops:
- Proceed as follows:
- For Windows-based Desktops:
- Tehama Windows Desktops Beta:
- You may see two choices at the top of the dialog.
◯ Tehama Windows Desktop BETA
◯ Workspace
Select 'Tehama Windows Desktop BETA'.- Note: If there are no choices, then your Room only supports the 'Workspaces' type of Windows-based desktop. Desktops of the type 'Tehama Windows Desktops Beta' are not enabled for your Room.
- First enter the requested information:
- Name of Desktop (friendly name used to identify the Desktop template function or owner)
- Specification (hardware specifications)
- Click on the NEXT: ASSIGN MEMBER(S) AND REVIEW button. The ASSIGN MEMBER(S) AND REVIEW dialog will appear. (Click on the arrow to the left of the dialog title to return to the previous dialog.)
- Click on the Users field to open the list of Room members that you can assign to this Desktop template. (These are the users who will have access to the Virtual Desktop instance built from this template.)
- 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.
- Read the disclaimer (if any) and review the specification details.
- Click CREATE. The SUCCESS dialog will appear.
- Click CLOSE to dismiss the SUCCESS dialog.
- You may see two choices at the top of the dialog.
- Workspaces:
- You may see two choices at the top of the dialog.
◯ Tehama Windows Desktop BETA
◯ Workspace
Select 'Workspace'.- Note: If there are no choices, then your Room only supports the 'Workspaces' type of Windows-based desktop. Continue to the next step.
- First enter the requested information:
- Name of Desktop (friendly name used to identify the Desktop template function or owner)
- Mode (choose if individual or multiple (Shared) login functionality is enabled)
(field is not available for every Room - default is individual) - Number of Desktops (choose how many Desktops are to be instantiated)
(field is only visible if 'Shared' chosen for Mode) - Specification (hardware specifications)
- Power Management (choose if the Desktop instance needs to remain powered on when idle)
- Click on the NEXT: ASSIGN MEMBER(S) AND REVIEW button. The ASSIGN MEMBER(S) AND REVIEW dialog will appear. (Click on the arrow to the left of the dialog title to return to the previous dialog.)
- Click on the Users field to open the list of Room members that you can assign to this Desktop template. (These are the users who will have access to the Virtual Desktop instance built from this template.)
- 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.
- Read the disclaimer (if any) and review the specification details.
- Click CREATE. The SUCCESS dialog will appear.
- Click CLOSE to dismiss the SUCCESS dialog.
- You may see two choices at the top of the dialog.
- Tehama Windows Desktops Beta:
- For Linux-based Desktops:
- Tehama Linux Desktops:
- You may see two choices at the top of the dialog.
◯ Linux Desktop
◯ Linux (Legacy)
Select 'Linux Desktop'.- Note: If there are no choices, then your Room only supports one type of Linux-based Desktop. If it is the 'Linux Legacy Desktop', then Desktops of the type 'Tehama Linux Desktops' are not enabled for your Room.
- How to tell the difference? The initial creation dialog looks the same for both types of Linux-based Desktop templates, but on the next dialog, where you assign members to the desktop, 'Linux Legacy Desktops' shows you a 'Multi User Desktop' checkbox, while the 'Tehama Linux Desktops' does not.
- Note: If there are no choices, then your Room only supports one type of Linux-based Desktop. If it is the 'Linux Legacy Desktop', then Desktops of the type 'Tehama Linux Desktops' are not enabled for your Room.
- Enter the requested information:
- Name of Desktop (friendly name used to identify the Desktop function or owner)
- Operating System
- Specification (Hardware specifications)
- Click on the NEXT: ASSIGN MEMBER(S) AND REVIEW button. The ASSIGN MEMBER(S) dialog will appear. (Click on the arrow to the left of the dialog title to return to the previous dialog.)
- Click on the Users field to open the list of Room members that you can assign to this Desktop template.
- 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.
- Note that the user(s) assigned to this Desktop template will be given full sudo user capabilities on the Desktop instance built for them from the template.
- Click NEXT: REVIEW. The REVIEW dialog will appear.
- Read the disclaimer (if any) and review the specification details.
- Click CREATE.
- You may see two choices at the top of the dialog.
- Linux Legacy Desktops:
- You may see two choices at the top of the dialog.
◯ Linux Desktop
◯ Linux (Legacy)
Select 'Linux (Legacy)'.- Note: If there are no choices, then your Room only supports one type of Linux Desktop. If it is the 'Tehama Linux Desktops', then Desktops of the type 'Linux Legacy Desktops' are not enabled for your Room.
- How to tell the difference? The initial creation dialog looks the same for both types of Linux-based Desktop templates, but on the next dialog, where you assign members to the desktop, 'Linux Legacy Desktops' shows you a 'Multi User Desktop' checkbox, while the 'Tehama Linux Desktops' does not.
- Note: If there are no choices, then your Room only supports one type of Linux Desktop. If it is the 'Tehama Linux Desktops', then Desktops of the type 'Linux Legacy Desktops' are not enabled for your Room.
- Enter the requested information:
- Name of Desktop (friendly name used to identify the Desktop function or owner)
- Operating System
- Specification (Hardware specifications)
- Click on the NEXT: ASSIGN MEMBER(S) AND REVIEW button. The ASSIGN MEMBER(S) dialog will appear. (Click on the arrow to the left of the dialog title to return to the previous dialog.)
- Opt for either a multi-user Desktop or single-user Desktops and fill out the remaining fields.
WARNING: Once the Desktop is created it is not possible to convert a single user Desktop to multi-user.- To create single user Desktops (one for each User) from this template:
- Leave the Multi User Desktop checkbox unchecked.
- In the User field, enter the name of the Room member who will be assigned to this Desktop template. (The field cannot be left empty.)
- Note that the single user assigned to this Desktop template will be given full sudo user capabilities on the Desktop instance built from the template.
- To create a multi-user Desktop (one for all Users to share) from this template:
- Place a checkmark in the Multi User Desktop checkbox. The User field will change to Users and a new field, Sudo Users, will appear on the dialog.
- In the Users field, enter the names of those who will be assigned to this Desktop template. (There must be at least one name specified.) The users will share one Desktop instance.
- In the Sudo Users field, enter the name(s) of those users who will be given the ability to perform certain operations with elevated privileges, such as using the package manager, on the Desktop instance built from the template.
- To create single user Desktops (one for each User) from this template:
- Click NEXT: REVIEW. The REVIEW dialog will appear.
- Read the disclaimer (if any) and review the specification details.
- Click CREATE.
- You may see two choices at the top of the dialog.
- Tehama Linux Desktops:
- For Windows-based Desktops:
See the Add a Desktop Template section in the Desktops User Guide for more details.
• Find your desktop
All members of a Room that have been assigned to a Desktop template (other than type 'Linux Legacy Desktop') 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. Find your Desktop's list entry so you can begin working with it.
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:
- Choose A or B.
A: find the Desktop in the list of all your Desktops in the organization- Log in to the Tehama Web UI.
- Click on the DESKTOPS tab.
- 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.)
- Look for the entry in the list with your Desktop's name and your Desktop's Room's name.
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click on the name of the Room to which your Desktop belongs. You will see the Room's interface.
- Click the Room's WORK tab.
- Click on the MY DESKTOPS sidebar item.
- 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 Tehama Client
All members of a Room that have been assigned to a Desktop template (other than type 'Linux Legacy Desktop') in the Room will have access to the Tehama Desktop Client and the Teradici PCoIP Desktop Client downloads required to configure their devices through the Tehama Web UI.
Download and install the Tehama Desktop Client ('Tehama App') and the Teradici PCoIP Desktop Client on to your device before attempting to launch a Desktop (other than 'Linux Legacy Desktops') from it.
This is a one time action per device.
You can do this from the list entry for your Desktop in the Tehama Web UI.
Perform the download as follows:
- Locate the entry for one of your Desktops in the Tehama Web UI (of any type except 'Linux Legacy Desktop').
- 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 proceed with configuring your device at this time. A maximum of 75 Desktop instances can be in use within a Room concurrently.
- Click on the CONNECT button in the entry.
- If your device is ALREADY CONFIGURED, this will launch your Desktop instance as a standalone application. (Again, this is not the behaviour for 'Linux Legacy Desktops'.) The Launching your Desktop dialog will appear while your desktop is launching. Dismiss this dialog once your desktop launches successfully.
- If your device is NOT CONFIGURED - most likely if you are following these steps - the Launching your Desktop dialog will appear but your desktop will not launch. Proceed with configuring your device.
- Click on the words DOWNLOAD and INSTALL on the Launching your Desktop dialog. You will see the Download Tehama Client dialog appear. You can download the desktop clients from this dialog.
- Click the icon for your device's operating system (Linux, Windows or MacOS) to download the desktop clients onto your device.
- Follow any installation/configuration instructions that are provided in the downloaded artifact(s).
- Return to the Launching your Desktop dialog from the Download Tehama Client dialog by clicking on the back arrow in the top left corner.
Once the Tehama Desktop Client and the Teradici PCoIP Desktop Client are downloaded and installed onto your device, you can test the single-click connect capability by clicking on the Retry link in the Launching your Desktop dialog. This will launch your Desktop instance as a standalone application. (This is identical to returning to the table entry for your desktop and clicking on the CONNECT button there.)
See the Download the Tehama Client onto Your Device section in the Desktops User Guide for more details.
• Connect with 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 your Desktop instance. While you are connected to your Desktop, it is considered to be 'in use'.
To connect to your Desktop:
- Locate the entry for the Desktop to which you want to connect in the Tehama Web UI.
- 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 Desktop instances can be in use within a Room concurrently.
- Click on the CONNECT button in the entry.
- For 'Linux Legacy Desktops':
- This will launch your 'Linux Legacy Desktop' instance in a new tab in your browser.
Once the Desktop is visible, the first thing you will see is the options menu.
Simply close the options menu to continue.
- This will launch your 'Linux Legacy Desktop' instance in a new tab in your browser.
- For all Desktop types except 'Linux Legacy Desktops':
- This will launch your Desktop instance as a standalone application.
The Launching your Desktop dialog will appear while your Desktop is launching. Dismiss this dialog once your Desktop launches successfully.
IMPORTANT Your Desktop will fail to launch unless you have downloaded the Tehama Desktop Client ('Tehama App') and the Teradici PCoIP Desktop Client to your device. This is a one time action per device.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 Launching your Desktop dialog, you can manually connect to your desktop from the Teradici desktop client's user interface with credentials. See section 'Connect to a Desktop (with credentials)'.
Follow the steps in section Download the Tehama Client onto Your Device to configure your device. This is a one time action per device.
- This will launch your Desktop instance as a standalone application.
- For 'Linux Legacy Desktops':
See the Connect to a Desktop (single click) section in the Desktops User Guide for more details.
Important Notes about possible issues connecting your 'Workspace' type 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' type 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 with credentials
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 Launching your Desktop dialog, you can manually connect to your desktop from the Teradici desktop client's user interface with credentials.
(Note, this is not available for Desktops of type 'Linux Legacy Desktops'.)
IMPORTANT Your Desktop will fail to launch unless you have downloaded the Tehama Desktop Client ('Tehama App') and the Teradici PCoIP Desktop Client to your device. This is a one time action per device.
Follow the steps in section Download the Tehama Client onto Your Device to configure your device. This is a one time action per device.
- Locate the entry for the Desktop to which you want to connect in the Tehama Web UI.
- Select the "Connect with Credentials" menu item in the Actions menu for the entry. The Connect with Credentials dialog will appear. This dialog provides the credentials needed for manual connection.
- Launch the Teradici PCoIP desktop client in your device. You should see its user interface appear.
- Copy the Host Address/Registration Code field value from the Connect with Credentials dialog into the "Host Address or Code" field in the desktop 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. - Enter a name for this connection in the desktop client's "Connection Name" field.
- Click NEXT in the desktop client.
- Copy the User Name field value from the Connect with Credentials dialog into the "Username" field in the desktop client.
- Copy the Password field value from the Connect with Credentials dialog into the "Password" field in the desktop client. (To view the Password value as plaintext, click on the 'eye' symbol in the field.)
- Click LOGIN in the desktop client. This will launch your Desktop instance as a standalone application.
See the Connect to a Desktop (with credentials) section in the Desktops User Guide for more details.
• Connect with AWS web clnt
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' type Desktops is through the Amazon Workspaces® Web Client with manually entered credentials.
(Note, this is ONLY available for Desktops of type 'Workspaces'.)
- Locate the entry for the Desktop (of type Workspace) to which you want to connect in the Tehama Web UI.
- Select the "Connect with Web Client" menu item in the Actions menu for the entry. The Amazon WorkSpaces® Web Access interface will appear in a new browser tab.
- 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. - Copy the host address/registration code and paste it into the Amazon WorkSpaces® Web Access interface as indicated.
- Click Register.
- Copy the User Name and Password and paste them into the Amazon WorkSpaces® Web Access interface as indicated.
- Click Sign In. (If you are prompted with a Remember Me option, click No.) Your Windows Desktop session will begin.
See the Connect to an Workspace with Web Client section in the Desktops User Guide for more details.
⁍ (Addendum) Additional Admin
This section details additional administrative functions that are performed only as needed, and are not necessary to begin using Tehama.
They are included here in this getting started guide since they are commonly performed tasks.
• Resend org invite
Only the Admin user and Org/Room Managers of an organization can resend an invite email.
In the event the original email invitation link has expired, a new invite may be generated and sent. Follow these steps to resend an invite:
- Log in to the Tehama Web UI.
- Click on the MEMBERS tab.
- Click name of the invited, but still pending, member you wish to resend an invite to.
- In the resulting screen, Click the blue RESEND INVITE button.
- If there is a need to send the link manually, you can use the invitation link presented.
See the 'Resend member invite' section in the Organization User Guide for more details.
• Delete org members
Only the Admin user and Org/Room Managers of an organization can delete a member of the organization.
Note: If the organization has enabled Single Sign On (SSO) and SCIM user provisioning as its authentication method, delete or un-assign members from Tehama in the identity provider used. (See Single Sign On (SSO) and SSO User Provisioning in the Authentication User Guide for more information.)
Should you need to delete existing members, follow these steps:
- Log in to the Tehama Web UI.
- Click on the MEMBERS tab.
- Option 1 (allows for bulk deletions):
- (a) Select the member you wish to delete by clicking in the checkbox to the left of the member's name. Select multiple members for bulk deletions.
- (b) At the bottom of the page, click the Trash Can icon. You will see the DELETE MEMBER(S)) dialog.
- (c) Confirm that you want to continue with the deletion and click DELETE.
- (a) Select the member you wish to delete by clicking in the checkbox to the left of the member's name. Select multiple members for bulk deletions.
- Option 2:
- (a) In the row for the member you wish to delete, click on the three vertical dots menu under the Actions column.
- (b) Select the Delete Member item. You will see the DELETE MEMBER(S)) dialog.
- (c) Confirm that you want to continue with the deletion and click DELETE.
- (a) In the row for the member you wish to delete, click on the three vertical dots menu under the Actions column.
- Option 1 (allows for bulk deletions):
See the Delete a member section in the Organization User Guide for more details.
• Edit a Desktop
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.
The Admin users and Org Managers and Room Managers (who are members of the Room) of a Room's non-owner organizations (user_only and connected_only) can only edit Desktop templates in the Room made by their organizations that have not already been approved (pending Desktop templates). Room members who are Staff members of their organizations can similarly only edit those pending Desktop requests that they themselves have made that have not yet been approved. (See the Edit a pending Desktop request section in the Desktops User Guide for more details.)
The Room's owner organization must handle this task.
If you need to modify the Virtual Desktop (Desktop Name or Member permissions only) follow these steps:
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room that contains the Desktop you wish to edit.
- In the resulting screen (the Room interface), click CONFIGURE.
- Click on the WINDOWS DESKTOPS or LINUX DESKTOPS sidebar item, depending on what type of Desktop template you wish to edit.
- A list of previously configured Desktops will appear.
- Locate the Desktop template you wish to edit.
- Click on the three vertical dots under the Actions column in the entry you wish to edit, then select 'Edit'. In the resulting dialog:
- (a) Modify the name of the Desktop.
- (b) Modify the authorized users (and sudo users for Linux Desktops) by clicking in the drop-down list for the field.
- (c) Add or remove members as necessary.
- (d) Click SAVE.
See the Edit a Desktop section in the Desktops User Guide for more details.
• Delete a Desktop
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.
The Admin users and Org Managers and Room Managers (who are members of the Room) of a Room's non-owner organizations (user-only and connected-only) can only delete Desktop templates in the Room made by their organizations that have not already been approved (pending Desktop templates). Room members who are Staff members of their organizations can similarly only delete those pending Desktops requests that they themselves have made that have not yet been approved. (See the Delete a pending Desktop request section in the Desktops User Guide for more details.)
If you need to delete a Desktop template completely, follow these steps:
- Log in to the Tehama Web UI.
- Click on the ROOMS tab.
- Click the name of the Room that contains the Desktop template you wish to delete.
- In the resulting screen (the Room interface), click CONFIGURE.
- Click on the WINDOWS DESKTOPS or LINUX DESKTOPS sidebar item, depending on what type of Desktop template you wish to delete.
- A list of previously configured Desktops templates will appear.
- Locate the Desktop template you wish to delete.
- 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 appear1.
- Type the name of the Virtual Desktop to confirm deletion (case sensitive).
- Click DELETE.
- If the Desktop template you intend to delete is in a pending state, you will see the REJECT TEMPLATE dialog. Enter a reason to reject the pending Desktop template and click REJECT. ↩
See the Delete a Desktop section in the Desktops User Guide for more details.