jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

update documentation to match FortiOS device tracker updates (#20713)

Browse Source 
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Kim Frellsen 2022-01-23 20:43:57 +01:00 committed by GitHub
parent cc6abf1bbb
commit 554f1f683e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
source/_integrations/fortios.markdown
View File

@ -2,27 +2,31 @@
title: FortiOS title: FortiOS
description: Instructions on how to use Fortinet FortiOS to track devices in Home Assistant. description: Instructions on how to use Fortinet FortiOS to track devices in Home Assistant.
ha_category: ha_category:
- Presence Detection - Presence Detection
ha_release: 0.97
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_codeowners: ha_release: 0.97
- '@kimfrellsen'
ha_domain: fortios ha_domain: fortios
ha_platforms: ha_platforms:
- device_tracker - device_tracker
ha_codeowners:
- '@kimfrellsen'
--- ---
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 FortiOS presence detection enables Home Assistant to track 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 relies on the [fortiosapi](https://pypi.org/project/fortiosapi/). It has been verified on FortiGate appliances and FortiGate VM running FortiOS v. 6.4.x (up to 6.4.8) and 7.0.x (up to 7.0.4).
The integration has been tested both on FortiGate appliance and FortiGate VM running SW FortiOS v. 6.0.x and 6.2.0. The minimum version supported is FortiOS 6.4.3.
All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and Wi-Fi devices, including devices detected by LLDP. All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and Wi-Fi devices, including devices detected by LLDP.
The integration is based on the Home Assistant `device_tracker` platform. The integration is based on the Home Assistant `device_tracker` platform.
### Example Configuration:
This example uses the FortiOS integration as a device tracker, with an API token and does not verify the SSL certificate.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml
device_tracker: device_tracker:
- platform: fortios - platform: fortios
host: YOUR_HOST host: YOUR_HOST
@ -31,16 +35,16 @@ device_tracker:
{% configuration %} {% configuration %}
host: host:
description: Hostname or IP address of the FortiGate. description: Hostname or IP address of the FortiGate. Optionally port name can be added like this "10.10.10.10:443". Remember quotes if port number is added.
required: true required: true
type: string type: string
token: token:
description: "See: [Generate an API token for FortiOS](https://registry.terraform.io/providers/fortinetdev/fortios/latest/docs/guides/fgt_token) 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." description: "See: [Generate an API token for FortiOS](https://docs.fortinet.com/document/forticonverter/6.2.0/online-help/866905/connect-fortigate-device-via-api-token) for how to create an API token. 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 required: true
type: string type: string
verify_ssl: verify_ssl:
description: If the SSL certificate should be verified. In most home cases users do not have a verified certificate. description: If the SSL certificate should be verified. In most home cases users do not have a verified certificate.
required: false required: false
type: boolean type: boolean
default: false default: false
{% endconfiguration %} {% endconfiguration %}