Product documentation
Citrix Virtual Apps and Desktops
Service Current Release 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
View PDF

Create and manage connections and resources

March 8, 2024
Contributed by: 
C C

Important:

As of Citrix Virtual Apps and Desktops 7 2006, if your current deployment uses any of the following technologies, you can upgrade your deployment to the current release only after removing End of Life (EOL) items that use those technologies.

  • Personal vDisks (PvDs)
  • AppDisks
  • Public cloud host types: Citrix CloudPlatform, Microsoft Azure Classic

For details, see Remove PVD, AppDisks, and unsupported hosts.

Note:

You can manage your Citrix Virtual Apps and Desktops deployment using two management consoles: Web Studio (web-based) and Citrix Studio (Windows-based). This article covers only Web Studio. For information about Citrix Studio, see the equivalent article in Citrix Virtual Apps and Desktops 7 2212 or earlier.

If you want to use public cloud host connections to your deployment, you need Hybrid Rights License to complete your fresh installation or upgrade to the current release.

When the installer detects one or more of the unsupported technologies or host connections without Hybrid Rights License, the upgrade pauses or stops, and an explanatory message appears. The installer logs contain details. For more information, see Upgrade a deployment.

Effect of Hybrid Rights License on host connection

There are three scenarios where the host connection to the public cloud hosts is affected based on Hybrid Rights License entitlement:

  • To create a new host connection to the public cloud hosts, you must have Hybrid Rights License.

  • If you have Hybrid Rights License but the license has expired, then the existing connections to public cloud hosts are marked as not entitled and enter into maintenance mode. When existing host connections are in maintenance mode, you cannot do the following:

    • Add or modify host connections
    • Create catalog and update image
    • Perform power actions

  • When not entitled host connections change to entitled, existing hosting connections are re-enabled.

Introduction

You can optionally create your first connection to hosting resources when you create a Site. Later, you can change that connection and create other connections. Configuring a connection includes selecting the connection type from among the supported hypervisors and the storage and network that you select from the resources for that connection.

Read Only Administrators can view connection and resource details. You must be a Full Administrator to perform connection and resource management tasks. For details, see Delegated administration.

Where to find information about connection types

You can use the supported virtualization platforms to host and manage machines in your Citrix Virtual Apps or Citrix Virtual Desktops environment. The System requirements article lists the supported types.

For details, see the following information sources:

  • XenServer (formerly Citrix Hypervisor):

  • Nutanix Acropolis:

  • VMware:

  • Microsoft Hyper-V:

  • Public Cloud host connections (AWS, Google Cloud, Microsoft Azure, Nutanix cloud and partner solutions, and VMware cloud and partner solutions): For information related to public cloud hosts, see Set up resource type.

    Note:

    The information sources direct you to the Citrix DaaS documentation. If you are familiar with the public cloud hosts in the Citrix DaaS product, the on-premises version has several differences. In on-premises Virtual Apps and Desktops, the management interface is known as Web Studio. Updates are rolled out to the service approximately every four weeks. So, you might find that certain features available with the service are not available with the on-premises version.

Host storage

A storage product is supported when managed by a supported hypervisor. Citrix Support assists those storage product vendors in troubleshooting and resolving issues, and documents those issues in the knowledge center, as needed.

When provisioning machines, data is classified by type:

  • Operating system (OS) data, which includes master images.
  • Temporary data. This data includes all non-persistent data written to MCS-provisioned machines, Windows page files, user profile data, and any data that is synchronized with ShareFile. This data is discarded each time a machine restarts.

Providing separate storage for each data type can reduce load and improve performance on each storage device, making best use of the host’s available resources. It also enables appropriate storage to be used for the different data types – persistence and resilience is more important for some data than others.

Storage can be shared (located centrally, separate from any host, used by all hosts) or local to a hypervisor. For example, central shared storage can be one or more Windows Server 2012 clustered storage volumes (with or without attached storage), or an appliance from a storage vendor. The central storage might also provide its own optimizations such as hypervisor storage control paths and direct access through partner plug-ins.

Storing temporary data locally avoids having to traverse the network to access shared storage. It also reduces load on the shared storage device. Shared storage can be more costly, so storing data locally can lower expenses. These benefits must be weighed against the availability of sufficient storage on the hypervisor servers.

When you create a connection, you choose one of two storage management methods: storage shared by hypervisors, or storage local to the hypervisor.

When using local storage on one or more XenServer hosts for temporary data storage, make sure that each storage location in the pool has a unique name. (To change a name in XenCenter, right-click the storage and edit the name property.)

Storage shared by hypervisors

The storage shared by hypervisors method stores data that needs longer-term persistence centrally, providing centralized backup and management. That storage holds the OS disks.

When you select this method, you can choose whether to use local storage (on servers in the same hypervisor pool) for temporary machine data. This method does not require persistence or as much resilience as the data in the shared storage, referred to as the temporary data cache. The local disk helps reduce traffic to the main OS storage. This disk is cleared after every machine restart. The disk is accessed through a write-through memory cache. If you use local storage for temporary data, the provisioned VDA is tied to a specific hypervisor host. If that host fails, the VM cannot start.

Exception: Microsoft System Center Virtual Machine Manager does not allow temporary data cache disks on local storage when using Clustered Storage Volumes (CSV).

Create a connection to store temporary data locally and then enable and configure nondefault values for each VM’s cache disk size and memory size. The default values are tailored to the connection type, and are sufficient for most cases. For details, see Create machine catalogs.

The hypervisor can also provide optimization technologies through read caching of the disk images locally. For example, XenServer offers IntelliCache, which reduces network traffic to the central storage.

Storage local to the hypervisor

The storage local to the hypervisor method stores data locally on the hypervisor. With this method, master images and other OS data are transferred to the hypervisors in the Site. This process occurs for initial machine creation and future image updates. This process results in significant traffic on the management network. Image transfers are also time-consuming, and the images become available to each host at a different time.

Create a connection and resources

You can optionally create the first connection when you create the Site. The Site creation wizard contains the connection-related pages described in the following sections.

If you are creating a connection after you create the Site, start with step 1.

Important:

The host resources (storage and network) must be available before you create a connection.

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select Add Connections and Resources in the action bar.
  4. The wizard guides you through the following pages (specific page content depends on the selected connection type). After completing each page, click Next until you reach the Summary page.

Connection

Connection page in the Create Connection wizard

On the Connection page:

  • To create a connection, select Create a new Connection. To create a connection based on the same host configuration as an existing connection, select Use an existing Connection and then choose the relevant connection.
  • Select the hypervisor you are using in the Connection type field. Public cloud host connections are listed in the drop-down list only if you use Hybrid Rights License. Alternatively, you can use the PowerShell command Get-HypHypervisorPlugin [-ZoneUid] $rluid [-IncludeUnavailable] false/true to get the following:
    • List of all Citrix supported hypervisor plugins, including third party plugins.
    • Availability of hypervisor plugin. If the availability status is false, possible reason could be that the hypervisor plug-in is not installed correctly or you are not entitled with Hybrid Rights License.
  • The connection address and credentials fields differ, depending on the selected connection type. Enter the requested information.
  • Enter a connection name. This name appears in Web Studio.
  • Choose the tool you use to create virtual machines: Web Studio tools (such as Machine Creation Services or Citrix Provisioning) or other tools.

Storage management

Storage management

For information about storage management types and methods, see Host storage.

If you are configuring a connection to a Hyper-V or VMware host, browse to and then select a cluster name. Other connection types do not request a cluster name.

Select a storage management method: storage shared by hypervisors or storage local to the hypervisor.

  • If you choose storage shared by hypervisors, indicate if you want to keep temporary data on available local storage. (You can specify nondefault temporary storage sizes in the machine catalogs that use this connection.) Exception: When using Clustered Storage Volumes (CSV), Microsoft System Center Virtual Machine Manager does not allow temporary data cache disks on local storage. Configuring that storage management setup in Web Studio fails.

If you use shared storage in a XenServer pool, indicate if you want to use IntelliCache to reduce the load on the shared storage device. See Use IntelliCache for XenServer connections.

Storage selection

Storage selection page in the Create Connection wizard

For more information about storage selection, see Host storage.

Select at least one host storage device for each available data type. The storage management method you selected on the previous page affects which data types are available for selection on this page. Select at least one storage device for each supported data type before you can proceed to the next page in the wizard.

The lower portion of the Storage Selection page contains more configuration options if you chose storage shared by hypervisors and enabled Optimize temporary data on available local storage on the previous page. You can select which local storage devices to use for temporary data.

The number of currently selected storage devices is shown (in the preceding graphic, “1 storage device selected”). When you hover over that entry, the selected device names appear.

  1. Click Select to change the storage devices to use.
  2. In the Select Storage dialog box, select or clear the storage device check boxes, and then click OK.

Network

On the Network page, enter a name for the resources. This name appears in Web Studio to identify the storage and network combination associated with the connection.

Select one or more networks that the VMs use.

Summary

On the Summary page, review your selections. When you’re done, click Finish.

Remember: Storing temporary data locally allows you to configure nondefault values for temporary data storage when you create the Machine Catalog containing machines using this connection. See Create Machine Catalogs.

Edit connection settings

Do not use this procedure to rename a connection or to create a connection. Those connections are different operations. Change the address only if the current host machine has a new address. Entering an address to a different machine breaks the connection’s Machine Catalogs.

You cannot change the GPU settings for a connection, because Machine Catalogs accessing this resource must use an appropriate GPU-specific master image. Create a connection.

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select the connection and then select Edit Connection in the action bar.
  4. Follow the guidance for the settings available when you edit a connection.
  5. When you are finished, click Apply to apply any changes you made and keep the window open, or click Save to apply changes and close the window.

Connection Properties page:

  • To change the connection address and credentials, select Edit settings… and then enter the new information.

  • To specify the high-availability servers for a XenServer connection, select Edit servers… and select the servers. Citrix recommends that you select all servers in the pool to allow communication with XenServer if the pool master fails.

    Note:

    If you are using HTTPS and want to configure high-availability servers, do not install a wildcard certificate for all servers in a pool. An individual certificate for each server is required.

Advanced page:

  • For a Microsoft System Center Configuration Manager (ConfMgr) Wake on LAN connection type, which is used with Remote PC Access, enter ConfMgr Wake Proxy, magic packets, and packet transmission information.

  • The throttling threshold settings enable you to specify a maximum number of power actions allowed on a connection. These settings can help when power management settings allow too many or too few machines to start at the same time. Each connection type has specific default values that are appropriate for most cases and must not be changed.

  • The Simultaneous actions (all types) setting specifies two values: a maximum absolute number that can occur simultaneously on this connection, and a maximum percentage of all machines that use this connection. You must specify both absolute and percentage values. The actual limit applied is the lower of the values.

    For example, in a deployment with 34 machines, if Simultaneous actions (all types) is set to an absolute value of 10 and a percentage value of 10, the actual limit applied is 3 (that is, 10 percent of 34 rounded to the nearest whole number, which is less than the absolute value of 10 machines).

  • The Maximum new actions per minute is an absolute number. There is no percentage value.

  • Enter information in the Connection options field only under the guidance of a Citrix Support representative or explicit documentation instructions.

Shared Tenants page:

Add tenants and subscriptions that share the Azure Compute Gallery with the subscription of this connection. As a result, when creating or updating catalogs, you can select shared images from those tenants and subscriptions.

  • Enter the Application ID and Application secret for the application associated with this connection. With this information, you can authenticate to Azure. We recommend that you change keys regularly to ensure security.
  • Specify shared tenants and subscriptions. You can add up to eight shared tenants. For each tenant, you can add up to eight subscriptions.
  • Click Save and Apply when you’re done.

Enter information in the Connection options field only under the guidance of a Citrix Support representative.

Edit networks

You can change networks for a connection. Do the following:

  1. Go to Hosting.
  2. Select the target resources under the connection and then select Edit Network in the action bar.
  3. Select one or more networks for the virtual machines to use.
  4. Click Save to save your changes and to exit.

Turn maintenance mode on or off for a connection

Turning on maintenance mode for a connection prevents any new power action from affecting any machine stored on the connection. Users cannot connect to a machine when it is in maintenance mode. If users are already connected, maintenance mode takes effect when they log off.

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select the connection. To turn maintenance mode on, select Turn On Maintenance Mode in the action bar. To turn maintenance mode off, select Turn Off Maintenance Mode.

You can also turn maintenance mode on or off for individual machines. Also, you can turn maintenance mode on or off for machines in Machine Catalogs or Delivery Groups.

Delete a connection

Deleting a connection can result in the deletion of large numbers of machines and loss of data. Ensure that user data on affected machines is backed up or no longer required.

Before deleting a connection, ensure that:

  • All users are logged off from the machines stored on the connection.
  • No disconnected user sessions are running.
  • Maintenance mode is turned on for pooled and dedicated machines.
  • All machines in Machine Catalogs used by the connection are powered off.

A Machine Catalog becomes unusable when you delete a connection that is referenced by that catalog. If this connection is referenced by a catalog, you have the option to delete the catalog. Before you delete a catalog, make sure it is not used by other connections.

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select the connection and then select Delete Connection in the action bar.
  4. If this connection has machines stored on it, you are asked whether the machines should be deleted. If they are to be deleted, specify what should be done with the associated Active Directory computer accounts.

Rename or test a connection

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select the connection and then select Rename Connection or Test Connection in the action bar.

View machine details on a connection

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select the connection and then select View Machines in the action bar.

The upper pane lists the machines accessed through the connection. Select a machine to view its details in the lower pane. Session details are also provided for open sessions.

Use the search feature to find machines quickly. Either select a saved search from the list at the top of the window, or create a search. You can either search by typing all or part of the machine name, or you can build an expression to use for an advanced search. To build an expression, click Unfold, and then select from the lists of properties and operators.

Manage machines on a connection

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select a connection and then select View Machines in the Action pane.
  4. Select one of the following in the action bar. Some actions are not available, depending on the machine state and the connection host type.
Action Description
Start Starts the machine if it is powered off or suspended.
Suspend Pauses the machine without shutting it down, and refreshes the list of machines.
Shut down Requests the operating system to shut down.
Force shut down Forcibly powers off the machine, and refreshes the list of machines.
Restart Requests the operating system to shut down and then start the machine again. If the operating system cannot comply, the desktop remains in its current state.
Enable maintenance mode Temporarily stops connections to a machine. Users cannot connect to a machine in this state. If users are connected, maintenance mode takes effect when they log off. (You can also turn maintenance mode on or off for all machines accessed through a connection, as described above.)
Remove from Delivery Group Removing a machine from a Delivery Group does not delete it from the Machine Catalog that the Delivery Group uses. You can remove a machine only when no user is connected to it. Turn on maintenance mode to temporarily prevent users from connecting while you are removing the machine.
Delete When you delete a machine, users no longer have access to it, and the machine is deleted from the Machine Catalog. Before deleting a machine, ensure that all user data is backed up or no longer required. You can delete a machine only when no user is connected to it. Turn on maintenance mode to temporarily stop users from connecting while you are deleting the machine.

For actions that involve machine shutdown, if the machine does not shut down within 10 minutes, it is powered off. If Windows attempts to install updates during shutdown, there is a risk that the machine is powered off before the updates are complete.

Edit storage

You can display the status of servers that are used to store operating system and temporary data for VMs that use a connection. You can also specify which servers to use for storage of each data type.

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select the connection and then select Edit Storage in the action bar.
  4. In the left pane, select the data type: operating system, or temporary.
  5. Select or clear the check boxes for one or more storage devices for the selected data type.
  6. Click OK.

Each storage device in the list includes its name and storage status. Valid storage status values are:

  • In use: The storage is being used for creating machines.
  • Superseded: The storage is being used only for existing machines. No new machines are added in this storage.
  • Not in use: The storage is not being used for creating machines.

If you clear the check box for a device that is currently In use, its status changes to Superseded. Existing machines will continue to use that storage device (and can write data to it), so it is possible for that location to become full even after it stops being used for creating machines.

Delete, rename, or test resources

  1. Sign in to Web Studio.
  2. Select Hosting in the left pane.
  3. Select the resource and then select the appropriate entry in the action bar: Delete Resources, Rename Resources, or Test Resources.

Detect Orphaned Azure resources

Orphaned resources are unused resources present in the system and they can lead to unnecessary expenses.

This feature allows you to detect the orphaned Azure resources in the hosts on your Citrix Virtual Apps and Desktops site.

Follow the steps on Web Studio:

  1. From Manage, select Hosting in the left pane.
  2. Select a connection, and then select Detect Orphaned Resources in the action bar. The Detect Orphaned Resources dialog box displays the orphaned resource report.
  3. To view the orphaned resource report, select View Report.

Alternatively, you can detect orphaned Azure resources using PowerShell. For more information, see Retrieve a list of orphaned resources.

To understand the reasons behind the orphaned resources, and to learn how to proceed further, see Efficiently manage Orphaned Azure resources with Citrix.

Connection timers

You can use policy settings to configure three connection timers:

  • Maximum connection timer: Determines the maximum duration of an uninterrupted connection between a user device and a virtual desktop. Use the Session connection timer and Session connection timer interval policy settings.
  • Connection idle timer: Determines how long an uninterrupted user device connection to a virtual desktop is maintained if there is no input from the user. Use the Session idle timer and Session idle timer interval policy settings.
  • Disconnect timer: Determines how long a disconnected, locked virtual desktop can remain locked before the session is logged off. Use the Disconnected session timer and Disconnected session timer interval policy settings.

When you update any of these settings, ensure they are consistent across your deployment.

See the policy settings documentation for more information.

Retrieve a list of orphaned resources

You can get a list of orphaned resources that are created by MCS but are no longer tracked by MCS. This is currently applicable to Azure environments. To get the list, you can use PowerShell commands. You can filter using connections.

Note:

  • The PowerShell command is rejected if any provisioning or image update is in progress.
  • A customer-managed resource tagged with all Citrix tags is detected as an orphaned resource. However, if you add another tag CitrixDetectIgnore with value as true to that resource, then the resource is ignored while detecting orphaned resources.

Limitations

  • Only a built-in full admin or cloud admin role admin user can run the PowerShell command and get the list of orphaned resources.
  • To avoid incorrect recognition of orphaned resources, do not power on VMs while you are filtering orphaned resources.
  • Around 2,000 records are displayed as orphaned in case of possible heavy workload.

To display the list of orphaned resources:

  1. Open a PowerShell window.

  2. Run the following commands:

    1. Get the connection uid. The connection uid is the value of the HypervisorConnectionUid attribute.

      Get-ChildItem xdhyp:\connections | where { $_.PluginId -like 'Azure*' }"
<!--NeedCopy-->

    2. Get the list of orphaned resources.

      get-provorphanedresource -HypervisorConnectionUid <connection uid>
<!--NeedCopy-->

To display the list of orphaned resources from an subscription id:

  1. Open a PowerShell window.

  2. Run the following commands:

    1. Find the connection uid using the subscription ID. The connection uid is the value of the HypervisorConnectionUid attribute.

      Get-ChildItem xdhyp:\connections | where { $_.CustomProperties -match '<subscriptionId>' }
<!--NeedCopy-->

    2. Get the list of orphaned resources:

      get-provorphanedresource -HypervisorConnectionUid <connection uid>
<!--NeedCopy-->

Note:

Check the resources carefully before deleting.

Where to go next

For information on connection to specific host types, see:

If you’re in the initial deployment process, create a machine catalog.

Create and manage connections and resources
March 8, 2024
Contributed by: 
C C
March 8, 2024
Contributed by: 
C C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.