80e7e1a17c
* Due to the takeover of freenode we're moving to a different irc network. * Our channels updated to point at the same channel name on libera.chat * Some links went to webchat.freenode.net. At this time, libera.chat doesn't point you to an official webchat client so I changed these to https://libera.chat. (kiwi irc does work with libera.chat so that could be another option). * In general, I used the name irc.libera.net for link names and https://libera.chat for link targets. This is because the irc service is hosted on irc.libera.chat but the project web server is hosted on libera.chat. (This appears to also be true for freenode but we were using http://irc.freenode.net which doesn't seem to work. Oops). * Removed http://irc.freenode.net from the linkcheck exceptions. linkcheck was actually correct to flag that as invalid (should have been http://frenode.net instead). * Looks like hte important people in #yaml are now in libera.chat * Link to where contributors should get help Add a link target and then link to where contributors should get support for developing groups of modules. * Update docs/docsite/rst/dev_guide/developing_modules_in_groups.rst Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: John R Barker <john@johnrbarker.com> Co-authored-by: Felix Fontein <felix@fontein.de>
47 lines
1.9 KiB
ReStructuredText
47 lines
1.9 KiB
ReStructuredText
.. _cliconf_plugins:
|
|
|
|
Cliconf Plugins
|
|
===============
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
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. Ansible loads the appropriate cliconf plugin automatically 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 affect how tasks are translated into CLI commands.
|
|
|
|
Plugins are self-documenting. Each plugin should document its configuration options.
|
|
|
|
.. _cliconf_plugin_list:
|
|
|
|
Viewing cliconf plugins
|
|
-----------------------
|
|
|
|
These plugins have migrated to collections on `Ansible Galaxy <https://galaxy.ansible.com>`_. If you installed Ansible version 2.10 or later using ``pip``, you have access to several cliconf plugins. To list all available cliconf plugins on your control node, type ``ansible-doc -t cliconf -l``. To view plugin-specific documentation and examples, use ``ansible-doc -t cliconf``.
|
|
|
|
|
|
.. 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.libera.chat <https://libera.chat/>`_
|
|
#ansible-network IRC chat channel
|