Documentation

    PLEASE NOTE: This document applies to v2.6 version and not to the latest stable release v2.9

    Documentation for other releases can be found by using the version selector in the left bottom of any doc page.

    Modules

    Modules are operations executed by tasks. They require parameters for its execution.

    E.g.:

    - name: save user info
      copy:
        content: |
          uid: {{ rash.user.uid }}
          gid: {{ rash.user.gid }}
        dest: "{% if rash.user.uid != 0 %}/tmp{% endif %}/user_info"
        mode: "{{ env.FILE_MODE | default('400') }}"
    
    

    Modules index

    Omitting parameters

    By default all parameters defined in yaml are passed to the module. However, you can omit them programmatically.

    E.g.:

    "{{ env.MY_PASSWORD_MODE | default(omit) }}"
    

    Furthermore, if you are chaining additional filters after the default(omit), you should instead do something like this: "{{ foo | default(None) | some_filter or omit }}". In this example, the default None value will cause the later filters to fail, which will trigger the or omit portion of the logic. Using omit in this manner is very specific to the later filters you are chaining though, so be prepared for some trial and error if you do this.