internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-08 22:33:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change cliconf get() method signature with explicit args (#33341)

Browse Source 
* Change cliconf get() method signature to explicit args instead of *args and **kwargs

* updates doc string
This commit is contained in:
Kedar K
2017-11-28 21:40:58 +05:30
committed by GitHub
parent 0592fd47bc
commit 6749a39dbe
13 changed files with 30 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
lib/ansible/plugins/cliconf/__init__.py
View File

@@ -150,22 +150,16 @@ class CliconfBase(with_metaclass(ABCMeta, object)):
pass
@abstractmethod
def get(self, *args, **kwargs):
def get(self, command, prompt=None, answer=None, sendonly=False):
"""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.
command: command in string format to be executed on remote device
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
answer: the string to respond to the prompt with (optional)
sendonly: bool to disable waiting for response, default is false (optional)
:returns: Returns output received from remote device as byte string
"""
pass