Ubiquiti UniFi

One native integration that can be set up within Hudu is UniFi. Before setting up your UniFi integration, read our Understanding Integrations article to learn basic concepts and useful tips.

In order to setup an integration with UniFi, you will need:

  • UniFi domain.
  • Username and Password used to log into UniFi.
  • Admin or Super-Admin user role within Hudu.

    The unifi intgration is only compatible with locally hosted Unifi services; there is currently no API support for unifi.ui.com domains.

    At any time, you can come back to your Hudu admin area >> Integrations >> UniFi to make changes to the integration.

Prefer a video walkthrough of how to set up the Unifi integration? Here is a quick video guide on how to get started.

Integration Features

Hudu's integration with UniFi allows you to sync over:

  • UniFi Provided Devices
    • Pull device information from UniFi into an asset layout.
  • Client Devices
    • Pull client device information from UniFi into an asset layout. Note, that client devices older than 2 weeks will not be pulled in.
  • Guest Devices
    • Pull in guest device information from UniFi into an asset layout. 
  • Network Configurations
    • Pull in data about a specific network into an asset layout.
  • Port Forward Instances
    • Pull in information about a port-forwarded interface into an asset layout.
  • Backups
    • Pull in backup File Name and Backup Date from UniFi into an asset layout. 

What Hudu Needs From Unifi

  • UniFi Domain.
  • UniFi Username.
  • UniFi Password.

 

Guides

Enabling Integrations

Integrations can be enabled at any point during your Hudu environment testing and/or during production. They can be merged into your existing documentation based on set rules; providing the ability to start with integration setup, or easily connect them at a later date.

To enable the Unifi integration:

  • Navigate to Hudu Admin area Integrations.
  • Select UniFi from the list.
  • Enter your UniFi domain, Username, and Password into the provided fields.
    • For example: exampleco.test.com:1234.

    Make sure to test the integration for a successful connection before continuing; do not continue on until you see a connection successful message display.

 

Matching Unifi Sites

Before your UniFi sites (and their corresponding data) can be brought into Hudu, they must first be matched to companies that either already exist within your Hudu environment; OR to companies that you create now.

    Hudu recommends matching one site first, for testing purposes, to ensure that your information comes over correctly.

  • The first time your integration connection runs successfully, it will attempt to bring in sites from UniFi; these are then added to the Matched Companies List of that integration.
    • Navigate to your Hudu Admin area Integrations and find UniFi from the list. Click into it.
    • It should now have a button that says Match Companies.
    • Go through the list of companies and either bulk create/match all OR decide to:
      • Match the site to an existing (already created) client in Hudu,
      • Leave unmatched, site and corresponding data will not be created/brought into Hudu.
      • Change match, if the suggested match is not what you want.

1.png

  • After matching companies, stop and start the sync again to begin bringing in device types.
 

Select Sync Locations

The UniFi integration requires you to Select Sync Locations for Client (non-UniFi) devices, Guest Devices, Network Configurations, Port Forward Instances, and Backups as well as a Primary Sync Location for UniFi Devices. The Primary Sync Location will serve as your "junk drawer" asset layout; storing the information that is being pulled in, but not otherwise told where to be placed.

Connect_Unifi_-_TestCo.png

Connect_Unifi_-_TestCo.png

  • Navigate back to your Hudu admin area >> Integrations >> UniFi ((Edit Settings)).
  • Choose asset layouts (must be active asset layouts) from the list to designate as the primary sync locations.

    If you don't see/have not created any asset layouts yet, you’ll need to create these. Visit Asset Layouts for additional information!

 

Other Options:

  • Auto-update names of assets
    • Automatically update the names of assets if they are changed in UniFi.
  • Auto-archive deleted devices
    • Devices deleted in UniFi will be automatically archived in Hudu.
  • Do not update basic company details
    • Will not change company details that are already in Hudu.

unifi_otheroptions.png

    If you have more than one integration syncing into the same company and the names are different between integrations, this may cause companies in Hudu to be renamed. You'll want to make sure to have the 'Do not update basic company details' option checked.

 

Choose Data Types To Skip

Skip the following:

  • Inactive Companies
    • Skip bringing inactive companies in UniFi into Hudu.
  • All Devices
    • Skip syncing in all devices into Hudu from UniFi.

Skip Device Subtypes:

  • Backups
    • Skip syncing backup information into Hudu from UniFi.
  • Unifi Provided Devices
    • Skip syncing UniFi-provided devices into Hudu from UniFi.
  • Client Devices
    • Skip syncing in all client devices into Hudu from UniFi.
  • Guest Devices
    • Skip syncing all guest devices into Hudu from UniFi.
  • Networks
    • Skip syncing in network configurations into Hudu from UniFi.
  • Port Forward Data
    • Skip syncing in port forward data into Hudu from UniFi.

unifi_choosetoskip.png

Choose to skip specific Unifi Device Types

Unifi_Skip Device Types.png

 

Choose Layouts For Unifi Device Types

Sort rules allow you to select which data types (from UniFi) will be mapped into which asset layouts (within Hudu). They allow you to specify certain "rules" for asset types as to where they get placed; any asset types that are brought in but are not told where to be placed via sort rules will be placed into the corresponding primary sync location.

The asset layouts that you're choosing to sort into can be created beforehand (Hudu admin area >> Asset Layouts; ensure that they're marked active) OR you can create new asset layouts when selecting the sort rules for UniFi Device Types.
 
Unifi_Sort_Rules.png
 
Save your settings and stop/start your integration sync again to reflect your changes. 

 

FAQ

How often do integrations sync?

Answer: Native integrations will automatically re-sync (update) every 3 hours.
You can also use either the global or the card-specific re-sync features to refresh native integration syncs at any point.

Why is my integration taking a long time to finish?

Answer: Please note, the UniFi integration takes longer than most other integrations to sync. If the UniFi sync has been loading for a significant amount of time (it can take up to 15 minutes depending on the amount of data), follow the steps below:

  • Verify your UniFi credentials.
  • Test the connection to ensure Hudu and UniFi are communicating correctly.
  • Refresh the page (while a sync is actively running).
  • Stop the sync and restart the sync.
Accidentally deleted an integration card; how do I get this back?

Answer: It should appear on subsequent re-syncs. If it is still not appearing, ensure that it has not been archived; and still exists in your sort rules.

Notes: Active integrations sync automatically every 3 hours; manual re-syncs can be performed either within an integrations’ settings page or by clicking the top right re-sync button.

Does UniFi integration pull in VLAN networks automatically?

Answer: Since they are not defined with a subnet mask by default, UniFi Integration does not pull in VLAN networks automatically.

Why are Default UniFi networks being filtered out?

Answer: Default UniFi networks will be filtered out unless they are marked enabled.

Why am I getting a failed test connection?

Answer: The UniFi integration is only compatible with locally hosted UniFi services; there is not currently any API support for unifi.ui.com domains.

How can I integrate multiple Unifi controllers?

Answer: The UniFi integration cannot currently support multiple Unifi controllers.

Was this article helpful?
0 out of 1 found this helpful