From 85219dfdf3322153ca9311433eb5d0ba27f84b7d Mon Sep 17 00:00:00 2001 From: Ganesh Nalawade Date: Fri, 2 Jun 2017 09:04:57 +0530 Subject: [PATCH] Add support to fetch old style junos facts (#25250) * Add support to fetch old style junos facts Fixes #25050 Add support to fetch old style facts supported in Ansible <= 2.2 To fetch old style facts value `gather_subset` value shoule be `all` and `junos-eznc` is required to be installed on control node as a prerequisite. * Remove unwanted import --- lib/ansible/module_utils/junos.py | 3 + .../modules/network/junos/junos_facts.py | 74 +++++++++++++++++-- .../modules/network/junos/junos_package.py | 5 +- test/sanity/pep8/legacy-files.txt | 1 - 4 files changed, 73 insertions(+), 10 deletions(-) diff --git a/lib/ansible/module_utils/junos.py b/lib/ansible/module_utils/junos.py index bf4e797cbe4..31bfe8a5d13 100644 --- a/lib/ansible/module_utils/junos.py +++ b/lib/ansible/module_utils/junos.py @@ -191,3 +191,6 @@ def load_config(module, candidate, warnings, action='merge', commit=False, forma discard_changes(module) return diff + +def get_param(module, key): + return module.params[key] or module.params['provider'].get(key) diff --git a/lib/ansible/modules/network/junos/junos_facts.py b/lib/ansible/modules/network/junos/junos_facts.py index b90191aa797..7dff91c1d38 100644 --- a/lib/ansible/modules/network/junos/junos_facts.py +++ b/lib/ansible/modules/network/junos/junos_facts.py @@ -42,7 +42,9 @@ options: all, hardware, config, and interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial C(M(!)) to specify that a specific subset should - not be collected. + not be collected. To maintain backward compatbility old style facts + can be retrieved using all value, this reqires junos-eznc to be installed + as a prerequisite. required: false default: "!config" version_added: "2.3" @@ -78,18 +80,25 @@ ansible_facts: type: dict """ -import re from xml.etree.ElementTree import Element, SubElement, tostring from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.pycompat24 import get_exception from ansible.module_utils.six import iteritems -from ansible.module_utils.junos import junos_argument_spec, check_args +from ansible.module_utils.junos import junos_argument_spec, check_args, get_param from ansible.module_utils.junos import command, get_configuration from ansible.module_utils.netconf import send_request +try: + from jnpr.junos import Device + from jnpr.junos.exception import ConnectError + HAS_PYEZ = True +except ImportError: + HAS_PYEZ = False USE_PERSISTENT_CONNECTION = True + class FactsBase(object): def __init__(self, module): @@ -140,7 +149,7 @@ class Config(FactsBase): config_format = self.module.params['config_format'] reply = get_configuration(self.module, format=config_format) - if config_format =='xml': + if config_format == 'xml': config = tostring(reply.find('configuration')).strip() elif config_format == 'text': @@ -155,7 +164,6 @@ class Config(FactsBase): self.facts['config'] = config - class Hardware(FactsBase): def populate(self): @@ -202,11 +210,55 @@ class Interfaces(FactsBase): self.facts['interfaces'] = interfaces +class Facts(FactsBase): + def _connect(self, module): + host = get_param(module, 'host') + + kwargs = { + 'port': get_param(module, 'port') or 830, + 'user': get_param(module, 'username') + } + + if get_param(module, 'password'): + kwargs['passwd'] = get_param(module, 'password') + + if get_param(module, 'ssh_keyfile'): + kwargs['ssh_private_key_file'] = get_param(module, 'ssh_keyfile') + + kwargs['gather_facts'] = False + + try: + device = Device(host, **kwargs) + device.open() + device.timeout = get_param(module, 'timeout') or 10 + except ConnectError: + exc = get_exception() + module.fail_json('unable to connect to %s: %s' % (host, str(exc))) + + return device + + def populate(self): + + device = self._connect(self.module) + facts = dict(device.facts) + + if '2RE' in facts: + facts['has_2RE'] = facts['2RE'] + del facts['2RE'] + + facts['version_info'] = dict(facts['version_info']) + if 'junos_info' in facts: + for key, value in facts['junos_info'].items(): + if 'object' in value: + value['object'] = dict(value['object']) + + return facts + FACT_SUBSETS = dict( default=Default, hardware=Hardware, config=Config, - interfaces=Interfaces, + interfaces=Interfaces ) VALID_SUBSETS = frozenset(FACT_SUBSETS.keys()) @@ -229,6 +281,7 @@ def main(): check_args(module, warnings) gather_subset = module.params['gather_subset'] + ofacts = False runable_subsets = set() exclude_subsets = set() @@ -236,12 +289,14 @@ def main(): for subset in gather_subset: if subset == 'all': runable_subsets.update(VALID_SUBSETS) + ofacts = True continue if subset.startswith('!'): subset = subset[1:] if subset == 'all': exclude_subsets.update(VALID_SUBSETS) + ofacts = False continue exclude = True else: @@ -278,6 +333,13 @@ def main(): key = 'ansible_net_%s' % key ansible_facts[key] = value + if ofacts: + if HAS_PYEZ: + ansible_facts.update(Facts(module).populate()) + else: + warnings += ['junos-eznc is required to gather old style facts but does not appear to be installed. ' + 'It can be installed using `pip install junos-eznc`'] + module.exit_json(ansible_facts=ansible_facts, warnings=warnings) diff --git a/lib/ansible/modules/network/junos/junos_package.py b/lib/ansible/modules/network/junos/junos_package.py index d7779ae7649..9dba38b244c 100644 --- a/lib/ansible/modules/network/junos/junos_package.py +++ b/lib/ansible/modules/network/junos/junos_package.py @@ -99,7 +99,7 @@ EXAMPLES = """ """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.pycompat24 import get_exception -from ansible.module_utils.junos import junos_argument_spec +from ansible.module_utils.junos import junos_argument_spec, get_param try: from jnpr.junos import Device @@ -110,8 +110,6 @@ except ImportError: HAS_PYEZ = False -get_param = lambda x, y: x.params[y] or x.params['provider'].get(y) - def connect(module): host = get_param(module, 'host') @@ -138,6 +136,7 @@ def connect(module): return device + def install_package(module, device): junos = SW(device) package = module.params['src'] diff --git a/test/sanity/pep8/legacy-files.txt b/test/sanity/pep8/legacy-files.txt index e5085b56986..b2ea62fedf6 100644 --- a/test/sanity/pep8/legacy-files.txt +++ b/test/sanity/pep8/legacy-files.txt @@ -411,7 +411,6 @@ lib/ansible/modules/net_tools/ipinfoio_facts.py lib/ansible/modules/network/junos/_junos_template.py lib/ansible/modules/network/junos/junos_command.py lib/ansible/modules/network/junos/junos_config.py -lib/ansible/modules/network/junos/junos_facts.py lib/ansible/modules/network/junos/junos_netconf.py lib/ansible/modules/network/junos/junos_package.py lib/ansible/modules/network/lenovo/cnos_conditional_template.py