Ubiquiti UniFi

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. 
• Guest Devices
  • Pull in guest device information from UniFi into an asset layout. Note, that Guest Devices older than 2 weeks will not be pulled in.
• 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.

Enabling the Unifi Integration

• Integrations can be enabled at any time, during Hudu environment testing or in production.

• Once enabled, integrations can be merged into existing documentation based on predefined rules.

• This allows you to configure the integration upfront or connect it later as needed.

• To enable the Unifi integration:

  • Navigate to the Hudu admin area (Admin → Integrations).

  • Select Unifi from the list.

Setting up the Integration in Hudu

Step 1. Connect to Unifi

• Enter Unifi domain
  • For example: exampleco.test.com:1234
• Enter Username and Password
• Select any additional options:
  • Auto-update names of Assets - If name is changed in Unifi, the name will automatically be updated in Hudu
  • Do not update basic company details - This will prevent the company details from being changed in Hudu if they are changed in Unifi
  • Match assets on primary serial - This option tells Unifi to match devices using their primary serial number. It helps ensure that assets are correctly identified and reduces the chance of duplicates when device names or other attributes change.

Step 2. Choose Data Types to Skip (optional)

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.

Step 3. Test Connection and Run an Initial Sync

• On the integration overview page, click Test Connection
• If successful, start an initial sync to bring in Unifi clients/companies

Step 4. Match Unifi Sites

• Before Sites from Unifi can be brought into Hudu, they must be matched to:

  • Existing companies in Hudu, or

  • New companies you create in Hudu

• Hudu recommends matching one client first for testing to ensure data imports correctly

• When the integration runs successfully for the first time:

  • Clients from Unifi are imported

  • They appear in the Matched Companies List for the integration

• Navigate to Hudu Admin → Integrations → Unifi

• Open the integration and click Match Companies

• Review the list of companies and choose one of the following options:

  • Bulk create and/or match all companies

  • Match a company to an existing Hudu company

  • Create a new matched company in Hudu from a Unifi company

  • Leave a company unmatched (it and its data will not be imported)

• After matching companies, re-run the integration import to populate data for the matched or newly created companies

Step 5. Run a sync to pull in device types

After companies are matched, you will need to start a second sync to bring in the Unifi device types.

Step 6. Select Unifi device types to skip

You will need to run a sync first to bring in the ability to skip configuration types, then return the the integration page to choose which types to skip.

Step 7. Choose Asset Layouts for each device type

• Select Default Asset Layout

  • Choose an asset layout (must be an active asset layout) from the list to designate as the default asset layout

  • This will store information that is pulled in but not explicitly mapped to another asset layout

• The Unifi integration requires one default asset layout for:

  • Unified provided devices

• Add Sort Rules

  • Sort Rules determine how data types from Unifi are mapped to asset layouts in Hudu

  • They let you define specific rules that control where each asset type is placed

  • Any asset types imported without an assigned Sort Rule will automatically be placed into the default asset layout

  • Asset layouts used for Sort Rules can be created ahead of time in the Hudu admin area (Admin → Asset Layouts) and must be marked as Active

  • You can also create new asset layouts directly from this section if needed.

Step 8. Run a Final Sync

Once you match sites and choose where to sync each device type, you'll need to run a final sync. This sync will bring in Unifi devices, network configurations, and port forwards.