Asuswrt


The asuswrt component is the main component to connect to a ASUSWRT based router.

Configuration

To use an ASUSWRT router in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
asuswrt:
  host: YOUR_ROUTER_IP
  username: YOUR_ADMIN_USERNAME

Configuration Variables

host

(string)(Required)The IP address of your router, eg. 192.168.1.1.

username

(string)(Required)The username of a user with administrative privileges, usually admin.

password

(string)(Optional)The password for your given admin account (use this if no SSH key is given).

protocol

(string)(Optional)The protocol (ssh or telnet) to use.

Default value: ssh

port

(integer)(Optional)SSH port to use.

Default value: 22

mode

(string)(Optional)The operating mode of the router (router or ap).

Default value: router

ssh_key

(string)(Optional)The path to your SSH private key file associated with your given admin account (instead of password).

require_ip

(boolean)(Optional)If the router is in access point mode.

Default value: true

You need to enable telnet on your router if you choose to use protocol: telnet.