Connect UniFi Site Manager

If your customers run UniFi, connect your UniFi Site Manager account once. Witina lists every console and site the account can see, and you adopt each site into the customer it belongs to. Witina then reads that site’s devices, ports, clients, and wireless networks from its console.

You need:

• A region of your own with a gateway online in it. The Site Manager key can read every customer’s console, so keep it out of customers’ regions.
• A customer region with a gateway online for each site you adopt; see Add customers.

Connect your Site Manager account

1. In UniFi Site Manager (unifi.ui.com), open API Keys and choose Create New API Key. Keep Site Manager ticked, create the key, and copy it.
2. In Witina, go to Controllers and choose Add controller.
3. For Controller type, choose UniFi Site Manager.
4. Enter a Name, and choose your own Region.
5. Under Site Manager API key, choose + New credential…, paste the key, and choose Create.
6. Choose Add controller.

The key is sent only to the gateways in the region you chose. A gateway there reads your account straight away, then every 5 minutes. Connecting Site Manager imports no devices by itself: it lists your consoles and sites so you can match each one to a customer.

Your sites

Open the Site Manager controller from Controllers to see its Sites: each console and site, its status, and where it belongs. Each site is in one of these states:

• Not placed: you haven’t said which customer it belongs to.
• Ready to adopt: it has a place, and is waiting to be adopted.
• Adopted: Witina is reading the site.
• Dismissed: you’ve marked it as not yours to monitor. It stays dismissed until you choose Restore.

A console that disappears from your UniFi account is shown as Gone from account. Witina never removes a site on its own.

Adopt a site

1. On the site’s row, choose Adopt.
2. Under Belongs to, choose the customer’s region. Witina suggests regions whose names share a word with the console or site.
3. Choose how Witina should reach the console:
   • Through UniFi’s cloud (recommended). In Site Manager, create another API key: untick Site Manager, keep only Network under Applications, and choose only this site under Sites.
   • Directly on the console’s network. On the console, create a key under Network → Settings → Control Plane → Integrations; a Site Manager key won’t work here. Witina fills in the Console URL with the address the console reports; change it if the gateway reaches the console another way.
4. Paste the key under API key, check the Name, and choose Adopt site.

Adopting creates a UniFi controller in the customer’s region, and a gateway in that region starts reading the console within a few minutes. If no gateway there is online yet, the controller waits until one connects.

If you’ve already added the console as a UniFi controller by hand, choose Link a controller you already added instead of creating a new one.

What Witina reads from a UniFi site

Every 5 minutes, the customer’s gateway reads from the console:

• devices, with model, firmware version, serial number, status, CPU, and memory
• switch ports, with traffic and error counters, and which device is on which port
• LLDP neighbors, for the network map
• VLANs and port profiles
• routes
• wireless clients, radios, and SSIDs

A device Witina has already found another way, for example by SNMP or LLDP, is matched to its UniFi entry rather than added twice.

UniFi consoles don’t report the spanning-tree root, so Witina doesn’t show spanning-tree topology for UniFi switches.

Witina also picks up the site’s device SSH credentials when UniFi shares them with your key, which lets you open a terminal on UniFi switches and access points. It doesn’t use them on the console itself.

Change or undo an adoption

• Move changes which region a site belongs to.
• Unlink controller separates the site from its UniFi controller. The controller keeps running on its own, and the site can be adopted again.
• Deleting a site’s controller returns the site to Ready to adopt.