homepage/docs/widgets/services/unifi-controller.md

30 lines
1.0 KiB
Markdown
Raw Normal View History

2023-09-29 21:01:11 +03:00
---
title: Unifi Controller
description: Unifi Controller Widget Configuration
---
2024-01-24 14:27:47 -08:00
Learn more about [Unifi Controller](https://ui.com/).
2023-09-29 21:01:11 +03:00
_(Find the Unifi Controller information widget [here](../info/unifi_controller.md))_
You can display general connectivity status from your Unifi (Network) Controller. When authenticating you will want to use a local account that has at least read privileges.
2023-09-29 21:01:11 +03:00
An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.
2024-07-17 13:32:16 -07:00
Allowed fields: `["uptime", "wan", "lan", "lan_users", "lan_devices", "wlan", "wlan_users", "wlan_devices"]` (maximum of four). Fields unsupported by the unifi device will not be shown.
2024-07-17 13:32:16 -07:00
!!! hint
If you enter e.g. incorrect credentials and receive an "API Error", you may need to recreate the container to clear the cache.
2023-09-29 21:01:11 +03:00
```yaml
widget:
type: unifi
url: https://unifi.host.or.ip:port
username: username
password: password
site: Site Name # optional
```
_Added in v0.4.18, updated in 0.6.7_