How to integrate Auvik with ServiceNow CMDB

Prerequisites

The following prerequisites are required for setting up the integration.

• An active ServiceNow subscription for ITOM Visibility or ITOM Discovery (based on Subscription Units)
• Sufficient available Subscription Unit capacity in your ServiceNow environment
• Integration Commons for CMDB (2.21.0 or higher)
• CMDB CI Class Models (1.75.0 or higher)
• SGC Central (2.1.0 or higher)
• ITOM Licensing (1.0.0 or higher)
• ITOM Discovery License (1.0.0 or higher)
• Flow Designer
• Flow Templates for IntegrationHub Enterprise
• Platform Core: Integration Hub
• API read access in Auvik
• App admin and auvik_mapping_user_admin access in ServiceNow

Planning

The Auvik–ServiceNow CMDB integration makes it easy to sync your device inventory into the ServiceNow CMDB using out-of-the-box defaults. At the same time, the Service Graph Connector offers flexible configuration options so you can tailor the integration to your specific requirements. Reviewing these options ensures your device inventory is synchronized in a way that best fits your organization’s needs. 

Review default class mapping and field mapping

Determine which Auvik device classes that you want to sync to ServiceNow CMDB. You can find what Configuration Item (CI) classes they are mapped to in What is the default device class mapping for the Auvik - ServiceNow CMDB integration? See How to update Auvik device classes to sync to ServiceNow CMDB to change the default mapping.

You can also see what fields are synced for each CI class in What is the default field mapping for the Auvik - ServiceNow CMDB integration? See How to change the default field mapping for Auvik - ServiceNow CMDB integration to change the default mapping. 

Review identification rules

You may have to update or add identification rules to sync specific Auvik device classes. Review the following to see which ones apply to your situation.

• No identification rules - The default target CI class for the following Auvik device classes do not have identification rules out-of-the box. Identification rules must be added to allow the creation of the CI. If you need to add an identification rule, see Create or edit a CI identification rule.
  • Air Conditioner is mapped to HVAC Equipment in ServiceNow
  • Intelligent Platform Management Interface is mapped to Out-of-Band Device in ServiceNow
  • IP Phone and Phone is mapped to IP Phone in ServiceNow
  • Telecommunications Device is mapped to Communications Device in ServiceNow
• Multiple devices match the same identifier - If there are multiple Auvik devices that match the same identification rule, then the same CI will be updated. For example, Linux Auvik Collectors have the same name and the minimum required identifier for the Computer Class is name. There are multiple options to resolve this depending on your situation:
  • Update the identification rules for the current CI class, so that each device has unique identifiers. For example, suppose the minimum is name and there are multiple devices that have the same name, you can consider raising the minimum to name and serial number. See Create or edit a CI identification rule to add a new identification rule.
  • Map the minimum identifier to a new identifier. For example, suppose the minimum identifier is name. You can map the name field for that CI class to a concatenation to device name and ID. See Preview and prepare data in Create an ETL transform map.
  • Add a new CI class and add an identification rule, so that each device has unique identifiers. See Create a CI class. For Linux Auvik Collectors, the solution may be to add a class for Auvik Collectors and set an identification rule that requires both name and serial number because every Linux Auvik Collector will have a unique serial number.
• Missing required identifiers - If a device is missing required identifiers, the device won’t be matched or created in ServiceNow CMDB. In this case, add the required credentials in Auvik to retrieve the required identifiers. If this is not possible, you can try to relax the identification rules. For example, if the identification rule requires name and serial number and the majority of devices will only have names and they are unique, then the identification rule might be relaxed to require name only.

For a complete overview, see CMDB Identification and Reconciliation (IRE) and Identification rules.

Review reconciliation rules (if necessary)

If you have multiple discovery sources for the same CI class, you may need to update or add reconciliation rules to account for Auvik as another discovery source. See Create a reconciliation rule on how to do this.

For a complete overview, see CMDB Identification and Reconciliation (IRE) and Reconciliation rules.

Note: Reconciliation rules are domain-specific.
 

Setting Up The Auvik Service Graph Connector

Step 1: Install the Auvik Service Graph Connector

Install the Auvik Service Graph Connector in the ServiceNow App Store.
 

Step 2: Open the Guided Setup in ServiceNow

Open the guided setup in ServiceNow from:

Service Graph Connector for Auvik → Guided Setup
 

Step 3: Configure the Connection to Auvik

Generate an Auvik API Key

Follow Generating an API Key in Auvik to obtain an Auvik API key.
 

Identify Your Auvik API Region

Obtain your Auvik API region, by checking your browser URL when logged into Auvik.

• Example: us2.my.auvik.com → region is us2.

See How do I know which region I’m in? for additional details.
 

Update the Region in ServiceNow

1. In ServiceNow, open the Auvik API connection record.
2. Replace [YOUR_REGION] in the Connection URL with your region (e.g., us1, us2, eu1). Note: The URL must be in the format: https://auvikapi.[YOUR_REGION].my.auvik.com/v1 where [YOUR_REGION] is replaced with the region you are in.
3. Click Update.
    

Create an Auvik Credential Record

1. In ServiceNow, create a credential record for the Auvik connection.
2. For Username, enter your Auvik email address.
3. For Password, enter the API key generated earlier.
4. Click Update.
    

Test the Connection

1. In ServiceNow, open the Auvik API connection record.
2. Click Test Connection under Related Links.

The system will attempt to connect to the Auvik API — this may take a few moments. Once complete, the page refreshes automatically to display the test results.

1. The connection is successful if the HTTP Status is 200.
2. If you see an Error Code or Error Message, the connection failed and additional troubleshooting is required.

For troubleshooting API connections, see How do I troubleshoot issues using the Auvik API?.

Step 4: Map Auvik Tenants to ServiceNow Companies and Locations

1. Import tenants from Auvik:
   • Open the Scheduled Data Import record.
   • Click Execute Now to fetch tenants from Auvik.

Note: Disabled tenants are omitted.

2. Map Auvik tenants to ServiceNow Companies and Locations:
   • Open the Auvik Tenants table in ServiceNow.
   • Map each Auvik tenant to the appropriate ServiceNow Company and Location by double clicking on the cell.
   • The Domain field updates automatically.
   • Select which Auvik tenants that you want to sync devices from. Change the mapped rows to Active by double clicking on the cell.

Notes: 

• The global site and multi-sites do not need to be mapped are marked as active. They are included for informational purposes only.
• If the ServiceNow instance is domain-separated, you may have to refresh the page to see the updated Domain field.
• When you are in a specific ServiceNow domain scope, you will only see tenant rows mapped to the current domain and the global domain. 

Step 5: Configure Device Sync System Properties

Define Which Devices Sync

• By default, firewalls, routers, and switches are included.
• You can:
  • Add more device classes (Inclusion list).
    1. Open an existing record where the Tenant field is empty and the Mapping Type field is Inclusion.
    2. Select additional device classes to include using the dropdown.
    3. Click Update.
  • Remove device classes (Exclusion list).
    1. Create a new record.
    2. Set the Mapping Type to Exclusion.
    3. Select the device classes to exclude using the dropdown.
    4. Check Active.
    5. Click Save.
  • Set rules per tenant (specific Inclusion or Exclusion).
    1. Create a new record.
    2. Select the desired tenant.
    3. Set Mapping Type to Inclusion or Exclusion.
    4. Select the device classes to include/exclude using the dropdown.
    5. Check Active.
    6. Click Save.
• Note: Exclusion rules take priority over inclusion rules.

See the Planning section for additional configuration required for certain Auvik device classes.

Optional Device Sync Settings

• Enable Delta Sync: Determines whether only new devices and modified devices are fetched or all devices are fetched on each sync.
  • Yes → Only imports changed records after the first full sync.
    • Note: If you add new device classes to sync OR add new mapped tenants, set Enable Delta Sync to No, perform a manual sync and re-set Enable Delta Sync to Yes.
  • No → Every run performs a full sync.
  • The default is Yes.
    • This avoids unnecessary API calls to fetch data that has not changed.
• Max devices per API page: Defines the maximum number of devices to request for each page of data from the Auvik API.
  • The default is 100 devices.
  • The maximum is 1000.
• Enable Debug Logging: This property enables detailed logging for tracking all Auvik import processes to troubleshoot issues.
  • The default is No.
• Fetch Discovery Status and Interface Details: This property enables fetching of device discovery status and interface details.
  • Note: This is only recommended for manual syncs on small sets of devices to avoid reaching the Auvik API rate limit.
  • You can still sync IP addresses using a custom attribute. See How to sync IP addresses without using Network Adapters for Auvik - ServiceNow CMDB integration on how to do this.
  • The default is No.
     

Step 6: Configure Scheduled Import Jobs

To keep your CMDB updated:

Tenant Sync Job

• Default: Disabled.
• Steps:
  1. Edit the Auvik Tenant Scheduled Import Job.
  2. Set Active = true.
  3. Set Run = Periodically and define frequency.
     • The default is set to run weekly at midnight local time.

Device Sync Job

• Default: Disabled.
• Recommended: Run daily.
• Steps:
  1. Edit the Auvik Device Scheduled Import Job.
  2. Set Active = true.
  3. Set Run = Periodically and define frequency.
     • The default is set to run daily at 3am local time.

Verification

After completing setup, verify that Auvik devices and tenants are appearing in your ServiceNow CMDB. See How to view configuration items in ServiceNow CMDB created by Auvik to find CIs created by Auvik.

Support

If you encounter issues, See How to troubleshoot issues with Auvik / ServiceNow CMDB.