dnos* -> dellos* (Rename module & updated copyright) (#4888)

* Renamed the Modules from dnos* -> dellos*, updated copyright, corrected doc issues

* Removed the unwanted module import

lib/ansible/modules/network/dellos10/dellos10_command.py

@@ -0,0 +1,213 @@
+#!/usr/bin/python
+#
+# (c) 2015 Peter Sprygada, <psprygada@ansible.com>
+#
+# Copyright (c) 2016 Dell 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/>.
+#
+
+DOCUMENTATION = """
+---
+module: dellos10_command
+version_added: "2.2"
+author: "Senthil Kumar Ganesan (@skg-net)"
+short_description: Run commands on remote devices running Dell OS10
+description:
+  - Sends arbitrary commands to a Dell OS10 node and returns the results
+    read from the device. This module includes an
+    argument that will cause the module to wait for a specific condition
+    before returning or timing out if the condition is not met.
+  - This module does not support running commands in configuration mode.
+    Please use M(dellos10_config) to configure Dell OS10 devices.
+extends_documentation_fragment: dellos10
+options:
+  commands:
+    description:
+      - List of commands to send to the remote dellos10 device over the
+        configured provider. The resulting output from the command
+        is returned. If the I(wait_for) argument is provided, the
+        module is not returned until the condition is satisfied or
+        the number of retries has expired.
+    required: true
+  wait_for:
+    description:
+      - List of conditions to evaluate against the output of the
+        command. The task will wait for each condition to be true
+        before moving forward. If the conditional is not true
+        within the configured number of I(retries), the task fails.
+        See examples.
+    required: false
+    default: null
+  retries:
+    description:
+      - Specifies the number of retries a command should by tried
+        before it is considered failed. The command is run on the
+        target device every retry and evaluated against the
+        I(wait_for) conditions.
+    required: false
+    default: 10
+  interval:
+    description:
+      - Configures the interval in seconds to wait between retries
+        of the command. If the command does not pass the specified
+        conditions, the interval indicates how long to wait before
+        trying the command again.
+    required: false
+    default: 1
+"""
+
+EXAMPLES = """
+# Note: examples below use the following provider dict to handle
+#       transport and authentication to the node.
+vars:
+  cli:
+    host: "{{ inventory_hostname }}"
+    username: admin
+    password: admin
+    transport: cli
+
+tasks:
+  - name: run show version on remote devices
+    dellos10_command:
+      commands: show version
+      provider: "{{ cli }}"
+
+  - name: run show version and check to see if output contains OS10
+    dellos10_command:
+      commands: show version
+      wait_for: result[0] contains OS10
+      provider: "{{ cli }}"
+
+  - name: run multiple commands on remote nodes
+     dellos10_command:
+      commands:
+        - show version
+        - show interface
+      provider: "{{ cli }}"
+
+  - name: run multiple commands and evaluate the output
+    dellos10_command:
+      commands:
+        - show version
+        - show interface
+      wait_for:
+        - result[0] contains OS10
+        - result[1] contains Ethernet
+      provider: "{{ cli }}"
+"""
+
+RETURN = """
+stdout:
+  description: The set of responses from the commands
+  returned: always
+  type: list
+  sample: ['...', '...']
+
+stdout_lines:
+  description: The value of stdout split into a list
+  returned: always
+  type: list
+  sample: [['...', '...'], ['...'], ['...']]
+
+failed_conditions:
+  description: The list of conditionals that have failed
+  returned: failed
+  type: list
+  sample: ['...', '...']
+
+warnings:
+  description: The list of warnings (if any) generated by module based on arguments
+  returned: always
+  type: list
+  sample: ['...', '...']
+"""
+
+from ansible.module_utils.basic import get_exception
+from ansible.module_utils.netcli import CommandRunner, FailedConditionsError
+from ansible.module_utils.network import NetworkModule, NetworkError
+import ansible.module_utils.dellos10
+
+def to_lines(stdout):
+    for item in stdout:
+        if isinstance(item, basestring):
+            item = str(item).split('\n')
+        yield item
+
+def main():
+    spec = dict(
+        commands=dict(type='list', required=True),
+        wait_for=dict(type='list'),
+        retries=dict(default=10, type='int'),
+        interval=dict(default=1, type='int')
+    )
+
+    module = NetworkModule(argument_spec=spec,
+                           connect_on_load=False,
+                           supports_check_mode=True)
+
+    commands = module.params['commands']
+    conditionals = module.params['wait_for'] or list()
+
+    warnings = list()
+
+    runner = CommandRunner(module)
+
+    for cmd in commands:
+        if module.check_mode and not cmd.startswith('show'):
+            warnings.append('only show commands are supported when using '
+                            'check mode, not executing `%s`' % cmd)
+        else:
+            if cmd.startswith('conf'):
+                module.fail_json(msg='dellos10_command does not support running '
+                                     'config mode commands.  Please use '
+                                     'dellos10_config instead')
+            runner.add_command(cmd)
+
+    for item in conditionals:
+        runner.add_conditional(item)
+
+    runner.retries = module.params['retries']
+    runner.interval = module.params['interval']
+
+    try:
+        runner.run()
+    except FailedConditionsError:
+        exc = get_exception()
+        module.fail_json(msg=str(exc), failed_conditions=exc.failed_conditions)
+    except NetworkError:
+        exc = get_exception()
+        module.fail_json(msg=str(exc))
+
+    result = dict(changed=False)
+
+    result['stdout'] = list()
+    for cmd in commands:
+        try:
+            output = runner.get_command(cmd)
+        except ValueError:
+            output = 'command not executed due to check_mode, see warnings'
+        result['stdout'].append(output)
+
+
+    result['warnings'] = warnings
+    result['stdout_lines'] = list(to_lines(result['stdout']))
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

lib/ansible/modules/network/dellos10/dellos10_config.py

@@ -0,0 +1,284 @@
+#!/usr/bin/python
+#
+# (c) 2015 Peter Sprygada, <psprygada@ansible.com>
+#
+# Copyright (c) 2016 Dell 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/>.
+#
+
+DOCUMENTATION = """
+---
+module: dellos10_config
+version_added: "2.2"
+author: "Senthil Kumar Ganesan (@skg-net)"
+short_description: Manage Dell OS10 configuration sections
+description:
+  - Dell OS10 configurations use a simple block indent file syntax
+    for segmenting configuration into sections.  This module provides
+    an implementation for working with Dell OS10 configuration sections in
+    a deterministic way.
+extends_documentation_fragment: dellos10
+options:
+  lines:
+    description:
+      - The ordered set of commands that should be configured in the
+        section.  The commands must be the exact same commands as found
+        in the device running-config.  Be sure to note the configuration
+        command syntax as some commands are automatically modified by the
+        device config parser. This argument is mutually exclusive with I(src).
+    required: false
+    default: null
+    aliases: ['commands']
+  parents:
+    description:
+      - The ordered set of parents that uniquely identify the section
+        the commands should be checked against.  If the parents argument
+        is omitted, the commands are checked against the set of top
+        level or global commands.
+    required: false
+    default: null
+  src:
+    description:
+      - Specifies the source path to the file that contains the configuration
+        or configuration template to load.  The path to the source file can
+        either be the full path on the Ansible control host or a relative
+        path from the playbook or role root dir.  This argument is mutually
+        exclusive with I(lines).
+    required: false
+    default: null
+  before:
+    description:
+      - The ordered set of commands to push on to the command stack if
+        a change needs to be made.  This allows the playbook designer
+        the opportunity to perform configuration commands prior to pushing
+        any changes without affecting how the set of commands are matched
+        against the system.
+    required: false
+    default: null
+  after:
+    description:
+      - The ordered set of commands to append to the end of the command
+        stack if a change needs to be made.  Just like with I(before) this
+        allows the playbook designer to append a set of commands to be
+        executed after the command set.
+    required: false
+    default: null
+  match:
+    description:
+      - Instructs the module on the way to perform the matching of
+        the set of commands against the current device config.  If
+        match is set to I(line), commands are matched line by line.  If
+        match is set to I(strict), command lines are matched with respect
+        to position.  If match is set to I(exact), command lines
+        must be an equal match.  Finally, if match is set to I(none), the
+        module will not attempt to compare the source configuration with
+        the running configuration on the remote device.
+    required: false
+    default: line
+    choices: ['line', 'strict', 'exact', 'none']
+  replace:
+    description:
+      - Instructs the module on the way to perform the configuration
+        on the device.  If the replace argument is set to I(line) then
+        the modified lines are pushed to the device in configuration
+        mode.  If the replace argument is set to I(block) then the entire
+        command block is pushed to the device in configuration mode if any
+        line is not correct.
+    required: false
+    default: line
+    choices: ['line', 'block']
+  update:
+    description:
+      - The I(update) argument controls how the configuration statements
+        are processed on the remote device.  Valid choices for the I(update)
+        argument are I(merge) and I(check).  When the argument is set to
+        I(merge), the configuration changes are merged with the current
+        device running configuration.  When the argument is set to I(check)
+        the configuration updates are determined but not actually configured
+        on the remote device.
+    required: false
+    default: merge
+    choices: ['merge', 'check']
+  save:
+    description:
+      - The C(save) argument instructs the module to save the running-
+        config to the startup-config at the conclusion of the module
+        running.  If check mode is specified, this argument is ignored.
+    required: false
+    default: no
+    choices: ['yes', 'no']
+  config:
+    description:
+      - The C(config) argument allows the playbook desginer to supply
+        the base configuration to be used to validate configuration
+        changes necessary.  If this argument is provided, the module
+        will not download the running-config from the remote node.
+    required: false
+    default: null
+  backup:
+    description:
+      - This argument will cause the module to create a full backup of
+        the current C(running-config) from the remote device before any
+        changes are made.  The backup file is written to the C(backup)
+        folder in the playbook root directory.  If the directory does not
+        exist, it is created.
+    required: false
+    default: no
+    choices: ['yes', 'no']
+"""
+
+EXAMPLES = """
+- dellos10_config:
+    lines: ['hostname {{ inventory_hostname }}']
+    provider: "{{ cli }}"
+
+- dellos10_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+      - 50 permit ip host 5.5.5.5 any log
+    parents: ['ip access-list test']
+    before: ['no ip access-list test']
+    match: exact
+    provider: "{{ cli }}"
+
+- dellos10_config:
+    lines:
+      - 10 permit ip host 1.1.1.1 any log
+      - 20 permit ip host 2.2.2.2 any log
+      - 30 permit ip host 3.3.3.3 any log
+      - 40 permit ip host 4.4.4.4 any log
+    parents: ['ip access-list test']
+    before: ['no ip access-list test']
+    replace: block
+    provider: "{{ cli }}"
+
+"""
+
+RETURN = """
+updates:
+  description: The set of commands that will be pushed to the remote device
+  returned: always
+  type: list
+  sample: ['...', '...']
+
+responses:
+  description: The set of responses from issuing the commands on the device
+  retured: when not check_mode
+  type: list
+  sample: ['...', '...']
+
+saved:
+  description: Returns whether the configuration is saved to the startup 
+               configuration or not.
+  retured: when not check_mode
+  type: bool
+  sample: True
+
+"""
+from ansible.module_utils.netcfg import NetworkConfig, dumps
+from ansible.module_utils.network import NetworkModule
+from ansible.module_utils.dellos10 import get_config, get_sublevel_config 
+
+def get_candidate(module):
+    candidate = NetworkConfig(indent=1)
+    if module.params['src']:
+        candidate.load(module.params['src'])
+    elif module.params['lines']:
+        parents = module.params['parents'] or list()
+        candidate.add(module.params['lines'], parents=parents)
+    return candidate
+
+
+def main():
+
+    argument_spec = dict(
+        lines=dict(aliases=['commands'], type='list'),
+        parents=dict(type='list'),
+
+        src=dict(type='path'),
+
+        before=dict(type='list'),
+        after=dict(type='list'),
+
+        match=dict(default='line',
+                   choices=['line', 'strict', 'exact', 'none']),
+        replace=dict(default='line', choices=['line', 'block']),
+
+        update=dict(choices=['merge', 'check'], default='merge'),
+        save=dict(type='bool', default=False),
+        config=dict(),
+        backup =dict(type='bool', default=False)
+    )
+
+    mutually_exclusive = [('lines', 'src')]
+
+    module = NetworkModule(argument_spec=argument_spec,
+                           connect_on_load=False,
+                           mutually_exclusive=mutually_exclusive,
+                           supports_check_mode=True)
+
+    parents = module.params['parents'] or list()
+
+    match = module.params['match']
+    replace = module.params['replace']
+    result = dict(changed=False, saved=False)
+
+    candidate = get_candidate(module)
+
+    if match != 'none':
+        config = get_config(module)
+        if parents:
+            contents = get_sublevel_config(config, module)
+            config = NetworkConfig(contents=contents, indent=1)
+        configobjs = candidate.difference(config, match=match, replace=replace)
+
+    else:
+        configobjs = candidate.items
+
+    if module.params['backup']:
+        result['__backup__'] = module.cli('show running-config')[0]
+
+    commands = list()
+    if configobjs:
+        commands = dumps(configobjs, 'commands')
+        commands = commands.split('\n')
+
+        if module.params['before']:
+            commands[:0] = module.params['before']
+
+        if module.params['after']:
+            commands.extend(module.params['after'])
+
+        if not module.check_mode and module.params['update'] == 'merge':
+            response = module.config.load_config(commands)
+            result['responses'] = response
+
+            if module.params['save']:
+                module.config.save_config()
+                result['saved'] = True
+
+        result['changed'] = True
+
+    result['updates'] = commands
+
+    module.exit_json(**result)
+
+if __name__ == '__main__':
+    main()

lib/ansible/modules/network/dellos10/dellos10_facts.py

@@ -0,0 +1,450 @@
+#!/usr/bin/python
+#
+# (c) 2015 Peter Sprygada, <psprygada@ansible.com>
+#
+# Copyright (c) 2016 Dell 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/>.
+#
+DOCUMENTATION = """
+---
+module: dellos10_facts
+version_added: "2.2"
+author: "Senthil Kumar Ganesan (@skg-net)"
+short_description: Collect facts from remote devices running Dell OS10
+description:
+  - Collects a base set of device facts from a remote device that
+    is running Dell OS10.  This module prepends all of the
+    base network fact keys with C(ansible_net_<fact>).  The facts
+    module will always collect a base set of facts from the device
+    and can enable or disable collection of additional facts.
+extends_documentation_fragment: dellos10
+options:
+  gather_subset:
+    description:
+      - When supplied, this argument will restrict the facts collected
+        to a given subset.  Possible values for this argument inlcude
+        all, hardware, config, and interfaces.  Can specify a list of
+        values to include a larger subset.  Values can also be used
+        with an initial M(!) to specify that a specific subset should
+        not be collected.
+    required: false
+    default: '!config'
+"""
+
+EXAMPLES = """
+# Collect all facts from the device
+- dellos10_facts:
+    gather_subset: all
+
+# Collect only the config and default facts
+- dellos10_facts:
+    gather_subset:
+      - config
+
+# Do not collect hardware facts
+- dellos10_facts:
+    gather_subset:
+      - "!hardware"
+"""
+
+RETURN = """
+ansible_net_gather_subset:
+  description: The list of fact subsets collected from the device
+  returned: always
+  type: list
+
+# default
+ansible_net_name:
+  description: The name of the OS which is running
+  returned: always
+  type: str
+ansible_net_version:
+  description: The operating system version running on the remote device
+  returned: always
+  type: str
+ansible_net_servicetag:
+  description: The service tag number of the remote device
+  returned: always
+  type: str
+ansible_net_model:
+  description: The model name returned from the device
+  returned: always
+  type: str
+ansible_net_hostname:
+  description: The configured hostname of the device
+  returned: always
+  type: str
+
+# hardware
+ansible_net_cpu_arch:
+  description: Cpu Architecture of the remote device
+  returned: when hardware is configured
+  type: str
+ansible_net_memfree_mb:
+  description: The available free memory on the remote device in Mb
+  returned: when hardware is configured
+  type: int
+ansible_net_memtotal_mb:
+  description: The total memory on the remote device in Mb
+  returned: when hardware is configured
+  type: int
+
+# config
+ansible_net_config:
+  description: The current active config from the device
+  returned: when config is configured
+  type: str
+
+# interfaces
+ansible_net_all_ipv4_addresses:
+  description: All IPv4 addresses configured on the device
+  returned: when interfaces is configured
+  type: list
+ansible_net_all_ipv6_addresses:
+  description: All IPv6 addresses configured on the device
+  returned: when interfaces is configured
+  type: list
+ansible_net_interfaces:
+  description: A hash of all interfaces running on the system
+  returned: when interfaces is configured
+  type: dict
+ansible_net_neighbors:
+  description: The list of LLDP neighbors from the remote device
+  returned: when interfaces is configured
+  type: dict
+"""
+
+import re
+
+from ansible.module_utils.basic import get_exception
+from ansible.module_utils.netcli import CommandRunner
+from ansible.module_utils.network import NetworkModule
+import ansible.module_utils.dellos10
+
+try:
+    from lxml import etree as ET
+except ImportError:
+    import xml.etree.ElementTree as ET
+
+class FactsBase(object):
+
+    def __init__(self, runner):
+        self.runner = runner
+        self.facts = dict()
+
+        self.commands()
+
+
+class Default(FactsBase):
+
+    def commands(self):
+        self.runner.add_command('show version | display-xml')
+        self.runner.add_command('show system | display-xml')
+        self.runner.add_command('show running-configuration | grep hostname')
+
+    def populate(self):
+
+        data = self.runner.get_command('show version | display-xml')
+        xml_data = ET.fromstring(data)    
+
+        self.facts['name'] = self.parse_name(xml_data)
+        self.facts['version'] = self.parse_version(xml_data)
+
+        data = self.runner.get_command('show system | display-xml')
+        xml_data = ET.fromstring(data)    
+
+        self.facts['servicetag'] = self.parse_serialnum(xml_data)
+        self.facts['model'] = self.parse_model(xml_data)
+
+        data = self.runner.get_command('show running-configuration | grep hostname')
+        self.facts['hostname'] = self.parse_hostname(data)
+
+    def parse_name(self, data):
+        sw_name = data.find('./data/system-sw-state/sw-version/sw-name')    
+        if sw_name is not None:
+            return sw_name.text
+        else:
+            return ""
+ 
+    def parse_version(self, data):
+        sw_ver = data.find('./data/system-sw-state/sw-version/sw-version')    
+        if sw_ver is not None:
+            return sw_ver.text
+        else:
+            return ""
+     
+    def parse_hostname(self, data):
+        match = re.search(r'hostname\s+(\S+)', data, re.M)
+        if match:
+            return match.group(1)
+
+    def parse_model(self, data):
+        prod_name = data.find('./data/system/node/mfg-info/product-name')    
+        if prod_name is not None:
+            return prod_name.text
+        else:
+            return ""
+
+    def parse_serialnum(self, data):
+        svc_tag = data.find('./data/system/node/unit/mfg-info/service-tag')    
+        if svc_tag is not None:
+            return svc_tag.text
+        else:
+            return ""
+
+
+class Hardware(FactsBase):
+
+    def commands(self):
+        self.runner.add_command('show processes memory | grep Total')
+
+    def populate(self):
+
+        data = self.runner.get_command('show version | display-xml')
+        xml_data = ET.fromstring(data)    
+
+        self.facts['cpu_arch'] = self.parse_cpu_arch(xml_data)
+
+        data = self.runner.get_command('show processes memory | grep Total')
+         
+        match = self.parse_memory(data)
+        if match:
+            self.facts['memtotal_mb'] = int(match[0]) / 1024
+            self.facts['memfree_mb'] = int(match[2]) / 1024
+
+    def parse_cpu_arch(self, data):
+        cpu_arch = data.find('./data/system-sw-state/sw-version/cpu-arch')    
+        if cpu_arch is not None:
+            return cpu_arch.text
+        else:
+            return ""
+ 
+    def parse_memory(self, data):
+        return re.findall(r'\:\s*(\d+)', data, re.M)
+
+
+class Config(FactsBase):
+
+    def commands(self):
+        self.runner.add_command('show running-config')
+
+    def populate(self):
+        config = self.runner.get_command('show running-config')
+        self.facts['config'] = config
+
+
+class Interfaces(FactsBase):
+
+    def commands(self):
+        self.runner.add_command('show interface | display-xml')
+
+    def populate(self):
+        self.facts['all_ipv4_addresses'] = list()
+        self.facts['all_ipv6_addresses'] = list()
+
+        data = self.runner.get_command('show interface | display-xml')
+
+        xml_data = ET.fromstring(data)    
+
+        self.facts['interfaces'] = self.populate_interfaces(xml_data)
+        self.facts['neighbors'] = self.populate_neighbors(xml_data)
+
+    def populate_interfaces(self, interfaces):
+        int_facts = dict()
+
+        for interface in interfaces.findall('./data/interfaces/interface'):
+            intf = dict()
+            name = self.parse_item(interface, 'name')
+
+            intf['description'] = self.parse_item(interface, 'description') 
+            intf['duplex'] = self.parse_item(interface, 'duplex')
+            intf['primary_ipv4'] = self.parse_primary_ipv4(interface) 
+            intf['secondary_ipv4'] = self.parse_secondary_ipv4(interface)
+            intf['ipv6'] = self.parse_ipv6_address(interface) 
+            intf['mtu'] = self.parse_item(interface, 'mtu')
+            intf['type'] = self.parse_item(interface, 'type')
+
+            int_facts[name] = intf
+
+        for interface in interfaces.findall('./data/interfaces-state/interface'):
+            name = self.parse_item(interface, 'name')
+            intf = int_facts[name]
+            intf['bandwidth'] = self.parse_item(interface, 'speed')   
+            intf['adminstatus'] = self.parse_item(interface, 'admin-status')
+            intf['operstatus'] = self.parse_item(interface, 'oper-status')
+            intf['macaddress'] = self.parse_item(interface, 'phys-address')
+
+        for interface in interfaces.findall('./data/ports/ports-state/port'):
+            name = self.parse_item(interface, 'name')
+            fanout = self.parse_item(interface, 'fanout-state')
+            mediatype = self.parse_item(interface, 'media-type')  
+
+            typ, sname = name.split('-eth')
+
+            if fanout == "BREAKOUT_1x1":
+                name = "ethernet" + sname
+                intf = int_facts[name]
+                intf['mediatype'] = mediatype  
+            else:
+                #TODO: Loop for the exact subport
+                for subport in xrange(1, 5):
+                    name = "ethernet" + sname + ":" + str(subport)
+                    intf = int_facts[name]
+                    intf['mediatype'] = mediatype  
+
+        return int_facts
+
+    def add_ip_address(self, address, family):
+        if family == 'ipv4':
+            self.facts['all_ipv4_addresses'].append(address)
+        else:
+            self.facts['all_ipv6_addresses'].append(address)
+
+    def parse_item(self, interface, item):
+        elem = interface.find(item)
+        if elem is not None:
+            return elem.text
+        else:
+            return ""
+
+    def parse_primary_ipv4(self, interface):
+        ipv4 = interface.find('ipv4')
+        ip_address = ""
+        if ipv4 is not None:
+            prim_ipaddr  = ipv4.find('./address/primary-addr')
+            if prim_ipaddr is not None:
+                ip_address = prim_ipaddr.text
+                self.add_ip_address(ip_address, 'ipv4')
+
+        return ip_address
+
+    def parse_secondary_ipv4(self, interface):
+        ipv4 = interface.find('ipv4')
+        ip_address = ""
+        if ipv4 is not None:
+            sec_ipaddr  = ipv4.find('./address/secondary-addr')
+            if sec_ipaddr is not None:
+                ip_address = sec_ipaddr.text
+                self.add_ip_address(ip_address, 'ipv4')
+
+        return ip_address
+
+    def parse_ipv6_address(self, interface):
+        ipv6 = interface.find('ipv6')
+        ip_address = ""
+        if ipv6 is not None:
+            ipv6_addr  = ipv6.find('./address/ipv6-address')
+            if ipv6_addr is not None:
+                ip_address = ipv6_addr.text
+                self.add_ip_address(ip_address, 'ipv6')
+
+        return ip_address
+
+    def populate_neighbors(self, interfaces):
+        lldp_facts = dict()
+        for interface in interfaces.findall('./data/interfaces-state/interface'):
+            name = interface.find('name').text
+            rem_sys_name = interface.find('./lldp-rem-neighbor-info/info/rem-system-name')
+            if rem_sys_name is not None:
+                lldp_facts[name] = list()
+                fact = dict()
+                fact['host'] = rem_sys_name.text
+                rem_sys_port = interface.find('./lldp-rem-neighbor-info/info/rem-lldp-port-id')
+                fact['port'] = rem_sys_port.text 
+                lldp_facts[name].append(fact)
+
+        return lldp_facts     
+ 
+FACT_SUBSETS = dict(
+    default=Default,
+    hardware=Hardware,
+    interfaces=Interfaces,
+    config=Config,
+)
+
+VALID_SUBSETS = frozenset(FACT_SUBSETS.keys())
+
+
+def main():
+    spec = dict(
+        gather_subset=dict(default=['!config'], type='list')
+    )
+
+    module = NetworkModule(argument_spec=spec, supports_check_mode=True)
+
+    gather_subset = module.params['gather_subset']
+
+    runable_subsets = set()
+    exclude_subsets = set()
+
+    for subset in gather_subset:
+        if subset == 'all':
+            runable_subsets.update(VALID_SUBSETS)
+            continue
+
+        if subset.startswith('!'):
+            subset = subset[1:]
+            if subset == 'all':
+                exclude_subsets.update(VALID_SUBSETS)
+                continue
+            exclude = True
+        else:
+            exclude = False
+
+        if subset not in VALID_SUBSETS:
+            module.fail_json(msg='Bad subset')
+
+        if exclude:
+            exclude_subsets.add(subset)
+        else:
+            runable_subsets.add(subset)
+
+    if not runable_subsets:
+        runable_subsets.update(VALID_SUBSETS)
+
+    runable_subsets.difference_update(exclude_subsets)
+    runable_subsets.add('default')
+
+    facts = dict()
+    facts['gather_subset'] = list(runable_subsets)
+
+    runner = CommandRunner(module)
+
+    instances = list()
+    for key in runable_subsets:
+        runs = FACT_SUBSETS[key](runner)
+        instances.append(runs)
+
+    runner.run()
+
+    try:
+        for inst in instances:
+            inst.populate()
+            facts.update(inst.facts)
+    except Exception:
+        module.exit_json(out=module.from_json(runner.items))
+
+    ansible_facts = dict()
+    for key, value in facts.iteritems():
+        key = 'ansible_net_%s' % key
+        ansible_facts[key] = value
+
+    module.exit_json(ansible_facts=ansible_facts)
+
+
+if __name__ == '__main__':
+    main()

lib/ansible/modules/network/dellos10/dellos10_template.py

@@ -0,0 +1,180 @@
+#!/usr/bin/python
+#
+# (c) 2015 Peter Sprygada, <psprygada@ansible.com>
+#
+# Copyright (c) 2016 Dell 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/>.
+#
+DOCUMENTATION = """
+---
+module: dellos10_template
+version_added: "2.2"
+author: "Senthil Kumar Ganesan (@skg-net)"
+short_description: Manage Dell OS10 device configurations over SSH.
+description:
+  - Manages Dell OS10 network device configurations over SSH.  This module
+    allows implementors to work with the device running-config.  It
+    provides a way to push a set of commands onto a network device
+    by evaluating the current running-config and only pushing configuration
+    commands that are not already configured.  The config source can
+    be a set of commands or a template.
+extends_documentation_fragment: dellos10
+options:
+  src:
+    description:
+      - The path to the config source.  The source can be either a
+        file with config or a template that will be merged during
+        runtime.  By default the task will first search for the source
+        file in role or playbook root folder in templates unless a full
+        path to the file is given.
+    required: true
+  force:
+    description:
+      - The force argument instructs the module not to consider the
+        current device running-config.  When set to true, this will
+        cause the module to push the contents of I(src) into the device
+        without first checking if already configured. This argument is
+        mutually exclusive with I(config).
+    required: false
+    default: false
+    choices: [ "true", "false" ]
+  backup:
+    description:
+      - When this argument is configured true, the module will backup
+        the running-config from the node prior to making any changes.
+        The backup file will be written to backup_{{ hostname }} in
+        the root of the playbook directory. This argument is
+        mutually exclusive with I(config).
+
+    required: false
+    default: false
+    choices: [ "true", "false" ]
+  config:
+    description:
+      - The module, by default, will connect to the remote device and
+        retrieve the current running-config to use as a base for comparing
+        against the contents of source.  There are times when it is not
+        desirable to have the task get the current running-config for
+        every task.  The I(config) argument allows the implementer to
+        pass in the configuration to use as the base config for
+        comparison. This argument is mutually exclusive with
+        I(force) and I(backup).
+
+    required: false
+    default: null
+"""
+
+EXAMPLES = """
+- name: push a configuration onto the device
+  dellos10_template:
+    host: hostname
+    username: foo
+    src: config.j2
+
+- name: forceable push a configuration onto the device
+  dellos10_template:
+    host: hostname
+    username: foo
+    src: config.j2
+    force: yes
+
+- name: provide the base configuration for comparison
+  dellos10_template:
+    host: hostname
+    username: foo
+    src: candidate_config.txt
+    config: current_config.txt
+"""
+
+RETURN = """
+updates:
+  description: The set of commands that will be pushed to the remote device
+  returned: always
+  type: list
+  sample: ['...', '...']
+
+_backup:
+  description: The current running config of the remote device.
+  returned: when running config is present in the remote device.
+  type: list
+  sample: ['...', '...']
+
+responses:
+  description: The set of responses from issuing the commands on the device
+  returned: when not check_mode
+  type: list
+  sample: ['...', '...']
+"""
+from ansible.module_utils.netcfg import NetworkConfig, dumps
+from ansible.module_utils.network import NetworkModule
+import ansible.module_utils.dellos10
+
+
+def get_config(module):
+    config = module.params['config'] or dict()
+    if not config and not module.params['force']:
+        config = module.config.get_config()
+    return config
+
+
+def main():
+    """ main entry point for module execution
+    """
+
+    argument_spec = dict(
+        src=dict(),
+        force=dict(default=False, type='bool'),
+        backup=dict(default=False, type='bool'),
+        config=dict(),
+    )
+
+    mutually_exclusive = [('config', 'backup'), ('config', 'force')]
+
+    module = NetworkModule(argument_spec=argument_spec,
+                           mutually_exclusive=mutually_exclusive,
+                           supports_check_mode=True)
+
+    result = dict(changed=False)
+
+    candidate = NetworkConfig(contents=module.params['src'], indent=1)
+
+    
+    contents = get_config(module)
+   
+    if contents:
+        config = NetworkConfig(contents=contents[0], indent=1)
+        result['_backup'] = contents[0]
+
+    commands = list()
+    if not module.params['force']:
+        commands = dumps(candidate.difference(config), 'commands')
+    else:
+        commands = str(candidate)
+
+    if commands:
+        commands = commands.split('\n')
+        if not module.check_mode:
+            response = module.config(commands)
+            result['responses'] = response
+        result['changed'] = True
+
+    result['updates'] = commands
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()