d123669a46
* Update default roles_path documentation (#56320) (cherry picked from commitc1ebc8d9c2) * docs: Update scopes value example (#56362): example in GCE guide needs "https://" prefix (cherry picked from commit85fa65e5f0) * [doc] fix example: always trigger the handler (#56384): by default, debug task result isn't changed - add 'changed_when: yes' to trigger handler (cherry picked from commitb3ab83bc70) * Update of Ansible 2.8 roadmap (#56436): Remove **if needed** for RC2 & RC3, correct date for RC3 (cherry picked from commitd55823b013) * add how to create HttpApi plugins for network modules (#54340): in a developer guide for networks (cherry picked from commitcca365061c) * [Doc-Release-2.8] fixed broken module links in 2.8 porting guide (#56494) (cherry picked from commit635931051b)
59 lines
1.7 KiB
ReStructuredText
59 lines
1.7 KiB
ReStructuredText
.. _httpapi_plugins:
|
|
|
|
Httpapi Plugins
|
|
===============
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
Httpapi plugins tell Ansible how to interact with a remote device's HTTP-based API and execute tasks on the
|
|
device.
|
|
|
|
Each plugin represents a particular dialect of API. Some are platform-specific (Arista eAPI, Cisco NXAPI), while
|
|
others might be usable on a variety of platforms (RESTCONF).
|
|
|
|
.. _enabling_httpapi:
|
|
|
|
Adding httpapi plugins
|
|
-------------------------
|
|
|
|
You can extend Ansible to support other APIs by dropping a custom plugin into the ``httpapi_plugins`` directory. See :ref:`developing_plugins_httpapi` for details.
|
|
|
|
.. _using_httpapi:
|
|
|
|
Using httpapi plugins
|
|
------------------------
|
|
|
|
The httpapi plugin to use is determined automatically from the ``ansible_network_os`` variable.
|
|
|
|
Most httpapi plugins can operate without configuration. Additional options may be defined by each plugin.
|
|
|
|
Plugins are self-documenting. Each plugin should document its configuration options.
|
|
|
|
|
|
.. _httpapi_plugin_list:
|
|
|
|
Plugin List
|
|
-----------
|
|
|
|
You can use ``ansible-doc -t httpapi -l`` to see the list of available plugins.
|
|
Use ``ansible-doc -t httpapi <plugin name>`` to see detailed documentation and examples.
|
|
|
|
|
|
.. toctree:: :maxdepth: 1
|
|
:glob:
|
|
|
|
httpapi/*
|
|
|
|
|
|
.. seealso::
|
|
|
|
:ref:`Ansible for Network Automation<network_guide>`
|
|
An overview of using Ansible to automate networking devices.
|
|
:ref:`Developing network modules<developing_modules_network>`
|
|
How to develop network modules.
|
|
`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
|