Creating an extended integration for Nautobot assets

Let Oomnitza be your single source of truth!

The Nautobot Asset Load uses the Device List API. For further information, see Nautobot API Documentation: List Devices. 

Choose the Nautobot asset integration for Oomnitza to gain complete visibility of your assets as data from Nautobot is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Nautobot in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key asset information
• Configurable reports to share information about asset with your colleagues and management
• Configurable asset workflows that you can easily create to automate tasks such as:
  • Retrieving Primary IPv4 and or IPv6 details
  • Platform details
  • Device location details

Navigation

Create the asset integration

Custom mappings

Before you start

Before you can create the integration with Oomnitza, you need to have added your Nautobot credentials to Oomnitza.

When you create the integration, you will need to enter your full Nautobot URL, for example https://demo.nautobot.com

Creating the asset integration

1. In Oomnitza, click Configuration> Integrations> Overview.
2. Click Block view
3. Scroll down to the Extended section for asset integrations.
4. Click NEW INTEGRATION.
5. Select the integration in the sidebar.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

Installation type

Select Cloud if you want to store credentials in the Oomnitza cloud.

Select Local if you want to store credentials locally. Local extended integrations do not support AWS and OAuth authentication. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select Cloud.

Integration preferences

By default, the option Create & Update option is selected. Select this option  when you want to edit records and add new records. If you want to edit records and not add new records, select Update Only. If you only want to add new records, select Create Only.

Integration details

To review or update the integrations details, click Edit .

1. Update the integration name if necessary. 
2. Select an installation type.
3. For integration preferences, select an option.
4. Enter the name of the integration user.

Credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Schedule

By default, data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Click the Edit .
2. Configure your schedule.
3. Click Update.

Mappings

To map the fields to Oomnitza, click Edit .

You can define rules for your integration by selecting Edit integration on the mapping page. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  
You can add new fields to your integration by selecting Add new field   on the mapping page. All you need to do is specify the property name. See Creating custom API fields. 

Custom mappings

Map the Nautobot fields to Oomnitza fields and create custom mappings to get the asset information that you need.

Complete these actions:

1. Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. Create a custom mapping for the ID. Complete the following steps:
   1. Click the down arrow on the ID field.
   2. Select Add new Oomnitza field.
   3. Change the name of the field to Nautobot Device ID.
   4. Select the Unique checkbox.
   5. Click CREATE. 
3. (Optional) Create custom mappings for the Nautobot Platform ID, Nautobot Location ID, Nautobot Primary IPv6 ID, and Primary IPv4 ID if you intend to create workflows.
4. Assign a sync key to a unique field, such as the Serial Number.
5. Click UPDATE.

Tracking information for asset loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:   

• Connect: Credentials
• Connect: Nautobot URL

Standard Nautobot to Oomnitza Asset Load mappings

Asset Tag
Changed at
Comments
Connector Sync Time
Created at
Device Type
Id
Location ID
Manufacturer ID
Model
Name
Natural Slug
Part Number
Platform ID
Position # in rack
Primary IPv4 ID
Primary IPv6 ID
Serial Number

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See Getting started for more information.