mirror of https://github.com/ansible/ansible.git
net_lldp_interface module implementation for junos (#26915)
* junos_lldp_interface module implementation * junos_lldp_interface integration test * net_lldp_interface module intgration test for junos * Add lldp configuration parameter in junos_lldp * Modify junos_lldp testcase as per above change * Add net_lldp_interface module documentationpull/17644/merge
Ganesh Nalawade
7 years ago
committed by
GitHub
parent
3f67d167fe
commit
b8cd646afd
@ -0,0 +1,81 @@
|
||||
#!/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: net_lldp_interface
|
||||
version_added: "2.4"
|
||||
author: "Ganesh Nalawade (@ganeshrn)"
|
||||
short_description: Manage LLDP interfaces configuration on network devices
|
||||
description:
|
||||
- This module provides declarative management of LLDP interfaces
|
||||
configuration on network devices.
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the interface LLDP should be configured on.
|
||||
aggregate:
|
||||
description: List of interfaces LLDP should be configured on.
|
||||
purge:
|
||||
description:
|
||||
- Purge interfaces not defined in the aggregate parameter.
|
||||
default: no
|
||||
state:
|
||||
description:
|
||||
- State of the LLDP configuration.
|
||||
default: present
|
||||
choices: ['present', 'absent', 'enabled', 'disabled']
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Configure LLDP on specific interfaces
|
||||
net_lldp_interface:
|
||||
name: eth1
|
||||
state: present
|
||||
|
||||
- name: Disable LLDP on specific interfaces
|
||||
net_lldp_interface:
|
||||
name: eth1
|
||||
state: disabled
|
||||
|
||||
- name: Enable LLDP on specific interfaces
|
||||
net_lldp_interface:
|
||||
name: eth1
|
||||
state: enabled
|
||||
|
||||
- name: Delete LLDP on specific interfaces
|
||||
net_lldp_interface:
|
||||
name: eth1
|
||||
state: absent
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
commands:
|
||||
description: The list of configuration mode commands to send to the device
|
||||
returned: always, except for the platforms that use Netconf transport to manage the device.
|
||||
type: list
|
||||
sample:
|
||||
- set service lldp eth1 disable
|
||||
"""
|
||||
@ -0,0 +1,182 @@
|
||||
#!/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_interface
|
||||
version_added: "2.4"
|
||||
author: "Ganesh Nalawade (@ganeshrn)"
|
||||
short_description: Manage LLDP interfaces configuration on Juniper JUNOS network devices
|
||||
description:
|
||||
- This module provides declarative management of LLDP interfaces
|
||||
configuration on Juniper JUNOS network devices.
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the interface LLDP should be configured on.
|
||||
aggregate:
|
||||
description: List of interfaces LLDP should be configured on.
|
||||
purge:
|
||||
description:
|
||||
- Purge interfaces not defined in the aggregate parameter.
|
||||
default: no
|
||||
state:
|
||||
description:
|
||||
- Value of C(present) ensures given LLDP configured on given I(interfaces)
|
||||
and is enabled, for value of C(absent) LLDP configuration on given I(interfaces) deleted.
|
||||
Value C(enabled) ensures LLDP protocol is enabled on given I(interfaces) and
|
||||
for value of C(disabled) it ensures LLDP is disabled on given I(interfaces).
|
||||
default: present
|
||||
choices: ['present', 'absent', 'enabled', 'disabled']
|
||||
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: Configure LLDP on specific interfaces
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
|
||||
- name: Disable LLDP on specific interfaces
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: disabled
|
||||
|
||||
- name: Enable LLDP on specific interfaces
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: enabled
|
||||
|
||||
- name: Delete LLDP configuration on specific interfaces
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
|
||||
- name: Deactivate LLDP on specific interfaces
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
active: False
|
||||
|
||||
- name: Activate LLDP on specific interfaces
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
active: True
|
||||
"""
|
||||
|
||||
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]
|
||||
+ interface ge-0/0/5;
|
||||
"""
|
||||
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(
|
||||
name=dict(),
|
||||
aggregate=dict(type='list'),
|
||||
purge=dict(default=False, type='bool'),
|
||||
state=dict(default='present', choices=['present', 'absent', 'enabled', 'disabled']),
|
||||
active=dict(default=True, type='bool')
|
||||
)
|
||||
|
||||
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/interface'
|
||||
|
||||
param_to_xpath_map = collections.OrderedDict()
|
||||
param_to_xpath_map.update([
|
||||
('name', {'xpath': 'name', 'is_key': True}),
|
||||
('disable', {'xpath': 'disable', 'tag_only': True})
|
||||
])
|
||||
|
||||
state = module.params.get('state')
|
||||
module.params['disable'] = True if state in ('disabled', 'absent') else False
|
||||
|
||||
if state in ('enabled', 'disabled'):
|
||||
module.params['state'] = 'present'
|
||||
|
||||
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()
|
||||
@ -0,0 +1,2 @@
|
||||
---
|
||||
testcase: "*"
|
||||
@ -0,0 +1,2 @@
|
||||
---
|
||||
- { include: netconf.yaml, tags: ['netconf'] }
|
||||
@ -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
|
||||
@ -0,0 +1,104 @@
|
||||
---
|
||||
- debug: msg="START junos_lldp_interface netconf/basic.yaml"
|
||||
|
||||
- name: setup - Remove lldp interface configuration
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: absent
|
||||
provider: "{{ netconf }}"
|
||||
|
||||
- name: lldp interface configuration
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'+ interface ge-0/0/5;' in result.diff.prepared"
|
||||
|
||||
- name: lldp interface configuration (idempotent)
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == false"
|
||||
|
||||
- name: Deactivate lldp interface configuration
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
active: False
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'! inactive: interface ge-0/0/5' in result.diff.prepared"
|
||||
|
||||
- name: Activate lldp interface configuration
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
active: True
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'! active: interface ge-0/0/5' in result.diff.prepared"
|
||||
|
||||
- name: Disable lldp on particular interface
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: disabled
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'[edit protocols lldp interface ge-0/0/5]\n+ disable;' in result.diff.prepared"
|
||||
|
||||
- name: Enable lldp on particular interface
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: enabled
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'[edit protocols lldp interface ge-0/0/5]\n- disable;' in result.diff.prepared"
|
||||
|
||||
- name: Delete lldp on particular interface
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: absent
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'[edit protocols lldp]\n- interface ge-0/0/5;' in result.diff.prepared"
|
||||
|
||||
- name: Delete lldp on particular interface (idempotent)
|
||||
junos_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: absent
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == false"
|
||||
@ -0,0 +1,78 @@
|
||||
---
|
||||
- debug: msg="START net_lldp_interface junos/basic.yaml"
|
||||
|
||||
- name: setup - Remove lldp interface configuration
|
||||
net_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: absent
|
||||
provider: "{{ netconf }}"
|
||||
|
||||
- name: lldp interface configuration
|
||||
net_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'+ interface ge-0/0/5;' in result.diff.prepared"
|
||||
|
||||
- name: lldp interface configuration (idempotent)
|
||||
net_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: present
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == false"
|
||||
|
||||
- name: Disable lldp on particular interface
|
||||
net_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: disabled
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'[edit protocols lldp interface ge-0/0/5]\n+ disable;' in result.diff.prepared"
|
||||
|
||||
- name: Enable lldp on particular interface
|
||||
net_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: enabled
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'[edit protocols lldp interface ge-0/0/5]\n- disable;' in result.diff.prepared"
|
||||
|
||||
- name: Delete lldp on particular interface
|
||||
net_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
state: absent
|
||||
provider: "{{ netconf }}"
|
||||
register: result
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- "result.changed == true"
|
||||
- "'[edit protocols lldp]\n- interface ge-0/0/5;' in result.diff.prepared"
|
||||
|
||||
- name: Delete lldp on particular interface (idempotent)
|
||||
net_lldp_interface:
|
||||
name: ge-0/0/5
|
||||
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 New Issue