mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
220 lines
8.7 KiB
Python
220 lines
8.7 KiB
Python
|
# This code is part of Ansible, but is an independent component.
|
||
|
|
# This particular file snippet, and this file snippet only, is BSD licensed.
|
||
|
|
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
||
|
|
# still belong to the author of the module, and may assign their own license
|
||
|
|
# to the complete work.
|
||
|
|
#
|
||
|
|
# (c) 2016 Red Hat Inc.
|
||
|
|
#
|
||
|
|
# Redistribution and use in source and binary forms, with or without modification,
|
||
|
|
# are permitted provided that the following conditions are met:
|
||
|
|
#
|
||
|
|
# * Redistributions of source code must retain the above copyright
|
||
|
|
# notice, this list of conditions and the following disclaimer.
|
||
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
||
|
|
# this list of conditions and the following disclaimer in the documentation
|
||
|
|
# and/or other materials provided with the distribution.
|
||
|
|
#
|
||
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
|
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||
|
|
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||
|
|
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||
|
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||
|
|
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
#
|
||
|
|
import json
|
||
|
|
from ansible.module_utils._text import to_text
|
||
|
|
from ansible.module_utils.basic import env_fallback
|
||
|
|
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list, ComplexList
|
||
|
|
from ansible.module_utils.common._collections_compat import Mapping
|
||
|
|
from ansible.module_utils.connection import Connection, ConnectionError
|
||
|
|
|
||
|
|
_DEVICE_CONNECTION = None
|
||
|
|
|
||
|
|
|
||
|
|
class Cli:
|
||
|
|
def __init__(self, module):
|
||
|
|
self._module = module
|
||
|
|
self._device_configs = {}
|
||
|
|
self._connection = None
|
||
|
|
|
||
|
|
def get_capabilities(self):
|
||
|
|
"""Returns platform info of the remove device
|
||
|
|
"""
|
||
|
|
connection = self._get_connection()
|
||
|
|
return json.loads(connection.get_capabilities())
|
||
|
|
|
||
|
|
def _get_connection(self):
|
||
|
|
if not self._connection:
|
||
|
|
self._connection = Connection(self._module._socket_path)
|
||
|
|
return self._connection
|
||
|
|
|
||
|
|
def get_config(self, flags=None):
|
||
|
|
"""Retrieves the current config from the device or cache
|
||
|
|
"""
|
||
|
|
flags = [] if flags is None else flags
|
||
|
|
if self._device_configs == {}:
|
||
|
|
connection = self._get_connection()
|
||
|
|
try:
|
||
|
|
out = connection.get_config(flags=flags)
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
self._device_configs = to_text(out, errors='surrogate_then_replace').strip()
|
||
|
|
return self._device_configs
|
||
|
|
|
||
|
|
def run_commands(self, commands, check_rc=True):
|
||
|
|
"""Runs list of commands on remote device and returns results
|
||
|
|
"""
|
||
|
|
connection = self._get_connection()
|
||
|
|
try:
|
||
|
|
response = connection.run_commands(commands=commands, check_rc=check_rc)
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
return response
|
||
|
|
|
||
|
|
def get_diff(self, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'):
|
||
|
|
conn = self._get_connection()
|
||
|
|
try:
|
||
|
|
diff = conn.get_diff(candidate=candidate, running=running, diff_match=diff_match,
|
||
|
|
diff_ignore_lines=diff_ignore_lines, path=path, diff_replace=diff_replace)
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
return diff
|
||
|
|
|
||
|
|
|
||
|
|
class HttpApi:
|
||
|
|
def __init__(self, module):
|
||
|
|
self._module = module
|
||
|
|
self._device_configs = {}
|
||
|
|
self._connection_obj = None
|
||
|
|
|
||
|
|
def get_capabilities(self):
|
||
|
|
"""Returns platform info of the remove device
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
capabilities = self._connection.get_capabilities()
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
|
||
|
|
return json.loads(capabilities)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def _connection(self):
|
||
|
|
if not self._connection_obj:
|
||
|
|
self._connection_obj = Connection(self._module._socket_path)
|
||
|
|
return self._connection_obj
|
||
|
|
|
||
|
|
def get_config(self, flags=None):
|
||
|
|
"""Retrieves the current config from the device or cache
|
||
|
|
"""
|
||
|
|
flags = [] if flags is None else flags
|
||
|
|
if self._device_configs == {}:
|
||
|
|
try:
|
||
|
|
out = self._connection.get_config(flags=flags)
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
self._device_configs = to_text(out, errors='surrogate_then_replace').strip()
|
||
|
|
return self._device_configs
|
||
|
|
|
||
|
|
def run_commands(self, commands, check_rc=True):
|
||
|
|
"""Runs list of commands on remote device and returns results
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
response = self._connection.run_commands(commands=commands, check_rc=check_rc)
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
return response
|
||
|
|
|
||
|
|
def send_requests(self, requests):
|
||
|
|
"""Send a list of http requests to remote device and return results
|
||
|
|
"""
|
||
|
|
if requests is None:
|
||
|
|
raise ValueError("'requests' value is required")
|
||
|
|
|
||
|
|
responses = list()
|
||
|
|
for req in to_list(requests):
|
||
|
|
try:
|
||
|
|
response = self._connection.send_request(**req)
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
responses.append(response)
|
||
|
|
return responses
|
||
|
|
|
||
|
|
def get_diff(self, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'):
|
||
|
|
try:
|
||
|
|
diff = self._connection.get_diff(candidate=candidate, running=running, diff_match=diff_match,
|
||
|
|
diff_ignore_lines=diff_ignore_lines, path=path, diff_replace=diff_replace)
|
||
|
|
except ConnectionError as exc:
|
||
|
|
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||
|
|
return diff
|
||
|
|
|
||
|
|
|
||
|
|
def get_capabilities(module):
|
||
|
|
conn = get_connection(module)
|
||
|
|
return conn.get_capabilities()
|
||
|
|
|
||
|
|
|
||
|
|
def get_connection(module):
|
||
|
|
global _DEVICE_CONNECTION
|
||
|
|
if not _DEVICE_CONNECTION:
|
||
|
|
connection_proxy = Connection(module._socket_path)
|
||
|
|
cap = json.loads(connection_proxy.get_capabilities())
|
||
|
|
if cap['network_api'] == 'cliconf':
|
||
|
|
conn = Cli(module)
|
||
|
|
elif cap['network_api'] == 'exosapi':
|
||
|
|
conn = HttpApi(module)
|
||
|
|
else:
|
||
|
|
module.fail_json(msg='Invalid connection type %s' % cap['network_api'])
|
||
|
|
_DEVICE_CONNECTION = conn
|
||
|
|
return _DEVICE_CONNECTION
|
||
|
|
|
||
|
|
|
||
|
|
def get_config(module, flags=None):
|
||
|
|
flags = None if flags is None else flags
|
||
|
|
conn = get_connection(module)
|
||
|
|
return conn.get_config(flags)
|
||
|
|
|
||
|
|
|
||
|
|
def load_config(module, commands):
|
||
|
|
conn = get_connection(module)
|
||
|
|
return conn.run_commands(to_command(module, commands))
|
||
|
|
|
||
|
|
|
||
|
|
def run_commands(module, commands, check_rc=True):
|
||
|
|
conn = get_connection(module)
|
||
|
|
return conn.run_commands(to_command(module, commands), check_rc=check_rc)
|
||
|
|
|
||
|
|
|
||
|
|
def to_command(module, commands):
|
||
|
|
transform = ComplexList(dict(
|
||
|
|
command=dict(key=True),
|
||
|
|
output=dict(default='text'),
|
||
|
|
prompt=dict(type='list'),
|
||
|
|
answer=dict(type='list'),
|
||
|
|
sendonly=dict(type='bool', default=False),
|
||
|
|
check_all=dict(type='bool', default=False),
|
||
|
|
), module)
|
||
|
|
return transform(to_list(commands))
|
||
|
|
|
||
|
|
|
||
|
|
def send_requests(module, requests):
|
||
|
|
conn = get_connection(module)
|
||
|
|
return conn.send_requests(to_request(module, requests))
|
||
|
|
|
||
|
|
|
||
|
|
def to_request(module, requests):
|
||
|
|
transform = ComplexList(dict(
|
||
|
|
path=dict(key=True),
|
||
|
|
method=dict(),
|
||
|
|
data=dict(type='dict'),
|
||
|
|
), module)
|
||
|
|
return transform(to_list(requests))
|
||
|
|
|
||
|
|
|
||
|
|
def get_diff(module, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'):
|
||
|
|
conn = get_connection(module)
|
||
|
|
return conn.get_diff(candidate=candidate, running=running, diff_match=diff_match, diff_ignore_lines=diff_ignore_lines, path=path, diff_replace=diff_replace)
|