Creating an extended integration for Netbox assets

Let Oomnitza be your single source of truth!

You’ll get complete visibility of your assets as data from Netbox is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Netbox 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 assets with your colleagues and management

Navigation

Adding the credentials

Creating the asset integration

Creating custom mappings

Before you start

When you create the integration with Oomnitza, you need to supply the following information:

• Your Netbox API Key. To create a key, navigate to the API tokens page under your user profile. More information on Netbox's REST API can be found in the Authentication section on the Netbox Documentation website.
• Your Netbox URL.

Adding the credentials

To add your Netbox credentials in Oomnitza, complete the following steps:

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. On the INFORMATION tab, complete these actions:
   1. Add the name of the credential.
   2. Add the name of the owner. 
2. Ensure that API Key is selected as the Authorization type.
3. Ensure that the Token Name is Authorization 
4. Enter your API Key. 
5. Select Header from the Add to dropdown.

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. 

Creating custom mappings

Map Netbox fields to Oomnitza fields to get the asset information that you need. For the field mapping, it is recommended to follow these steps:

1. Click Smart Mapping.
2. You have the option to create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza assets field.
   3. Change the name of the field.
   4. Click CREATE. 
3. Map and assign a sync key to the Serial Number field.
4. Click UPDATE.

Standard mappings

Asset Tag
Changed at
Cluster
Comments
Created at
Device Role
Face
Manufacturer
Model
Name
Platform
Position # in rack
Primary IP
Primary IPv4
Primary IPv6
Rack
Serial Number
Site
Status
Tenant

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.