CI Lookup Rules for identifying configuration items from Configuration Compliance third-party vulnerability integrations
Summarize
Summary of CI Lookup Rules for identifying configuration items from Configuration Compliance third-party vulnerability integrations
CI Lookup Rules in Configuration Compliance automatically identify configuration items (CIs) when importing data from third-party vulnerability integrations, specifically the Qualys Integration for Security Operations. These rules help map imported host data to existing CIs in the Configuration Management Database (CMDB) or create placeholder unmatched CIs if no match is found. This process aids in remediation by associating vulnerability test results with the correct CIs.
Show less
How CI Lookup Rules Work
- Imported assets are first matched against the Discovered Items list using third-party IDs to find existing CIs.
- If no exact match is found or the
cmdbcifield is empty, other host information is used to identify the CI. - If still unmatched, a placeholder CI designated as an Unmatched CI is created with a new discovered item mapped to it.
- Matching begins with a vendor ID lookup for an exact match across source, sourceinstance, and vendor ID.
- CI Lookup Rules are evaluated in order of their defined priority until a single CI match is found.
- If multiple CIs match a rule, only the first match is used.
- Low-level networking elements (e.g., switchports, network adapters, NICs, IP addresses) are excluded by returning their parent CI.
- A system property is available to exclude specific CI classes from matching.
- The CI lookup rule used for matching is recorded in the Discovered Item's CI matching rule field for traceability.
Key Features
- Domain-separated and source-specific rules, supporting multiple deployments per source such as multiple Qualys Integration instances.
- Rules are shared across all deployments of a vulnerability integration; changes impact all deployments.
- Base system includes predefined CI lookup rules for Qualys (e.g., HOST ID, FQDN, NetBIOS, DNS, IP), Microsoft Defender (S3 Bucket Name, Resource Id), and Palo Alto Prisma Cloud (S3 Bucket Name, Resource Id).
- Ability to reapply updated CI lookup rules to refresh discovered items and test results, ensuring consistent and accurate CI associations.
Performance Considerations
Importing test results and executing CI lookup rules can impact instance performance due to the complexity of matching logic in the CMDB. It is important to carefully design and test custom CI lookup rules or modifications to existing rules to avoid resource degradation and lengthy processing times.
Practical Guidance for ServiceNow Customers
- Use the Discovered Items list to monitor how imported assets are mapped to CIs and verify matches.
- Be aware that changes to CI lookup rules affect all deployments within a vulnerability integration source.
- After modifying CI lookup rules, use the "Apply Changes" function to update existing discovered items and test results accordingly.
- Leverage system properties to exclude low-level CI classes when appropriate to improve match accuracy.
- Follow recommended steps to prevent duplicate or orphaned records and maintain data integrity after running vulnerability response CI lookup rules.
When data is imported from a third-party integration, Configuration Compliance automatically uses host data to search for matches in the Configuration Management Database (CMDB). It does this using CI Lookup Rules. These rules are used to identify configuration items (CIs) and add them to the test result record to aid in remediation.
As assets are imported, a lookup is performed first on the Discovered Items list using third-party IDs to find matches to configuration item (CIs) from prior imports. When a host ID match is found, it is used as the Configuration item field in the test result record.
You can see how imported assets are mapped to CIs using the Discovered Items list. If a match is not found, or the cmdb_ci field is empty, the rules use the other host information to attempt to correctly identify the CI. If a match is still not found, a placeholder CI is created and is designated as an Unmatched CI. See Discovered Items for Configuration Compliance for more information on how those CIs are handled.
A new discovered item is created and mapped to this CI.
dscy_switchport,
cmdb_ci_network_adapter, cmdb_ci_nic, or cmdb_ci_ip_address, the parent CI is returned.A system property to exclude CI classes is available. This property is not available with upgrade. See Ignore CI classes for upgrade information and instructions on setting the property.
To make it easier to find matching issues, when a match is found, the CI lookup rule used to find it is added to the Discovered Item record in the CI matching rule field. Lookup rules are evaluated by lowest Order value first.
- QUALYS HOST ID
- FQDN
- NetBIOS
- DNS
- IP
- S3 Bucket
- Name
- Resource Id
- S3 Bucket
- Name
- Resource Id
Importing test results data can be taxing on an instance and performance issues with resources can occur if rules are not carefully constructed. The logic used to iterate through and perform matching within the CMDB can result in lengthy processing times. To avoid any potential degradation of resources or performance complications, test any custom-written CI Lookup Rules or modifications to pre-defined CI Lookup Rules. See Steps to help prevent duplicate or orphaned records after running Vulnerability Response CI lookup rules for more information on preventing duplicate orphan records, deleting data, and cleaning up data.
Reapplying updated CI lookup rules
- Were matched by the updated rules
- Are not matched by any rule