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

Monitor and manage machines and sessions using Search

November 15, 2024
Contributed by: 
C C

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.

This article guides you through how to monitor and manage machines and sessions using the Search node in Web Studio.

Learn about the node

The Search node provides a central place for monitoring and managing machines and user sessions.

Components in the Search node

Callout Area Description
A Search bar Provides a quick search and a filter-based search that allows you to define complex search criteria. For more information, see Search for instances.
B Type tabs Displays tabs to list machines by type or list all sessions. Instance counts appear in the tab names.
C Instance-level actions Displays actions that you can perform on the selected instances (machines or sessions). For more information, see Machine actions and Session actions.
D



List-level actions



Displays actions that you can perform on the current list:
  • Export icon: Export the list of instances displayed in the main view to a CSV file.
  • Column to display icon: Customize the main view for the list.
  • Errors label: Enable this label to display only unregistered machines with errors in the main view. To view issue details, go to the Troubleshoot tab in the Details pane.
  • Warning label: Enable this label to display only unregistered machines with warnings in the main view. To view issue details, go to the Troubleshoot tab in the Details pane.
    		•
    E Main view Displays the instances and their properties. You can customize the main view by selecting the Column to display icon. For more information about available columns, see Machine columns and Session columns.
    F


    		Details pane


    		Displays the following details:
  • Details of the selected instance (machine or session)
  • Tags applied to the selected machine
  • Details of errors or warnings with the selected machine, including problems, possible causes, and suggested solutions
    		•

    Search for instances

    Use the search function to locate specific machines and sessions:

    Search using filters

    For example, to locate all single-session OS machines that are static and assigned to users, follow these steps:

    1. On the Single-session OS machines tab, click the Filters icon. The Filters panel appears.

    2. Add the necessary filter criteria.

      Search with filter

    3. Select Match all (AND operator) if you want the search to return results that match all filter criteria. Select Match any (OR operator) if you want the search to return results that match any of the filter criteria.

    4. Click Apply.

      The filtered list displays all single-session OS machines that are static and assigned to users. Search filter result

    For example, to save the filter set for single-session OS machines that are static and assigned to users for future use, follow these steps:

    1. After you conduct a filter-based search, click the Star icon in the search bar, as shown in the preceding figure.
    2. On the page that appears, enter a name for this filter set (for example, Static & assigned machines).

    3. Click Save.

      The saved filter set appears in the search history list when you click the search box.

      Search filter set

    Note:

    Filter sets are saved on a per user account basis. To manage saved filter sets, select Manage.

    Pin frequently used filter fields in the search bar for easy access. For example, after conducting a filter-based search, you want to pin Allocate Type in the search bar. Follow these steps:

    1. Click the filter setting in the search bar.

    2. In the panel that appears, click the Pin icon to pin the filter field (Allocation Type for this example) in the search bar. Search filter pin

    The quick search box provides a convenient way to search for instances based on name-related properties or saved filter sets. Detailed steps are as follows:

    1. Click the search box. Your recent searches and saved filter sets appear in the drop-down list. You can click a previous search or filter set for a quick search.

    2. To start a new search, enter a complete or partial name from the following options:

      • Machine name or DNS name
      • Machine catalog name
      • Delivery group name
      • Session user name
      • Session client name
      • Friendly name of the VM hosting the session, as used by its hypervisor
      • Hosting server name

    Consider the following tips when using the Search feature:

    • On the Search node, select any column to sort items.

    • To show more characteristics to include in the display where you can search and sort, select Columns to Display or click any column and select Columns to Display. In the Columns to Display window, select the checkbox next to the items you want to display and select Save to exit.

      Note:

      Columns that degrade performance are marked with the Degrades performance label.

    • To locate a user device connected to a machine, use Client (IP) and Is, and enter the device IP address.

    • To locate active sessions, use Session State, Is, and Connected.

    • To list all machines in a delivery group, select Delivery Groups in the left pane. Select the group, and then select View Machines from the action bar or the context menu.

    Keep the following considerations in mind when performing sorting operations:

    • As long as the number of items does not exceed 5,000, you can click any column to sort the items in it. When the number exceeds 5,000, you can sort only by name or by current user (depending on which tab you are on). To enable sorting, use filters to reduce the number of items to 5,000 or fewer.

    • When the number of items is greater than 500 but no more than 5,000:

      • We cache all data locally to improve sort performance. On the Single-session OS Machines and Multi-session OS Machines tabs, we cache the data the first time you click a column (any column except the Name column) to sort. On the Sessions tab, we cache the data the first time you click a column (any column except the Current User column) to sort. As a result, the sort takes longer to complete. For faster performance, sort by name or current user, or use filters to reduce the number of items.
      • The following message under the table indicates that the data is cached: Last refreshed: <the time when you refreshed the table>. In that case, sort operations are based on items that were loaded previously. Those items might not be up to date. To bring them up to date, click the refresh icon.

    Customize columns to display

    Create a personalized main view to display the properties and statuses crucial for your daily operations. Detailed steps are as follows:

    1. In the Search node, select the Multi-session OS Machines, Single-session OS Machines, or Sessions tab as necessary.

    2. Click the Columns to display icon in the action bar and select the columns.

      For more information about the available columns and their descriptions, see Machine columns and Session columns.

    When choosing columns, you can see columns marked with the Degrades performance label. Selecting those columns might degrade the performance of the console. Keep these considerations in mind:

    • After you complete your customization, the table refreshes to display the columns you select. Their presence might result in delays when you refresh the table.

    • After you refresh the browser or sign out of the console and then sign in, a message appears asking whether to preserve those columns. If you choose to preserve them, you’re restricted to refreshing the table more than once a minute for optimal console performance. For more frequent refreshes, remove any columns that degrade performance.

    Manage machines and sessions

    Use actions in the Search node to troubleshoot machines and session issues or process user requests.

    Good to know

    You can manage machines at different levels:

    • At the individual machine level. Use the Search node to locate target machines and perform actions.

    • At the machine catalog level, such as changing master images for a catalog, deleting machines from a catalog, and adding machines to a catalog. For more information, see Manage machine catalogs.

    • At the delivery group level, such as turning on or off maintenance mode for machines in a group. For more information, see Manage delivery groups.

    In addition to the individual session level, You can also manage sessions at the delivery group level, such as configuring session prelaunch and linger for a delivery group. For more information, see Manage Delivery Groups.

    Perform actions on machines or sessions

    To manage machines or sessions at the individual instance level, follow these steps:

    1. In the Search node, select the Multi-session OS Machines, Single-session OS Machines, or Sessions tab.
    2. Select one or more instances as necessary.

    3. From the action bar or right-click menu, select an action based on the issues that you encounter with those instances or user requests.

      For more information about the available actions and their descriptions, see Machine actions and Session actions.

    Note:

    If you select two or more instances, only actions that apply to all of them are available.

    Export machine or session data to CSV files

    Export the list of instances (machines or sessions) displayed on a tab (up to 30,000 items) to a CSV file. Detailed steps are as follows:

    1. In the Search node, select the Multi-session OS Machines, Single-session OS Machines, or Sessions tab as necessary.

    2. Click the Export icon in the upper right corner.

    3. In the dialog box that appears, click Continue.

      The export might take several minutes to complete. You can find the file in the default download folder of your browser.

    Note:

    On each tab of the Search node, you cannot perform another export while an export is in progress.

    Monitor and manage machines and sessions using Search
    November 15, 2024
    Contributed by: 
    C C
    November 15, 2024
    Contributed by: 
    C C

    In this article

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