Nautobot ChatOps App

A multi-platform ChatOps bot App for Nautobot.

Overview

• Support for multiple chat platforms:
  • Mattermost
  • Microsoft Teams
  • Slack
  • Cisco Webex
• Support for multiple integrations:
  • Cisco ACI
  • AWX / Ansible Tower
  • Arista CloudVision
  • Grafana
  • IPFabric
  • Cisco Meraki
  • Palo Alto Panorama
• Write a command once and run it on every supported platform, including rich content formatting.
• Extensible - other Nautobot apps can provide additional commands which will be dynamically discovered.
• Automatic generation of basic help menus (accessed via help, /command help, or /command sub-command help).
• Metrics of command usage via the nautobot_capacity_metrics app.

Screenshots

Command: /nautobot

Command: /nautobot get-devices

Command: /nautobot get-interface-connections

Try it out!

This App is installed in the Nautobot Community Sandbox found over at demo.nautobot.com!

For a full list of all the available always-on sandbox environments, head over to the main page on networktocode.com.

Documentation

Full documentation for this App can be found over on the Nautobot Docs website:

• User Guide - Overview, Using the App, Getting Started.
• Administrator Guide - How to Install, Configure, Upgrade, or Uninstall the App.
• Developer Guide - Extending the App, Code Reference, Contribution Guide.
• Release Notes / Changelog.
• Frequently Asked Questions.
• Glossary

Contributing to the Documentation

You can find all the Markdown source for the App documentation under the docs folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.

If you need to view the fully-generated documentation site, you can build it with MkDocs. A container hosting the documentation can be started using the invoke commands (details in the Development Environment Guide) on http://localhost:8001. Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.

Any PRs with fixes or improvements are very welcome!

Questions

For any questions or comments, please check the FAQ first and feel free to swing by the Network to Code slack channel (channel #nautobot). Sign up here

Acknowledgements

This project includes code originally written in separate apps, which have been merged into this project:

• nautobot-plugin-chatops-aci: Thanks @mamullen13316, @smk4664, @ubajze, @whitej6,
• nautobot-plugin-chatops-ansible: Thanks @chipn, @dgjustice, @jeffkala, @jvanderaa, @matt852, @smk4664, @ubajze, @whitej6,
• nautobot-plugin-chatops-arista-cloudvision: Thanks @qduk, @ubajze, @whitej6,
• nautobot-plugin-chatops-grafana: Thanks @jedelman8, @josh-silvas, @nniehoff, @tim-fiola, @ubajze, @whitej6,
• nautobot-plugin-chatops-ipfabric: Thanks @alhogan, @chadell, @chipn, @justinjeffery-ipf, @nniehoff, @pke11y, @scetron, @smk4664, @ubajze, @whitej6,
• nautobot-plugin-chatops-meraki: Thanks @jedelman8, @jeffkala, @qduk, @tim-fiola, @ubajze, @whitej6,
• nautobot-plugin-chatops-panorama: Thanks @FragmentedPacket, @PhillSimonds, @armartirosyan, @itdependsnetworks, @jamesholland-uk, @jdrew82, @matt852, @qduk, @ubajze, @whitej6,