|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "Cisco IOS" |
| 4 | +description: "Instructions how to integrate Cisco IOS routers into Home Assistant." |
| 5 | +date: 2016-11-07 19:59 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +logo: cisco.png |
| 11 | +ha_category: Presence Detection |
| 12 | +--- |
| 13 | + |
| 14 | +This is a presence detection scanner for [Cisco](http://www.cisco.com) IOS devices. |
| 15 | + |
| 16 | +<p class='note warning'> |
| 17 | +This device tracker needs SSH to be enabled on the router. |
| 18 | +</p> |
| 19 | + |
| 20 | +Before using this scanner it is recommended that you lower the arp cache timeout on your router, as Cisco IOS normally comes with a 4 hour default arp cache timeout. |
| 21 | + |
| 22 | +For example, the following commands will lower the timeout to 2 minutes on Vlan1: |
| 23 | + |
| 24 | +```bash |
| 25 | +# 1. use this command to see what Vlan your devices are on |
| 26 | +show ip arp |
| 27 | + |
| 28 | +# 2. Go into configure mode |
| 29 | +conf t |
| 30 | + |
| 31 | +# 3. Use the Vlan name as you see it from step 1 above |
| 32 | +interface Vlan1 |
| 33 | + |
| 34 | +# 4. Set a new arp cache timeout |
| 35 | +arp timeout 120 |
| 36 | + |
| 37 | +# 5. Exit |
| 38 | +# Press <ctrl+c> to exit configure mode |
| 39 | + |
| 40 | +# 6. Don't forget to save the new config, so that it will survive a reboot |
| 41 | +copy running-config startup-config |
| 42 | +``` |
| 43 | + |
| 44 | +<p class='note warning'> |
| 45 | +If you have a very large number of devices on your VLan (+1000), then you may want to adjust the arp cache timeout to suit your needs. See [this discussion](https://supportforums.cisco.com/discussion/10169296/arp-timeout) to learn more. |
| 46 | +</p> |
| 47 | + |
| 48 | +To use this device tracker in your installation, add the following to your `configuration.yaml` file: |
| 49 | + |
| 50 | +```yaml |
| 51 | +# Example configuration.yaml entry |
| 52 | +device_tracker: |
| 53 | + platform: cisco_ios |
| 54 | + host: ROUTER_IP_ADDRESS |
| 55 | + username: YOUR_ADMIN_USERNAME |
| 56 | + password: YOUR_ADMIN_PASSWORD |
| 57 | +``` |
| 58 | +
|
| 59 | +Configuration variables: |
| 60 | +
|
| 61 | +- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. |
| 62 | +- **username** (*Required*): The username of an user with administrative privileges. |
| 63 | +- **password** (*Required*): The password for your given admin account. |
| 64 | +
|
| 65 | +
|
| 66 | +See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. |
| 67 | +
|
| 68 | +
|
0 commit comments