Execute Ansible command.

yaml
type: "io.kestra.plugin.ansible.cli.ansiblecli"

Execute a list of Ansible CLI commands to orchestrate an Ansible playbook stored in the Editor using Namespace Files.

yaml
id: ansible
namespace: company.team

tasks:
  - id: ansible_task
    type: io.kestra.plugin.ansible.cli.AnsibleCLI
    inputFiles:
      inventory.ini: "{{ read('inventory.ini') }}"
      myplaybook.yml: "{{ read('myplaybook.yml') }}"
    docker:
      image: cytopia/ansible:latest-tools
    commands:
      - ansible-playbook -i inventory.ini myplaybook.yml

Execute a list of Ansible CLI commands to orchestrate an Ansible playbook defined inline in the flow definition.

yaml
id: ansible
namespace: company.team

tasks:
  - id: ansible_task
    type: io.kestra.plugin.ansible.cli.AnsibleCLI
    inputFiles:
      inventory.ini: |
        localhost ansible_connection=local
      myplaybook.yml: |
        ---
        - hosts: localhost
          tasks:
            - name: Print Hello World
              debug:
                msg: "Hello, World!"
    docker:
      image: cytopia/ansible:latest-tools
    commands:
      - ansible-playbook -i inventory.ini myplaybook.yml

Execute an ansible playbook and use ansible.builtin.debug command to extract outputs.

yaml
id: ansible_playbook_outputs
namespace: company.team

tasks:
  - id: ansible_playbook_outputs
    type: io.kestra.plugin.ansible.cli.AnsibleCLI
    outputLogFile: true
    inputFiles:
      playbook.yml: |
        ---
        - hosts: localhost
          tasks:
            - name: Create file
              shell: echo "Test output" >> greeting.txt

            - name: Register output file to var
              shell: cat greeting.txt
              register: myOutput

            - name: Print return information from the previous task
              ansible.builtin.debug:
                var: myOutput

            - name: Prints two lines of messages
              ansible.builtin.debug:
                msg:
                  - "Multiline message : line 1"
                  - "Multiline message : line 2"
    docker:
      image: cytopia/ansible:latest-tools
    commands:
      - ansible-playbook -i localhost -c local playbook.yml

SubType string

The commands to run.

Default

[defaults]
log_path={{ workingDir }}/log
callback_plugins = ./callback_plugins
stdout_callback = kestra_logger

Ansible configuration.

If not provided an ansible.cfg file will be created at the working directory base and will enable a custom callback plugin to output your results to Kestra. If you want to provide your own ansible configuration but still want to use the output callback for Kestra add the following lines to your configuration :

text

[defaults]
log_path={{ workingDir }}/log
callback_plugins = ./callback_plugins
stdout_callback = kestra_logger

SubType string

The commands to run before the main list of commands.

Default cytopia/ansible:latest-tools

The task runner container image, only used if the task runner is container-based.

Deprecated, use 'taskRunner' instead

SubType string

Additional environment variables for the current process.

The files to create on the local filesystem. It can be a map or a JSON object.

Inject namespace files.

Inject namespace files to this task. When enabled, it will, by default, load all namespace files into the working directory. However, you can use the include or exclude properties to limit which namespace files will be injected.

SubType string

The files from the local filesystem to send to Kestra's internal storage.

Must be a list of glob expressions relative to the current working directory, some examples: my-dir/**, my-dir/*/** or my-dir/my-file.txt.

Default false

Output log file.

If true, the ansible log file will be available in the outputs.

Default

{
  "type": "io.kestra.plugin.scripts.runner.docker.Docker"
}

The task runner to use.

Task runners are provided by plugins, each have their own properties.

Default 0

The exit code of the entire flow execution.

SubType string

The output files' URIs in Kestra's internal storage.

The value extracted from the output of the executed commands.

Default true

Whether to enable namespace files to be loaded into the working directory. If explicitly set to true in a task, it will load all Namespace Files into the task's working directory. Note that this property is by default set to true so that you can specify only the include and exclude properties to filter the files to load without having to explicitly set enabled to true.

SubType string

A list of filters to exclude matching glob patterns. This allows you to exclude a subset of the Namespace Files from being downloaded at runtime. You can combine this property together with include to only inject a subset of files that you need into the task's working directory.

Default OVERWRITE

Possible Values

OVERWRITEFAILWARNIGNORE

Comportment of the task if a file already exist in the working directory.

SubType string

A list of filters to include only matching glob patterns. This allows you to only load a subset of the Namespace Files into the working directory.

SubType string

Default ["{{flow.namespace}}"]

A list of namespaces in which searching files. The files are loaded in the namespace order, and only the latest version of a file is kept. Meaning if a file is present in the first and second namespace, only the file present on the second namespace will be loaded.

The maximum amount of CPU resources a container can use.

Make sure to set that to a numeric value e.g. cpus: "1.5" or cpus: "4" or For instance, if the host machine has two CPUs and you set cpus: "1.5", the container is guaranteed at most one and a half of the CPUs.

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4MB. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See the kernel-memory docs for more details.

The maximum amount of memory resources the container can use.

Make sure to use the format number + unit (regardless of the case) without any spaces. The unit can be KB (kilobytes), MB (megabytes), GB (gigabytes), etc.

Given that it's case-insensitive, the following values are equivalent:

"512MB"
"512Mb"
"512mb"
"512000KB"
"0.5GB"

It is recommended that you allocate at least 6MB.

Allows you to specify a soft limit smaller than memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

The total amount of memory and swap that can be used by a container.

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap includes both the physical memory and swap space, while memory is only the amount of physical memory that can be used.

A setting which controls the likelihood of the kernel to swap memory pages.

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100 to tune this percentage.

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.

Min length 1

Docker image to use.

Docker configuration file.

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

SubType

A list of device requests to be sent to device drivers.

SubType string

Docker entrypoint to use.

SubType string

Extra hostname mappings to the container network interface configuration.

Docker API URI.

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

Docker network mode to use e.g. host, none, etc.

Give extended privileges to this container.

Default ALWAYS

Possible Values

IF_NOT_PRESENTALWAYSNEVER

The image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted, the system uses 64MB.

User in the Docker container.

SubType string

List of volumes to mount.

Must be a valid mount expression as string, example : /home/user:/app.

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true.

The registry authentication.

The auth field is a base64-encoded authentication string of username: password or a token.

The identity token.

The registry password.

The registry URL.

If not defined, the registry will be extracted from the image name.

The registry token.

The registry username.

SubType array

A list of capabilities; an OR list of AND lists of capabilities.

SubType string

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.