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:
Log in to OpsRamp.
Navigate to Infrastructure > Search.
From the Infrastructure Search page, click the search (magnifying glass) icon next to the Home tab. The New View tab is displayed.
Click +Query. The Search box displays the list of resource attributes.
Build a query using the basic query mode.
Basic Query Mode
Select the attribute and the operator from the dynamically populated matching operator list.
Type in (or select) a value from the VALUES drop-down. The values are populated based on the selected attribute and operator.
The query result is displayed.
Click + to add another expression.
The AND logical operator is selected by default. Click and select the desired operator.
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.
Click </> to switch to the Advanced query mode.
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.Select the attribute and the operator from the dynamically populated matching operator list and then type in (or select) a value.
Select the logical operators,
AND
orOR
Follow the steps mentioned above – select the attribute, operator, and value, to add another expression. You can add as many valid expressions as possible.
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
Views
Save your query results as Views. This helps you to save the complex queries and modify them as and when needed.
Managing Views
Create and manage (Add, Copy, Set as default, etc.) views from the Infrastructure search page.
You can do the following actions after performing a search operation:
Action | Steps/Description |
---|---|
Save a View | Once you execute a query, you can save the query results as a view. To save a view:
|
Set Favorite | To mark a view as favorite:
|
Restore | The Restore option reverts to the previous query. Once you have made changes to a specific query, which is already saved as a view:
|
Rename | The Rename option allows you to rename the name of the view. To rename a view:
|
Copy | The Copy option allows you to create a copy of a view. To create a copy of a view:
|
Set Default View | The 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:
|
Share | The Share option allows you to share a view with other users. To share a view:
Based on the scope of the user, the options appear. For SP and Partner users: 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. |
Remove | The Remove option allows you to remove a view. To remove a view:
|
Download | The Download Resources functionality lets you download the resources at the client level, in CSV format. To download resources:
|
Customize columns
You can add columns as required.
- Use the Settings (gear) icon available on the right-upper corner on the listing page. The selected columns will be displayed on the page.
Filters
Use the Filters option to filter and search.
To filter:
- Click Filters and then select the required attribute.
- Click Filter.
Multi-select capability
This feature is for pages that support multi-select.
You can select multiple items and perform actions.
Search for the items and select the checkbox next to the item.
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:
id | name | ipAddress | make | model | serialNumber |
hostName | resourceName | dnsName | aliasName | os | description |
softwareVersion | LocationName | CloudInstance Public Ip | CloudInstance instance Id (Management Object Id) | NetworkInterface Name | NetworkInterface Ip address |
NetworkInterface Mac address | NetworkInterface description | NetworkInterface aliasIp | custom attribute name | custom attribute value |