- 4 Minutes to read
-
Print
-
PDF
ServiceNow CMDB
- 4 Minutes to read
-
Print
-
PDF
About this document
This document gives you the step-by-step procedure to configure ServiceNow CMDB in SAFE.
Introduction
SAFE integrates with the ServiceNow CMDB (Configuration Management Database) via REST APIs and updates the assets in SAFE. This reduces the need for managing assets on SAFE separately.
A SAFE Admin can configure the ServiceNow CMDB from Safe hooks.
Prerequisites
To configure ServiceNow CMDB in SAFE, you need the following details:
- Instance Name: Instance name of the user’s ServiceNow Instance (E.G: safe.service-now.com)
- User Credentials: The minimum access required for the user account on ServiceNow is cmdb_read
- Client ID and Secret Key: Follow the below steps in ServiceNow to get the Client ID and Secret Key
- Go to System OAuth> Application Registry.
- Create a new OAuth Client type by clicking 'OAuth API endpoint for external clients' or click on any of the existing OAuth Clients listed.
- Copy the Client ID and Client Secret Key from the respective fields.
- Go to System OAuth> Application Registry.
Mapping for ServiceNow CMDB assets to SAFE
On import, SAFE maps each ServiceNow Configuration item (CI) to a Technology vertical in SAFE. Different ServiceNow CI classes require different sets of mandatory fields for SAFE to map the CI correctly to an Asset Type. If any mandatory field is not populated, then the corresponding CI will be fetched as an Unconfirmed Asset. The list of mandatory fields against each ServiceNow CI class is described in the table below.
SAFE Vertical | SAFE Asset Type | Classes in ServiceNow | Mandatory Fields |
---|---|---|---|
Databases | Oracle <version> | cmdb_ci_db_ora_instance | Name Version IP Address |
MS SQL <version> | cmdb_ci_db_mssql_instance | ||
MySQL <version> | cmdb_ci_db_mysql_instance | ||
MongoDB <version> | cmdb_ci_db_mongodb_instance | ||
PostgresSQL <version> | cmdb_ci_db_postgresql_instance | ||
IBM Db2 <version> | cmdb_ci_db_db2_instance | ||
SAP HANA Database <version> | cmdb_ci_appl_sap_hana_db | ||
Network & Security Nodes | See SAFE Support Matrix for supported asset types - SAFE Support Matrix | cmdb_ci_ip_firewall | Name Manufacturer Version IP Address |
See SAFE Support Matrix for supported asset types - SAFE Support Matrix | cmdb_ci_ip_router | ||
See SAFE Support Matrix for supported asset types - SAFE Support Matrix | cmdb_ci_ip_switch | ||
F5 Big Ip | cmdb_ci_lb_bigip | Name Version IP Address | |
End Points or Server Note - Asset type will be mapped to the Technology Vertical on the Operating System | See SAFE Support Matrix for supported asset types - SAFE Support Matrix | cmdb_ci_computer | Name OS OS Version |
Web Applications Note: Java and ASP.NET are the only asset types supported. | JAVA | cmdb_ci_app_server_java | Name IP Address with the URL of the application or a custom field with the CI’s URL. If the custom field is present then update the environment variableSERVICENOW_WEB_APPLICATION_URL_FIELD to the custom field name in .env file. |
ASP.NET | cmdb_ci_appl_dot_net | ||
Middleware | See SAFE Support Matrix for supported asset types - SAFE Support Matrix | cmdb_ci_app_server_tomcat | Name Model number |
See SAFE Support Matrix for supported asset types - SAFE Support Matrix | cmdb_ci_app_server_websphere | Name Model number | |
See SAFE Support Matrix for supported asset types - SAFE Support Matrix | cmdb_ci_microsoft_iis_web_server | Name Model number | |
See SAFE Support Matrix for supported asset types - SAFE Support Matrix The manufacturer is required to determine between Domain and stand-alone servers | cmdb_ci_app_server_jboss | Name Manufacturer Model number |
Required Mapping Information
Please complete the following tables for each CI Class the organization would like to map to a SAFE technology vertical.
The supported Asset Types by SAFE can be found in SAFE Support Matrix
End Points and Server
End Points and Servers are mapped by the combination of their CI Class, Operating System, and Operating System version to SAFE Asset Types and Technology Verticals.
Complete the following table to map the values of your ServiceNow CI cmdb_ci_computer class Operating System and Versions to SAFE Endpoint or Server Asset Types. Please provide all of the CI versions for a given CI Operating System.
ServiceNow CI Operating System | ServiceNow CI Version |
---|---|
Example | |
Windows | 7, 10 |
Windows Server | 2008, 08 |
Windows Server | 08, 8 |
Windows Server | 2008, 8 |
Network & Security Nodes
Network & Security Nodes are mapped by the combination of their CI Class, Manufacturer, and their version to SAFE Asset Types and Technology Vertical.
Complete the following table to map your ServiceNow CI Class, Manufacturer, and Versions to SAFE Database Asset Types. Please provide all of the CI versions for a given CI Manufacturer.
ServiceNow CI Class | ServiceNow CI Manufacturer | ServiceNow CI Version |
---|---|---|
Example | ||
cmdb_ci_ip_firewall | Checkpoint | 76, 77 |
cmdb_ci_ip_firewall | Fortinet | 4, 5 |
cmdb_ci_ip_switch | Cisco | 12, 15 |
Web Applications
Web Applications are mapped by the combination of their CI Class and their version to SAFE Asset Types and Technology Vertical. The ServiceNow Web Application CI Class to SAFE Asset Type mappings are described in Table above.
All Web Applications that are contained in cmdb_ci_app_server_java will be mapped to the “JAVA” asset type.
All Web Applications that are contained in cmdb_ci_appl_dot_net will be mapped to the “ASP.NET” asset type.
Databases
Databases are mapped by the combination of their CI Class and their version to SAFE Asset Types and Technology Vertical. The ServiceNow Database CI Class to SAFE Asset Type mappings are described in the Table above.
Complete the following table to map your ServiceNow CI Class and Versions to SAFE Database Asset Types. Please provide all versions for the given CI Class.
ServiceNow CI Class | ServiceNow CI “Versions” values |
---|---|
Example | |
cmdb_ci_db_ora_instance | 19c, 19 |
Configure ServiceNow CMDB
SAFE Admin can configure the ServiceNow CMDB from Safe Hooks. To configure:
- Navigate to Safe Hooks.
- Click the Configure button available on the ServiceNow CMDB option. The system opens the ServiceNow CMDB Configuration page.
- Enter the Instance Name.
- Enter the Username and Password.
- Enter the Client ID and Client Secret Key.
- Enter the Auto-Sync Frequency (In Days).
- Click the Test Connection button.
- Once the connection is verified, click the Save button to save the configuration.
- To sync the assets once the connection is verified, click the Sync Now button available at the bottom-right corner of the screen.
FAQs
1. What state will assets that have been retired in SAFE be in after the next ServiceNow CMDB Sync?
Assets that have been onboarded into SAFE via the ServiceNow CMDB integration and later retired will remain in a retired state even if matched in a future ServiceNow CMDB sync.
2. What state will assets that have been deleted from SAFE be in after the next ServiceNow CMDB Sync?
Assets that have been onboarded into SAFE via the ServiceNow CMDB integration and later deleted will be onboarded again as new assets if matched in a future ServiceNow CMDB sync.