From 31add3b2ec1dbf2ebc252fdca4c955447a4c4134 Mon Sep 17 00:00:00 2001 From: Gabe Cook Date: Tue, 20 Oct 2020 18:10:01 -0500 Subject: [PATCH] Add Ruckus Unleashed integration documentation (#14483) Co-authored-by: Franck Nijhof --- .../_integrations/ruckus_unleashed.markdown | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 source/_integrations/ruckus_unleashed.markdown diff --git a/source/_integrations/ruckus_unleashed.markdown b/source/_integrations/ruckus_unleashed.markdown new file mode 100644 index 00000000000..d11c83d4031 --- /dev/null +++ b/source/_integrations/ruckus_unleashed.markdown @@ -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 + +Please login: +Password: +Welcome to Ruckus Unleashed Network Command Line Interface +ruckus> enable +ruckus# exit +Exit ruckus CLI. +```