For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationCommand referenceRelease notes
DocumentationCommand referenceRelease notes
  • Command reference
    • iagctl cert-gen
    • iagctl completion
    • iagctl login
      • run service ansible-playbook
      • run service executable
      • run service opentofu-plan
      • run service python-script
    • iagctl runner
    • iagctl server
    • iagctl version
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Syntax
  • Usage notes
  • Runtime variables
  • View accepted inputs
  • Examples
  • Run a playbook service
  • Run a playbook service with extra variables
  • Options
  • Options inherited from parent commands
Command referenceiagctl run service

iagctl run service ansible-playbook

Was this page helpful?
Previous

iagctl run service executable

Next
Built with

Run an Ansible playbook service.

The iagctl run service ansible-playbook command executes an Ansible playbook service and displays the resulting stdout, stderr, return code, and execution time information.

Syntax

$iagctl run service ansible-playbook <service-name> [flags]

Usage notes

Runtime variables

Use the --set flag to pass Ansible extra variables at runtime using key=value syntax. If you defined a decorator during service creation, IAG validates all --set values against it.

View accepted inputs

Use the --use flag with the service name to display information about the inputs a service accepts:

$iagctl run service ansible-playbook <service-name> --use

Examples

Run a playbook service

$iagctl run service ansible-playbook my-ansible-service

Run a playbook service with extra variables

$iagctl run service ansible-playbook my-ansible-service \
>--set interface=0/0/0

Options

$      --profile string   Specify the client profile to use (case-insensitive, defaults to [client] section)
$  -h, --help              Help for ansible-playbook
$  --set stringArray       Runtime input arguments as key=value pairs. Values are validated against the decorator, if one is defined.
$  --use                   Display usage of the service.

Options inherited from parent commands

$  --profile string   Specify the client profile to use (case-insensitive, defaults to [client] section)
$  --config string   Path to the configuration file
$  --raw             Display the result of the command in raw format
$  --verbose         Enable verbose output