Initial release

Author: optiz0r

Diff for: .gitignore

@@ -0,0 +1,8 @@
+# python virtualenv
+env
+
+# Generated files
+*.pyc
+
+# Local inventory file
+inventory

Diff for: .gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/ntc-ansible"]
+	path = lib/ntc-ansible
+	url = https://github.com/networktocode/ntc-ansible.git

Diff for: CHANGELOG.md

@@ -0,0 +1,4 @@
+= v0.1 - 2017-12-14
+
+* Initial release
+

Diff for: README.md

@@ -0,0 +1,102 @@
+# ansible-multicast-graph
+
+Visualises the multicast trees for a single IPv4 group address  using information
+scraped from NX-OS, EOS and IOS devices using ansible, ntc-ansible and TextFSM.
+
+It is capable of showing the following information (provided all relevant
+devices are queried):
+
+* The Rendezvouz Point device
+* What every other device believes the RP to be (to help detect config mismatches)
+* The direction of traffic flow on the shared multicast tree
+* The direction of traffic flow on any source-specific multicast trees
+* The publishes (IP addresses and name as discovered through LLDP)
+* The subscribers (as discovered through IGMP Snooping and LLDP)
+
+![An example report](example.png)
+
+This tool is very young and could be significantly improved upon.
+It was a first attempt at doing something useful while studying for Ivan Pepelnjak's
+[Building Network Automation Solutions](http://www.ipspace.net/Building_Network_Automation_Solutions)
+course.
+
+## Quick start
+
+* Clone this repository
+* Initialise the ntc-ansible submodule:
+
+```bash
+git submodule update --init --recursive
+```
+
+* Create a python virtualenv and install the dependencies:
+
+```bash
+virtualenv env
+source env/bin/activate
+pip install -r requirements.txt
+```
+
+* Update the `hosts` inventory file with your own devices
+* Create a vault file at `secrets/vault.yml` if you need ssh username and password
+to access your devices, otherwise just create an empty file there:
+
+```bash
+ansible-vault create secrets/vault.yml
+# or
+touch secrets/vault.yml
+```
+
+* Run the tool for your chosen multicast group with:
+
+```bash
+ansible-playbook check_group.yml --extra-vars "mcast_group=224.0.0.123"
+```
+
+The rendered graph will be written to the `outputs` directory with the group
+address as the filename and a .`.png` extension, e.g. `outputs/224.0.0.123.png`.
+
+If you need to use a bastion host to connect to your network devices, uncomment the
+line in `hosts` file, and change the hostname of the bastion host there. Also edit
+`ssh_config` and set the right hostname there.
+
+## Dependencies
+
+* python (tested with 2.7 only)
+* ansible (tested with 2.3)
+* graphviz
+
+This tool depends on several python libraries which are listed in the
+`requirements.txt` file, which is intended to be used with a python virtualenv.
+
+## How it works
+
+The playbook has several stages (each of which is tagged and can be run separately):
+
+* `setup` - Creates the output directories
+* `fetch` - Fetches information from each device and writes them to separate output
+files. This stage is split into mutiple sub-stages, each of which are written to
+separate fiels.
+** `fetch-interfaces` - Retrieves list of interfaces
+** `fetch-lags` - Retrieves the list of link-aggregation groups
+** `fetch-neighbours` - Retrieves the list of LLDP neighbours
+** `fetch-rp` - Retrieves the Rendezvouz Point
+** `fetch-mroutes` - Retrieves the list of mroutes
+** `fetch-snooping` - Retrieves the list of IGMP subscribers
+* `compile` - Merges the separate output files into a single report for easier
+processing
+* `generate` - Generates the dot graph from the compiled report
+* `render` - Renders the output `png` image from the dot graph
+
+The data is scraped from the devices using `ntc-ansible` and `ntc-templates`.
+This tool ships its own modified copy of several of the TextFSM templates shipped
+by ntc-templates which did not retrieve all of the necessary data. I intend to
+upstream those modifications when time permits.
+
+All of the business logic for calculating the list of devices and relationships
+in the dot graph is done (ab)using jinja2 filters.
+
+## Contributions
+
+Pull requests are very much welcome!
+

Diff for: ansible.cfg

@@ -0,0 +1,10 @@
+[defaults]
+transport=paramiko
+hostfile=./hosts
+host_key_checking=False
+timeout=5
+retry_files_enabled = False
+
+library = env/lib/python2.7/site-packages/napalm_ansible/:lib/ntc-ansible/library
+#stdout_callback = selective
+callback_whitelist = profile_tasks

Diff for: check_group.yml

@@ -0,0 +1,63 @@
+---
+- name: Collate multicast details
+  hosts: all
+  connection: local
+  gather_facts: false
+  vars_files:
+    - "{{vault_file|default('./secrets/vault.yml')}}"
+    - "{{inventory_dir}}/vars/ntc.yml"
+  vars:
+    mcast_group: "UNSET"
+    mcast_net: "224.0.0.0/4"
+    results: "{{inventory_dir}}/outputs"
+    host_results: "{{ results }}/{{ inventory_hostname }}"
+    task_list:
+      - "tasks/{{os}}/{{task_path|basename}}"
+      - "{{task_path}}"
+
+  tasks:
+    - name: Validate multicast group address
+      fail:
+        msg: "Valid multicast group must be passed to playbook with -e/--extra-vars, e.g. `-e mcast_group=224.0.0.1`"
+      when: not mcast_group|ipaddr or not mcast_group|ipaddr(mcast_net)
+
+    - name: Create output directories
+      local_action: file path={{ results }} state=directory
+      run_once: true
+      tags: ['setup']
+
+    - name: Create host output directories
+      local_action: file path={{ host_results }} state=directory
+      tags: ['setup']
+
+    - name: "Include tasks"
+      include: "{{ lookup('first_found', task_list) }}"
+      with_fileglob: [ "tasks/*.yml" ]
+      loop_control:
+        loop_var: task_path
+
+    - name: "Compile Report"
+      template:
+        src: "templates/report.j2"
+        dest: "{{results}}/{{mcast_group}}.yaml"
+      run_once: true
+      tags: ['compile']
+
+    - name: "Generate Graph"
+      template:
+        src: "templates/graph.j2"
+        dest: "{{results}}/{{mcast_group}}.dot"
+      vars:
+        report: "{{ lookup('file', results + '/' + mcast_group + '.yaml')|from_yaml }}"
+        edges: "{{ report|get_mroute_edges(mcast_group, play_hosts) }}"
+      run_once: true
+      tags: ['generate']
+
+    - name: "Render Graph"
+      command: dot -Tpng "{{results}}/{{mcast_group}}.dot" -o "{{results}}/{{mcast_group}}.png"
+      run_once: true
+      tags: ['render']
+
+
+
+# vim: set ts=2 shiftwidth=2 expandtab :

Diff for: example.png

@@ -0,0 +1,9 @@
+class FilterModule(object):
+
+    def indent_block(self, value, indent=2):
+        return "\n".join([' '*indent + l for l in value.splitlines()])
+
+    def filters(self):
+        return {
+            'indent_block': self.indent_block,
+        }