From 9f9bedabdfb8abeb93dff67a3c230998b4bdc18a Mon Sep 17 00:00:00 2001 From: Kim Frellsen Date: Wed, 24 Jul 2019 02:02:40 +0200 Subject: [PATCH] Create fortios.markdown (#9044) * Create device_tracker.fortios.markdown this is documentation for the initial version of a new device_tracker component named Fortios from Fortinet. * Update device_tracker.fortios.markdown * Update device_tracker.fortios.markdown * Update source/_components/device_tracker.fortios.markdown Co-Authored-By: Franck Nijhof * Update source/_components/device_tracker.fortios.markdown Co-Authored-By: Franck Nijhof * Update source/_components/device_tracker.fortios.markdown Co-Authored-By: Franck Nijhof * Update source/_components/device_tracker.fortios.markdown Co-Authored-By: Franck Nijhof * Update source/_components/device_tracker.fortios.markdown Co-Authored-By: Franck Nijhof * Update source/_components/device_tracker.fortios.markdown Co-Authored-By: Franck Nijhof * Update source/_components/device_tracker.fortios.markdown Co-Authored-By: Franck Nijhof * Update device_tracker.fortios.markdown Added title and description * Update device_tracker.fortios.markdown added title * Update device_tracker.fortios.markdown added header and removed optional configurations * :pencil2: Tweaks * :fire: Removed some obsolete code * filename changed as requested * :pencil2: Tweaks * :pencil2: Fixing build * :pencil2: Fixes configuration block --- source/_components/fortios.markdown | 42 +++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 source/_components/fortios.markdown diff --git a/source/_components/fortios.markdown b/source/_components/fortios.markdown new file mode 100644 index 00000000000..e74f7c3a6cc --- /dev/null +++ b/source/_components/fortios.markdown @@ -0,0 +1,42 @@ +--- +title: "Device Tracker FortiOS" +description: "Instructions on how to use Fortinet FortiOS to track devices in Home Assistant." +logo: fortinet.png +ha_category: + - Presence Detection +ha_release: 0.97 +ha_iot_class: Local Polling +--- + +This integration enables Home Assistant to do device tracking of devices with a MAC address connected to a FortiGate from [Fortinet](https://www.fortinet.com). + +The integration relies on the [fortiosapi](https://pypi.org/project/fortiosapi/). +The integration has been tested both on FortiGate appliance and FortiGate VM running SW FortiOS v. 6.0.x and 6.2.0. + +All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and WiFi devices, including devices detected by LLDP. + +The integration is based on the Home Assistant `device_tracker` platform. + +```yaml +# Example configuration.yaml entry +device_tracker: + - platform: fortios + host: YOUR_HOST + token: YOUR_API_USER_KEY +``` + +{% configuration %} +host: + description: Hostname or IP address of the FortiGate. + required: true + type: string +token: + description: "See [Fortinet Developer Network](https://fndn.fortinet.com) for how to create an API token. Remember this integration only needs read access to a FortiGate, so configure the API user to only to have limited and read-only access." + required: true + type: string +verify_ssl: + description: If the SSL certificate should be verified. In most home cases users do not have a verified certificate. + required: false + type: boolean + default: false +{% endconfiguration %}