e7e295b693
The config argument is optional and should not be required. This removes the required attribute from the config argument. fixes #3878
128 lines
3.9 KiB
Python
128 lines
3.9 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# 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 <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: junos_facts
|
|
version_added: "2.1"
|
|
author: "Peter Sprygada (@privateip)"
|
|
short_description: Collect facts from remote device running Junos
|
|
description:
|
|
- Collects fact information from a remote device running the Junos
|
|
operating system. By default, the module will collect basic fact
|
|
information from the device to be included with the hostvars.
|
|
Additional fact information can be collected based on the
|
|
configured set of arguments.
|
|
extends_documentation_fragment: junos
|
|
options:
|
|
config:
|
|
description:
|
|
- The C(config) argument instructs the fact module to collect
|
|
the configuration from the remote device. The configuration
|
|
is then included in return facts. By default, the configuration
|
|
is returned as text. The C(config_format) can be used to return
|
|
different Junos configuration formats.
|
|
required: false
|
|
default: null
|
|
config_format:
|
|
description:
|
|
- The C(config_format) argument is used to specify the desired
|
|
format of the configuration file. Devices support three
|
|
configuration file formats. By default, the configuration
|
|
from the device is returned as text. The other options include
|
|
set and xml. If the xml option is choosen, the configuration file
|
|
is returned as both xml and json.
|
|
required: false
|
|
default: text
|
|
choices: ['xml', 'text', 'set']
|
|
requirements:
|
|
- junos-eznc
|
|
notes:
|
|
- This module requires the netconf system service be enabled on
|
|
the remote device being managed
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
# the required set of connection arguments have been purposely left off
|
|
# the examples for brevity
|
|
|
|
- name: collect default set of facts
|
|
junos_facts:
|
|
|
|
- name: collect default set of facts and configuration
|
|
junos_facts:
|
|
config: yes
|
|
|
|
- name: collect default set of facts and configuration in set format
|
|
junos_facts:
|
|
config: yes
|
|
config_format: set
|
|
|
|
- name: collect default set of facts and configuration in XML and JSON format
|
|
junos_facts:
|
|
config: yes
|
|
config_format: xml
|
|
"""
|
|
|
|
RETURN = """
|
|
ansible_facts:
|
|
descrption: Returns the facts collect from the device
|
|
returned: always
|
|
type: dict
|
|
"""
|
|
|
|
def main():
|
|
""" Main entry point for AnsibleModule
|
|
"""
|
|
spec = dict(
|
|
config=dict(type='bool'),
|
|
config_format=dict(default='text', choices=['xml', 'set', 'text']),
|
|
transport=dict(default='netconf', choices=['netconf'])
|
|
)
|
|
|
|
module = get_module(argument_spec=spec,
|
|
supports_check_mode=True)
|
|
|
|
result = dict(changed=False)
|
|
|
|
facts = module.get_facts()
|
|
|
|
if '2RE' in facts:
|
|
facts['has_2RE'] = facts['2RE']
|
|
del facts['2RE']
|
|
|
|
facts['version_info'] = dict(facts['version_info'])
|
|
|
|
if module.params['config'] is True:
|
|
config_format = module.params['config_format']
|
|
resp_config = module.get_config( config_format=config_format)
|
|
|
|
if config_format in ['text', 'set']:
|
|
facts['config'] = resp_config
|
|
elif config_format == "xml":
|
|
facts['config'] = xml_to_string(resp_config)
|
|
facts['config_json'] = xml_to_json(resp_config)
|
|
|
|
result['ansible_facts'] = facts
|
|
module.exit_json(**result)
|
|
|
|
from ansible.module_utils.basic import *
|
|
from ansible.module_utils.junos import *
|
|
|
|
if __name__ == '__main__':
|
|
main()
|