ServiceNow integration
Overview
The NetBox ServiceNow Integration provides API and CMDB integration capabilities between ServiceNow and NetBox instances. This application enables bidirectional synchronization of infrastructure data, allowing organizations to maintain consistent configuration management data across both platforms.
Version Information
- Application Version: 2.0.0
- ServiceNow Compatibility: Certified for Yokohama and Zurich versions.
- Dependencies:
- Configuration Management (CMDB)
- IntegrationHub
- Workflow Studio v26 or later
Documentation
Complete documentation for the NetBox ServiceNow Integration is organized into the following guides:
| Document | Description | Target Audience |
|---|---|---|
| Release Notes | Release features and bug fixes | End Users, System Administrators |
| Known Issues | Known issues, workarounds, and resolution status | All Users |
| Installation and Setup | Step-by-step installation guide, system requirements, and initial configuration | ServiceNow Administrators, Integration Specialists |
| Upgrading | Upgrade procedures and version migration instructions | ServiceNow Administrators |
| User Guide | Complete user guide including configuration, data synchronization, use cases, and best practices | End Users, System Administrators, Integration Specialists |
| FAQ and Troubleshooting | Frequently asked questions and troubleshooting guidance | All Users |
| Technical Information | Technical details, table schemas, API information, and logging | Developers, Technical Specialists |
Key Features
- Bidirectional Synchronization: Synchronize configuration items between ServiceNow CMDB and NetBox
- Automated Data Import: Import NetBox objects (devices, device types, sites, locations, etc.) into ServiceNow through import sets
- Real-time Integration: API-based integration for real-time data exchange
- Data Validation: Built-in validation and correlation mechanisms to ensure data integrity
- Duplicate Prevention: Based on ServiceNow's IRE, CIs are subjected to the same identification rules as your current implementation
- Extensible Architecture: Modular design using ServiceNow Flow Designer and IntegrationHub actions
- Security Integration: Role-based access controls and secure API communication
NetBox to ServiceNow Object Mapping
The following table shows the supported NetBox objects and their corresponding destinations in ServiceNow:
| NetBox Object | ServiceNow Destination | Mapping Details |
|---|---|---|
| Device | Configuration Item (cmdb_ci) | Mapped to appropriate CI class based on device role and type |
| Device Type | Hardware Product Model (cmdb_hardware_product_model) | Device specifications, manufacturer, and model information |
| Site | Location (cmn_location) | Physical site information and geographical data |
| Region | Location (cmn_location) | Geographic regions as top-level locations |
| Manufacturer | Company (core_company) | Vendor/manufacturer information |
| Tenant | Department (cmn_department) | Organizational units and client information |
| Device Role | CI Classification | Maps to ServiceNow CI classification and categories |
Field mappings are listed in the technical documentation.
Business Value
- Centralized configuration management across multiple platforms
- Reduced manual data entry and associated errors
- Improved visibility into infrastructure assets
- Enhanced change management processes
- Streamlined compliance reporting
Technical Architecture
The application is built as a ServiceNow scoped application (x_nbl_cmdb) and includes:
- Custom tables for NetBox data import staging
- A centralized NetBox Attributes table (
x_nbl_cmdb_netbox_attributes) that stores all NetBox-specific metadata for ServiceNow records (no custom fields added to base tables) - Flow Designer flows for automated synchronization processes
- IntegrationHub spokes for NetBox API connectivity
- Business rules and UI actions for user interaction
Obtaining the Application
Install NetBox Labs CMDB Integration from the ServiceNow Store. The scoped application identifier is x_nbl_cmdb (display name NetBox Labs CMDB Integration). Use Application Manager or your instance’s store navigation to install it; you need ServiceNow administrator privileges and any licenses your organization requires for the app and its dependencies (see Installation and Setup).
Prerequisites (before installing):
- ServiceNow Instance: Active instance with appropriate licensing for the store app and dependencies
- NetBox Environment: Operational NetBox instance with API access (for configuration after install)
- Administrator Access: ServiceNow administrator privileges for application installation
- ServiceNow MID Server (NetBox Enterprise Only): When required for your topology, a MID server on-premises to handle communication between ServiceNow and NetBox Enterprise