From 33d390fb5884af976b72023867051f5e4daf18aa Mon Sep 17 00:00:00 2001 From: Peter Sprygada Date: Tue, 19 Jan 2016 12:57:14 -0500 Subject: [PATCH] adds provider argument to junos shared module This commit adds a new argument `provider` to the junos shared module. The argument allows the set of common connection args to be passed to the junos shared module. This commit also updates the junos doc fragment --- lib/ansible/module_utils/junos.py | 42 +++++++++---------- .../utils/module_docs_fragments/junos.py | 7 ++++ 2 files changed, 26 insertions(+), 23 deletions(-) diff --git a/lib/ansible/module_utils/junos.py b/lib/ansible/module_utils/junos.py index fa3104101e4..33af9266e72 100644 --- a/lib/ansible/module_utils/junos.py +++ b/lib/ansible/module_utils/junos.py @@ -21,7 +21,8 @@ NET_COMMON_ARGS = dict( host=dict(required=True), port=dict(default=22, type='int'), username=dict(required=True), - password=dict(no_log=True) + password=dict(no_log=True), + provider=dict() ) def to_list(val): @@ -52,10 +53,10 @@ class Cli(object): return self.shell.send(commands) -class JunosModule(AnsibleModule): +class NetworkModule(AnsibleModule): def __init__(self, *args, **kwargs): - super(JunosModule, self).__init__(*args, **kwargs) + super(NetworkModule, self).__init__(*args, **kwargs) self.connection = None self._config = None @@ -65,14 +66,19 @@ class JunosModule(AnsibleModule): self._config = self.get_config() return self._config + def _load_params(self): + params = super(NetworkModule, self)._load_params() + provider = params.get('provider') or dict() + for key, value in provider.items(): + if key in NET_COMMON_ARGS.keys(): + params[key] = value + return params + def connect(self): - try: - self.connection = Cli(self) - self.connection.connect() - self.execute('cli') - self.execute('set cli screen-length 0') - except ShellErrror, exc: - self.fail_json(msg=str(exc)) + self.connection = Cli(self) + self.connection.connect() + self.execute('cli') + self.execute('set cli screen-length 0') def configure(self, commands): commands = to_list(commands) @@ -84,10 +90,7 @@ class JunosModule(AnsibleModule): return responses def execute(self, commands, **kwargs): - try: - return self.connection.send(commands) - except ShellError, exc: - self.fail_json(msg=exc.message) + return self.connection.send(commands) def disconnect(self): self.connection.close() @@ -100,27 +103,20 @@ class JunosModule(AnsibleModule): return self.execute(cmd)[0] def get_module(**kwargs): - """Return instance of JunosModule + """Return instance of NetworkModule """ - argument_spec = NET_COMMON_ARGS.copy() if kwargs.get('argument_spec'): argument_spec.update(kwargs['argument_spec']) kwargs['argument_spec'] = argument_spec kwargs['check_invalid_arguments'] = False - module = JunosModule(**kwargs) + module = NetworkModule(**kwargs) # HAS_PARAMIKO is set by module_utils/shell.py if not HAS_PARAMIKO: module.fail_json(msg='paramiko is required but does not appear to be installed') - # copy in values from local action. - params = json_dict_unicode_to_bytes(json.loads(MODULE_COMPLEX_ARGS)) - for key, value in params.iteritems(): - module.params[key] = value - module.connect() - return module diff --git a/lib/ansible/utils/module_docs_fragments/junos.py b/lib/ansible/utils/module_docs_fragments/junos.py index d7edb02da7f..96627288ca7 100644 --- a/lib/ansible/utils/module_docs_fragments/junos.py +++ b/lib/ansible/utils/module_docs_fragments/junos.py @@ -48,5 +48,12 @@ options: the SSH session required: false default: null + provider: + description: + - Convience method that allows all M(ios) arguments to be passed as + a dict object. All constraints (required, choices, etc) must be + met either by individual arguments or values in this dict. + required: false + default: null """