\r\n Get Well Playbook \r\nRefresh Stale CIs in your CMDB \r\nA guide for how to refresh stale CIs \r\n |
\r\n
Table of Contents
\r\nSummary. 3
\r\n\r\n\r\n\r\nHow this playbook can help you achieve your business goals 4
\r\nHow this playbook is structured. 4
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
Goal of this Playbook
\r\nThe goal of this playbook is to help you identify and refresh the stale configuration items (CIs) in the Configuration Management Database (CMDB).
\r\nAuthor | Emir Eminovic, Callan Bond | |
Date | 05/01/2025 | |
Addresses HSD # | HSD0002998, HSD0003550 | |
Applicable ServiceNow Releases | All Releases | |
Time required | Approximately 1-4 Hours |
\r\n\r\n
\r\n
Note: As you follow the instructions in this playbook, you may need help from people in the following roles:
\r\n\r\n\r\n
A stale configuration item (CI) is one that you have not updated within a specific number of days (for example, 90 days).
\r\nStale CIs can lead to:
\r\nHow this playbook can help you achieve your business goals
\r\n\r\n
How this playbook is structured
\r\nThis playbook guides you through three plays.
\r\n\r\n
\r\n\r\n\r\n
The following can create stale CIs:
\r\n\r\n\r\n
Data Consequence
\r\nOperation Consequence
\r\nApplication Consequence
\r\nStale CIs can cause you to make incorrect decisions about data at the application level. Stale CIs can also adversely affect your high-priority business initiatives.
\r\n\r\n\r\n
Consider the answers to these questions:
\r\n\r\n\r\n\r\n
The table below lists and summarizes each of the remediation plays in the playbook. Details are included later.
\r\n\r\n Play Name \r\n | \r\n \r\n | \r\n \r\n |
\r\n Analysis \r\n | \r\n What this play is about \r\n | \r\n Lets you see if you have any stale CIs in the CMDB. \r\n |
\r\n Required tasks \r\n | \r\n If you have stale CIs, run a script to get details. \r\n | |
\r\n Fix \r\n | \r\n What this play is about \r\n | \r\n Lists the methods you can use to refresh the stale CIs. Methods vary according to the root cause. \r\n |
\r\n Required tasks \r\n | \r\n Use one or more of the available methods to refresh the stale CIs. \r\n | |
\r\n Data Governance \r\n | \r\n What this play is about \r\n | \r\n Lists the methods you can use to limit the number of stale CIs. \r\n |
\r\n Required tasks \r\n | \r\n Use one or more of the methods to limit the number of stale CIs, and ensure data accuracy. \r\n |
\r\n\r\n
What this play is about
\r\nThis play helps you identify stale CIs in your CMDB. To first find your stale CI’s CMDB health score and a list of details, use the CMDB and CSDM Data Foundations Dashboards.
\r\n\r\n
Required tasks
\r\n\r\n
View the ServiceNow docs site to learn more about installing and configuring the Dashboards if you are setting them up for the first time.
\r\nStep 2: Navigate to the CMDB Data Foundation Dashboard
\r\n
Step 3: Navigate to the “Data Management Practices” tab and review the “Active Cis updated in Last 90 days” metric.
\r\n
This metric looks only at Operational records in the Hardware and VM instance classes. If your score shows 100%, there are no stale Cis in those classes and so no further action is required. However, this metric should be reviewed monthly.
\r\nStep 4: Click on the historical graph widget below to review individual records.
\r\nFirst you must disable “Real time score” (small clock icon beside the date) and then enable “Show Records”.
\r\n
Doing this will display individual records that have not been updated in 90 days or more. You may group by Class or Location to do further analysis to determine the cause of the Stale records.
\r\n
In general, there are one of two reasons a CI record shows as stale:
\r\nThe equipment is still actively in use and on the network, but it is not getting picked up by Discovery or another tool or data load, and thus is showing as stale in the CMDB. If the CI were being properly discovered, it would be showing as Operational with a recent Updated date (Fix Plays A – D below).
\r\nOR
\r\nThe equipment is no longer on the network, and the stale record should be retired and/or archived from the CMDB (Fix Play E below).
\r\nAlternatively, and typically for a smaller percentage of potential stale records, the equipment may also be in maintenance and off network while the Operational status has not been updated properly to account for this change.
\r\nYour analysis by Class and Location above can provide some hints as to the root cause. For example, if an inordinate number of stale records are all at a single location, it may be that the Discovery schedule running at that location has an issue and should be investigated. You may also notice a large number of records associated to a CI class that is no longer in use at your organization or using an outdated naming structure, and so realize they are likely remnants from a previous data load and should be Retired and Archived.
\r\n\r\n\r\n
\r\nWhat this play is about \r\n
This play lists the methods you can use to refresh the stale CIs. Choose one of five methods (described below), based on the output of your analysis using the CMDB Data Foundations Dashboard “Active CIs Not Updated in 90 Days” metric.
\r\nImportant: Careful review helps you identify the root causes, which then helps you decide which refresh method to use. If you have more than one root cause, you need to address all of them.
\r\nRefresh the category with the largest number of stale CIs first, or refresh the stale CIs in your most important CI classes.
\r\nThe table below lists the root cause and the corresponding method to choose.
\r\n\r\n \r\n \r\n\r\n \r\nWhat is causing the stale CIs (root cause) \r\n | \r\n \r\n \r\n\r\n \r\nMethod to use \r\n |
\r\n \r\n \r\n\r\n \r\nDiscovery \r\n | \r\n \r\n \r\n\r\n \r\nMethod A \r\n |
\r\n \r\n \r\n\r\n \r\nThird-party applications \r\n | \r\n \r\n \r\n\r\n \r\nMethod B \r\n |
\r\n \r\n \r\n\r\n \r\nData Imports \r\n | \r\n \r\n \r\n\r\n \r\nMethod C \r\n |
\r\n \r\n \r\n\r\n \r\nManually entered CI records \r\n | \r\n \r\n \r\n\r\n \r\nMethod D \r\n |
\r\n \r\n \r\n\r\n \r\nLegacy CI records \r\n | \r\n \r\n \r\n\r\n \r\nMethod E \r\n |
\r\n
Method A: Root cause — Discovery does not refresh the CIs
\r\n\r\n
Method B: Root cause — Third party applications are not refreshing the CIs
\r\nMethod C: Root cause — ImportSets are not updating the CIs
\r\nCIs that have been manually imported but are now stale may fall into one of two categories.
\r\nThe first is that the CIs may be hardware that really should be discovered automatically. If this is the case, consider identifying if Discovery or another discovery tool that is already in use at your company can instead be used to discover the CIs. This is ideal as state of CIs may change, and automated tools often are able to discover more attributes than whatever was in a manually populated data set.
\r\nThe second is that the CIs may be legacy hardware that cannot easily be discovered. For example, some customers have a handful of mainframe computers that are still operational and need to be tracked in the CMDB.
\r\nIn the out of the box Data Foundations Dashboards all hardware CIs are included in the score calculation, so the stale legacy CIs will be included. These typically make up a small portion of an organization’s overall hardware footprint. You may however consider excluding these classes from detailed analysis described earlier in this playbook.
When setting up Data Manager policies for retiring CIs, specific classes can be excluded. In this case those legacy classes (e.g., mainframes), should be excluded from Retirement policies. More information on using Data Manager is in the Data Governance Play section of this KB.
Method D: Root cause — Manually entered CIs are not being updated
\r\nMethod E: Root cause — Stale CIs are remnants of the legacy CMDB records
\r\n\r\n
What this play is about
\r\nTo help maintain freshness of data in your CMDB, you should use Data Manager to create Retire and Archive policies.
Required tasks
\r\nUse Data Manager to create Retire and Archive policies
\r\nData Manager is the tool to create and manage your Retirement and Archival policies of your CMDB Data. You can create policies that will run nightly that help maintain the hygiene of your CMDB.
\r\nStep 1: Navigate to Data Manager, either from CMDB Workspace or directly from the left navigation bar.
\r\n
Step 2: Review Retirement Definitions and adjust as needed.
\r\nReview the default Retirement Definitions within Data Manager. Retirement Definitions serve two purposes.
\r\nFirst, they allow you to specify what lifecycle fields on a CI are set, and to what values, when Data Manager policies ‘retire’ a CI.
\r\nSecond, the definitions are used when an Archive policy is looking for ‘retired’ records. It will select all records that match the active Retirement Definitions.
\r\nUpdate your Retirement Definitions as needed for your environment and lifecycle management processes. Note that out of box only the root cmdb_ci Retirement Definition is ‘Active’. All other Definitions are inactive unless set otherwise.
\r\n
In the out of box example above, when a Retirement Policy is triggered on a CI, it will set the Life Cycle Stage to End of Life and the Life Cycle Stage Status to Retired, in accordance with the Retirement Definition above. In addition, when an Archive Policy is run, it will Archive any CIs that meet the Retirement Definition (Life Cycle Stage is End of Life and Life Cycle Stage Status is Retired).
\r\nA Retirement Definition at a more granular level overrides any retirement definitions higher up in the hierarchy.
\r\nStep 3: Create your Retirement Policy
\r\nA Retirement policy will Retire (set fields identified by your Retirement Definitions) CIs that match the filter criteria you set in the policy.
\r\nTypically, you should retire CIs that have not had been updated (Updated / sys_updated_on field) for more than 60 days, and that are currently in an operational state.
\r\nRefer to ServiceNow docs for full details on creating a Retirement policy. In general you will:
\r\nData Manager will display how many records will be affected by the conditions set in your Retirement policy. Start small and for your first policy, adjust the filter so that only a few hundred records are affected. After the policy runs (default is nightly), review the retired records and ensure the results are as expected.
\r\nStep 4: Create your Archive Policy
\r\nOnce records are Retired, they can be Archived. Follow steps similar to the creation of a Retirement policy, however fewer filter conditions are usually needed as an Archive Policy can simply archive whatever records have been set to Retired.
\r\nAs with Retirement policies, you can set whether manual approval is needed prior to Archiving records. In addition, you can specify in Data Manager how long Archived records are retained prior to being deleted permanently from the CMDB. This value should be set in accordance with your organization’s record retention policy for the type of data that is being archived. Ensure you consult with appropriate data stewards within your organization before setting retention periods for Archived records. Once data is purged from Archived tables it cannot be recovered.
\r\n\r\n
Congratulations
\r\nYou have completed this Get Well Playbook.
\r\n\r\n
\r\n