On the Inventory page, you can browse, query and investigate entities that are currently in your Zenoss Cloud environment. Because you may have a very large number of entities in your system, the ability to query your inventory is important to locate and examine specific entities that are critical to your workflows.
Inventory queries consist of one or more entity property-value comparisons. You can view query results in a table with one row per entity and one column for each property. Entity properties vary widely by source, so the default table can include many columns.
You can filter your results using the query bar. When you create a query that provides rich results, you can save those queries and share them with your team.
For more information about entities, see Entities and devices.
Opening the Inventory page
You can query and examine your inventory of entities from the following locations:
- The Zenoss Cloud header is visible on all tabs. In the header, click INVENTORY.
Your account must be assigned the Read Only User role or a more privileged role to see the INVENTORY tab, run or create queries, and display entity tables.
Tour of the Inventory page
When you click the INVENTORY tab, you see the Inventory page title with a menu icon, the query bar, and several sections, such as Explore Properties and Templates. Each section includes property names or query cards that you can click to get started with your search. To hide or open a section, click its title.
Let's take a closer look at the main sections you might see on the initial page:
Click the section title to view a list of entity property names in your environment. By default, the list is hidden.
Once open, you can use the search field below the title to display a subset of properties. Note that the list doesn't include the internal properties that are generated by Zenoss Cloud.
This section contains queries that you create and save. You can only see this section when you have saved queries.
When you mark a query as public, it's also added to the Shared Queries list. Click any query card to display its results.
This section contains queries that are created and shared by you and others in your organization. You can only see this section when you have shared queries in your environment.
Click any query card to display its results.
- This section contains the queries that Zenoss provides. These templates are useful if you are new to using Inventory. Select a template to get started, customize it when viewing results, then save it as a query to use later or share with other users.
Accessing the Inventory Queries panel
The Inventory Queries panel provides an alternate way to to access your saved and shared queries and templates. In addition, you can also access your favorites and most recently used queries. In the Inventory Queries panel, you can share, edit, copy, and delete your queries.
To open the Inventory Queries panel, click the Inventory menu icon in the upper-left corner of the page.
To display a different query, click the name of one of your queries in the My Queries folder, or open the Shared Queries folder and click the name of a shared query. Also, you can click the FAVORITES or RECENT tabs to find a query that you marked as a favorite or opened recently.
The FAVORITES tab isn’t available to read-only users because read-only users can’t mark inventory queries as favorites.
After you run a query or open a template, you can view a table of entities with one row per entity and one column for each property.
There are several actions you can take to help you with your investigation:
To view additional information about an entity in the table, click the eye icon in the Actions column for the row. In the ENTITY DETAILS dialog box that opens, you can view more details and navigate to Smart View pages.
On the DETAILS tab, you can view core properties and metadata information about the entity. Click the SMART VIEW button to navigate to Smart View to examine the graphs and charts of an entity’s metrics and events. You can also click the RELATED METRICS tab to quickly view a snapshot of the current metrics for your entity and the RELATED ENTITIES tab to view what the metrics look like for related entities.
Optionally, you can choose to pin the Actions column on the left side of the table. To do so, click the More actions button next to the column name, then click Pin left.
Hide or reorder columns
You can change how the properties appear in the table. To make changes, click Adjust columns from the Settings menu.
In the ADJUST COLUMNS dialog box that opens, you can select or clear the available columns, and change the order of the columns in the table.
Adjust column views
In the column menu, view the sorting options for that column, including Group by <column name>. This option is useful if you want to focus on a specific group of entities, such as a set of entities in a specific device class or a location of entities. You can choose to group entities in several key columns, including Device, Device Class, Groups, Location, Name, Schema IDs, Source, Source Type, and Systems.
After you click Group by <column name>, expand the row to view the entities in that group. The number of entities within a group is indicated in parentheses. Open the column menu and choose to expand all the rows or collapse all the rows in the groups.
If you have a lot of entities to view, you can use the additional sorting options in this menu:
Sort the rows in ascending or descending alphabetical order, or clear any previously applied sort options.
Autosize the specified column or all the columns in the table, or choose to autosize all the column contents, but not the header.
Edit column headers
If you want to change an entity field to a friendlier name, you can edit the entity field in the Dictionary. For example, you might want to change “Source” to “My Source.” For more information, see the Entity Fields page in the Dictionary.
Table actions menu
Use the table action buttons to quickly perform a variety of tasks, including saving, sharing, and exporting your results. The actions you see depend on your query or template. These action icons are located in the upper-right corner above the results table.
View the following table to learn more about table actions.
|Make the inventory view public if you are the owner, or copy its URL to your clipboard.
|Download the results of the current query in HTML, CSV, Excel, or JSON format.
|Create a duplicate of the current query. You can update the title of the new query.
|Save the current query. This control is dimmed if the query is unchanged.
|Save the current query as a new query. You can update the title and description of the new query, and select a different icon for it.
|From Settings, click Adjust columns to open the ADJUST COLUMNS dialog box. Here, you can select or hide columns in the results table, or change the order of the columns in the table. Limiting the columns to just what you need can help avoid confusion.
|Expand/Collapse query bar
|Display or hide the query bar.
Search your inventory
In the Inventory view, you can browse, search, and filter your inventory of devices, property names, and more. If you want to browse your inventory easily without building queries, use quick search. If you’re an advanced user, then build queries in advanced search to tailor the results you want to see.
To switch between quick search (default) and advanced search, click the name of the mode you want to use on the right side of the search bar.
In Quick Search, enter a single keyword so the query can quickly search for the keyword in any of the following fields, including entity names, entity titles, entity types, organizer names, and virtual machine names.
As a best practice, enter only one keyword, such as Linux, Kubernetes, Windows, Docker, or Teams.
In Advanced Search, create a tailored search from scratch, a template, or a saved query using the query builder. As you enter text, the search bar suggests options for each part of the query, including property names, operators, values, and connectors. If needed, use the autocomplete dropdowns to change a part of the query.
For example, you might have saved a query to browse your Linux devices, but maybe you want to focus only on those devices that are in maintenance. You can add on to your existing query by adding a connector, property, operator, and value. In this example, you might enter “Production State” with the operator “equal to” and the value “Maintenance” to filter your results to just those Linux devices in maintenance.
Let's take a closer look at the query parts:
|Property name that you are asking for in the query, such as “Schema IDs” or “Device Class”. To view or add user-friendly alternatives to computer-generated entity field names, see the Entity Fields page in the Dictionary.
|Operators that control whether or not an entity meets the criteria defined in the query.
Operators for string types include the following:
- equal to: The property equals the defined value.
- contains: The property contains the string in the defined value.
- ends with: The property ends with the defined value.
- exists: Tests whether an entity has a property and, if so, whether the property's value is non-null.
- in: Contains one of the strings in the defined value.
- starts with: Starts with the defined value.
Operators for numeric types include the following:
- > numeric operator: The property is greater than the defined value.
- < numeric operator: The property is less than the defined value.
- = numeric operator: The property is equal to the defined value.
- Less than or equal to numeric operator: The property is less than or equal to the defined value.
|Value that is controlled by the operator. For example, you might build a query to find schema IDs that are equal to the value “Base.Device” in your inventory. “Base.Device” is the value controlled by the operator.
|Connector for conditions, such as AND and OR. The AND connector has precedence.
|Total number of results matching the query criteria.
If your query contains multiple lines, use the scroll control in the query bar.
Create a query
In Advanced Search, you can create queries composed of one or more entity property-value comparisons.
This query bar supports keyboard accessibility. For example, press the keyboard arrow keys to move through menus, press Enter or Tab to select options, and press Backspace or Delete to remove options.
Open the Advanced Search query bar:
From the default Inventory page, click Advanced Search next to the search bar.
From a template or saved query, click the Expand query bar button.
Select a property. Enter text and select a field in the dropdown menu.
Select an operator in the dropdown menu.
Enter a value.
Optionally, build a more targeted query. Choose between AND and OR to join another property-value comparison.
Click the search button (magnifying glass icon) to search for results that match your criteria.
Save a query
After you are satisfied with the results of your query, you can save it for future use. Click Save or Save as and name it for easy identification.
Share a query
After you create a query or open a saved query, you can share it. Click the Share button and turn on the Make inventory query public option. You can copy the link to share with other users.
Export query results
To download the table to your local machine, click the Export table button. Decide if you want to download all columns, then select the format for the table.
Keep in mind that selecting the All columns checkbox might impact the size of your exported file.
If you clear the All columns checkbox, then only those columns visible in the table are downloaded. These columns are selected in the ADJUST COLUMNS dialog box which you can open from Settings.
If you select the All columns checkbox, all the columns available in the ADJUST COLUMNS dialog box are downloaded, regardless of if they are selected or not.
Clone a query
Select the Action options button and select Clone query in the dropdown menu.
In the dialog box that appears, keep or enter a name for the cloned query and click COPY.