7ad238b358
* Create new documentation pages for httpapi and cliconf * Add new documentation to plugins toctree and Makefile * Add DOCUMENTATION to cliconf * Apply suggestions from code review
1.7 KiB
Cliconf Plugins
Cliconf plugins are abstactions 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
You can use ansible-doc -t cliconf -l to see the list of
available plugins. Use
ansible-doc -t cliconf <plugin name> to see detailed
documentation and examples.
- maxdepth
-
1
cliconf/*
Ansible for Network Automation<network_guide>-
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