mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
junos implementation of net_lldp (#26872)
* junos_lldp module * junos_lldp integration test * net_lldp integration test for junos * Other minor changes
This commit is contained in:
parent
30ad30c470
commit
879acf378d
12 changed files with 280 additions and 11 deletions
|
@ -303,10 +303,6 @@ def map_obj_to_ele(module, want, top, value_map=None):
|
||||||
if state == 'absent' and not (is_key or leaf_only):
|
if state == 'absent' and not (is_key or leaf_only):
|
||||||
continue
|
continue
|
||||||
|
|
||||||
# for tag only node if value is false continue to next attr
|
|
||||||
if tag_only and not value:
|
|
||||||
continue
|
|
||||||
|
|
||||||
# convert param value to device specific value
|
# convert param value to device specific value
|
||||||
if value_map and fxpath in value_map:
|
if value_map and fxpath in value_map:
|
||||||
value = value_map[fxpath].get(value)
|
value = value_map[fxpath].get(value)
|
||||||
|
@ -335,10 +331,11 @@ def map_obj_to_ele(module, want, top, value_map=None):
|
||||||
else:
|
else:
|
||||||
ele = ele_list[0]
|
ele = ele_list[0]
|
||||||
|
|
||||||
tags = fxpath.split('/')
|
if value is not None and not isinstance(value, bool):
|
||||||
if value is not None:
|
|
||||||
value = to_text(value, errors='surrogate_then_replace')
|
value = to_text(value, errors='surrogate_then_replace')
|
||||||
|
|
||||||
|
if fxpath:
|
||||||
|
tags = fxpath.split('/')
|
||||||
for item in tags:
|
for item in tags:
|
||||||
ele = SubElement(ele, item)
|
ele = SubElement(ele, item)
|
||||||
|
|
||||||
|
|
|
@ -216,7 +216,6 @@ def main():
|
||||||
|
|
||||||
if state in ('present', 'up', 'down'):
|
if state in ('present', 'up', 'down'):
|
||||||
module.params['state'] = 'present'
|
module.params['state'] = 'present'
|
||||||
|
|
||||||
else:
|
else:
|
||||||
module.params['disable'] = True
|
module.params['disable'] = True
|
||||||
|
|
||||||
|
|
|
@ -314,7 +314,7 @@ def main():
|
||||||
module.params['disable'] = True
|
module.params['disable'] = True
|
||||||
|
|
||||||
if module.params.get('mode') == 'off':
|
if module.params.get('mode') == 'off':
|
||||||
module.params['mode'] = False
|
module.params['mode'] = ''
|
||||||
elif module.params.get('mode') == 'on':
|
elif module.params.get('mode') == 'on':
|
||||||
module.params['mode'] = 'passive'
|
module.params['mode'] = 'passive'
|
||||||
|
|
||||||
|
|
144
lib/ansible/modules/network/junos/junos_lldp.py
Normal file
144
lib/ansible/modules/network/junos/junos_lldp.py
Normal file
|
@ -0,0 +1,144 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# (c) 2017, Ansible by Red Hat, inc
|
||||||
|
#
|
||||||
|
# This file is part of Ansible by Red Hat
|
||||||
|
#
|
||||||
|
# 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/>.
|
||||||
|
#
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
||||||
|
'status': ['preview'],
|
||||||
|
'supported_by': 'core'}
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = """
|
||||||
|
---
|
||||||
|
module: junos_lldp
|
||||||
|
version_added: "2.4"
|
||||||
|
author: "Ganesh Nalawade (@ganeshrn)"
|
||||||
|
short_description: Manage LLDP configuration on Juniper JUNOS network devices
|
||||||
|
description:
|
||||||
|
- This module provides declarative management of LLDP service
|
||||||
|
on Juniper JUNOS network devices.
|
||||||
|
options:
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- State of the LLDP configuration.
|
||||||
|
default: present
|
||||||
|
choices: ['present', 'absent']
|
||||||
|
active:
|
||||||
|
description:
|
||||||
|
- Specifies whether or not the configuration is active or deactivated
|
||||||
|
default: True
|
||||||
|
choices: [True, False]
|
||||||
|
requirements:
|
||||||
|
- ncclient (>=v0.5.2)
|
||||||
|
notes:
|
||||||
|
- This module requires the netconf system service be enabled on
|
||||||
|
the remote device being managed
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLES = """
|
||||||
|
- name: Enable LLDP service
|
||||||
|
junos_lldp:
|
||||||
|
state: present
|
||||||
|
|
||||||
|
- name: Disable LLDP service
|
||||||
|
vyos_lldp:
|
||||||
|
state: absent
|
||||||
|
"""
|
||||||
|
|
||||||
|
RETURN = """
|
||||||
|
diff.prepared:
|
||||||
|
description: Configuration difference before and after applying change.
|
||||||
|
returned: when configuration is changed and diff option is enabled.
|
||||||
|
type: string
|
||||||
|
sample: >
|
||||||
|
[edit]
|
||||||
|
+ protocols {
|
||||||
|
+ lldp {
|
||||||
|
+ disable;
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
"""
|
||||||
|
import collections
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.junos import junos_argument_spec, check_args
|
||||||
|
from ansible.module_utils.junos import load_config, map_params_to_obj, map_obj_to_ele
|
||||||
|
from ansible.module_utils.junos import commit_configuration, discard_changes, locked_config
|
||||||
|
|
||||||
|
try:
|
||||||
|
from lxml.etree import tostring
|
||||||
|
except ImportError:
|
||||||
|
from xml.etree.ElementTree import tostring
|
||||||
|
|
||||||
|
USE_PERSISTENT_CONNECTION = True
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
""" main entry point for module execution
|
||||||
|
"""
|
||||||
|
argument_spec = dict(
|
||||||
|
purge=dict(default=False, type='bool'),
|
||||||
|
state=dict(default='present', choices=['present', 'absent']),
|
||||||
|
)
|
||||||
|
|
||||||
|
argument_spec.update(junos_argument_spec)
|
||||||
|
|
||||||
|
module = AnsibleModule(argument_spec=argument_spec,
|
||||||
|
supports_check_mode=True)
|
||||||
|
|
||||||
|
warnings = list()
|
||||||
|
check_args(module, warnings)
|
||||||
|
|
||||||
|
result = {'changed': False}
|
||||||
|
|
||||||
|
if warnings:
|
||||||
|
result['warnings'] = warnings
|
||||||
|
|
||||||
|
top = 'protocols/lldp'
|
||||||
|
|
||||||
|
param_to_xpath_map = collections.OrderedDict()
|
||||||
|
param_to_xpath_map.update([
|
||||||
|
('disable', {'xpath': 'disable', 'tag_only': True, 'is_key': True})
|
||||||
|
])
|
||||||
|
|
||||||
|
state = module.params.get('state')
|
||||||
|
module.params['disable'] = True if state == 'absent' else False
|
||||||
|
|
||||||
|
want = map_params_to_obj(module, param_to_xpath_map)
|
||||||
|
ele = map_obj_to_ele(module, want, top)
|
||||||
|
|
||||||
|
with locked_config(module):
|
||||||
|
diff = load_config(module, tostring(ele), warnings, action='replace')
|
||||||
|
|
||||||
|
commit = not module.check_mode
|
||||||
|
if diff:
|
||||||
|
if commit:
|
||||||
|
commit_configuration(module)
|
||||||
|
else:
|
||||||
|
discard_changes(module)
|
||||||
|
result['changed'] = True
|
||||||
|
|
||||||
|
if module._diff:
|
||||||
|
result['diff'] = {'prepared': diff}
|
||||||
|
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
|
@ -120,6 +120,13 @@
|
||||||
rescue:
|
rescue:
|
||||||
- set_fact: test_failed=true
|
- set_fact: test_failed=true
|
||||||
|
|
||||||
|
- block:
|
||||||
|
- include_role:
|
||||||
|
name: junos_lldp
|
||||||
|
when: "limit_to in ['*', 'junos_lldp']"
|
||||||
|
rescue:
|
||||||
|
- set_fact: test_failed=true
|
||||||
|
|
||||||
###########
|
###########
|
||||||
- name: Has any previous test failed?
|
- name: Has any previous test failed?
|
||||||
fail:
|
fail:
|
||||||
|
|
|
@ -145,7 +145,7 @@
|
||||||
- assert:
|
- assert:
|
||||||
that:
|
that:
|
||||||
- "result.changed == true"
|
- "result.changed == true"
|
||||||
- "'<disable/>' not in config.xml"
|
- "'[edit interfaces ge-0/0/1]\n- disable;' in result.diff.prepared"
|
||||||
- "'<name>ge-0/0/1</name>' in config.xml"
|
- "'<name>ge-0/0/1</name>' in config.xml"
|
||||||
|
|
||||||
- name: Delete interface
|
- name: Delete interface
|
||||||
|
|
2
test/integration/targets/junos_lldp/defaults/main.yaml
Normal file
2
test/integration/targets/junos_lldp/defaults/main.yaml
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
---
|
||||||
|
testcase: "*"
|
2
test/integration/targets/junos_lldp/tasks/main.yaml
Normal file
2
test/integration/targets/junos_lldp/tasks/main.yaml
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
---
|
||||||
|
- { include: netconf.yaml, tags: ['netconf'] }
|
16
test/integration/targets/junos_lldp/tasks/netconf.yaml
Normal file
16
test/integration/targets/junos_lldp/tasks/netconf.yaml
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
---
|
||||||
|
- name: collect all netconf test cases
|
||||||
|
find:
|
||||||
|
paths: "{{ role_path }}/tests/netconf"
|
||||||
|
patterns: "{{ testcase }}.yaml"
|
||||||
|
register: test_cases
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: set test_items
|
||||||
|
set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
|
||||||
|
|
||||||
|
- name: run test case
|
||||||
|
include: "{{ test_case_to_run }}"
|
||||||
|
with_items: "{{ test_items }}"
|
||||||
|
loop_control:
|
||||||
|
loop_var: test_case_to_run
|
49
test/integration/targets/junos_lldp/tests/netconf/basic.yaml
Normal file
49
test/integration/targets/junos_lldp/tests/netconf/basic.yaml
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
---
|
||||||
|
- debug: msg="START junos_lldp netconf/basic.yaml"
|
||||||
|
|
||||||
|
- name: setup - remove lldp
|
||||||
|
junos_lldp:
|
||||||
|
state: absent
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
|
||||||
|
- name: configure lldp
|
||||||
|
junos_lldp:
|
||||||
|
state: present
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == true"
|
||||||
|
- "'[edit]\n- protocols {\n- lldp {\n- disable;\n- }\n- }' in result.diff.prepared"
|
||||||
|
|
||||||
|
- name: configure lldp (idempotent)
|
||||||
|
junos_lldp:
|
||||||
|
state: present
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == false"
|
||||||
|
|
||||||
|
- name: Disable lldp
|
||||||
|
junos_lldp:
|
||||||
|
state: absent
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == true"
|
||||||
|
- "'[edit]\n+ protocols {\n+ lldp {\n+ disable;\n+ }\n+ }' in result.diff.prepared"
|
||||||
|
|
||||||
|
- name: Disable lldp (idempotent)
|
||||||
|
junos_lldp:
|
||||||
|
state: absent
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == false"
|
50
test/integration/targets/net_lldp/tests/junos/basic.yaml
Normal file
50
test/integration/targets/net_lldp/tests/junos/basic.yaml
Normal file
|
@ -0,0 +1,50 @@
|
||||||
|
---
|
||||||
|
- debug: msg="START net_lldp junos/basic.yaml"
|
||||||
|
|
||||||
|
|
||||||
|
- name: setup - remove lldp
|
||||||
|
net_lldp:
|
||||||
|
state: absent
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
|
||||||
|
- name: configure lldp
|
||||||
|
net_lldp:
|
||||||
|
state: present
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == true"
|
||||||
|
- "'[edit]\n- protocols {\n- lldp {\n- disable;\n- }\n- }' in result.diff.prepared"
|
||||||
|
|
||||||
|
- name: configure lldp (idempotent)
|
||||||
|
net_lldp:
|
||||||
|
state: present
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == false"
|
||||||
|
|
||||||
|
- name: Disable lldp
|
||||||
|
net_lldp:
|
||||||
|
state: absent
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == true"
|
||||||
|
- "'[edit]\n+ protocols {\n+ lldp {\n+ disable;\n+ }\n+ }' in result.diff.prepared"
|
||||||
|
|
||||||
|
- name: Disable lldp (idempotent)
|
||||||
|
net_lldp:
|
||||||
|
state: absent
|
||||||
|
provider: "{{ netconf }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "result.changed == false"
|
|
@ -0,0 +1,3 @@
|
||||||
|
---
|
||||||
|
- include: "{{ role_path }}/tests/junos/basic.yaml"
|
||||||
|
when: hostvars[inventory_hostname]['ansible_network_os'] == 'junos'
|
Loading…
Reference in a new issue