mirror of
https://github.com/ansible-collections/community.routeros.git
synced 2025-06-21 09:35:45 +02:00
Add api_facts module (#88)
* Add API docs fragment. * Improve documentation. * Move API code to api module_utils. * Improve docs. * Add api_facts module. Does not yet support 'config'. I'm not sure whether that's actually possible with the API. * Convert subnet to integer if possible. * Cleanup. * Linting and fix tests. * Remove things that make no sense. * Simplify code. * Add basic tests. * Lint.
This commit is contained in:
parent
a90c696589
commit
3d80ccec5f
9 changed files with 1618 additions and 277 deletions
108
plugins/module_utils/api.py
Normal file
108
plugins/module_utils/api.py
Normal file
|
@ -0,0 +1,108 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2022, Felix Fontein (@felixfontein) <felix@fontein.de>
|
||||
# Copyright: (c) 2020, Nikolay Dachev <nikolay@dachev.info>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
from ansible.module_utils.basic import missing_required_lib
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
|
||||
import re
|
||||
import ssl
|
||||
import traceback
|
||||
|
||||
LIB_IMP_ERR = None
|
||||
try:
|
||||
from librouteros import connect
|
||||
from librouteros.exceptions import LibRouterosError
|
||||
HAS_LIB = True
|
||||
except Exception as e:
|
||||
HAS_LIB = False
|
||||
LIB_IMP_ERR = traceback.format_exc()
|
||||
|
||||
|
||||
def check_has_library(module):
|
||||
if not HAS_LIB:
|
||||
module.fail_json(
|
||||
msg=missing_required_lib('librouteros'),
|
||||
exception=LIB_IMP_ERR,
|
||||
)
|
||||
|
||||
|
||||
def api_argument_spec():
|
||||
return dict(
|
||||
username=dict(type='str', required=True),
|
||||
password=dict(type='str', required=True, no_log=True),
|
||||
hostname=dict(type='str', required=True),
|
||||
port=dict(type='int'),
|
||||
tls=dict(type='bool', default=False, aliases=['ssl']),
|
||||
validate_certs=dict(type='bool', default=True),
|
||||
validate_cert_hostname=dict(type='bool', default=False),
|
||||
ca_path=dict(type='path'),
|
||||
)
|
||||
|
||||
|
||||
def _ros_api_connect(module, username, password, host, port, use_tls, validate_certs, validate_cert_hostname, ca_path):
|
||||
'''Connect to RouterOS API.'''
|
||||
if not port:
|
||||
if use_tls:
|
||||
port = 8729
|
||||
else:
|
||||
port = 8728
|
||||
try:
|
||||
if use_tls:
|
||||
ctx = ssl.create_default_context(cafile=ca_path)
|
||||
wrap_context = ctx.wrap_socket
|
||||
if not validate_certs:
|
||||
ctx.check_hostname = False
|
||||
ctx.verify_mode = ssl.CERT_NONE
|
||||
elif not validate_cert_hostname:
|
||||
ctx.check_hostname = False
|
||||
else:
|
||||
# Since librouteros doesn't pass server_hostname,
|
||||
# we have to do this ourselves:
|
||||
def wrap_context(*args, **kwargs):
|
||||
kwargs.pop('server_hostname', None)
|
||||
return ctx.wrap_socket(*args, server_hostname=host, **kwargs)
|
||||
api = connect(
|
||||
username=username,
|
||||
password=password,
|
||||
host=host,
|
||||
ssl_wrapper=wrap_context,
|
||||
port=port,
|
||||
)
|
||||
else:
|
||||
api = connect(
|
||||
username=username,
|
||||
password=password,
|
||||
host=host,
|
||||
port=port,
|
||||
)
|
||||
except Exception as e:
|
||||
connection = {
|
||||
'username': username,
|
||||
'hostname': host,
|
||||
'port': port,
|
||||
'ssl': use_tls,
|
||||
'status': 'Error while connecting: %s' % to_native(e),
|
||||
}
|
||||
module.fail_json(msg=connection['status'], connection=connection)
|
||||
return api
|
||||
|
||||
|
||||
def create_api(module):
|
||||
return _ros_api_connect(
|
||||
module,
|
||||
module.params['username'],
|
||||
module.params['password'],
|
||||
module.params['hostname'],
|
||||
module.params['port'],
|
||||
module.params['tls'],
|
||||
module.params['validate_certs'],
|
||||
module.params['validate_cert_hostname'],
|
||||
module.params['ca_path'],
|
||||
)
|
Loading…
Add table
Add a link
Reference in a new issue