# # (c) 2017 Red Hat Inc. # # This file is part of Ansible # # Ansible is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Ansible is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Ansible. If not, see . # from __future__ import (absolute_import, division, print_function) __metaclass__ = type import signal from abc import ABCMeta, abstractmethod from functools import wraps from ansible.errors import AnsibleError, AnsibleConnectionFailure from ansible.module_utils.six import with_metaclass try: from scp import SCPClient HAS_SCP = True except ImportError: HAS_SCP = False try: from __main__ import display except ImportError: from ansible.utils.display import Display display = Display() def enable_mode(func): @wraps(func) def wrapped(self, *args, **kwargs): prompt = self.get_prompt() if not str(prompt).strip().endswith('#'): raise AnsibleError('operation requires privilege escalation') return func(self, *args, **kwargs) return wrapped class CliconfBase(with_metaclass(ABCMeta, object)): """ A base class for implementing cli connections .. note:: Unlike most of Ansible, nearly all strings in :class:`CliconfBase` plugins are byte strings. This is because of how close to the underlying platform these plugins operate. Remember to mark literal strings as byte string (``b"string"``) and to use :func:`~ansible.module_utils._text.to_bytes` and :func:`~ansible.module_utils._text.to_text` to avoid unexpected problems. List of supported rpc's: :get_config: Retrieves the specified configuration from the device :edit_config: Loads the specified commands into the remote device :get: Execute specified command on remote device :get_capabilities: Retrieves device information and supported rpc methods :commit: Load configuration from candidate to running :discard_changes: Discard changes to candidate datastore Note: List of supported rpc's for remote device can be extracted from output of get_capabilities() :returns: Returns output received from remote device as byte string Usage: from ansible.module_utils.connection import Connection conn = Connection() conn.get('show lldp neighbors detail'') conn.get_config('running') conn.edit_config(['hostname test', 'netconf ssh']) """ def __init__(self, connection): self._connection = connection def _alarm_handler(self, signum, frame): """Alarm handler raised in case of command timeout """ display.display('closing shell due to command timeout (%s seconds).' % self._connection._play_context.timeout, log_only=True) self.close() def send_command(self, command, prompt=None, answer=None, sendonly=False): """Executes a cli command and returns the results This method will execute the CLI command on the connection and return the results to the caller. The command output will be returned as a string """ if not signal.getsignal(signal.SIGALRM): signal.signal(signal.SIGALRM, self._alarm_handler) signal.alarm(self._connection._play_context.timeout) resp = self._connection.send(command, prompt, answer, sendonly) signal.alarm(0) return resp def get_prompt(self): """Returns the current prompt from the device""" return self._connection._matched_prompt def get_base_rpc(self): """Returns list of base rpc method supported by remote device""" return ['get_config', 'edit_config', 'get_capabilities', 'get'] @abstractmethod def get_config(self, source='running', format='text'): """Retrieves the specified configuration from the device This method will retrieve the configuration specified by source and return it to the caller as a string. Subsequent calls to this method will retrieve a new configuration from the device :args: arg[0] source: Datastore from which configuration should be retrieved eg: running/candidate/startup. (optional) default is running. arg[1] format: Output format in which configuration is retrieved Note: Specified datastore should be supported by remote device. :kwargs: Keywords supported :command: the command string to execute :source: Datastore from which configuration should be retrieved :format: Output format in which configuration is retrieved :returns: Returns output received from remote device as byte string """ pass @abstractmethod def edit_config(self, commands): """Loads the specified commands into the remote device This method will load the commands into the remote device. This method will make sure the device is in the proper context before send the commands (eg config mode) :args: arg[0] command: List of configuration commands :kwargs: Keywords supported :command: the command string to execute :returns: Returns output received from remote device as byte string """ pass @abstractmethod def get(self, *args, **kwargs): """Execute specified command on remote device This method will retrieve the specified data and return it to the caller as a string. :args: arg[0] command: command in string format to be executed on remote device arg[1] prompt: the expected prompt generated by executing command. This can be a string or a list of strings (optional) arg[2] answer: the string to respond to the prompt with (optional) arg[3] sendonly: bool to disable waiting for response, default is false (optional) :kwargs: :command: the command string to execute :prompt: the expected prompt generated by executing command. This can be a string or a list of strings :answer: the string to respond to the prompt with :sendonly: bool to disable waiting for response :returns: Returns output received from remote device as byte string """ pass @abstractmethod def get_capabilities(self): """Retrieves device information and supported rpc methods by device platform and return result as a string :returns: Returns output received from remote device as byte string """ pass def commit(self, comment=None): """Commit configuration changes""" return self._connection.method_not_found("commit is not supported by network_os %s" % self._play_context.network_os) def discard_changes(self): "Discard changes in candidate datastore" return self._connection.method_not_found("discard_changes is not supported by network_os %s" % self._play_context.network_os) def put_file(self, source, destination): """Copies file over scp to remote device""" if not HAS_SCP: self._connection.internal_error("Required library scp is not installed. Please install it using `pip install scp`") ssh = self._connection._connect_uncached() with SCPClient(ssh.get_transport()) as scp: scp.put(source, destination) def fetch_file(self, source, destination): """Fetch file over scp from remote device""" if not HAS_SCP: self._connection.internal_error("Required library scp is not installed. Please install it using `pip install scp`") ssh = self._connection._connect_uncached() with SCPClient(ssh.get_transport()) as scp: scp.get(source, destination)