af07c35f98
* Add description for COLLECTIONS_SCAN_SYS_PATH (#74351) Fixes: #74275 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit567361b124) * lighten navigation background to make section labels easier to read for core docs (#74356) * make section labels for /ansible-core/ docs easier to read, with black text and lighter gray background (cherry picked from commit6119fb0a9a) * Correct splitext() description, and example (#74377) `splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.` (cherry picked from commitc295de661c) * Using "~" instead of "+" for concatination (#74364) Changed FAQ examples to conform with the Jinja documentation: If both values on either side of a plus/+ are numbers, they will be added whereas using "~" will convert all operands into strings and then concatenate them. Closes #73799. (cherry picked from commite6a5245d60) * Docs - Split Developing collections page, add info on optional module_utils (#74105) * (cherry picked from commitc90922ee36) * Add weos4 network platform to documentation (#74088) * Add weos4 network platform to documentation * Fix small format issues (cherry picked from commit7ca5dede97) * Fix typo in Makefile (#74396) Fixed minor typo specfic -> specific (cherry picked from commit4880fee6ca) * Update complex_data_manipulation.rst (#72509) (cherry picked from commitc2985c491b) * Update VMware library installation docs (#71219) Depending upon OS/distro, please use pip/pip3. (cherry picked from commitddfc648d37) * Update AWS dev guides to use collections utils and fragments (#72312) (cherry picked from commitcf08c23b4f) * Use is_boto3_error_code in 'standard' example (#72313) Use is_boto3_error_code in 'standard' example rather than e.response['Error']['Code'] (#72313) Co-authored-by: Sloane Hertel <shertel@redhat.com> (cherry picked from commit63afb33d86) * Update Kubernetes collection name in docs (#74440) (cherry picked from commit8d499bbc83) * Update argcomplete docs links on installation guide (#74410) Link on installation docs is outdated. Switch to currently docs at: https://kislyuk.github.io/argcomplete/ (cherry picked from commitf97787ca74) * fix spacing to fix header, reorg contributing page (#74421) Co-authored-by: John R Barker <john@johnrbarker.com> (cherry picked from commit9d9b08bece) * Update first_found documentation (#70502) * import_tasks do not work with loop, use use include_tasks instead * update documentation (cherry picked from commitbacede7a2b) * Product-related updates. (#74454) (cherry picked from commit34c9ed8a28) Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Alex Willmer <alex@moreati.org.uk> Co-authored-by: Hublerho <43293510+Hublerho@users.noreply.github.com> Co-authored-by: Ernst Oudhof <17832702+ernst-s@users.noreply.github.com> Co-authored-by: Hu Shuai <hus.fnst@cn.fujitsu.com> Co-authored-by: dhx-mike-palandra <45608336+dhx-mike-palandra@users.noreply.github.com> Co-authored-by: jakelevinez <31458570+jakelevinez@users.noreply.github.com> Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Lidiane Taquehara <lidi.mayra@gmail.com> Co-authored-by: Alex Domoradov <alex.hha@gmail.com> Co-authored-by: Bill Nottingham <notting@redhat.com>
48 lines
2.1 KiB
ReStructuredText
48 lines
2.1 KiB
ReStructuredText
.. _developing_api:
|
|
|
|
**********
|
|
Python API
|
|
**********
|
|
|
|
.. contents:: Topics
|
|
|
|
.. note:: This API is intended for internal Ansible use. Ansible may make changes to this API at any time that could break backward compatibility with older versions of the API. Because of this, external use is not supported by Ansible. If you want to use Python API only for executing playbooks or modules, consider `ansible-runner <https://ansible-runner.readthedocs.io/en/latest/>`_ first.
|
|
|
|
There are several ways to use Ansible from an API perspective. You can use
|
|
the Ansible Python API to control nodes, you can extend Ansible to respond to various Python events, you can
|
|
write plugins, and you can plug in inventory data from external data sources. This document
|
|
gives a basic overview and examples of the Ansible execution and playbook API.
|
|
|
|
If you would like to use Ansible programmatically from a language other than Python, trigger events asynchronously,
|
|
or have access control and logging demands, please see the `AWX project <https://github.com/ansible/awx/>`_.
|
|
|
|
.. note:: Because Ansible relies on forking processes, this API is not thread safe.
|
|
|
|
.. _python_api_example:
|
|
|
|
Python API example
|
|
==================
|
|
|
|
This example is a simple demonstration that shows how to minimally run a couple of tasks:
|
|
|
|
.. literalinclude:: ../../../../examples/scripts/uptime.py
|
|
:language: python
|
|
|
|
.. note:: Ansible emits warnings and errors via the display object, which prints directly to stdout, stderr and the Ansible log.
|
|
|
|
The source code for the ``ansible``
|
|
command line tools (``lib/ansible/cli/``) is `available on GitHub <https://github.com/ansible/ansible/tree/devel/lib/ansible/cli>`_.
|
|
|
|
.. seealso::
|
|
|
|
:ref:`developing_inventory`
|
|
Developing dynamic inventory integrations
|
|
:ref:`developing_modules_general`
|
|
Getting started on developing a module
|
|
:ref:`developing_plugins`
|
|
How to develop plugins
|
|
`Development Mailing List <https://groups.google.com/group/ansible-devel>`_
|
|
Mailing list for development topics
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|