README.md

Ansible AWX Client

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 for more details.