diff --git a/source/_integrations/fortios.markdown b/source/_integrations/fortios.markdown index 5e1ce233ce6..d302b31d172 100644 --- a/source/_integrations/fortios.markdown +++ b/source/_integrations/fortios.markdown @@ -1,28 +1,32 @@ --- title: FortiOS description: Instructions on how to use Fortinet FortiOS to track devices in Home Assistant. -ha_category: - - Presence Detection -ha_release: 0.97 +ha_category: + - Presence Detection ha_iot_class: Local Polling -ha_codeowners: - - '@kimfrellsen' +ha_release: 0.97 ha_domain: fortios ha_platforms: - 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 has been tested both on FortiGate appliance and FortiGate VM running SW FortiOS v. 6.0.x and 6.2.0. +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 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. 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 -# Example configuration.yaml entry +# Example configuration.yaml device_tracker: - platform: fortios host: YOUR_HOST @@ -31,16 +35,16 @@ device_tracker: {% configuration %} host: - description: Hostname or IP address of the FortiGate. - required: true - type: string + 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 + type: string 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." - required: true - type: string + 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 + 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 + 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 %}