Build a CMDB query using the CMDB Query Builder - Product Documentation: Utah (2024)

A CMDB query type that queries the infrastructure for CI classes and optionally\n non-CMDB tables, and the relationships and references that connect them.

\n\n

\n\n

\n\n

1. \n Navigate to All > Configuration and click CMDB Query Builder.\n
2. \n On the CMDB Query Builder page do either of the\n following steps:\n
   • Click Create new. Type in a\n Name, choose CMDB Query as\n the Query type, and then click\n Create.
   • Click a widget of a saved query to continue building an existing query.\n Search saved queries first if needed.
   • Point to the upper right corner of a saved query widget, and click the\n Duplicate Query icon to edit a copy of a saved\n query. The default name of the new query contains the string\n 'copy'.
   \n\n
3. \n On the canvas, you can do any of the following operations:\n

   \n

   • Add CI classes to the query: On the CMDB Classes\n tab, select classes from the hierarchy list and drag them to the\n canvas.

   • Add an Application Service CI to the query: On the CMDB\n Classes tab, select the Application\n Service class from the hierarchy list and drag it to\n the canvas.

     \n\n

     In Application Service\n Properties on the right-side bar, you can select Convert\n attached nodes to pattern to query on patterns\n between the application service and other CMDB class nodes. When\n querying on a pattern, the nodes on both ends of the pattern\n connection, can be any number of levels apart. If Convert\n attached nodes to pattern is not selected, then the\n connection between the application service node and other CMDB class\n nodes, represent direct relationships.

     \n
   • Add non-CMDB tables to the query: Select a table from the\n Non-CMDB Tables list and drag it to the\n canvas.

     Note: A non-CMDB table cannot be the starting node in the\n query.

     \n

   • Add connections (relationships or patterns for application services)\n between two nodes on the canvas:

     1. On the first node in the connection, click the small square\n at the center of the right side.
     2. On the second node in the connection, click the small square\n at the center of the left side to create the\n connection.

     \n

     \n\n

     \n

     Table 1. Connection UI Notations

     Notation	Description
     Full line	A relationship in a CMDB query.
     Red asterisk at the center of the connection\n line	Information such as relationship type is\n missing, invalidating the query.
     Levels:<n>\n Types:<n> or a\n <Reference type>\n notation on the connection line	As applicable: The number of relationship\n levels and the number of relationship types\n included for the connection. Or, a reference type\n for a relationship that is a reference. \n
     Dashed line	A pattern connection between an application\n service node and another node.

     \n

     \n

     \n
   • In Connection Properties on the right-side bar, configure relationship\n settings (click the connection line if necessary):
     1. In the Relationship Direction section, select the\n Parent node (the\n Child node automatically\n adjusts).
     2. In the Relationship Levels section, set\n Level to First level\n relationships if the CIs are directly connected.\n Or, Up to 2nd level relationships if the\n CIs are connected either directly or indirectly through another\n CI.

     3. In the Relationship Types and Related Items section, select\n either option:\n

        Option	Description
        No\n Relationships	To query for CIs with no connecting\n relationships, such as All Tomcat WAR CIs\n which are not connected to a Windows\n Server.
        Add Relationship\n Types	To select specific or any relationship\n type.
        Add a Related\n Item	To query for related CIs between the\n nodes.

        \n

        \n

        \n
     \n
   • Configure CI reference column for a connection to a non-CMDB table: In\n the Connection Properties right-side bar, in the CI Reference Column\n section, select the column with a reference to a CI from the\n Use CI reference column list. If only one\n option is available, it is automatically selected.
   • Configure the pattern between an application service node set with the\n Convert attached nodes to pattern option, and\n a non-CMDB table node: Select Apply <table> reference\n filter to all nodes in the pattern to apply the query to\n the application service CI itself and to the CIs within the application\n service.
   • Add filters to a class node: Apply filters to narrow down a class query\n to a specific set of CIs or to a single specific CI.
     1. Point to the node to add a filter to, and then click the\n Apply filters icon that pops up\n above the node.
     2. In the Filters section, add attribute and related list conditions.
     3. Close the Filters section.

     \nFor example: Add a filter for database location to query for\n databases located in Seattle.

     \n\n

     Click Applied\n Filters in the right-side bar to view all filters\n for each node on the canvas.

     \n
   • Add And/Or operators to the query:
     1. Connect one node to two other nodes.
     2. Click the And box that appears on the\n connection line, to toggle between the\n And/Or\n operators.

     \nFor example: C1 is Tomcat WAR, C2 is Linux Server, and C3 is\n Windows Server. Query for All Tomcat WAR CIs which are\n connected either to Linux Server Or to a Windows\n Server.

     \n
   • Add property columns for a node, to appear in the query\n results:

     Note: For a relationship, the query results include the\n parent, child, and\n type columns. You cannot add any other\n columns from the [cmdb_rel_ci]\n table.

     \n\n
     1. Click Properties in the right-side\n pane.
     2. Click a node once or twice, so that the Report Columns section\n appears in the right-side bar, and then click Add\n Columns.
     3. Select properties and then click outside the properties list to\n close it.
     \n
   • Create a combination query by integrating a Service Mapping\n query into a CMDB query:
     1. When building a CMDB query, click Saved Service\n Queries in the left-side bar.
     2. Select and then drag a Service Mapping query to the canvas.

     \nThis query returns all CIs that satisfy the CMDB query, and\n that are included in the services returned by the embedded Service Mapping\n query.

     \n
   • Add a search tag that can then be used as a search criteria for saved\n queries:
     1. Click the Add Tags icon at the top of the\n canvas.
     2. Click Add Tag and in the Query\n Tags dialog box enter one or more tag\n strings.
     3. Click the Add Tags icon again to close\n the Query Tags dialog box.
     \n

   \n\n

   \n
4. \n Click Save.\n

   \n

   On the Saved Queries tab, point to a saved query\n widget and click Query Information. Query details\n such as the query type, last update date, CMDB groups associated with the\n query, and the query schedules appear.

   \n\n

   \n

\n\n

\n\n