Skip to content

UniFi-Probe

UniFi

Introduction

A UniFi environment has a hierarchical setup, a controller can contain one or more sites and a site consists of one or more devices. 

graph TD
  controller(("`UniFi
  controller`"))
  site-1(("`UniFi
  site`"))
  site-2(("`UniFi
  site`"))
  site-3(("`UniFi
  site`"))
  device-1-1(("`UniFi
  device`"))
  device-1-2(("`UniFi
  device`"))
  device-1-3(("`UniFi
  device`"))
  device-2-1(("`UniFi
  device`"))
  device-2-2(("`UniFi
  device`"))
  device-2-3(("`UniFi
  device`"))
  device-3-1(("`UniFi
  device`"))
  device-3-2(("`UniFi
  device`"))
  device-3-3(("`UniFi
  device`"))
  controller --> site-1
  controller --> site-2
  controller --> site-3
  site-1 --> device-1-1
  site-1 --> device-1-2
  site-1 --> device-1-3
  site-2 --> device-2-1
  site-2 --> device-2-2
  site-2 --> device-2-3
  site-3 --> device-3-1
  site-3 --> device-3-2
  site-3 --> device-3-3

To fully support this hierarchical setup we created three corresponding collectors:

See also our UniFi SNMP probe

When you have no controller you can also use our UniFi SNMP probe to access UniFi devices directly.

Credentials

All three collectors use the UniFi API to collect data from the UniFi controller and this the same read-only credentials.

Use the following sections in your credentials file:

unificontroller:
  config:
    password: "username"
    username: "pasword goes here"
unifidevice:
  use: unificontroller

See our credentials documentation for more detailed information.

Deployment

The UniFi probes can easily be deployed using our appliance manager.

UniFi controller

  1. Start by adding an asset for the controller.
  2. Next set kind to UniFi in the General section.
  3. Add the unificontroller collector.
  4. Open the unificontroller collector configuration tab.
    1. Enter the address (IP or FQDN) of the UniFi controller.
    2. Ensure the correct port is set.

UniFi Site

  1. Open the UniFi controller asset.
  2. Locate the Sites widget
  3. Click the icon for the site you want to add.
  4. Choose wether you want to create a new asset of add the site to an existing asset, using a new asset is most often preferred.
  5. Verify the suggested settings and click Save.
  6. The site will now appear with a icon indicating it has been setup.
  7. Add the correct labels to the newly created asset and add the lastseen collector if desired.

You can automate this step using our toolkit and UniFi devices report.

UniFi devices

  1. Open the UniFi Site you want to add UniFi devices for.
  2. Locate the Devices widget
  3. Click the icon for the device you want to add.
  4. Choose wether you want to create a new asset of add the site to an existing asset, using a new asset is most often preferred.
  5. Verify the suggested settings and click Save.
  6. The device will now appear with a icon indicating it has been setup.
  7. Add the correct labels to the newly created asset and add the lastseen collector if desired.

You can automate this step using our toolkit and UniFi devices report.

Additional information