54 lines
2 KiB
ReStructuredText
54 lines
2 KiB
ReStructuredText
.. _cliconf_plugins:
|
|
|
|
Cliconf Plugins
|
|
===============
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. 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 <https://galaxy.ansible.com>`_. For the current development status of Collections and FAQ see `Ansible Collections Community Guide <https://github.com/ansible-collections/overview/blob/main/README.rst>`_.
|
|
|
|
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.
|
|
|
|
.. _enabling_cliconf:
|
|
|
|
Adding cliconf plugins
|
|
-------------------------
|
|
|
|
You can extend Ansible to support other network devices by dropping a custom plugin into the ``cliconf_plugins`` directory.
|
|
|
|
.. _using_cliconf:
|
|
|
|
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.
|
|
|
|
.. _cliconf_plugin_list:
|
|
|
|
Plugin list
|
|
-----------
|
|
|
|
These plugins have migrated to a collection. Updates on where to find and how to use them will be coming soon.
|
|
|
|
|
|
.. seealso::
|
|
|
|
:ref:`Ansible for Network Automation<network_guide>`
|
|
An overview of using Ansible to automate networking devices.
|
|
`User Mailing List <https://groups.google.com/group/ansible-devel>`_
|
|
Have a question? Stop by the google group!
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible-network IRC chat channel
|