Add Ruckus Unleashed integration documentation (#14483)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Gabe Cook 2020-10-20 18:10:01 -05:00 committed by GitHub
parent 0a9a8f2757
commit 31add3b2ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,46 @@
---
title: Ruckus Unleashed
description: Instructions on how to integrate your Ruckus Unleashed device into Home Assistant.
ha_category:
- Presence Detection
ha_release: 0.117
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@gabe565'
ha_domain: ruckus
---
This platform allows you to connect to a [Ruckus Unleashed](https://support.ruckuswireless.com/product_families/19-ruckus-unleashed) router.
There is currently support for the following device types within Home Assistant:
- **Presence Detection** - The platform will look at devices connected to the router and will create a `device_tracker` for each discovered device.
## Configuration
To add a Ruckus Unleashed device to your installation, go to **Configuration** -> **Integrations**, click the `+` button, then select **Ruckus** from the list of integrations.
You will have to create a user on the device which is a **Monitoring Admin**. Login to the Ruckus Unleashed admin UI and follow these steps:
- [Create a new role](https://docs.ruckuswireless.com/unleashed/200.1.9.12/t-ConfigUserRoles.html).
- Check **Allow Unleashed Administration**.
- Select the **Monitoring Admin (Monitoring and viewing operation status only)** radio button.
- [Create a new user](https://docs.ruckuswireless.com/unleashed/200.1.9.12/t-AddingNewUsersInternal.html) with the new role.
## Troubleshooting
For this platform to work, the Ruckus Unleashed device will need to be accessible over SSH. If you are having trouble with Home Assistant not connecting, make sure the user you created above can log in to SSH and can run privileged commands.
Terminal:
```bash
ssh <ruckus_ip>
Please login: <username>
Password: <password>
Welcome to Ruckus Unleashed Network Command Line Interface
ruckus> enable
ruckus# exit
Exit ruckus CLI.
```