Introduction

This document explains the difference between the Basic and Advanced modes of querying.

Using OpsQL, you can perform advanced search operations to fetch the results. These results help you analyze and make better decisions.

The Advanced Search feature allows you to:

  • Quickly and easily build queries.
  • Search for resources at the partner or the client level.

Follow these steps to navigate to the Advanced Search query box and build queries:

  1. Log in to OpsRamp.

  2. Navigate to Infrastructure > Search.

  3. From the Infrastructure Search screen, click the search (magnifying glass) icon next to the Home tab. The New View tab is displayed.

  4. Click +Query. The Search box displays the list of resource attributes.

Build a query using the basic query mode.

Basic Query Mode

  1. Select the attribute and the operator from the dynamically populated matching operator list.

  2. Type in (or select) a value from the VALUES dropdown. The values are populated based on the selected attribute and operator.

    The query result is displayed.

  3. Click + to add another expression.

  4. The AND logical operator is selected by default. Click and select the desired operator.

  5. Follow the steps mentioned above to form another expression – attribute, operator and value. The query result is displayed.

For more examples, click here.

Advanced Query Mode

Alternatively, use the Advanced Query Mode to start building more complex queries with nested expressions.

  1. Click </> to switch to the Advanced query mode.

  2. As soon as you start typing in the Search box, the available attributes are displayed automatically.
    You can search using a keyword / string and then click on search for " “. The keyword search will search for occurrence of that string across multiple fields. The result is displayed.

    Example:
    Enter a string, Linux and click on search for “Linux”. The search result is displayed. The string “Linux” may occur in one or more fields, like Name, description, OS.
    Click here to view the list of attributes.

  3. Select the attribute and the operator from the dynamically populated matching operator list and then type in (or select) a value.

  4. Select the logical operators, AND or OR

  5. Follow the steps mentioned above – select the attribute, operator, and value, to add another expression. You can add as many valid expressions as possible.

  6. Click the Search icon or press Enter. The query result is displayed.

Note:

  • Your most recent query is added to the Recent Queries list, which shows the query string used for the search.
  • To repeat a previous query, click the (magnifying glass) search icon to create a new tab, and then click the tile for that search string. The search results are displayed.

For more information on how to use OpsQL, click here

MY RESOURCES VIEWS

Save your query results as Views to easily preserve complex queries and their results, and update them whenever needed.

The MY RESOURCES VIEWS slide-out is a feature that provides quick and easy access to your saved query views. Instead of typing the same queries over and over, you can just open this slide-out and select a saved view to instantly run that query again. This allows you to save time by easily reusing your frequently accessed queries.

To access the MY RESOURCES VIEWS slide-out:

  1. Navigate to Infrastructure → Search. The Infrastructure search listing screen is displayed.

    Infrastructure search listing screen
  2. Click on the hamburger icon on the upper-left corner of the screen.
    The MY RESOURCES VIEWS slide-out is displayed.

    MY RESOURCES VIEWS slide-out

Managing Views

Create and manage (Add, Copy, Set as default, etc.) views from the Infrastructure search screen.

You can do the following actions after performing a search operation:

ActionSteps/Description
Save a ViewAfter executing a query, you have an option to save the current view.
To save the current view:
  1. Click SAVE VIEW option available at the upper-right corner of the screen.
    2. The VIEW OPTIONS dialog box is displayed.
  2. Select a collection from the dropdown.
  3. Enter a name for the view in the View Name box.
    The view will be saved under the collection.
  4. Click ADD.
    5. The view is saved, and a confirmation message appears.
To confirm the view is added to the collection:
  1. Click the hamburger menu icon available at the upper-left corner of the screen.
  2. From the MY RESOURCES VIEWS slide-out, click the collection name to access the view.
  3. Click the view name to see the details.
As an alternative, follow these steps to save the current view:
  1. Click the hamburger menu icon available at the upper-left corner of the screen.
  2. From the slide-out, click + icon and select Add Current View option. The ADD CURRENT VIEW dialog box is displayed.
  3. Select a collection from the dropdown.
  4. Enter a name for the view in the View Name box.
  5. Click ADD. The view is saved, and a confirmation message appears.
Save New ViewYou can modify an existing query and save the filter criteria and its results as a new view.
Follow these steps to do this:
  1. After modifying the existing query, click SAVE VIEW option available at the upper-right corner of the screen.
  2. From the VIEW OPTIONS popup, select Save New View. The ADD CURRENT VIEW dialog box is displayed.
  3. Select a collection from the dropdown.
  4. Enter a new name for the view in the View Name box.
    The view will be saved under the collection.
  5. Click ADD. The view is saved, and a confirmation message appears.
Update Saved ViewYou can modify an existing query and save the view.
Follow these steps to do this:
  1. After modifying the existing query, click SAVE VIEW option available at the upper-right corner of the screen.
  2. From the VIEW OPTIONS popup, select Update Saved View. The view is updated with the latest query and filter settings, and a confirmation message appears.
As an alternative, follow these steps to save:
  1. Click the hamburger menu icon available at the upper-left corner of the screen.
  2. Hover over the current view name and click the actions (three dots) menu. The View Options popup is displayed.
  3. Select Save.
Restore Saved ViewThis option reverts to the previously saved view.
Once you have made changes to a specific query, which is already saved as a view:
  1. Click SAVE VIEW option available at the upper-right corner of the screen.
  2. From the VIEW OPTIONS popup, select Restore Saved View. The view is restored to the previous state, and a confirmation message appears.
As an alternative, follow these steps to revert to the previous state: Once you have made changes to a specific query, which is already saved as a view:
  1. Click the hamburger menu icon available at the upper-left corner of the screen.
  2. From the MY RESOURCES VIEWS slide-out, hover over the view name and click the actions (three dots) menu. The View Options popup is displayed.
  3. Select Restore. The view is automatically reverted.
Note: Avoid saving any modifications to the query. Otherwise, the original query cannot be restored.
Copy LinkAfter executing a query, you have an option to copy the Direct link (URL) to the view.
To copy a Direct link (URL) to a view:
  1. Click the Ellipsis menu (three horizontal dots) at the right-top corner of the page.
  2. Select Copy Link. The link is copied.
Note: The link is valid for 14 days from the time it is generated.
Set FavoriteTo mark a view as favorite:
  1. Hover over the view name on the slide-out.
  2. Click the star icon. The view is added as favorite and appears under the Favorite category. The blue colored star icon indicates that the view is added as favorite.
  • To unfavorite a view, click the blue colored star against the view. The view is removed from the Favorite category.
RenameThe Rename option allows you to rename the name of the view.
To rename a view:
  1. Hover over the view name on the slide-out.
  2. Click the actions menu. The View Options popup is displayed.
  3. Click the Rename option. The Rename View popup is displayed.
  4. Enter a new name for the view in the Name box and click Save.
CopyThe Copy option allows you to create a copy of a view.
To create a copy of a view:
  1. Hover over the view name on the slide-out.
  2. Click the actions menu. The View Options popup is displayed.
  3. Click the Copy option. The Copy View popup is displayed.
  4. Enter a name for the view in the Name box and click Save. The view is copied and is displayed in the slide-out.
Set Default ViewThe Set Default View option allows you to set a view as a default view for the current user.
To set a view as a default:
  1. Hover over the view name on the slide-out.
  2. Click the actions menu. The View Options popup is displayed.
  3. Click the Set Default View option. The Set Default View dialog box is displayed.
  4. Turn on the My Default View option and click the SAVE button.
  5. A DEFAULT tag appears next to the view name. Hovering over it will display a tooltip: user default. The view is set as default for the current user.
    Similarly, you can set the default view for a collection.
  6. To set the default view for other users, share the view and make it as default.
For Partner scope:
  1. In Set Default View dialog box select the role from the Partner Roles dropdown. (The view is shared with all the partners with the role selected.)
  2. Under Client Roles, select the client and the role from the dropdowns. If you select a specific client, it will show the roles that are available for that client.
    3. To set default view with multiple users click +Add Client Users.
  • To remove a default view or a collection, in the Set Default View dialog box clear the My Default View option and click SAVE.
  • If you have shared a view with another user and set it as the default view, you can remove the default view setting when it is no longer needed.
    To do this:
    1. From My Resources Views slide-out, click the three dots (action menu) and select Set Default View option.
    2. In the Set Default View dialog box remove the role from the Roles dropdown and click SAVE.
Note: The order of precedence for default applicability of a view or collection is USER → ROLE → SYSTEM.
The User default takes first precedence. In the absence of a User default, the Role default is displayed. If no Role default exists, the System default is displayed.
ShareThe Share option allows you to share a view with users who are assigned the selected role.
To share a view:
  1. Hover over the view name on the slide-out.
  2. Click the actions menu. The View Options popup is displayed.
  3. Click the Share option. The Share View dialog box is displayed.

    4. Based on the scope of the user, the options appear.
    For Partner scope:
    1. In Share View dialog box select the role from the Partner Roles dropdown. (The view is shared with all the partners with the role selected.)
    2. Under Client Roles, select the client and the role from the dropdown. If you select a specific client, it will show the roles that are available for that client.
    3. Click +Add Client Users to share the view with multiple users.
    For Client scope:
    1. Select the role from the dropdown.
    2. Click Share. The view is shared.

  4. After sharing the view, set it as the default for the user you shared it with.
    Follow Set Default View article above to set the view as default. A DEFAULT tag appears next to the view name for users with whom the view is shared. Hovering over it will display a tooltip: role default. The view is set as default for the user(s) with the role specified.
    Similarly, you can set a collection as default for other users.
The user with whom the view is shared with has the following view options available. The user can perform these actions on the shared view:
  • Copy
  • Set Default View
  • Share
To unshare a view:
    For Partner scope:
    1. In the Share View dialog box remove the role from the Partner Roles/Client Roles dropdown and click Share.
    For Client scope:
    1. In the Share View dialog box, remove the role from the Client Roles dropdown and click Share.
    Copy URL: The Copy URL link is available on the Share View dialog box. Click this link and copy the URL, add the view as a bookmark on the browser. You can view the search result as required.
    Note: Only users with Resource View or Resource Manage permission have access to this link.
RemoveThe Remove option allows you to remove a view.
To remove a view:
  1. Hover over the view name on the slide-out.
  2. Click the actions menu. The View Options popup is displayed.
  3. Click the Remove option. A confirmation dialog box is displayed.
  4. Click Remove.
Add ResourceThe Add Resource functionality lets you add a resource manually.
To add a resource:
  1. Click Add Resource under QUICK ACTIONS, from the slide-out.
  2. Enter the mandatory details in the ADD RESOURCE screen like Host Name, Resource Name, Resource Type.
    Note: The resource name should contain alphanumeric, (- . / or @) and should be more than 2 characters.
    Examples: Prod"app"-v1.0, service"prod/east,
    db-"replica/prod.
    When querying for a resource with resource name if there is a double quotes in the name, for example, server1029"prodmon/21 use a backslash ("\") before the double quotes to escape it.
    The query should be: resourceName = server1029\"prodmon/21
    Supported special characters: single quotes (`'`), double quotes (`"`), backslash (`\`).
  3. Click ADD RESOURCE. The resource is added and a confirmation message appears.
Following are the permissions required to access the Add Resource link:
CategoryPermission TypePermission Value
Account AdministrationDevicesCreate
Download resourcesThe Download Resources functionality lets you download the resources at the client level, in CSV format.
To download resources:
  1. Click Download Resources under QUICK ACTIONS, from the slide-out. The resources are downloaded.

Attribute Update Policies

Attribute Update Policies automate the process of applying attribute values to resources that match a defined filter query. Instead of updating resource attributes manually one by one, you define a policy once and run it to apply consistent attribute values across all matching resources automatically.

Why use the policy?

Use Attribute Update Policies to:

  • Standardize attribute values such as time zone across a large set of resources.
  • Enforce consistent attributes across resources as your infrastructure grows or changes.
  • Reduce manual effort and the risk of inconsistent resource tagging.
  • Prevent attribute overwrites from agent updates or discovery processes, ensuring policy-assigned values remain stable.

You can create, view, update, run, and remove policies from the Attribute Update Policies page, which is accessible from the My Resources Views sidebar under Quick Actions.

Permissions

Following are the permissions required to perform various tasks.

CategoryPermission TypePermission ValueTask
Account AdministrationDevicesManage
and
Access to all resources.		To create, update, and delete a policy.

Access Attribute Update Policies

  1. Navigate to Infrastructure > Search.
  2. Click the hamburger menu on the left top corner of the page. The My Resources Views slide-out appears.
  3. Click Attribute Update Policies under Quick Actions. The Attribute Update Policies page appears.

Add a policy

Follow these steps to add a policy:

  1. Click ADD on the Attribute Update Policies page. The Add Policy page appears.


  2. Enter the following details:

    Mandatory fields

    General Details

    FieldTypeDescription
    Policy NameStringEnter a unique name that identifies the policy.
    Force UnassignCheckboxWhen selected, resources that do not match the filter query will be removed.

    Resource Filter

    FieldTypeDescription
    Filter QueryQueryDefines which resources the policy applies to. Click anywhere in the box to open the query builder and construct a query using OpsQL.
    Only resources matching this query will receive the attribute updates.

    Attributes

    This section defines the attribute values to apply to all matching resources. Existing attribute values on those resources will be overwritten.

    FieldDescription
    AttributeSelect the attribute to update from the dropdown (for example, Time Zone).
    ValueSelect the value to assign to the chosen attribute from the dropdown (for example, Europe/Dublin).
    You can select up to a maximum of 5 values.
    • +ATTRIBUTE: Click to add another attribute-value pair.
    • Delete icon: Click the trash icon next to an attribute row to remove that attribute-value pair from the policy.

  3. Click one of the following buttons to complete the action:

    • SAVE & RUN: Saves the policy and immediately executes it against all matching resources.
    • SAVE Saves the policy without running it. You can run it later using Run now.
    • CANCEL Discards all changes and closes the page without saving.

    The policy is created and displayed in the listing page.


    The listing page has the following columns:

    ColumnDescription
    Policy NameThe name assigned to the policy when it was created.
    Updated ByThe username or email of the person who last modified the policy.
    Created TimeThe date and time when the policy was created.
    Last Run TimeThe date and time of the most recent execution of the policy.

Manage policies

You can perform the following actions on any existing policy from the Attribute Update Policies list.

View and Update Policy details

Follow these steps to view and update policy details:

  1. Navigate to Infrastructure > Search.
  2. Click the hamburger menu on the left top corner of the page. The My Resources Views slide-out appears.
  3. Click Attribute Update Policies under Quick Actions. The Attribute Update Policies page appears.
  4. Search for the policy you want to update.
  5. Mouse hover over the row and click the three dots (ellipsis) icon.


  6. Select View Details. Alternatively, you can click on the policy name. The Attribute Update Policy page appears with details including Policy Name, Force Unassign setting, Filter Query, and the list of attribute-value pairs defined.


  7. Update the fields as required.
  8. Click one of the following buttons to complete the action:
    • SAVE & RUN: Saves the policy and immediately executes it against all matching resources.
    • SAVE Saves the policy without running it. You can run it later using Run now.
Run now

Immediately executes the policy. The system evaluates the filter query, identifies all matching resources, and applies the defined attribute values to those resources. The Last Run Time column is updated after execution completes.

Follow these steps to execute the policy:

  1. Navigate to Infrastructure > Search.
  2. Click the hamburger menu on the left top corner of the page. The My Resources Views slide-out appears.
  3. Click Attribute Update Policies under Quick Actions. The Attribute Update Policies page appears.
  4. Search for the policy you want to execute.
  5. Mouse hover over the row and click the three dots (ellipsis) icon.
  6. Select Run now.
View policy logs

Displays the execution history and logs for the policy. Use policy logs to:

  • Verify that a policy ran successfully.
  • Identify which resources were updated during the last run.
  • Investigate errors or unexpected results.

Follow these steps to view the policy logs:

  1. Navigate to Infrastructure > Search.
  2. Click the hamburger menu on the left top corner of the page. The My Resources Views slide-out appears.
  3. Click Attribute Update Policies under Quick Actions. The Attribute Update Policies page appears.
  4. Search for the policy you want to view and update.
  5. Mouse hover over the row and click the three dots (ellipsis) icon.
    The View Policy Logs option is also available at the right top corner of the policy details page.
  6. Select View policy logs. The logs listing page appears.


See [Activty] for more information.

Remove

Follow these steps to remove a policy log:

  1. Navigate to Infrastructure > Search.
  2. Click the hamburger menu on the left top corner of the page. The My Resources Views slide-out appears.
  3. Click Attribute Update Policies under Quick Actions. The Attribute Update Policies page appears.
  4. Search for the policy you want to remove.
  5. Mouse hover over the row and click the three dots (ellipsis) icon.
  6. Select Remove. A confirmation dialog box appears.
  7. Select Remove to remove the policy.

FAQs & troubleshooting

This page answers frequently asked questions about Attribute Update Policies and provides troubleshooting steps for common issues.

FAQs

How many attribute-value pairs can I add to a single policy?

You can add up to 5 attribute-value pairs per policy. If you need to apply more than 5 attributes, create additional policies targeting the same filter query.

Can I run a policy immediately after saving it?

Yes. Click SAVE & RUN instead of SAVE when creating or editing a policy. This saves the policy and runs it immediately. You can also run any saved policy at any time by clicking the three-dot (ellipsis) menu and selecting Run now.

Where can I see which resources were updated by a policy?

Use the View policy logs option from the three-dot menu (⋯) next to a policy. Policy logs show the execution history and the list of resources that were processed during each run.

What happens to resource attributes if I remove a policy? __

Removing a policy deletes the policy definition but does not revert attribute values that were previously applied by that policy. Resources retain any attribute values set by the policy until they are changed or removed through another action.

Can a resource be affected by more than one Attribute Update Policy?__

Yes. If a resource matches the filter query of multiple policies, it can be updated by all of them. If two policies assign different values to the same attribute, the most recently run policy determines the final value.

Troubleshooting

Access denied error when opening the Attribute Update Policies page

You do not have the appropriate permissions. Contact your Administrator.

A policy is saved successfully but attributes are not updated on resources

The policy was saved using SAVE rather than SAVE & RUN, so it has not executed yet.
Click the three-dot (ellipcis) menu next to the policy and select Run now to execute it.

Customize columns

You can select resource attributes and custom attributes for listing from the Column Settings popup window.

  1. Navigate to Infrastructure → Search.

  2. Click the Settings (gear) icon available on the upper-right corner of the resource listing screen to view a list of 100 resource attributes including custom attributes.
    Note: A maximum of 100 custom attributes are displayed in the list. You can search for a custom attribute that is not listed but is available under the client.


  3. Search for the resource attribute or custom attribute. The search result can have resource attribute or custom attribute or both.

    Search attributes

  4. Select the resource attribute(s)/custom attribute(s) and click UPDATE.

  5. The resource attribute is added as a column in the list.
    Scroll to the right of the screen to view the column(s).

    • The custom attribute is listed as a column, with its value for the resource(s) it is assigned to.

      Search attribute result
      Note:
      • In case a custom attribute is assigned to one or more resources, you will see the custom attribute value for all those resources.
      • Custom attributes are case-sensitive. The custom attribute must be entered in the search field with the exact capitalization as it was originally defined.
      • Refreshing the screen will clear all the selected columns. The default columns will be displayed. You can create Views to save the column listing. See Views for more information on saving a view.

Filters

Use the Filters option to filter and search.

To filter:

  1. Click Filters and then select the required attribute.
  2. Click Filter.

Multi-select capability

This feature is for screens that support multi-select.

You can select multiple items and perform actions.

  1. Search for the items and select the checkbox next to the item.

  2. Click the Actions menu and select the required option.

Note: Depending on the actions performed, there will be limitations. If there is a breach on the limit, then the UI will show you a message.

List of Attributes

Keyword search will search for occurrence of that string across the following fields:

idnameipAddressmakemodelserialNumber
hostNameresourceNamednsNamealiasNameosdescription
softwareVersionLocationNameCloudInstance Public IpCloudInstance instance Id (Management Object Id)NetworkInterface NameNetworkInterface Ip address
NetworkInterface Mac addressNetworkInterface descriptionNetworkInterface aliasIpcustom attribute namecustom attribute value