ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

minor updates to network connection plugins (#23043)

Browse source 
* removes unused log() function in network_cli
* adds method comments to terminal plugin base
This commit is contained in:
Peter Sprygada 2017-03-28 12:57:18 -04:00 • committed by GitHub
parent c0db6d79f6
commit 768cb437ab
2 changed files with 31 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/ansible/plugins/connection/network_cli.py
View file

@ -58,10 +58,6 @@ class Connection(_Connection):
if play_context.verbosity > 3: if play_context.verbosity > 3:
logging.getLogger('paramiko').setLevel(logging.DEBUG) logging.getLogger('paramiko').setLevel(logging.DEBUG)
def log(self, msg):
msg = 'h=%s u=%s %s' % (self._play_context.remote_addr, self._play_context.remote_user, msg)
logger.debug(msg)
def update_play_context(self, play_context): def update_play_context(self, play_context):
"""Updates the play context information for the connection""" """Updates the play context information for the connection"""

31
lib/ansible/plugins/terminal/__init__.py
View file

@ -32,10 +32,13 @@ class TerminalBase(with_metaclass(ABCMeta, object)):
A base class for implementing cli connections A base class for implementing cli connections
''' '''
# compiled regular expression as stdout
terminal_stdout_re = [] terminal_stdout_re = []
# compiled regular expression as stderr
terminal_stderr_re = [] terminal_stderr_re = []
# copiled regular expression to remove ANSI codes
ansi_re = [ ansi_re = [
re.compile(r'(\x1b\[\?1h\x1b=)'), re.compile(r'(\x1b\[\?1h\x1b=)'),
re.compile(r'\x08.') re.compile(r'\x08.')
@ -45,24 +48,52 @@ class TerminalBase(with_metaclass(ABCMeta, object)):
self._connection = connection self._connection = connection
def _exec_cli_command(self, cmd, check_rc=True): def _exec_cli_command(self, cmd, check_rc=True):
"""Executes a CLI command on the device"""
rc, out, err = self._connection.exec_command(cmd) rc, out, err = self._connection.exec_command(cmd)
if check_rc and rc != 0: if check_rc and rc != 0:
raise AnsibleConnectionFailure(err) raise AnsibleConnectionFailure(err)
return rc, out, err return rc, out, err
def _get_prompt(self): def _get_prompt(self):
""" Returns the current prompt from the device"""
for cmd in ['\n', 'prompt()']: for cmd in ['\n', 'prompt()']:
rc, out, err = self._exec_cli_command(cmd) rc, out, err = self._exec_cli_command(cmd)
return out return out
def on_open_shell(self): def on_open_shell(self):
"""Called after the SSH session is established
This method is called right after the invoke_shell() is called from
the Paramiko SSHClient instance. It provides an opportunity to setup
terminal parameters such as disbling paging for instance.
"""
pass pass
def on_close_shell(self): def on_close_shell(self):
"""Called before the connection is closed
This method gets called once the connection close has been requested
but before the connection is actually closed. It provides an
opportunity to clean up any terminal resources before the shell is
actually closed
"""
pass pass
def on_authorize(self, passwd=None): def on_authorize(self, passwd=None):
"""Called when privilege escalation is requested
This method is called when the privilege is requested to be elevated
in the play context by setting become to True. It is the responsibility
of the terminal plugin to actually do the privilege escalation such
as entering `enable` mode for instance
"""
pass pass
def on_deauthorize(self): def on_deauthorize(self):
"""Called when privilege deescalation is requested
This method is called when the privilege changed from escalated
(become=True) to non escalated (become=False). It is the responsibility
of the this method to actually perform the deauthorization procedure
"""
pass pass