--- name: cmdb-patterns-e9ad2560e99b description: Create ServiceNow CIs and cmdb_rel_ci relationships, walk upstream/downstream impact, detect orphan/stale CIs, and align discovered CIs with the proper sys_class_name hierarchy. license: Apache-2.0 compatibility: Designed for Serac and ServiceNow development metadata: author: serac version: "1.0.0" category: servicenow tools: - snow_cmdb_search - snow_cmdb_identify_reconcile - snow_create_ci - snow_create_ci_relationship - snow_query_table --- # CMDB Patterns for ServiceNow The Configuration Management Database (CMDB) is the foundation of ServiceNow ITSM, tracking all Configuration Items (CIs) and their relationships. ## CMDB Architecture ### CI Class Hierarchy ``` cmdb (Base) └── cmdb_ci (Configuration Item) ├── cmdb_ci_computer │ ├── cmdb_ci_server │ │ ├── cmdb_ci_linux_server │ │ ├── cmdb_ci_win_server │ │ └── cmdb_ci_unix_server │ └── cmdb_ci_pc_hardware ├── cmdb_ci_service │ ├── cmdb_ci_service_business │ ├── cmdb_ci_service_technical │ └── cmdb_ci_service_auto │ └── cmdb_ci_service_discovered ├── cmdb_ci_appl │ ├── cmdb_ci_app_server │ └── cmdb_ci_db_instance └── cmdb_ci_network_gear ├── cmdb_ci_netgear └── cmdb_ci_lb ``` ### Key CI Tables | Table | Purpose | Key Fields | | ----------------- | ----------------- | ------------------------------------------- | | `cmdb_ci` | Base CI table | name, sys_class_name, operational_status | | `cmdb_ci_server` | Servers | ip_address, os, cpu_count, ram | | `cmdb_ci_service` | Service (base class — Business Service is `cmdb_ci_service_business`) | service_classification, busines_criticality | | `cmdb_ci_appl` | Applications | version, install_directory | | `cmdb_rel_ci` | CI Relationships | parent, child, type | ## Creating Configuration Items ### Basic CI Creation (ES5) ```javascript // Create a new server CI var ci = new GlideRecord("cmdb_ci_server") ci.initialize() ci.setValue("name", "PROD-WEB-001") ci.setValue("ip_address", "10.0.1.100") ci.setValue("os", "Linux Red Hat") ci.setValue("os_version", "8.5") ci.setValue("cpu_count", 8) ci.setValue("ram", 32768) ci.setValue("operational_status", 1) // Operational ci.setValue("install_status", 1) // Installed ci.setValue("used_for", "Production") ci.setValue("owned_by", "sys_id_of_owner") ci.setValue("support_group", "sys_id_of_group") var sysId = ci.insert() ``` ### CI with Discovery Source ```javascript // CI from Discovery var ci = new GlideRecord("cmdb_ci_linux_server") ci.initialize() ci.setValue("name", "discovered-server-001") ci.setValue("discovery_source", "ServiceNow") ci.setValue("first_discovered", new GlideDateTime()) ci.setValue("last_discovered", new GlideDateTime()) ci.setValue("ip_address", "10.0.2.50") // Set classification ci.setValue("classification", "Production") ci.setValue("environment", "Production") ci.insert() ``` ## CI Relationships ### Relationship Types | Type | Parent → Child | Example | | ------------------------ | ---------------- | ------------------------- | | `Runs on::Runs` | App → Server | ERP runs on PROD-DB-01 | | `Depends on::Used by` | Service → App | HR Service depends on SAP | | `Contains::Contained by` | Cluster → Server | Cluster contains Node1 | | `Hosted on::Hosts` | VM → Hypervisor | VM01 hosted on ESX01 | | `Members::Member of` | CI → Group | Server member of Pool | ### Creating Relationships (ES5) ```javascript // Create relationship between CIs function createCIRelationship(parentSysId, childSysId, relationType) { // Find relationship type var relType = new GlideRecord("cmdb_rel_type") relType.addQuery("name", relationType) relType.query() if (!relType.next()) { gs.error("Relationship type not found: " + relationType) return null } // Check if relationship already exists var existing = new GlideRecord("cmdb_rel_ci") existing.addQuery("parent", parentSysId) existing.addQuery("child", childSysId) existing.addQuery("type", relType.getUniqueValue()) existing.query() if (existing.next()) { gs.info("Relationship already exists") return existing.getUniqueValue() } // Create new relationship var rel = new GlideRecord("cmdb_rel_ci") rel.initialize() rel.setValue("parent", parentSysId) rel.setValue("child", childSysId) rel.setValue("type", relType.getUniqueValue()) return rel.insert() } // Usage createCIRelationship(appSysId, serverSysId, "Runs on::Runs") ``` ### Querying Relationships ```javascript // Find all servers an application runs on function getAppServers(appSysId) { var servers = [] var rel = new GlideRecord("cmdb_rel_ci") rel.addQuery("parent", appSysId) rel.addQuery("type.name", "Runs on::Runs") rel.query() while (rel.next()) { var server = rel.child.getRefRecord() servers.push({ sys_id: server.getUniqueValue(), name: server.getValue("name"), ip_address: server.getValue("ip_address"), }) } return servers } // Find all dependencies of a service function getServiceDependencies(serviceSysId) { var deps = [] var rel = new GlideRecord("cmdb_rel_ci") rel.addQuery("parent", serviceSysId) rel.addQuery("type.name", "Depends on::Used by") rel.query() while (rel.next()) { deps.push({ sys_id: rel.child.getUniqueValue(), name: rel.child.getDisplayValue(), class: rel.child.sys_class_name.toString(), }) } return deps } ``` ## Impact Analysis ### Upstream/Downstream Analysis ```javascript // Get all CIs affected by a CI outage (downstream impact) function getDownstreamImpact(ciSysId, depth) { if (typeof depth === "undefined") depth = 3 var impacted = [] var processed = {} function traverse(sysId, currentDepth) { if (currentDepth > depth || processed[sysId]) return processed[sysId] = true var rel = new GlideRecord("cmdb_rel_ci") rel.addQuery("child", sysId) rel.query() while (rel.next()) { var parentId = rel.parent.toString() if (!processed[parentId]) { impacted.push({ sys_id: parentId, name: rel.parent.getDisplayValue(), depth: currentDepth, }) traverse(parentId, currentDepth + 1) } } } traverse(ciSysId, 1) return impacted } // Get all CIs this CI depends on (upstream dependencies) function getUpstreamDependencies(ciSysId, depth) { if (typeof depth === "undefined") depth = 3 var dependencies = [] var processed = {} function traverse(sysId, currentDepth) { if (currentDepth > depth || processed[sysId]) return processed[sysId] = true var rel = new GlideRecord("cmdb_rel_ci") rel.addQuery("parent", sysId) rel.query() while (rel.next()) { var childId = rel.child.toString() if (!processed[childId]) { dependencies.push({ sys_id: childId, name: rel.child.getDisplayValue(), depth: currentDepth, }) traverse(childId, currentDepth + 1) } } } traverse(ciSysId, 1) return dependencies } ``` ### Business Service Impact ```javascript // Find all business services impacted by a CI function getImpactedServices(ciSysId) { var services = [] var processed = {} function findServices(sysId) { if (processed[sysId]) return processed[sysId] = true // Check if this CI is a service var ci = new GlideRecord("cmdb_ci") if (ci.get(sysId)) { if (ci.sys_class_name.toString().indexOf("cmdb_ci_service") === 0) { services.push({ sys_id: sysId, name: ci.getValue("name"), criticality: ci.getValue("busines_criticality"), }) } } // Traverse upstream var rel = new GlideRecord("cmdb_rel_ci") rel.addQuery("child", sysId) rel.query() while (rel.next()) { findServices(rel.parent.toString()) } } findServices(ciSysId) return services } ``` ## CMDB Health & Data Quality ### Orphan CI Detection ```javascript // Find CIs without relationships function findOrphanCIs(ciClass) { var orphans = [] var ci = new GlideRecord(ciClass || "cmdb_ci") ci.addQuery("operational_status", 1) // Operational only ci.query() while (ci.next()) { var sysId = ci.getUniqueValue() // Check for any relationships var rel = new GlideRecord("cmdb_rel_ci") rel.addQuery("parent", sysId).addOrCondition("child", sysId) rel.setLimit(1) rel.query() if (!rel.hasNext()) { orphans.push({ sys_id: sysId, name: ci.getValue("name"), class: ci.getValue("sys_class_name"), }) } } return orphans } ``` ### Stale CI Detection ```javascript // Find CIs not updated by discovery function findStaleCIs(daysOld) { if (typeof daysOld === "undefined") daysOld = 30 var stale = [] var cutoff = new GlideDateTime() cutoff.addDaysLocalTime(-daysOld) var ci = new GlideRecord("cmdb_ci") ci.addQuery("operational_status", 1) ci.addQuery("last_discovered", "<", cutoff) ci.addNotNullQuery("last_discovered") ci.query() while (ci.next()) { stale.push({ sys_id: ci.getUniqueValue(), name: ci.getValue("name"), last_discovered: ci.getValue("last_discovered"), }) } return stale } ``` ## MCP Tool Integration ### Available CMDB Tools | Tool | Purpose | | ------------------------------ | -------------------------------------------------------------------- | | `snow_cmdb_identify_reconcile` | Insert/update CIs through IRE — identifies before it writes | | `snow_create_ci` | Create new CI with proper class (writes straight to the class table) | | `snow_cmdb_search` | Search CIs with filters | | `snow_create_ci_relationship` | Create CI relationships | | `snow_impact_analysis` | Analyze CI impact | | `snow_get_ci_details` | Get full CI information | | `snow_run_discovery` | Trigger discovery | ### Write CIs through IRE, not by searching first Searching for a CI and creating it when the search misses is the pattern that fills a CMDB with duplicates: it loses to any variance in name, IP or serial, and the second write carries no record of where the data came from. The Identification and Reconciliation Engine exists to do that matching properly. `snow_cmdb_identify_reconcile` posts the payload to `/api/now/identifyreconcile`, so each class's identifier rules run against it, an existing CI is updated instead of duplicated, reconciliation rules decide whether this data source may overwrite each attribute, and the write is recorded in Source [`sys_object_source`]. `snow_create_ci` and `snow_update_ci` write to a class table directly, which skips all of that. Use them for a CI you know is not in the CMDB and do not need attributed to a source. Ignore `snow_reconcile_ci` despite the name — it PUTs your fields onto base `cmdb_ci` and echoes its `reconciliation_rule` argument back untouched; no rule runs. One payload can also carry `relations` between its own items, where `type` is a name field value from CI Relationship Type [`cmdb_rel_type`] and `parent`/`child` are indexes into `items`. That is how a source that discovers a host and the application on it submits both in a single call. `dry_run` commits nothing, but permission is per tool rather than per argument, so it still counts as a write: on a production instance the dry run needs the same `__confirmProd` as the real call. ### Example Workflow ```javascript // 1. Dry run first: IRE reports what it would do and commits nothing. On a // 400-CI payload this is the only way to see the verdict before taking it. await snow_cmdb_identify_reconcile({ data_source: "ServiceNow", // must be a choice on cmdb_ci.discovery_source dry_run: true, items: [ { className: "cmdb_ci_linux_server", values: { name: "PROD-WEB-002", ip_address: "10.0.1.101", serial_number: "VMW-42-8A" }, }, ], }) // Read items[0].operation — INSERT, UPDATE, NO_CHANGE, UPDATE_WITH_UPGRADE, // UPDATE_WITH_DOWNGRADE, UPDATE_WITH_SWITCH or DELETE — and // items[0].identificationAttempts for the identifier rule that matched. // 2. Same payload without dry_run commits it. IRE answers HTTP 200 even when // individual items fail, so check data.items[i].errors, which the tool // surfaces as a failure rather than a success. const ire = await snow_cmdb_identify_reconcile({ data_source: "ServiceNow", items: [ { className: "cmdb_ci_linux_server", values: { name: "PROD-WEB-002", ip_address: "10.0.1.101", serial_number: "VMW-42-8A" }, }, ], }) // sys_id of the CI IRE inserted or matched: ire.data.items[0].sysId // 3. Create relationship (relationship_type is a cmdb_rel_type sys_id, // look it up via snow_query_table on cmdb_rel_type) await snow_create_ci_relationship({ parent_ci: appSysId, child_ci: serverSysId, relationship_type: runsOnRelTypeSysId, // sys_id of "Runs on::Runs" }) // 4. Impact analysis (the CI argument is ci_id; there is no direction parameter). // include_services is left off on purpose: the business_services key it fills // is not impact — see the csdm-modeling skill. await snow_impact_analysis({ ci_id: serverSysId, depth: 3, include_services: false, }) ``` ## Best Practices 1. **Use Correct CI Class** - Always use most specific class (cmdb_ci_linux_server, not cmdb_ci) 2. **Maintain Relationships** - CIs without relationships have limited value 3. **Discovery Alignment** - Align manual CIs with discovery patterns 4. **Operational Status** - Keep status current (Operational, Retired, etc.) 5. **Unique Identifiers** - Use serial_number, asset_tag for uniqueness 6. **Service Mapping** - Connect CIs to business services 7. **Regular Cleanup** - Archive retired CIs, remove orphans --- Source attribution: serac Original project: https://github.com/groeimetai/snow-flow/blob/af3ad2b3c01305526a44b2647415ba794237462c/packages/skills/cmdb-patterns/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2026 Serac Labs Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: serac Original project: https://github.com/groeimetai/snow-flow/blob/af3ad2b3c01305526a44b2647415ba794237462c/packages/skills/cmdb-patterns/SKILL.md Attribution basis: Source repository record Fields of work: Sales, Product Management, Operations Roles: Sales Development Rep (SDR), Customer Success Manager, Business Development, Product Manager, Operations Manager Specialties: Frontend, Design, Database, Backend Tools: Service Now Country applicability: Country not specified Classification basis: Source category, role and specialization labels Instruction SHA-256: c2976b7d11f5789ce7fceee2de842360ab4e6f4fc5b5c7aa455045e20d9d7598