https://github.com/mdiniz97/ansibleawx-client
This is a unofficial python API client for Ansible AWX.
https://github.com/mdiniz97/ansibleawx-client
ansible ansible-awx awx awx-api python tower tower-api
Last synced: 3 months ago
JSON representation
This is a unofficial python API client for Ansible AWX.
- Host: GitHub
- URL: https://github.com/mdiniz97/ansibleawx-client
- Owner: mdiniz97
- License: mit
- Created: 2020-07-23T19:22:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T20:50:47.000Z (over 4 years ago)
- Last Synced: 2025-07-26T22:25:38.942Z (4 months ago)
- Topics: ansible, ansible-awx, awx, awx-api, python, tower, tower-api
- Language: Python
- Homepage:
- Size: 9.77 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ansible AWX Client
============
[](https://www.python.org/download/releases/3.4.0/) [](https://github.com/mdiniz97/AnsibleAWX-Client/blob/master/README.md)
Donate to help keep this project maintained
Summary
-------
This is a unofficial python API client for Ansible AWX.
Requirements
------------
* requests
Quick Start Guide
-----------------
### Install Ansible AWX Client
pip install ansibleawx-client
### Initialize API Client
You can do this with your username and password or using your Token.
#### Initialize client with your username and password
import ansibleawx
API_URL = "http://my-ansibleawx.com/api/v2"
client = ansibleawx.Api("username", "password", api_url=API_URL)
#### Initialize client with your token
import ansibleawx
API_URL = "http://my-ansibleawx.com/api/v2"
TOKEN = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
client = ansibleawx.Api(api_url=API_URL, token=TOKEN)
Examples
--------
#### Get Inventories
# to get all inventories
response = client.get_inventories()
# to get specific inventory by id
response = client.get_inventories(1)
#### Get Jobs Templates
# to get all jobs templates
response = client.get_jobs_templates()
# to get specific job template by id
response = client.get_jobs_templates(1)
#### Launch Job Template by id
response = client.launch_job_template(1)
#### Relaunch Job by id
response = client.relaunch_job(1)
#### Cancel Job by id
response = client.cancel_job(1)
Function Reference
------------------
Consult the [Ansible Tower documentation](https://docs.ansible.com/ansible-tower/latest/html/towerapi/api_ref.html#/Authentication) for more details.