Add net_interface declarative module (#25766)

* Add net_interface declartive module

*  Add net_interface module
*  Add junos_interface implementation module
*  Other minor changes

* Add integration test

*  Integration test for net_interface
*  Integration test for junos_interface

* Fix CI failures

* Documentation changes
This commit is contained in:
Ganesh Nalawade 2017-06-16 22:12:50 +05:30 committed by GitHub
parent e7deb07a87
commit 2ff464c949
24 changed files with 751 additions and 16 deletions

View file

@ -216,15 +216,23 @@ def get_param(module, key):
return module.params[key] or module.params['provider'].get(key)
def map_params_to_obj(module, param_xpath_map):
def map_params_to_obj(module, param_to_xpath_map):
obj = collections.OrderedDict()
for key, value in param_xpath_map.items():
for key, attrib in param_to_xpath_map.items():
if key in module.params:
obj.update({value: module.params[key]})
return [obj]
if isinstance(attrib, dict):
xpath = attrib.get('xpath')
del attrib['xpath']
attrib.update({'value': module.params[key]})
obj.update({xpath: attrib})
else:
xpath = attrib
obj.update({xpath: {'value': module.params[key]}})
return obj
def map_obj_to_ele(module, want, top):
def map_obj_to_ele(module, want, top, value_map=None):
top_ele = top.split('/')
root = Element(top_ele[0])
ele = root
@ -244,14 +252,26 @@ def map_obj_to_ele(module, want, top):
elif state == 'suspend':
node.set('inactive', 'inactive')
for key, value in obj.items():
if value:
for xpath, attrib in obj.items():
tag_only = attrib.get('tag_only', False)
value = attrib.get('value')
if value_map and xpath in value_map:
value = value_map[xpath].get(value)
if value or tag_only:
ele = node
tags = key.split('/')
tags = xpath.split('/')
for item in tags:
ele = SubElement(ele, item)
ele.text = to_text(value, errors='surrogate_then_replace')
if tag_only:
if not value:
ele.set('delete', 'delete')
else:
ele.text = to_text(value, errors='surrogate_then_replace')
if state != 'present':
break

View file

@ -0,0 +1,231 @@
#!/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_interface
version_added: "2.4"
author: "Ganesh Nalawade (@ganeshrn)"
short_description: Manage Interface on Juniper JUNOS network devices
description:
- This module provides declarative management of Interfaces
on Juniper JUNOS network devices.
options:
name:
description:
- Name of the Interface.
required: true
description:
description:
- Description of Interface.
enabled:
description:
- Configure operational status of the interface link.
If value is I(yes/true), interface is configured in up state.
For I(no/false) interface is configured in down state.
default: yes
speed:
description:
- Interface link speed.
mtu:
description:
- Maximum size of transmit packet.
duplex:
description:
- Interface link status.
default: auto
choices: ['full', 'half', 'auto']
tx_rate:
description:
- Transmit rate.
rx_rate:
description:
- Receiver rate.
collection:
description: List of Interfaces definitions.
purge:
description:
- Purge Interfaces not defined in the collections parameter.
This applies only for logical interface.
default: no
state:
description:
- State of the Interface configuration.
default: present
choices: ['present', 'absent', 'active', 'suspend']
"""
EXAMPLES = """
- name: configure interface
junos_interface:
name: ge-0/0/1
description: test-interface
- name: remove interface
junos_interface:
name: ge-0/0/1
state: absent
- name: make interface down
junos_interface:
name: ge-0/0/1
state: present
enabled: False
- name: make interface up
junos_interface:
name: ge-0/0/1
state: present
enabled: True
- name: Deactivate interface config
junos_interface:
name: ge-0/0/1
state: suspend
- name: Activate interface config
net_interface:
name: ge-0/0/1
state: active
- name: Configure interface speed, mtu, duplex
junos_interface:
name: ge-0/0/1
state: present
speed: 1g
mtu: 256
duplex: full
enabled: True
"""
RETURN = """
rpc:
description: load-configuration RPC send to the device
returned: when configuration is changed on device
type: string
sample: >
<interfaces>
<interface>
<name>ge-0/0/0</name>
<description>test interface</description>
</interface>
</interfaces>
"""
import collections
from xml.etree.ElementTree import tostring
from ansible.module_utils.junos import junos_argument_spec, check_args
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.junos import load_config, map_params_to_obj, map_obj_to_ele
USE_PERSISTENT_CONNECTION = True
def validate_mtu(value, module):
if value and not 256 <= value <= 9192:
module.fail_json(msg='mtu must be between 256 and 9192')
def validate_param_values(module, obj):
for key in obj:
# validate the param value (if validator func exists)
validator = globals().get('validate_%s' % key)
if callable(validator):
validator(module.params.get(key), module)
def main():
""" main entry point for module execution
"""
argument_spec = dict(
name=dict(required=True),
description=dict(),
enabled=dict(default=True, type='bool'),
speed=dict(),
mtu=dict(type='int'),
duplex=dict(choices=['full', 'half', 'auto']),
tx_rate=dict(),
rx_rate=dict(),
collection=dict(),
purge=dict(default=False, type='bool'),
state=dict(default='present',
choices=['present', 'absent', 'active', 'suspend'])
)
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 = 'interfaces/interface'
param_to_xpath_map = collections.OrderedDict()
param_to_xpath_map.update({
'name': 'name',
'description': 'description',
'speed': 'speed',
'mtu': 'mtu',
'enabled': {'xpath': 'disable', 'tag_only': True},
'duplex': 'link-mode'
})
choice_to_value_map = {
'link-mode': {'full': 'full-duplex', 'half': 'half-duplex', 'auto': 'automatic'},
'disable': {True: False, False: True}
}
validate_param_values(module, param_to_xpath_map)
want = list()
want.append(map_params_to_obj(module, param_to_xpath_map))
ele = map_obj_to_ele(module, want, top, choice_to_value_map)
kwargs = {'commit': not module.check_mode}
kwargs['action'] = 'replace'
diff = load_config(module, tostring(ele), warnings, **kwargs)
if diff:
result.update({
'changed': True,
'diff': {'prepared': diff},
'rpc': tostring(ele)
})
module.exit_json(**result)
if __name__ == "__main__":
main()

View file

@ -50,7 +50,7 @@ options:
- List of interfaces to check the VLAN has been
configured correctly.
collection:
description: List of VLANs definitions
description: List of VLANs definitions.
purge:
description:
- Purge VLANs not defined in the collections parameter.
@ -63,6 +63,26 @@ options:
"""
EXAMPLES = """
- name: configure VLAN ID and name
junos_vlan:
vlan_name: test
vlan_id: 20
name: test-vlan
- name: remove VLAN configuration
junos_vlan:
vlan_name: test
state: absent
- name: deactive VLAN configuration
junos_vlan:
vlan_name: test
state: suspend
- name: activate VLAN configuration
junos_vlan:
vlan_name: test
state: active
"""
RETURN = """
@ -125,16 +145,17 @@ def main():
top = 'vlans/vlan'
param_xpath_map = collections.OrderedDict()
param_xpath_map.update({
param_to_xpath_map = collections.OrderedDict()
param_to_xpath_map.update({
'name': 'name',
'vlan_id': 'vlan-id',
'description': 'description'
})
validate_param_values(module, param_xpath_map)
validate_param_values(module, param_to_xpath_map)
want = map_params_to_obj(module, param_xpath_map)
want = list()
want.append(map_params_to_obj(module, param_to_xpath_map))
ele = map_obj_to_ele(module, want, top)
kwargs = {'commit': not module.check_mode}

View file

@ -0,0 +1,128 @@
#!/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_interface
version_added: "2.4"
author: "Ganesh Nalawade (@ganeshrn)"
short_description: Manage Interface on network devices
description:
- This module provides declarative management of Interfaces
on network devices.
options:
name:
description:
- Name of the Interface.
required: true
description:
description:
- Description of Interface.
enabled:
description:
- Configure operational status of the interface link.
If value is I(yes) interface is configured in up state,
for I(no) interface is configured in down state.
default: yes
speed:
description:
- Interface link speed.
mtu:
description:
- Maximum size of transmit packet.
duplex:
description:
- Interface link status
default: auto
choices: ['full', 'half', 'auto']
tx_rate:
description:
- Transmit rate
rx_rate:
description:
- Receiver rate
collection:
description: List of Interfaces definitions.
purge:
description:
- Purge Interfaces not defined in the collections parameter.
This applies only for logical interface.
default: no
state:
description:
- State of the Interface configuration.
default: present
choices: ['present', 'absent']
"""
EXAMPLES = """
- name: configure interface
net_interface:
name: ge-0/0/1
description: test-interface
- name: remove interface
net_interface:
name: ge-0/0/1
state: absent
- name: make interface up
net_interface:
name: ge-0/0/1
description: test-interface
state: present
enabled: True
- name: make interface down
net_interface:
name: ge-0/0/1
description: test-interface
state: present
enabled: False
"""
RETURN = """
commands:
description: The list of configuration mode commands to send to the device.
returned: always
type: list
sample:
- interface 20
- name test-interface
rpc:
description: load-configuration RPC send to the device
returned: C(rpc) is returned only for junos device
when configuration is changed on device
type: string
sample: >
<interfaces>
<interface>
<name>ge-0/0/0</name>
<description>test interface</description>
</interface>
</interfaces>
"""

View file

@ -44,7 +44,7 @@ options:
description:
- List of interfaces the VLAN should be configured on.
collection:
description: List of VLANs definitions
description: List of VLANs definitions.
purge:
description:
- Purge VLANs not defined in the collections parameter.
@ -81,4 +81,10 @@ commands:
sample:
- vlan 20
- name test-vlan
rpc:
description: load-configuration RPC send to the device
returned: C(rpc) is returned only for junos device
when configuration is changed on device
type: string
sample: "<vlans><vlan><name>test-vlan-4</name></vlan></vlans>"
"""

View file

@ -0,0 +1,26 @@
# (c) 2017, Ansible Inc,
#
# 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/>.
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
from ansible.plugins.action.net_base import ActionModule as _ActionModule
class ActionModule(_ActionModule):
def run(self, tmp=None, task_vars=None):
result = super(ActionModule, self).run(tmp, task_vars)
return result

View file

@ -15,3 +15,4 @@
- { role: junos_rpc, when: "limit_to in ['*', 'junos_rpc']" }
- { role: junos_template, when: "limit_to in ['*', 'junos_template']" }
- { role: junos_vlan, when: "limit_to in ['*', 'junos_vlan']" }
- { role: junos_interface, when: "limit_to in ['*', 'junos_interface']" }

View file

@ -14,3 +14,4 @@
- { role: net_user, when: "limit_to in ['*', 'net_user']" }
- { role: net_vlan, when: "limit_to in ['*', 'net_vlan']" }
- { role: net_vrf, when: "limit_to in ['*', 'net_vrf']" }
- { role: net_interface, when: "limit_to in ['*', 'net_interface']" }

View file

@ -0,0 +1 @@
network/ci

View file

@ -0,0 +1,2 @@
---
testcase: "*"

View file

@ -0,0 +1,2 @@
---
- { include: netconf.yaml, tags: ['netconf'] }

View 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

View file

@ -0,0 +1,130 @@
---
- debug: msg="START junos_interface netconf/basic.yaml"
- name: setup - remove interface
junos_interface:
name: ge-0/0/1
description: test-interface
state: absent
provider: "{{ netconf }}"
- name: Create interface
junos_interface:
name: ge-0/0/1
description: test-interface
state: present
provider: "{{ netconf }}"
register: result
- debug:
msg: "{{ result }}"
- assert:
that:
- "result.changed == true"
- "'<name>ge-0/0/1</name>' in result.rpc"
- "'<description>test-interface</description>' in result.rpc"
- name: Create interface (idempotent)
junos_interface:
name: ge-0/0/1
description: test-interface
state: present
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == false"
- name: Deactivate interface configuration
junos_interface:
name: ge-0/0/1
description: test-interface
state: suspend
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<interface inactive=\"inactive\">' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"
- name: Activate interface configuration
junos_interface:
name: ge-0/0/1
description: test-interface
state: active
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<interface active=\"active\">' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"
- name: Configure interface attributes
junos_interface:
name: ge-0/0/1
description: test-interface
state: present
speed: 1g
mtu: 256
duplex: full
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<name>ge-0/0/1</name>' in result.rpc"
- "'<link-mode>full-duplex</link-mode>' in result.rpc"
- "'<mtu>256</mtu>' in result.rpc"
- "'<speed>1g</speed>' in result.rpc"
- "'<description>test-interface</description>' in result.rpc"
- name: Disable interface
junos_interface:
name: ge-0/0/1
description: test-interface
state: present
enabled: False
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<disable />' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"
- name: Enable interface
junos_interface:
name: ge-0/0/1
description: test-interface
state: present
enabled: True
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<disable delete=\"delete\" />' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"
- name: Delete interface
junos_interface:
name: ge-0/0/1
description: test-interface
state: absent
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<interface operation=\"delete\">' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"

View file

@ -0,0 +1 @@
network/ci

View file

@ -0,0 +1,2 @@
---
testcase: "*"

View file

@ -0,0 +1,16 @@
---
- name: collect all cli test cases
find:
paths: "{{ role_path }}/tests/cli"
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

View file

@ -0,0 +1,3 @@
---
- { include: cli.yaml, tags: ['cli'] }
- { include: netconf.yaml, tags: ['netconf'] }

View 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

View file

@ -0,0 +1,4 @@
---
- include: "{{ role_path }}/tests/eos/basic.yaml"
when: hostvars[inventory_hostname]['ansible_network_os'] == 'eos'

View file

@ -0,0 +1,2 @@
---
- debug: msg="START net_interface eos/basic.yaml"

View file

@ -0,0 +1,102 @@
---
- debug: msg="START net_interface junos/basic.yaml"
- name: setup - remove interface
net_interface:
name: ge-0/0/1
description: test-interface
state: absent
provider: "{{ netconf }}"
- name: Create interface
net_interface:
name: ge-0/0/1
description: test-interface
state: present
provider: "{{ netconf }}"
register: result
- debug:
msg: "{{ result }}"
- assert:
that:
- "result.changed == true"
- "'<name>ge-0/0/1</name>' in result.rpc"
- "'<description>test-interface</description>' in result.rpc"
- name: Create interface (idempotent)
net_interface:
name: ge-0/0/1
description: test-interface
state: present
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == false"
- name: Configure interface attributes
net_interface:
name: ge-0/0/1
description: test-interface
state: present
speed: 1g
mtu: 256
duplex: full
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<name>ge-0/0/1</name>' in result.rpc"
- "'<link-mode>full-duplex</link-mode>' in result.rpc"
- "'<mtu>256</mtu>' in result.rpc"
- "'<speed>1g</speed>' in result.rpc"
- "'<description>test-interface</description>' in result.rpc"
- name: Disable interface
net_interface:
name: ge-0/0/1
description: test-interface
state: present
enabled: False
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<disable />' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"
- name: Enable interface
net_interface:
name: ge-0/0/1
description: test-interface
state: present
enabled: True
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<disable delete=\"delete\" />' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"
- name: Delete interface
net_interface:
name: ge-0/0/1
description: test-interface
state: absent
provider: "{{ netconf }}"
register: result
- assert:
that:
- "result.changed == true"
- "'<interface operation=\"delete\">' in result.rpc"
- "'<name>ge-0/0/1</name>' in result.rpc"

View file

@ -0,0 +1,3 @@
---
- include: "{{ role_path }}/tests/junos/basic.yaml"
when: hostvars[inventory_hostname]['ansible_network_os'] == 'junos'

View file

@ -1,4 +1,5 @@
---
- debug: msg="START net_vlan eos/basic.yaml"
- name: setup - remove vlan
eos_vlan:

View file

@ -1,5 +1,5 @@
---
- debug: msg="START net_vlan netconf/basic.yaml"
- debug: msg="START net_vlan junos/basic.yaml"
- name: setup - remove vlan
net_vlan: