ansible/network/nxos/nxos_facts.py

#!/usr/bin/python
#
# 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: nxos_facts
version_added: "2.1"
short_description: Gets facts about NX-OS switches
description:
  - Collects facts from Cisco Nexus devices running the NX-OS operating
    system.  Fact collection is supported over both Cli and Nxapi
    transports.  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: nxos
author:
    - Jason Edelman (@jedelman8)
    - Gabriele Gerbino (@GGabriele)
options:
  gather_subset:
    description:
      - When supplied, this argument will restrict the facts collected
        to a given subset.  Possible values for this argument include
        all, hardware, config, legacy, and interfaces.  Can specify a
        list of values to include a larger subset.  Values can also be used
        with an initial C(M(!)) to specify that a specific subset should
        not be collected.
    required: false
    default: '!config'
    version_added: "2.2"
"""

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

- nxos_facts:
    gather_subset: all

# Collect only the config and default facts
- nxos_facts:
    gather_subset:
      - config

# Do not collect hardware facts
- nxos_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_model:
  description: The model name returned from the device
  returned: always
  type: str
ansible_net_serialnum:
  description: The serial number of the remote device
  returned: always
  type: str
ansible_net_version:
  description: The operating system version running on the remote device
  returned: always
  type: str
ansible_net_hostname:
  description: The configured hostname of the device
  returned: always
  type: string
ansible_net_image:
  description: The image file the device is running
  returned: always
  type: string

# hardware
ansible_net_filesystems:
  description: All file system names availabe on the device
  returned: when hardware is configured
  type: list
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

# legacy (pre Ansible 2.2)
fan_info:
  description: A hash of facts about fans in the remote device
  returned: when legacy is configured
  type: dict
hostname:
  description: The configured hostname of the remote device
  returned: when legacy is configured
  type: dict
interfaces_list:
  description: The list of interface names on the remote device
  returned: when legacy is configured
  type: dict
kickstart:
  description: The software version used to boot the system
  returned: when legacy is configured
  type: str
module:
  description: A hash of facts about the modules in a remote device
  returned: when legacy is configured
  type: dict
platform:
  description: The hardware platform reported by the remote device
  returned: when legacy is configured
  type: str
power_supply_info:
  description: A hash of facts about the power supplies in the remote device
  returned: when legacy is configured
  type: str
vlan_list:
  description: The list of VLAN IDs configured on the remote device
  returned: when legacy is configured
  type: list
"""
import re

from ansible.module_utils.basic import get_exception
from ansible.module_utils.netcli import CommandRunner, AddCommandError
from ansible.module_utils.nxos import NetworkModule, NetworkError


def add_command(runner, command, output=None):
    try:
        runner.add_command(command, output)
    except AddCommandError:
        # AddCommandError is raised for any issue adding a command to
        # the runner.  Silently ignore the exception in this case
        pass

class FactsBase(object):

    def __init__(self, module, runner):
        self.module = module
        self.runner = runner
        self.facts = dict()
        self.commands()


class Default(FactsBase):

    SYSTEM_MAP = {
        'sys_ver_str': 'version',
        'proc_board_id': 'serialnum',
        'chassis_id': 'model',
        'isan_file_name': 'image',
        'host_name': 'hostname'
    }

    def commands(self):
        add_command(self.runner, 'show version', output='json')

    def populate(self):
        data = self.runner.get_command('show version', output='json')
        for key, value in self.SYSTEM_MAP.iteritems():
            if key in data:
                self.facts[value] = data[key]

class Config(FactsBase):

    def commands(self):
        add_command(self.runner, 'show running-config')

    def populate(self):
        self.facts['config'] = self.runner.get_command('show running-config')


class Hardware(FactsBase):

    def commands(self):
        add_command(self.runner, 'dir', output='text')
        add_command(self.runner, 'show system resources', output='json')

    def populate(self):
        data = self.runner.get_command('dir', 'text')
        self.facts['filesystems'] = self.parse_filesystems(data)

        data = self.runner.get_command('show system resources', output='json')
        self.facts['memtotal_mb'] = int(data['memory_usage_total']) / 1024
        self.facts['memfree_mb'] = int(data['memory_usage_free']) / 1024

    def parse_filesystems(self, data):
        return re.findall(r'^Usage for (\S+)//', data, re.M)


class Interfaces(FactsBase):

    INTERFACE_MAP = {
        'state': 'state',
        'desc': 'description',
        'eth_bw': 'bandwidth',
        'eth_duplex': 'duplex',
        'eth_speed': 'speed',
        'eth_mode': 'mode',
        'eth_ip_addr': 'address',
        'eth_ip_mask': 'masklen',
        'eth_hw_addr': 'macaddress',
        'eth_mtu': 'mtu',
        'eth_hw_desc': 'type'
    }

    INTERFACE_IPV4_MAP = {
        'eth_ip_addr': 'address',
        'eth_ip_mask': 'masklen'
    }

    INTERFACE_IPV6_MAP = {
        'addr': 'address',
        'prefix': 'subnet'
    }

    def commands(self):
        add_command(self.runner, 'show interface', output='json')

        resp = self.module.cli(['show ipv6 interface | wc lines'])
        if int(resp[0]) > 1:
            add_command(self.runner, 'show ipv6 interface', output='json')
            self.ipv6 = True
        else:
            self.ipv6 = False

        try:
            self.module.cli(['show lldp neighbors'])
            add_command(self.runner, 'show lldp neighbors', output='json')
            self.lldp_enabled = True
        except NetworkError:
            self.lldp_enabled = False

    def populate(self):
        self.facts['all_ipv4_addresses'] = list()
        self.facts['all_ipv6_addresses'] = list()

        data = self.runner.get_command('show interface', 'json')
        self.facts['interfaces'] = self.populate_interfaces(data)

        if self.ipv6:
            data = self.runner.get_command('show ipv6 interface', 'json')
            if data:
                self.parse_ipv6_interfaces(data)

        if self.lldp_enabled:
            data = self.runner.get_command('show lldp neighbors', 'json')
            self.facts['neighbors'] = self.populate_neighbors(data)

    def populate_interfaces(self, data):
        interfaces = dict()
        for item in data['TABLE_interface']['ROW_interface']:
            intf = dict()
            name = item['interface']

            for key, value in self.INTERFACE_MAP.iteritems():
                if key in item:
                    intf[value] = item[key]

            if 'eth_ip_addr' in item:
                intf['ipv4'] = dict()
                for key, value in self.INTERFACE_IPV4_MAP.iteritems():
                    if key in item:
                        intf['ipv4'][value] = item[key]
                self.facts['all_ipv4_addresses'].append(item['eth_ip_addr'])

            interfaces[name] = intf

        return interfaces

    def populate_neighbors(self, data):
        data = data['TABLE_nbor']
        if isinstance(data, dict):
            data = [data]

        objects = dict()
        for item in data:
            local_intf = item['ROW_nbor']['l_port_id']
            if local_intf not in objects:
                objects[local_intf] = list()
            nbor = dict()
            nbor['port'] = item['ROW_nbor']['port_id']
            nbor['host'] = item['ROW_nbor']['chassis_id']
            objects[local_intf].append(nbor)
        return objects

    def parse_ipv6_interfaces(self, data):
        data = data['TABLE_intf']

        if isinstance(data, dict):
            data = [data]

        for item in data:
            name = item['ROW_intf']['intf-name']
            intf = self.facts['interfaces'][name]

            intf['ipv6'] = dict()
            for key, value in self.INTERFACE_IPV6_MAP.iteritems():
                intf['ipv6'][value] = item['ROW_intf'][key]

            self.facts['all_ipv6_addresses'].append(item['ROW_intf']['addr'])

class Legacy(FactsBase):
    # facts from nxos_facts 2.1

    def commands(self):
        add_command(self.runner, 'show version', output='json')
        add_command(self.runner, 'show module', output='json')
        add_command(self.runner, 'show environment', output='json')
        add_command(self.runner, 'show interface', output='json')
        add_command(self.runner, 'show vlan brief', output='json')

    def populate(self):
        data = self.runner.get_command('show version', 'json')
        self.facts['_hostname'] = data['host_name']
        self.facts['_kickstart'] = data['kickstart_ver_str']
        self.facts['_platform'] = data['chassis_id']

        if 'rr_sys_ver' in data:
            self.facts['_os'] = data['rr_sys_ver']

        if 'rr_reason' in data:
            self.facts['_rr'] = data['rr_reason']

        data = self.runner.get_command('show interface', 'json')
        self.facts['_interfaces_list'] = self.parse_interfaces(data)

        data = self.runner.get_command('show vlan brief', 'json')
        self.facts['_vlan_list'] = self.parse_vlans(data)

        data = self.runner.get_command('show module', 'json')
        self.facts['_module'] = self.parse_module(data)

        data = self.runner.get_command('show environment', 'json')
        self.facts['_fan_info'] = self.parse_fan_info(data)
        self.facts['_power_supply_info'] = self.parse_power_supply_info(data)

    def parse_interfaces(self, data):
        objects = list()
        for item in data['TABLE_interface']['ROW_interface']:
            objects.append(item['interface'])
        return objects

    def parse_vlans(self, data):
        objects = list()
        data = data['TABLE_vlanbriefxbrief']['ROW_vlanbriefxbrief']
        if isinstance(data, dict):
            objects.append(data['vlanshowbr-vlanid-utf'])
        elif isinstance(data, list):
            for item in data:
                objects.append(item['vlanshowbr-vlanid-utf'])
        return objects

    def parse_module(self, data):
        modules = list()
        for item in data['TABLE_modinfo']['ROW_modinfo']:
            mod = dict()
            mod['model'] = item['model']
            mod['type'] = item['modtype']
            mod['ports'] = item['ports']
            mod['status'] = item['status']
            modules.append(mod)
        return modules

    def parse_fan_info(self, data):
        objects = list()
        for item in data['fandetails']['TABLE_faninfo']['ROW_faninfo']:
            obj = dict()
            obj['name'] = item['fanname']
            obj['model'] = item['fanmodel']
            if 'fanhwver' in item:
                obj['hw_ver'] = item['fanhwver']
            if 'fandir' in item:
                obj['direction'] = item['fandir']
            if 'fanstatus' in item:
                obj['status'] = item['fanstatus']
            objects.append(obj)
        return objects

    def parse_power_supply_info(self, data):
        objects = list()
        for item in data['powersup']['TABLE_psinfo']['ROW_psinfo']:
            obj = dict()
            obj['model'] = item['psmodel']
            obj['number'] = item['psnum']
            obj['status'] = item['ps_status']
            if 'actual_out' in item:
                obj['actual_output'] = item['actual_out']
            if 'actual_in' in item:
                obj['actual_in'] = item['actual_in']
            if 'total_capa' in item:
                obj['total_capacity'] = item['total_capa']
            objects.append(obj)
        return objects



FACT_SUBSETS = dict(
    default=Default,
    legacy=Legacy,
    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:
        instances.append(FACT_SUBSETS[key](module, runner))

    try:
        runner.run()
    except NetworkError:
        exc = get_exception()
        module.fail_json(msg=str(exc), **exc.kwargs)

    try:
        for inst in instances:
            inst.populate()
            facts.update(inst.facts)
    except Exception:
        raise
        module.exit_json(out=module.from_json(runner.items))

    ansible_facts = dict()
    for key, value in facts.iteritems():
        # this is to maintain capability with nxos_facts 2.1
        if key.startswith('_'):
            ansible_facts[key[1:]] = value
        else:
            key = 'ansible_net_%s' % key
            ansible_facts[key] = value

    module.exit_json(ansible_facts=ansible_facts)


if __name__ == '__main__':
    main()