From 816c705ef19fafff3b6b15a9fa8795abb7df23cf Mon Sep 17 00:00:00 2001 From: Steve Haskew Date: Fri, 22 Jun 2018 15:28:00 +0100 Subject: [PATCH] Add info on new login. --- How-to-use.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/How-to-use.md b/How-to-use.md index e7d5d41..f8019a6 100644 --- a/How-to-use.md +++ b/How-to-use.md @@ -7,22 +7,36 @@ import routeros_api connection = routeros_api.RouterOsApiPool('IP', username='admin', password='') api = connection.get_api() ``` - -### Proposed SSL Options (pending merge of PR) -`routeros_api.RouterOsApiPool(host, username='admin', password='', port=8728, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ca_cert=None)` +### Connect Options +`routeros_api.RouterOsApiPool(host, username='admin', password='', port=8728)` Parameters: * host - String - Hostname or IP of device -Optional Parameters +Optional Parameters: * username - String - Login username - Default 'admin' * password - String - Login password - Default empty string * port - Integer - TCP Port for API - Default 8728 + +### Proposed SSL Options (pending merge of PR) +`routeros_api.RouterOsApiPool(host, username='admin', password='', port=8728, use_ssl=False, ssl_verify=True, ssl_verify_hostname=True, ca_cert=None)` + +New Optional Parameters * use_ssl - Boolean - Use SSL or not? - Default **False** * ssl_verify - Boolean - Verify the SSL certificate? - Default **True** * ssl_verify_hostname - Boolean - Verify the SSL certificate hostname matches? - Default **True** * ca_cert - String - Location of CA file if required - Default **None** +### Proposed New Login Options (pending merge of PR) +RouterOS Versions >v6.43 now use a different login method. The disadvantage is that it passes the password in plain text. The best auto-detection also sends the password in plain text at the start, even if the device doesn't support it. Therefore you can disable the new login method manually if you know the device you are connecting to uses ',{ })`