Add documentation of new login_method config option (#9881)

* Add documentation of new login_method config option

* ✏️ Tweaks
This commit is contained in:
bouni 2019-07-17 20:49:48 +02:00 committed by Franck Nijhof
parent 8c71761087
commit 583d685ea6

View File

@ -53,6 +53,12 @@ password:
description: The password of the given user account on the MikroTik device. description: The password of the given user account on the MikroTik device.
required: true required: true
type: string type: string
login_method:
description: The login method to use on the MikroTik device. The `plain` method is used by default, if you have an older RouterOS Version than 6.43, use `token` as the login method.
required: false
type: string
options: plain, token
default: plain
port: port:
description: RouterOS API port. description: RouterOS API port.
required: false required: false
@ -69,6 +75,15 @@ method:
type: string type: string
{% endconfiguration %} {% endconfiguration %}
<div class='note info'>
As of version 6.43 of RouterOS Mikrotik introduced a new login method (plain) in addition to the old login method (token). With Version 6.45.1 the old token login method got deprecated.
In order to support both login mechanisms, the new config option `login_method` has been introduced. If this option is not set, the component will try to login with the plain method first and the token method if that fails.
That can cause log entries on the router like `login failure for user homeassistant from 192.168.23.10 via api` but doesn't keep the component from working.
To get rid of these entries, set the `login_method` to `plain` for Routers with OS versions > 6.43 or `token` for routers with OS versions < 6.43.
</div>
## Use a certificate ## Use a certificate
To use SSL to connect to the API (via `api-ssl` instead of `api` service) further configuration is required at RouterOS side. You have to upload or generate a certificate and configure `api-ssl` service to use it. Here is an example of a self-signed certificate: To use SSL to connect to the API (via `api-ssl` instead of `api` service) further configuration is required at RouterOS side. You have to upload or generate a certificate and configure `api-ssl` service to use it. Here is an example of a self-signed certificate: