Skip to content

Commit

Permalink
Resource module for ios_vlans (ansible#59640)
Browse files Browse the repository at this point in the history
* ios_vlans resource module

* fix shippable error

* fix shippable

Signed-off-by: Sumit Jaiswal <[email protected]>

* fix vlans resource

* fix facts doc

Signed-off-by: Sumit Jaiswal <[email protected]>

* fix shippable n review

* fix test

Signed-off-by: Sumit Jaiswal <[email protected]>

* fix indentation

Signed-off-by: Sumit Jaiswal <[email protected]>

* fix review

* fix shebang

Signed-off-by: Sumit Jaiswal <[email protected]>
  • Loading branch information
justjais authored Aug 19, 2019
1 parent 8e99f0e commit b55a544
Show file tree
Hide file tree
Showing 25 changed files with 1,530 additions and 15 deletions.
4 changes: 3 additions & 1 deletion lib/ansible/module_utils/network/ios/argspec/facts/facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ def __init__(self, **kwargs):
'interfaces',
'!interfaces',
'l2_interfaces',
'!l2_interfaces'
'!l2_interfaces',
'vlans',
'!vlans',
]

argument_spec = {
Expand Down
Empty file.
50 changes: 50 additions & 0 deletions lib/ansible/module_utils/network/ios/argspec/vlans/vlans.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#
# -*- coding: utf-8 -*-
# Copyright 2019 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

#############################################
# WARNING #
#############################################
#
# This file is auto generated by the resource
# module builder playbook.
#
# Do not edit this file manually.
#
# Changes to this file will be over written
# by the resource module builder.
#
# Changes should be made in the model used to
# generate this file or in the resource module
# builder template.
#
#############################################

"""
The arg spec for the ios_vlans module
"""

from __future__ import absolute_import, division, print_function
__metaclass__ = type


class VlansArgs(object):
"""The arg spec for the ios_vlans module
"""

def __init__(self, **kwargs):
pass

argument_spec = {'config': {'elements': 'dict',
'options': {'name': {'type': 'str'},
'vlan_id': {'required': True, 'type': 'int'},
'mtu': {'type': 'int'},
'remote_span': {'type': 'bool'},
'state': {'type': 'str', 'choices': ['active', 'suspend']},
'shutdown': {'type': 'str', 'choices': ['enabled', 'disabled']}},
'type': 'list'},
'state': {'choices': ['merged', 'replaced', 'overridden', 'deleted'],
'default': 'merged',
'type': 'str'}}
Empty file.
277 changes: 277 additions & 0 deletions lib/ansible/module_utils/network/ios/config/vlans/vlans.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,277 @@
#
# -*- coding: utf-8 -*-
# Copyright 2019 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
"""
The ios_vlans class
It is in this file where the current configuration (as dict)
is compared to the provided configuration (as dict) and the command set
necessary to bring the current configuration to it's desired end-state is
created
"""

from __future__ import absolute_import, division, print_function
__metaclass__ = type


from ansible.module_utils.network.common.cfg.base import ConfigBase
from ansible.module_utils.network.common.utils import to_list
from ansible.module_utils.network.ios.facts.facts import Facts
from ansible.module_utils.network.ios.utils.utils import dict_to_set


class Vlans(ConfigBase):
"""
The ios_vlans class
"""

gather_subset = [
'!all',
'!min',
]

gather_network_resources = [
'vlans',
]

def __init__(self, module):
super(Vlans, self).__init__(module)

def get_interfaces_facts(self):
""" Get the 'facts' (the current configuration)
:rtype: A dictionary
:returns: The current configuration as a dictionary
"""
facts, _warnings = Facts(self._module).get_facts(self.gather_subset, self.gather_network_resources)
interfaces_facts = facts['ansible_network_resources'].get('vlans')
if not interfaces_facts:
return []
return interfaces_facts

def execute_module(self):
""" Execute the module
:rtype: A dictionary
:returns: The result from module execution
"""
result = {'changed': False}
commands = list()
warnings = list()

existing_interfaces_facts = self.get_interfaces_facts()
commands.extend(self.set_config(existing_interfaces_facts))
if commands:
if not self._module.check_mode:
self._connection.edit_config(commands)
result['changed'] = True
result['commands'] = commands

changed_interfaces_facts = self.get_interfaces_facts()

result['before'] = existing_interfaces_facts
if result['changed']:
result['after'] = changed_interfaces_facts

result['warnings'] = warnings
return result

def set_config(self, existing_interfaces_facts):
""" Collect the configuration from the args passed to the module,
collect the current configuration (as a dict from facts)
:rtype: A list
:returns: the commands necessary to migrate the current configuration
to the desired configuration
"""
want = self._module.params['config']
have = existing_interfaces_facts
resp = self.set_state(want, have)
return to_list(resp)

def set_state(self, want, have):
""" Select the appropriate function based on the state provided
:param want: the desired configuration as a dictionary
:param have: the current configuration as a dictionary
:rtype: A list
:returns: the commands necessary to migrate the current configuration
to the desired configuration
"""
state = self._module.params['state']
if state == 'overridden':
commands = self._state_overridden(want, have, state)
elif state == 'deleted':
commands = self._state_deleted(want, have, state)
elif state == 'merged':
commands = self._state_merged(want, have)
elif state == 'replaced':
commands = self._state_replaced(want, have)
return commands

def _state_replaced(self, want, have):
""" The command generator when state is replaced
:rtype: A list
:returns: the commands necessary to migrate the current configuration
to the desired configuration
"""
commands = []

check = False
for each in want:
for every in have:
if every['vlan_id'] == each['vlan_id']:
check = True
break
else:
continue
if check:
commands.extend(self._set_config(each, every))
else:
commands.extend(self._set_config(each, dict()))

return commands

def _state_overridden(self, want, have, state):
""" The command generator when state is overridden
:rtype: A list
:returns: the commands necessary to migrate the current configuration
to the desired configuration
"""
commands = []

for each in have:
for every in want:
if each['vlan_id'] == every['vlan_id']:
break
else:
# We didn't find a matching desired state, which means we can
# pretend we recieved an empty desired state.
commands.extend(self._clear_config(every, each, state))
continue
commands.extend(self._set_config(every, each))

return commands

def _state_merged(self, want, have):
""" The command generator when state is merged
:rtype: A list
:returns: the commands necessary to merge the provided into
the current configuration
"""
commands = []

check = False
for each in want:
for every in have:
if each.get('vlan_id') == every.get('vlan_id'):
check = True
break
else:
continue
if check:
commands.extend(self._set_config(each, every))
else:
commands.extend(self._set_config(each, dict()))

return commands

def _state_deleted(self, want, have, state):
""" The command generator when state is deleted
:rtype: A list
:returns: the commands necessary to remove the current configuration
of the provided objects
"""
commands = []

if want:
check = False
for each in want:
for every in have:
if each.get('vlan_id') == every.get('vlan_id'):
check = True
break
else:
check = False
continue
if check:
commands.extend(self._clear_config(each, every, state))
else:
for each in have:
commands.extend(self._clear_config(dict(), each, state))

return commands

def remove_command_from_config_list(self, vlan, cmd, commands):
if vlan not in commands and cmd != 'vlan':
commands.insert(0, vlan)
elif cmd == 'vlan':
commands.append('no %s' % vlan)
return commands
commands.append('no %s' % cmd)
return commands

def add_command_to_config_list(self, vlan_id, cmd, commands):
if vlan_id not in commands:
commands.insert(0, vlan_id)
if cmd not in commands:
commands.append(cmd)

def _set_config(self, want, have):
# Set the interface config based on the want and have config
commands = []
vlan = 'vlan {0}'.format(want.get('vlan_id'))

# Get the diff b/w want n have
want_dict = dict_to_set(want)
have_dict = dict_to_set(have)
diff = want_dict - have_dict

if diff:
name = dict(diff).get('name')
state = dict(diff).get('state')
shutdown = dict(diff).get('shutdown')
mtu = dict(diff).get('mtu')
remote_span = dict(diff).get('remote_span')
if name:
cmd = 'name {0}'.format(name)
self.add_command_to_config_list(vlan, cmd, commands)
if state:
cmd = 'state {0}'.format(state)
self.add_command_to_config_list(vlan, cmd, commands)
if mtu:
cmd = 'mtu {0}'.format(mtu)
self.add_command_to_config_list(vlan, cmd, commands)
if remote_span:
self.add_command_to_config_list(vlan, 'remote-span', commands)
if shutdown == 'enabled':
self.add_command_to_config_list(vlan, 'shutdown', commands)
elif shutdown == 'disabled':
self.add_command_to_config_list(vlan, 'no shutdown', commands)

return commands

def _clear_config(self, want, have, state):
# Delete the interface config based on the want and have config
commands = []
vlan = 'vlan {0}'.format(have.get('vlan_id'))

if have.get('vlan_id') and 'default' not in have.get('name')\
and (have.get('vlan_id') != want.get('vlan_id') or state == 'deleted'):
self.remove_command_from_config_list(vlan, 'vlan', commands)
elif 'default' not in have.get('name'):
if have.get('mtu') != want.get('mtu'):
self.remove_command_from_config_list(vlan, 'mtu', commands)
if have.get('remote_span') != want.get('remote_span') and want.get('remote_span'):
self.remove_command_from_config_list(vlan, 'remote-span', commands)
if have.get('shutdown') != want.get('shutdown') and want.get('shutdown'):
self.remove_command_from_config_list(vlan, 'shutdown', commands)
if have.get('state') != want.get('state') and want.get('state'):
self.remove_command_from_config_list(vlan, 'state', commands)

return commands
2 changes: 2 additions & 0 deletions lib/ansible/module_utils/network/ios/facts/facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from ansible.module_utils.network.common.facts.facts import FactsBase
from ansible.module_utils.network.ios.facts.interfaces.interfaces import InterfacesFacts
from ansible.module_utils.network.ios.facts.l2_interfaces.l2_interfaces import L2_InterfacesFacts
from ansible.module_utils.network.ios.facts.vlans.vlans import VlansFacts
from ansible.module_utils.network.ios.facts.legacy.base import Default, Hardware, Interfaces, Config


Expand All @@ -30,6 +31,7 @@
FACT_RESOURCE_SUBSETS = dict(
interfaces=InterfacesFacts,
l2_interfaces=L2_InterfacesFacts,
vlans=VlansFacts
)


Expand Down
Empty file.
Loading

0 comments on commit b55a544

Please sign in to comment.