Documentation(https://docs.ansible.

com/)

Ansible Docs Home (https://docs.ansible.com/) »

Ansible Automation Platform Docs (https://docs.ansible.com/automation.html) »
— AWX CLI Automation Controller 4.5 documentation »

AWX Command Line Interface

awx is the official command-line client for AWX and Red Hat Ansible Automation Platform
controller. It:

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 and Red Hat Ansible Automation Platform controller.

Potential uses include:

Configuring and launching jobs/playbooks

Checking on the status and output of job runs

Managing objects like organizations, users, teams, etc…

Basic Usage (usage.html)

Installation (usage.html#installation)
Synopsis (usage.html#synopsis)
Getting Started (usage.html#getting-started)
Resources and Actions (usage.html#resources-and-actions)
Global Options (usage.html#global-options)
Authentication (authentication.html)
Generating a Personal Access Token (authentication.html#generating-a-personal-
access-token)
Working with OAuth2.0 Applications (authentication.html#working-with-oauth2-0-
applications)
OAuth2.0 Token Scoping (authentication.html#oauth2-0-token-scoping)
Session Authentication (authentication.html#session-authentication)
Output Formatting (output.html)
YAML Formatting (output.html#yaml-formatting)
Search this site
 Human-Readable (Tabular) Formatting (output.html#human-readable-tabular-
formatting)
Custom Formatting with jq (output.html#custom-formatting-with-jq)
Colorized Output (output.html#colorized-output)
Usage Examples (examples.html)
Verifying CLI Configuration (examples.html#verifying-cli-configuration)
Printing the History of a Particular Job (examples.html#printing-the-history-of-a-
particular-job)
Creating and Launching a Job Template (examples.html#creating-and-launching-a-job-
template)
Updating a Job Template with Extra Vars (examples.html#updating-a-job-template-
with-extra-vars)
Importing an SSH Key (examples.html#importing-an-ssh-key)
Import/Export (examples.html#import-export)
Reference Guide (reference.html)
awx activity_stream (reference.html#awx-activity-stream)
awx activity_stream get (reference.html#awx-activity-stream-get)
awx activity_stream list (reference.html#awx-activity-stream-list)
awx ad_hoc_commands (reference.html#awx-ad-hoc-commands)
awx ad_hoc_commands create (reference.html#awx-ad-hoc-commands-create)
awx ad_hoc_commands delete (reference.html#awx-ad-hoc-commands-delete)
awx ad_hoc_commands get (reference.html#awx-ad-hoc-commands-get)
awx ad_hoc_commands list (reference.html#awx-ad-hoc-commands-list)
awx ad_hoc_commands stdout (reference.html#awx-ad-hoc-commands-stdout)
awx analytics (reference.html#awx-analytics)
awx analytics get (reference.html#awx-analytics-get)
awx analytics list (reference.html#awx-analytics-list)
awx applications (reference.html#awx-applications)
awx applications create (reference.html#awx-applications-create)
awx applications delete (reference.html#awx-applications-delete)
awx applications get (reference.html#awx-applications-get)
awx applications list (reference.html#awx-applications-list)
awx applications modify (reference.html#awx-applications-modify)
awx bulk (reference.html#awx-bulk)
awx bulk get (reference.html#awx-bulk-get)
awx bulk host_create (reference.html#awx-bulk-host-create)
awx bulk host_delete (reference.html#awx-bulk-host-delete)
awx bulk job_launch (reference.html#awx-bulk-job-launch)
awx bulk list (reference.html#awx-bulk-list)
awx config (reference.html#awx-config)
awx constructed_inventory (reference.html#awx-constructed-inventory)
awx constructed_inventory create (reference.html#awx-constructed-inventory-create)
awx constructed_inventory delete (reference.html#awx-constructed-inventory-delete)
awx constructed_inventory get (reference.html#awx-constructed-inventory-get)
awx constructed_inventory list (reference.html#awx-constructed-inventory-list)
Search this site
awx constructed_inventory modify (reference.html#awx-constructed-inventory-
modify)
awx credential_input_sources (reference.html#awx-credential-input-sources)
awx credential_input_sources create (reference.html#awx-credential-input-sources-
create)
awx credential_input_sources delete (reference.html#awx-credential-input-sources-
delete)
awx credential_input_sources get (reference.html#awx-credential-input-sources-get)
awx credential_input_sources list (reference.html#awx-credential-input-sources-list)
awx credential_input_sources modify (reference.html#awx-credential-input-sources-
modify)
awx credential_types (reference.html#awx-credential-types)
awx credential_types create (reference.html#awx-credential-types-create)
awx credential_types delete (reference.html#awx-credential-types-delete)
awx credential_types get (reference.html#awx-credential-types-get)
awx credential_types list (reference.html#awx-credential-types-list)
awx credential_types modify (reference.html#awx-credential-types-modify)
awx credentials (reference.html#awx-credentials)
awx credentials create (reference.html#awx-credentials-create)
awx credentials delete (reference.html#awx-credentials-delete)
awx credentials get (reference.html#awx-credentials-get)
awx credentials list (reference.html#awx-credentials-list)
awx credentials modify (reference.html#awx-credentials-modify)
awx execution_environments (reference.html#awx-execution-environments)
awx execution_environments create (reference.html#awx-execution-environments-
create)
awx execution_environments delete (reference.html#awx-execution-environments-
delete)
awx execution_environments get (reference.html#awx-execution-environments-get)
awx execution_environments list (reference.html#awx-execution-environments-list)
awx execution_environments modify (reference.html#awx-execution-environments-
modify)
awx export (reference.html#awx-export)
awx groups (reference.html#awx-groups)
awx groups create (reference.html#awx-groups-create)
awx groups delete (reference.html#awx-groups-delete)
awx groups get (reference.html#awx-groups-get)
awx groups list (reference.html#awx-groups-list)
awx groups modify (reference.html#awx-groups-modify)
awx host_metric_summary_monthly (reference.html#awx-host-metric-summary-
monthly)
awx host_metric_summary_monthly get (reference.html#awx-host-metric-summary-
monthly-get)
awx host_metric_summary_monthly list (reference.html#awx-host-metric-summary-
monthly-list) Search this site
awx host_metrics (reference.html#awx-host-metrics)
awx host_metrics delete (reference.html#awx-host-metrics-delete)
awx host_metrics get (reference.html#awx-host-metrics-get)
awx host_metrics list (reference.html#awx-host-metrics-list)
awx hosts (reference.html#awx-hosts)
awx hosts create (reference.html#awx-hosts-create)
awx hosts delete (reference.html#awx-hosts-delete)
awx hosts get (reference.html#awx-hosts-get)
awx hosts list (reference.html#awx-hosts-list)
awx hosts modify (reference.html#awx-hosts-modify)
awx import (reference.html#awx-import)
awx instance_groups (reference.html#awx-instance-groups)
awx instance_groups create (reference.html#awx-instance-groups-create)
awx instance_groups delete (reference.html#awx-instance-groups-delete)
awx instance_groups get (reference.html#awx-instance-groups-get)
awx instance_groups list (reference.html#awx-instance-groups-list)
awx instance_groups modify (reference.html#awx-instance-groups-modify)
awx instances (reference.html#awx-instances)
awx instances create (reference.html#awx-instances-create)
awx instances get (reference.html#awx-instances-get)
awx instances list (reference.html#awx-instances-list)
awx instances modify (reference.html#awx-instances-modify)
awx inventory (reference.html#awx-inventory)
awx inventory create (reference.html#awx-inventory-create)
awx inventory delete (reference.html#awx-inventory-delete)
awx inventory get (reference.html#awx-inventory-get)
awx inventory list (reference.html#awx-inventory-list)
awx inventory modify (reference.html#awx-inventory-modify)
awx inventory_sources (reference.html#awx-inventory-sources)
awx inventory_sources associate (reference.html#awx-inventory-sources-associate)
awx inventory_sources create (reference.html#awx-inventory-sources-create)
awx inventory_sources delete (reference.html#awx-inventory-sources-delete)
awx inventory_sources disassociate (reference.html#awx-inventory-sources-
disassociate)
awx inventory_sources get (reference.html#awx-inventory-sources-get)
awx inventory_sources list (reference.html#awx-inventory-sources-list)
awx inventory_sources modify (reference.html#awx-inventory-sources-modify)
awx inventory_sources update (reference.html#awx-inventory-sources-update)
awx inventory_updates (reference.html#awx-inventory-updates)
awx inventory_updates delete (reference.html#awx-inventory-updates-delete)
awx inventory_updates get (reference.html#awx-inventory-updates-get)
awx inventory_updates list (reference.html#awx-inventory-updates-list)
awx inventory_updates stdout (reference.html#awx-inventory-updates-stdout)
awx job_templates (reference.html#awx-job-templates)
awx job_templates associate (reference.html#awx-job-templates-associate)Search this site
awx job_templates create (reference.html#awx-job-templates-create)
awx job_templates delete (reference.html#awx-job-templates-delete)
awx job_templates disassociate (reference.html#awx-job-templates-disassociate)
awx job_templates get (reference.html#awx-job-templates-get)
awx job_templates launch (reference.html#awx-job-templates-launch)
awx job_templates list (reference.html#awx-job-templates-list)
awx job_templates modify (reference.html#awx-job-templates-modify)
awx jobs (reference.html#awx-jobs)
awx jobs delete (reference.html#awx-jobs-delete)
awx jobs get (reference.html#awx-jobs-get)
awx jobs list (reference.html#awx-jobs-list)
awx jobs monitor (reference.html#awx-jobs-monitor)
awx jobs stdout (reference.html#awx-jobs-stdout)
awx labels (reference.html#awx-labels)
awx labels create (reference.html#awx-labels-create)
awx labels get (reference.html#awx-labels-get)
awx labels list (reference.html#awx-labels-list)
awx labels modify (reference.html#awx-labels-modify)
awx login (reference.html#awx-login)
awx me (reference.html#awx-me)
awx mesh_visualizer (reference.html#awx-mesh-visualizer)
awx metrics (reference.html#awx-metrics)
awx notification_templates (reference.html#awx-notification-templates)
awx notification_templates create (reference.html#awx-notification-templates-create)
awx notification_templates delete (reference.html#awx-notification-templates-delete)
awx notification_templates get (reference.html#awx-notification-templates-get)
awx notification_templates list (reference.html#awx-notification-templates-list)
awx notification_templates modify (reference.html#awx-notification-templates-
modify)
awx notifications (reference.html#awx-notifications)
awx notifications get (reference.html#awx-notifications-get)
awx notifications list (reference.html#awx-notifications-list)
awx organizations (reference.html#awx-organizations)
awx organizations associate (reference.html#awx-organizations-associate)
awx organizations create (reference.html#awx-organizations-create)
awx organizations delete (reference.html#awx-organizations-delete)
awx organizations disassociate (reference.html#awx-organizations-disassociate)
awx organizations get (reference.html#awx-organizations-get)
awx organizations list (reference.html#awx-organizations-list)
awx organizations modify (reference.html#awx-organizations-modify)
awx ping (reference.html#awx-ping)
awx project_updates (reference.html#awx-project-updates)
awx project_updates delete (reference.html#awx-project-updates-delete)
awx project_updates get (reference.html#awx-project-updates-get)
awx project_updates list (reference.html#awx-project-updates-list) Search this site
awx project_updates stdout (reference.html#awx-project-updates-stdout)
awx projects (reference.html#awx-projects)
awx projects associate (reference.html#awx-projects-associate)
awx projects create (reference.html#awx-projects-create)
awx projects delete (reference.html#awx-projects-delete)
awx projects disassociate (reference.html#awx-projects-disassociate)
awx projects get (reference.html#awx-projects-get)
awx projects list (reference.html#awx-projects-list)
awx projects modify (reference.html#awx-projects-modify)
awx projects update (reference.html#awx-projects-update)
awx roles (reference.html#awx-roles)
awx roles get (reference.html#awx-roles-get)
awx roles list (reference.html#awx-roles-list)
awx schedules (reference.html#awx-schedules)
awx schedules create (reference.html#awx-schedules-create)
awx schedules delete (reference.html#awx-schedules-delete)
awx schedules get (reference.html#awx-schedules-get)
awx schedules list (reference.html#awx-schedules-list)
awx schedules modify (reference.html#awx-schedules-modify)
awx settings (reference.html#awx-settings)
awx settings list (reference.html#awx-settings-list)
awx settings modify (reference.html#awx-settings-modify)
awx system_job_templates (reference.html#awx-system-job-templates)
awx system_job_templates get (reference.html#awx-system-job-templates-get)
awx system_job_templates list (reference.html#awx-system-job-templates-list)
awx system_jobs (reference.html#awx-system-jobs)
awx system_jobs delete (reference.html#awx-system-jobs-delete)
awx system_jobs get (reference.html#awx-system-jobs-get)
awx system_jobs list (reference.html#awx-system-jobs-list)
awx teams (reference.html#awx-teams)
awx teams create (reference.html#awx-teams-create)
awx teams delete (reference.html#awx-teams-delete)
awx teams get (reference.html#awx-teams-get)
awx teams grant (reference.html#awx-teams-grant)
awx teams list (reference.html#awx-teams-list)
awx teams modify (reference.html#awx-teams-modify)
awx teams revoke (reference.html#awx-teams-revoke)
awx tokens (reference.html#awx-tokens)
awx tokens create (reference.html#awx-tokens-create)
awx tokens delete (reference.html#awx-tokens-delete)
awx tokens get (reference.html#awx-tokens-get)
awx tokens list (reference.html#awx-tokens-list)
awx tokens modify (reference.html#awx-tokens-modify)
awx unified_job_templates (reference.html#awx-unified-job-templates)
awx unified_job_templates get (reference.html#awx-unified-job-templates-get)
Search this site
awx unified_job_templates list (reference.html#awx-unified-job-templates-list)
awx unified_jobs (reference.html#awx-unified-jobs)
awx unified_jobs get (reference.html#awx-unified-jobs-get)
awx unified_jobs list (reference.html#awx-unified-jobs-list)
awx users (reference.html#awx-users)
awx users create (reference.html#awx-users-create)
awx users delete (reference.html#awx-users-delete)
awx users get (reference.html#awx-users-get)
awx users grant (reference.html#awx-users-grant)
awx users list (reference.html#awx-users-list)
awx users modify (reference.html#awx-users-modify)
awx users revoke (reference.html#awx-users-revoke)
awx workflow_approvals (reference.html#awx-workflow-approvals)
awx workflow_approvals delete (reference.html#awx-workflow-approvals-delete)
awx workflow_approvals get (reference.html#awx-workflow-approvals-get)
awx workflow_approvals list (reference.html#awx-workflow-approvals-list)
awx workflow_job_nodes (reference.html#awx-workflow-job-nodes)
awx workflow_job_nodes get (reference.html#awx-workflow-job-nodes-get)
awx workflow_job_nodes list (reference.html#awx-workflow-job-nodes-list)
awx workflow_job_template_nodes (reference.html#awx-workflow-job-template-
nodes)
awx workflow_job_template_nodes create (reference.html#awx-workflow-job-
template-nodes-create)
awx workflow_job_template_nodes delete (reference.html#awx-workflow-job-
template-nodes-delete)
awx workflow_job_template_nodes get (reference.html#awx-workflow-job-template-
nodes-get)
awx workflow_job_template_nodes list (reference.html#awx-workflow-job-template-
nodes-list)
awx workflow_job_template_nodes modify (reference.html#awx-workflow-job-
template-nodes-modify)
awx workflow_job_templates (reference.html#awx-workflow-job-templates)
awx workflow_job_templates associate (reference.html#awx-workflow-job-templates-
associate)
awx workflow_job_templates create (reference.html#awx-workflow-job-templates-
create)
awx workflow_job_templates delete (reference.html#awx-workflow-job-templates-
delete)
awx workflow_job_templates disassociate (reference.html#awx-workflow-job-
templates-disassociate)
awx workflow_job_templates get (reference.html#awx-workflow-job-templates-get)
awx workflow_job_templates launch (reference.html#awx-workflow-job-templates-
launch)
awx workflow_job_templates list (reference.html#awx-workflow-job-templates-list)
Search this site
 awx workflow_job_templates modify (reference.html#awx-workflow-job-templates-
modify)
awx workflow_jobs (reference.html#awx-workflow-jobs)
awx workflow_jobs delete (reference.html#awx-workflow-jobs-delete)
awx workflow_jobs get (reference.html#awx-workflow-jobs-get)
awx workflow_jobs list (reference.html#awx-workflow-jobs-list)
awx workflow_jobs monitor (reference.html#awx-workflow-jobs-monitor)

Indices and tables

Index (genindex.html)

Module Index (py-modindex.html)

Search Page (search.html)

Next  (usage.html)

Copyright © Red Hat, Inc.

Red Hat Ansible Automation Platform docs are generated using Sphinx (http://sphinx-
doc.org/) using a theme provided by Read the Docs (http://readthedocs.org).

Search this site