Managing entity filters

Entity filters are used to restrict an analysis or model to a subset of all available entities, which can be manually selected or automatically evaluated at runtime based on the provided search string.

Entity filters can be useful when you wish to analyze data coming from different domains, as they allow you to select systems and business drivers located in any domain. For ease of use, when creating a new entity filter you can always choose to restrict the search to the current domain.

For more information, see:

Related topics

The following video (3:55) illustrates how to create a static entity filter (based on tree) and dynamic entity filter (based on search criteria) in the workspace. You can use the entity filters in the analyses and models that you create.

  https://youtu.be/USuNmbMncr0

To create an entity filter

To add a global entity filter, perform the following task:

  1. Navigate to Workspace > All domains > Filters and click Add > Add entity filter.
  2. In the Add a new entity filter page, enter the following information:

    PropertyDescription

    Name

    Name of the filter
    Description

    Brief description of the filter

    TypeSelect one of the following options:
    • Based on tree: Manually select domains and entities to which the analysis or model will be restricted to. (See Tree-based entity filters)
    • Based on search: Specify a search query that will be automatically evaluated at execution time for dynamic selection of target entities. (See Search-based entity filters)
    ScopeSelect one of the following options:
    • Only selected domains: Create an entity filter on the selected domain.
    • Selected domains and their subdomains: Create an entity filter on the selected domain and all its subdomains.
    Entities

    Select entities from from Selectable entities and click >> to add them to Selected entities.

    Resource Monitor rule filter

    Specify whether you want to filter entities based on their severity status values.

    You can select entities as per any one of the following criteria:

    • All entities with specific status values that are generated based on the metric thresholds. To do so, select Include only entities in severity status and select at least one of the severity status options, such as OK, Warning, Critical. 
      For example: You can use this criteria in an entity filter that is used to create analyses and reports for ALL systems that match the selected severity status values.
    • Entities with specific status values that are generated by a specific Resource Monitor rule. To do so:
      1. Select Include only entities in severity status and select at least one of the severity status options, such as OK, Warning, Critical. 
      2. Select Only alerts generated by Resource Monitor rule and select the <Resource Monitor rule> from the list. For example, alerts generated by VMware Clusters, Datastores, or Hosts.
        For example: You can use this criteria in an entity filter that is used to create analyses and reports for Hyper-V virtual machines for which alerts are generated by the Hyper-V Virtualization – Virtual Machines rule.
    • Entities with specific status values that are generated by a specific Recommendation type. To do so:
      1. Select Include only entities in severity status and select at least one of the severity status options, such as OK, Warning, Critical. 
      2. Select Only alerts generated by Resource Monitor rule type and select the <Resource Monitor rule> from the list. For example, alerts generated by VMware Clusters, Datastores, or Hosts.  
        For example: You can use this criteria in an entity filter that is used to create analyses and reports for AWS virtual machines for which recommendations are generated by the AWS Virtual Machines recommendation type.
  3. Click Save.

Tree-based entity filters

  • Scope: Choose if you wish to limit the filter to the selected domains or also extend it to the contained subdomains.
  • Entities: Drag and drop the desired domains and entities to the Selected entities box; for navigation purposes, at the bottom of the selection box you can specify if you wish to limit the browser to the current domain or display the entire domain tree.
  • Access rights (only appears if you drag a domain to the Selected entities list):
    • Use current user access rights: Run the search with the current user's access rights; for your convenience, the current username is displayed.
    • Use access groups: Run the search with the access rights specified by the selected group(s)
    • (admin only) Use access rights of user: Run the search with the access rights of the selected user; this option is only available to administrators.

Search-based entity filters

  • Search string: Type the search string to be used to select target entities at runtime; for more information, see Searching for entities and metrics.
  • Scope: Choose if you wish to limit the filter to:
    • Only current domain; choosing this option, the search will only return entities contained in the domain where the entity filter is located.
    • Current domain and its subdomains.
    • Only container domain; choosing this option, the search will only return entities contained in the domain where the analysis or model using the entity filter is located.
    • Container domain and its subdomains.
    • All domains
  • Access rights:
    • Use current user access rights: Run the search with the current user's access rights; for your convenience, the current username is displayed.
    • Use access groups: Run the search with the access rights specified by the selected group(s).
    • (admin only) Use access rights of user: Run the search with the access rights of the selected user; this option is only available to administrators.

When done, click Save to create the filter.

Adding a new entity filter (based on search)

Note

When specifying the access rights for the search, keep in mind that the entity filter (and thus the search results) will be visible to all users who are allowed to see the domain. Ensure that the search does not expose confidential content to unauthorized users.

Creating an entity filter from a search

TrueSight Capacity Optimization allows you to create an entity filter starting from a search performed using the Search box, as described in Searching for entities and metrics.

Creating a new entity filter from search results

To create an entity filter based on this search, click the Save as new entity filter button at the bottom of the search results page and fill in the form that appears, specifying the following options:

  • Name: Name of the new entity filter.
  • Description: Brief description of the filter.
  • Domain: Choose the domain to which the search should be restricted from the drop-down list (by default, All Domains).
  • Save as: Choose how to save the entity filter (static or dynamic).
    • All systems and business drivers contained in the current search results: The entity filter will be static, that is the search results will not be automatically re-evaluated and the current search results will be used.
    • Search string: The entity filter will be dynamic, that is the search results will be automatically re-evaluated at every execution of the analysis.
  • Access rights: Set the access rights for the search (only if you are saving the entity filter as Search string).
    • Use current user access rights
    • Use access groups

Setting the entity filter's options

When done, click Save; you will be taken to the new entity filter's detail page, where the previous search results will be displayed in the Results table, as shown in the following figure.

Search results are displayed in the detail page of the new filter

To edit an entity filter

To edit a filter, click Edit  at the end of the row corresponding to the entity filter you wish to modify in the Filters page, or click Edit found in the filter's detail page.

The edit form is identical to the add form; make all the changes you need, then click Save to confirm.

Additional information

If the filter is in use, a warning may appear informing you that any changes will affect analyses, models, and reports that use it.

To delete an entity filter

Note

Before deleting an entity filter you must check that it is not used by any analysis or model.

You can delete a filter in two ways:

  1. Access the Filters page and then click Delete  at the end of the row of the entity filter you wish to remove.
  2. Access the filter's detail page and then click Delete.

To copy or move an entity filter

You can copy or move an entity filter to another domain clicking the Copy or Move on the filter's detail page; you will be prompted to specify the destination domain, as shown in the figure below:

Moving an entity filter to a different domain

Was this page helpful? Yes No Submitting... Thank you

Comments