AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is one of the upstream projects for the Red Hat Ansible Automation Platform.
Starting in version 18.0, the AWX Operator is the preferred way to install AWX.
AWX can also alternatively be installed and run in Docker, but this install path is only recommended for development/test-oriented deployments and has no official published release.
awx is the official command-line client for AWX.
- Uses naming and structure consistent with the AWX HTTP API Provides consistent output formats with optional machine-parsable formats
- To the extent possible, auto-detects API versions, available endpoints, and feature support across multiple versions of AWX.
Potential uses include:
- Configuring and launching jobs/playbooks
- Checking on the status and output of job runs
- Managing objects like organizations, users, teams, etc...
The preferred way to install the AWX CLI is through pip directly from PyPI:
pip3 install awxkit
To build the docs, spin up a real AWX server,
pip3 install sphinx sphinxcontrib-autoprogram, and run:
~ cd awxkit/awxkit/cli/docs
~ TOWER_HOST=https://awx.example.org TOWER_USERNAME=example TOWER_PASSWORD=secret make clean html
~ cd build/html/ && python -m http.server
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ..