Cliconf Plugins

Warning

Links on this page may not point to the most recent versions of plugins. In preparation for the release of 2.10, many plugins and modules have migrated to Collections on Ansible Galaxy. For the current development status of Collections and FAQ see Ansible Collections Community Guide.

Cliconf plugins are abstractions over the CLI interface to network devices. They provide a standard interface for Ansible to execute tasks on those network devices.

These plugins generally correspond one-to-one to network device platforms. The appropriate cliconf plugin will thus be automatically loaded based on the ansible_network_os variable.

Adding cliconf plugins

You can extend Ansible to support other network devices by dropping a custom plugin into the cliconf_plugins directory.

Using cliconf plugins

The cliconf plugin to use is determined automatically from the ansible_network_os variable. There should be no reason to override this functionality.

Most cliconf plugins can operate without configuration. A few have additional options that can be set to impact how tasks are translated into CLI commands.

Plugins are self-documenting. Each plugin should document its configuration options.

Plugin list

These plugins have migrated to a collection. Updates on where to find and how to use them will be coming soon.

See also

Ansible for Network Automation
An overview of using Ansible to automate networking devices.
User Mailing List
Have a question? Stop by the google group!
irc.freenode.net
#ansible-network IRC chat channel