You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Network Developer Guide

Welcome to the Developer Guide for Ansible Network Automation!

Who should use this guide?

If you want to extend Ansible for Network Automation by creating a module or plugin, this guide is for you. This guide is specific to networking. You should already be familiar with how to create, test, and document modules and plugins, as well as the prerequisites for getting your module or plugin accepted into the main Ansible repository. See the Developer Guide for details. Before you proceed, please read:

• How to add a custom plugin or module locally.

• How to figure out if developing a module is the right approach for my use case.

• How to set up my Python development environment.

• How to get started writing a module.

Find the network developer task that best describes what you want to do:

• I want to develop a network resource module.

• I want to develop a network connection plugin.

• I want to document my set of modules for a network platform.

If you prefer to read the entire guide, here’s a list of the pages in order.

• Developing network resource modules
• Developing network plugins
• Documenting new network platforms