mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Somehow lost the API docs. Put them back!
This commit is contained in:
parent
928095c623
commit
ca49676ef7
1 changed files with 31 additions and 0 deletions
31
README.md
31
README.md
|
@ -157,6 +157,37 @@ To run a playbook:
|
|||
|
||||
ansible -r playbook.yml
|
||||
|
||||
API
|
||||
===
|
||||
|
||||
The Python API is pretty powerful.
|
||||
|
||||
import ansible.runner
|
||||
|
||||
runner = ansible.runner.Runner(
|
||||
module_name='ping',
|
||||
module_args='',
|
||||
pattern='web*',
|
||||
forks=10
|
||||
)
|
||||
datastructure = runner.run()
|
||||
|
||||
And returns results per host, for hosts we could contact
|
||||
and also ones that we failed to contact.
|
||||
|
||||
{
|
||||
"dark" : {
|
||||
"web1.example.com" : "failure message"
|
||||
}
|
||||
"contacted" : {
|
||||
"web2.example.com" : 1
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
A module can return any type of JSON data it wants, so Ansible can
|
||||
be used as a framework to build arbitrary applications and very powerful
|
||||
scripts.
|
||||
|
||||
Future plans
|
||||
============
|
||||
|
|
Loading…
Reference in a new issue