OS Manuals

/opt/ansible/bin/ansible-runner

OpenStack Kolla toolbox — ansible + OpenStack clients (2026.1 Gazpacho)

From openstack-kolla-toolbox-2026.1 22.2.0-r9 (enterprise-packages), captured 2026-11-09 by running ansible-runner --help (exit 0). permalink

Also provided by 3 other package versions
usage: ansible-runner [-h] [--version] [--debug] [--logfile LOGFILE] [-b BINARY] [-i IDENT]
                      [--rotate-artifacts ROTATE_ARTIFACTS] [--artifact-dir ARTIFACT_DIR]
                      [--project-dir PROJECT_DIR] [--inventory INVENTORY] [-j] [--omit-event-data]
                      [--only-failed-event-data] [--omit-env-files] [-q] [-v]
                      {run,start,stop,is-alive,transmit,worker,process} ...

Use 'ansible-runner' (with no arguments) to see basic usage

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --debug               enable ansible-runner debug output logging (default=False)
  --logfile LOGFILE     log output messages to a file (default=None)

subcommands:
  COMMAND PRIVATE_DATA_DIR [ARGS]

  {run,start,stop,is-alive,transmit,worker,process}
                        Command to invoke
    run                 Run ansible-runner in the foreground
    start               Start an ansible-runner process in the background
    stop                Stop an ansible-runner process that's running in the background
    is-alive            Check if a an ansible-runner process in the background is still running.
    transmit            Send a job to a remote ansible-runner process
    worker              Execute work streamed from a controlling instance
    process             Receive the output of remote ansible-runner work and distribute the
                        results

Ansible Runner Options:
  configuration options for controlling the ansible-runner runtime environment.

  -b, --binary BINARY   specifies the full path pointing to the Ansible binaries (default=None)
  -i, --ident IDENT     an identifier that will be used when generating the artifacts directory
                        and can be used to uniquely identify a playbook run
                        (default=3a13a821-efc4-48ee-a542-fb2db3fd63ed)
  --rotate-artifacts ROTATE_ARTIFACTS
                        automatically clean up old artifact directories after a given number have
                        been created (default=0, disabled)
  --artifact-dir ARTIFACT_DIR
                        optional path for the artifact root directory
                        (default=<private_data_dir>/artifacts)
  --project-dir PROJECT_DIR
                        optional path for the location of the playbook content directory
                        (default=<private_data_dir>/project)
  --inventory INVENTORY
                        optional path for the location of the inventory content directory
                        (default=<private_data_dir>/inventory)
  -j, --json            output the JSON event structure to stdout instead of Ansible output
                        (default=False)
  --omit-event-data     Omits including extra event data in the callback payloads or the Runner
                        payload data files (status and stdout still included)
  --only-failed-event-data
                        Only adds extra event data for failed tasks in the callback payloads or
                        the Runner payload data files (status and stdout still included for other
                        events)
  --omit-env-files      Add flag to prevent the writing of the env directory
  -q, --quiet           disable all messages sent to stdout/stderr (default=False)
  -v                    increase the verbosity with multiple v's (up to 5) of the ansible-playbook
                        output (default=None)
Options (16)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--versionshow program's version number and exithelp
--debugenable ansible-runner debug output logging (default=False)help
--logfile LOGFILElog output messages to a file (default=None)help
-b, --binary BINARYspecifies the full path pointing to the Ansible binaries (default=None)help
-i, --ident IDENTan identifier that will be used when generating the artifacts directory and can be used to uniquely identify a playbook run (default=3a13a821-efc4-48ee-a542-fb2db3fd63ed)help
--rotate-artifacts ROTATE_ARTIFACTSautomatically clean up old artifact directories after a given number have been created (default=0, disabled)help
--artifact-dir ARTIFACT_DIRoptional path for the artifact root directory (default=<private_data_dir>/artifacts)help
--project-dir PROJECT_DIRoptional path for the location of the playbook content directory (default=<private_data_dir>/project)help
--inventory INVENTORYoptional path for the location of the inventory content directory (default=<private_data_dir>/inventory)help
-j, --jsonoutput the JSON event structure to stdout instead of Ansible output (default=False)help
--omit-event-dataOmits including extra event data in the callback payloads or the Runner payload data files (status and stdout still included)help
--only-failed-event-dataOnly adds extra event data for failed tasks in the callback payloads or the Runner payload data files (status and stdout still included for other events)help
--omit-env-filesAdd flag to prevent the writing of the env directoryhelp
-q, --quietdisable all messages sent to stdout/stderr (default=False)help
-vincrease the verbosity with multiple v's (up to 5) of the ansible-playbook output (default=None)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.