Creating an extended integration for FortiManager assets

Sync Oomnitza with FortiManager to gain visibility of asset data.

Before you start

To create the integration, you must retrieve the following information from FortiManager:

Integration information

• FortiManager URL. The format of the IP address is as follows: https://<fortimanager-ip-address>. Example: https://111.222.333.444. See Connect to FortiManager.
• FortiManager Device Filter Fields. You can use filters, such as name, serial number, and object identifier in a comma-separated list to refine the information that is retrieved. The format of the field filter is as follows: 

["name", "sn", "oid", "hostname", "ip", "vdom"]

Ensure that you include a unique field such as "sn" in the filter and map it to the Oomnitza Serial Number field. 

The following information is provided to help you create filters. Always check your FortiManager documentation to verify.

Field filter value	Description
"adom"	Administrative domain
"name"	Device name
"ha_mode"	High-availability status
"hostname"	System hostname
"ip"	Management IP for the device
"oid"	Object ID. A numeric identifier that FortiManager assigns to all objects
"sn"	Serial number
"vdom"	Virtual Domain

Review the FortiManager documentation to find the device field names that can be used as filters. To access some articles, you require a Fortinet account.

Add session-based credentials information

To add credentials to Oomnitza, you must retrieve the following information from FortiManager.

See FortiManager session based authentication. 

• FortiManager IP address. 
• FortiManager User and Password. In FortiManager, go to System Settings > Administrators and click the Create New dropdown and select Administrator. See Creating administrators for the FortiManager API. 

Related FortiManager documentation

How to FortiManager API

FortiManager document library

FortiNet developer network. A FortiNet account is required to access the documentation.  

Adding credentials

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. Enter your session-based credentials and any other additional information.
5. Click CREATE.

Information
If the integration is not listed, click Advanced Mode, and add your credentials.

Creating an integration user

To easily find the records that are uploaded to Oomnitza, it's best practice to create a dedicated user account for each integration. This will make it easier for you to retrieve the records that are uploaded to Oomnitza from the vendor application. 

Creating integration users 

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:

Software data

Depending on the asset integration, an option might be available to ingest desktop software information such as the name and version of the software installed on an asset. To view the software information in Oomnitza, you must have the software module. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Integration details

To review or update the integrations details, click Edit .

When you edit the Integration details section, you can select the name or names of integration contacts.  Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.

1. Update the integration name.
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

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Select Edit integration to add rules for syncing data. Filtering integration results.  

Click SMART MAPPING.

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Mappable fields

Map the fields that are retrieved by the device filter to Oomnitza.

Mapping the SN (serial number field) to Oomnitza

1. Click Edit next to the Mapping section.
2. On the SN field, click the down arrow .
3. From the list, select Serial Number.

Result

The SN field is mapped to the Oomnitza Serial Number field. 

Next

Select the Serial Number field as the sync key.

You can repeat this procedure to map FortiManager fields to Oomnitza fields.  

Adding a new field

If, for example, an equivalent field is not available in Oomnitza, you can create a new field.

1. Click Edit next to the Mapping section.
2. Click the down arrow .
3. Select Add new Oomnitza field.
4. Enter a unique user-friendly name.
5. Click CREATE.

Selecting sync keys

You must select at least one field as the sync key field. To ensure that the sync runs successfully, the field must contain unique values such as the serial number of an asset record or the email address of a user record. Records that do not contain a value for the sync key are skipped.   

See Configuring multiple sync keys.

Drag and drop

You can map additional fields to Oomnitza.

1. Drag and drop the fields in the Oomnitza column.
2. Rename the field.
3. Make your changes.
4. Save your changes.

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