12. Jinja2 模板语法¶

{{ foo.bar }}

{{ foo['bar'] }}

{% raw %}
     <ul>
     {% for item in seq %}
         <li>{{ item }}</li>
     {% endfor %}
     </ul>
 {% endraw %}

{{ user.username | e }} 

{% for item in seq -%}
    {{ item }}
{%- endfor %}

{%- if foo -%}...{% endif %}

{% for user in users %}
  <li>{{ user.username|e }}</li>
{% endfor %}

{% for key, value in my_dict.iteritems() %}
    <dt>{{ key|e }}</dt>
    <dd>{{ value|e }}</dd>
{% endfor %}

{% for user in users %}

    {%- if loop.index >= 10 %}{% break %}{% endif %}

{%- endfor %}

{% for dir in data_dirs if dir != "/" %}
data_dir = {{ dir }}
{% else %}
# no data dirs found
{% endfor %}

{% if kenny.sick %}
     Kenny is sick.
 {% elif kenny.dead %}
     You killed Kenny!  You bastard!!!
 {% else %}
     Kenny looks okay --- so far
 {% endif %}

{{ name | striptags | title }} 

{% filter upper %}
    This text becomes uppercase
{% endfilter %}

{% set navigation = [('index.html', 'Index'), ('about.html', 'About')] %}

{% set key, value = call_something() %}

{{ '[%s]' % page.title if page.title is defined else 'undefined' }}

# Only works with Python 2
{{ hosts.keys() }}
# Works with both Python 2 and Python 3
{{ hosts.keys() | list }}

# Only works with Python 2
{{ hosts.iteritems() }}

# Works with both Python 2 and Python 3
{{ hosts.items() | list }}

ansible localhost -m debug -a "msg={{ now(utc='True',fmt='%H-%m-%d %T') }}"

{{ some_variable | to_json }} 

{{ some_variable | to_yaml }}

{{ some_variable | to_nice_json }} 

{{ some_variable | to_nice_yaml }}

{{ some_variable | to_nice_json(indent=2) }}

{{ some_variable | to_nice_yaml(indent=8) }}

{{ some_variable | to_nice_yaml(indent=8, width=1337) }}

{{ some_variable | from_json }}

{{ some_variable | from_yaml }}

tasks:
  - shell: cat /some/path/to/file.json
    register: result

  - set_fact:
      myvar: "{{ result.stdout | from_json }}"

tasks:
  - shell: cat /some/path/to/multidoc-file.yaml
    register: result
  - debug:
      msg: '{{ item }}'
    loop: '{{ result.stdout | from_yaml_all | list }}'

{{ variable | mandatory }}

{{ result.cmd|default(5) }}

{{ lookup('env', 'MY_USER') | default('admin', true) }}

{{ lookup('env', 'MY_USER') | default('admin', false) }}

- name: touch files with an optional mode
  file:
    dest: "{{ item.path }}"
    state: touch
    mode: "{{ item.mode | default(omit) }}"
  loop:
    - path: /tmp/foo
    - path: /tmp/bar
    - path: /tmp/baz
      mode: "0444"

{{ list1 | min }}

{{ [3, 4, 2] | max }}

{{ [3, [4, 2] ] | flatten }}

{{ [3, [4, [2]] ] | flatten(levels=1) }}  # 展平第一级

{{ list1 | unique }}

{{ list1 | union(list2) }}

{{ list1 | intersect(list2) }}

{{ list1 | difference(list2) }}

{{ list1 | symmetric_difference(list2) }}

{{ dict | dict2items }}

- key: Application
  value: payment
- key: Environment
  value: dev

{{ files | dict2items(key_name='file', value_name='path') }}

{{ tags | items2dict }}

Application: payment
Environment: dev

{{ tags | items2dict(key_name='key', value_name='value') }}

- name: give me list combo of two lists
  debug:
   msg: "{{ [1,2,3,4,5] | zip(['a','b','c','d','e','f']) | list }}"

- name: give me shortest combo of two lists
  debug:
    msg: "{{ [1,2,3] | zip(['a','b','c','d','e','f']) | list }}"

- name: give me longest combo of three lists , fill with X
  debug:
    msg: "{{ [1,2,3] | zip_longest(['a','b','c','d','e','f'], [21, 22, 23], fillvalue='X') | list }}"

{{ dict(keys_list | zip(values_list)) }}

keys_list:
  - one
  - two
values_list:
  - apple
  - orange

one: apple
two: orange

{{ users | subelements('groups', skip_missing=True) }}

users:
- name: alice
  authorized:
  - /tmp/alice/onekey.pub
  - /tmp/alice/twokey.pub
  groups:
  - wheel
  - docker
- name: bob
  authorized:
  - /tmp/bob/id_rsa.pub
  groups:
  - docker

-
  - name: alice
    groups:
    - wheel
    - docker
    authorized:
    - /tmp/alice/onekey.pub
    - /tmp/alice/twokey.pub
  - wheel
-
  - name: alice
    groups:
    - wheel
    - docker
    authorized:
    - /tmp/alice/onekey.pub
    - /tmp/alice/twokey.pub
  - docker
-
  - name: bob
    authorized:
    - /tmp/bob/id_rsa.pub
    groups:
    - docker
  - docker

- name: Set authorized ssh key, extracting just that data from 'users'
  authorized_key:
    user: "{{ item.0.name }}"
    key: "{{ lookup('file', item.1) }}"
  loop: "{{ users | subelements('authorized') }}"

"{{ '52:54:00' | random_mac }}"
# => '52:54:00:ef:1c:03'

"{{ '52:54:00' | random_mac(seed=inventory_hostname) }}"

{{ ['a','b','c','d','e','f']|random }}

{{ 59 | random}}

{{ 100 |random(step=10) }}

{{ 100 |random(1, 10) }}

{{ 100 |random(start=1, step=10) }}

"{{ 60 | random(seed=inventory_hostname) }} * * * * root /script/from/cron"

{{ ['a','b','c']|shuffle }} => ['c','a','b']

{{ ['a','b','c']|shuffle }} => ['b','c','a']

{{ ['a','b','c'] | shuffle(seed=inventory_hostname) }}
# => ['b','a','c']

{{ myvar | log }}

{{ myvar | log(10) }}

{{ myvar | pow(2) }}

{{ myvar | pow(5) }}

{{ myvar | root }}

{{ myvar | root(5) }}

{
    "domain_definition": {
        "domain": {
            "cluster": [
                {
                    "name": "cluster1"
                },
                {
                    "name": "cluster2"
                }
            ],
            "server": [
                {
                    "name": "server11",
                    "cluster": "cluster1",
                    "port": "8080"
                },
                {
                    "name": "server12",
                    "cluster": "cluster1",
                    "port": "8090"
                }
            ],
            "library": [
                {
                    "name": "lib1",
                    "target": "cluster1"
                },
                {
                    "name": "lib2",
                    "target": "cluster2"
                }
            ]
        }
    }
}

- name: "Display all cluster names"
  debug:
    var: item
  loop: "{{ domain_definition | json_query('domain.cluster[*].name') }}"

- name: "Display all server names"
  debug:
    var: item
  loop: "{{ domain_definition | json_query('domain.server[*].name') }}"

- name: "Display all ports from cluster1"
  debug:
    var: item
  loop: "{{ domain_definition | json_query(server_name_cluster1_query) }}"
  vars:
    server_name_cluster1_query: "domain.server[?cluster=='cluster1'].port"

- name: "Display all ports from cluster1 as a string"
  debug:
    msg: "{{ domain_definition | json_query('domain.server[?cluster==`cluster1`].port') | join(', ') }}"

- name: "Display all ports from cluster1"
  debug:
    var: item
  loop: "{{ domain_definition | json_query('domain.server[?cluster==''cluster1''].port') }}"

{{ myvar | ipaddr }}

{{ myvar | ipv4 }}

{{ myvar | ipv6 }}

{{ '192.0.2.1/24' | ipaddr('address') }}

{{ output | parse_cli('path/to/spec') }}

{{ output | parse_cli_textfsm('path/to/fsm') }}

{{ output | parse_xml('path/to/spec') }}

{{ [3003, 3004, 3005, 100, 1688, 3002, 3999] | vlan_parser }}

['100,1688,3002-3005,3999']

{% set parsed_vlans = vlans | vlan_parser %}
switchport trunk allowed vlan {{ parsed_vlans[0] }}
{% for i in range (1, parsed_vlans | count) %}
switchport trunk allowed vlan add {{ parsed_vlans[i] }}

{{ 'test1'|hash('sha1') }}

{{ 'test1'|hash('md5') }}

{{ 'test2'|checksum }}

{{ 'passwordsaresecret'|password_hash('sha512') }}

{{ 'secretpassword'|password_hash('sha256', 'mysecretsalt') }}

{{ {'a':1, 'b':2}|combine({'b':3}) }}

{'a':1, 'b':3}

{{ {'a':{'foo':1, 'bar':2}, 'b':2}|combine({'a':{'bar':3, 'baz':4}}, recursive=True) }}

{'a':{'foo':1, 'bar':3, 'baz':4}, 'b':2}

{{ [0,2]|map('extract', ['x','y','z'] )| list }}

# ['x', 'z']

{{ ['x','y']|map('extract', {'x': 42, 'y': 31})|list }}

# [42, 31]

{{ groups['x']|map('extract', hostvars, 'ec2_ip_address')|list }}

{{ groups['test'] | map('extract', hostvars, 'ansible_default_ipv4.address')|list }}

{{ ['a']|map('extract', b, ['x','y'])|list }}

#  b['a']['x']['y']

# 更改列表中的文件目录
{{ ['/test/t.gz'] | map('basename')| map('regex_replace', '(.*)', '/tmp/\\1') | list )}}

{{ "Plain style (default)" | comment }}

#
# Plain style (default)
#

{{ "My Special Case" | comment(decoration="! ") }}

!
! My Special Case
!

{{ "C style" | comment('c') }}
{{ "C block style" | comment('cblock') }}
{{ "Erlang style" | comment('erlang') }}
{{ "XML style" | comment('xml') }}

{{ "Custom style" | comment('plain', prefix='#######\n#', postfix='#\n#######\n   ###\n    #') }}

#######
#
# Custom style
#
#######
   ###
    #

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('hostname') }}
# => 'www.acme.com'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('netloc') }}
# => 'user:password@www.acme.com:9000'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('username') }}
# => 'user'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('password') }}
# => 'password'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('path') }}
# => '/dir/index.html'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('port') }}
# => '9000'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('scheme') }}
# => 'http'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('query') }}
# => 'query=term'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('fragment') }}
# => 'fragment'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit }}
# =>
#   {
#       "fragment": "fragment",
#       "hostname": "www.acme.com",
#       "netloc": "user:password@www.acme.com:9000",
#       "password": "password",
#       "path": "/dir/index.html",
#       "port": 9000,
#       "query": "query=term",
#       "scheme": "http",
#       "username": "user"
#   }

# search for "foo" in "foobar"
{{ 'foobar' | regex_search('(foo)') }}

# will return empty if it cannot find a match
{{ 'ansible' | regex_search('(foobar)') }}

# case insensitive search in multiline mode
{{ 'foo\nBAR' | regex_search("^bar", multiline=True, ignorecase=True) }}

# Return a list of all IPv4 addresses in the string
{{ 'Some DNS servers are 8.8.8.8 and 8.8.4.4' | regex_findall('\\b(?:[0-9]{1,3}\\.){3}[0-9]{1,3}\\b') }}

# convert "ansible" to "able"
{{ 'ansible' | regex_replace('^a.*i(.*)$', 'a\\1') }}

# convert "foobar" to "bar"
{{ 'foobar' | regex_replace('^f.*o(.*)$', '\\1') }}

# convert "localhost:80" to "localhost, 80" using named groups
{{ 'localhost:80' | regex_replace('^(?P<host>.+):(?P<port>\\d+)$', '\\g<host>, \\g<port>') }}

# convert "localhost:80" to "localhost"
{{ 'localhost:80' | regex_replace(':80') }}

# convert '^f.*o(.*)$' to '\^f\.\*o\(\.\*\)\$'
{{ '^f.*o(.*)$' | regex_escape() }}

# convert '^f.*o(.*)$' to '\^f\.\*o(\.\*)\$'
{{ '^f.*o(.*)$' | regex_escape('posix_basic') }}

{{ configmap_resource_definition | k8s_config_resource_name }}

- shell: echo {{ string_value | quote }}

{{ ('name' == 'John') | ternary('Mr','Ms') }}

{{ enabled | ternary('no shutdown', 'shutdown', omit) }} # null 使用第三个值

{{ list | join(" ") }}

{{ path | basename }}

{{ '~/.ssh/id_rsa' | expanduser }}

{{ path | win_basename }}

{{ path | dirname }}

{{ path | expandvars }}

{{ path | realpath }}

{{ path | relpath('/etc') }}  # 指定启点

{{ path | splitext }}

{{ encoded | b64decode }}
{{ decoded | string | b64encode }}

{{ encoded | b64decode(encoding='utf-16-le') }}
{{ decoded | string | b64encode(encoding='utf-16-le') }}

{{ hostname | to_uuid }}

- debug: msg=test
 when: some_string_value | bool

# Get total amount of seconds between two dates. Default date format is %Y-%m-%d %H:%M:%S but you can pass your own format
{{ (("2016-08-14 20:00:12" | to_datetime) - ("2015-12-25" | to_datetime('%Y-%m-%d'))).total_seconds() }}

# Get remaining seconds after delta has been calculated. NOTE: This does NOT convert years, days, hours, etc to seconds. For that, use total_seconds()
{{ (("2016-08-14 20:00:12" | to_datetime) - ("2016-08-14 18:00:00" | to_datetime)).seconds }}
# This expression evaluates to "12" and not "132". Delta is 2 hours, 12 seconds

# get amount of days between two dates. This returns only number of days and discards remaining hours, minutes, and seconds
{{ (("2016-08-14 20:00:12" | to_datetime) - ("2015-12-25" | to_datetime('%Y-%m-%d'))).days }}

# Display year-month-day
{{ '%Y-%m-%d' | strftime }}

# Display hour:min:sec
{{ '%H:%M:%S' | strftime }}

# Use ansible_date_time.epoch fact
{{ '%Y-%m-%d %H:%M:%S' | strftime(ansible_date_time.epoch) }}

# Use arbitrary epoch value
{{ '%Y-%m-%d' | strftime(0) }}          # => 1970-01-01
{{ '%Y-%m-%d' | strftime(1441357287) }} # => 2015-09-04

{{ myvar | type }}

- name: give me largest permutations (order matters)
  debug:
    msg: "{{ [1,2,3,4,5] | permutations | list }}"

- name: give me permutations of sets of three
  debug:
    msg: "{{ [1,2,3,4,5] | permutations(3) | list }}"

- name: give me combinations for sets of two
  debug:
    msg: "{{ [1,2,3,4,5] | combinations(2) | list }}"

- name: generate multiple hostnames
  debug:
    msg: "{{ ['foo', 'bar'] | product(['com']) | map('join', '.') | join(',') }}"

{ "msg": "foo.com,bar.com" }

{{ myvar | type_debug }}

- name: "Human Readable"
  assert:
    that:
      - '"1.00 Bytes" == 1|human_readable'
      - '"1.00 bits" == 1|human_readable(isbits=True)'
      - '"10.00 KB" == 10240|human_readable'
      - '"97.66 MB" == 102400000|human_readable'
      - '"0.10 GB" == 102400000|human_readable(unit="G")'
      - '"0.10 Gb" == 102400000|human_readable(isbits=True, unit="G")'

{ "changed": false, "msg": "All assertions passed" }

- name: "Human to Bytes"
  assert:
    that:
      - "{{'0'|human_to_bytes}}        == 0"
      - "{{'0.1'|human_to_bytes}}      == 0"
      - "{{'0.9'|human_to_bytes}}      == 1"
      - "{{'1'|human_to_bytes}}        == 1"
      - "{{'10.00 KB'|human_to_bytes}} == 10240"
      - "{{  '11 MB'|human_to_bytes}} == 11534336"
      - "{{ '1.1 GB'|human_to_bytes}} == 1181116006"
      - "{{'10.00 Kb'|human_to_bytes(isbits=True)}} == 10240"

{ "changed": false, "msg": "All assertions passed" }

variable is test_name

result is failed

{% if loop.index is divisibleby 3 %}
{% if loop.index is divisibleby(3) %}

vars:
  url: "http://example.com/users/foo/resources/bar"

tasks:
    - debug:
        msg: "matched pattern 1"
      when: url is match("http://example.com/users/.*/resources/.*")

    - debug:
        msg: "matched pattern 2"
      when: url is search("/users/.*/resources/.*")

    - debug:
        msg: "matched pattern 3"
      when: url is search("/users/")

    - debug:
        msg: "matched pattern 4"
      when: url is regex("example.com/\w+/foo")

{{ ansible_distribution_version is version_compare('12.04', '>=') }}

{{ sample_version_var is version_compare('1.0', operator='lt', strict=True) }}

<, lt, <=, le, >, gt, >=, ge, ==, =, eq, !=, <>, ne

vars:
    a: [1,2,3,4,5]
    b: [2,3]
tasks:
    - debug:
        msg: "A includes B"
      when: a is superset(b)

    - debug:
        msg: "B is included in A"
      when: b is subset(a)

vars:
  lacp_groups:
    - master: lacp0
      network: 10.65.100.0/24
      gateway: 10.65.100.1
      dns4:
        - 10.65.100.10
        - 10.65.100.11
      interfaces:
        - em1
        - em2

    - master: lacp1
      network: 10.65.120.0/24
      gateway: 10.65.120.1
      dns4:
        - 10.65.100.10
        - 10.65.100.11
      interfaces:
          - em3
          - em4

tasks:
  - debug:
      msg: "{{ (lacp_groups|selectattr('interfaces', 'contains', 'em1')|first).master }}"

vars:
  mylist:
      - 1
      - "{{ 3 == 3 }}"
      - True
  myotherlist:
      - False
      - True
tasks:

  - debug:
      msg: "all are true!"
    when: mylist is all

  - debug:
      msg: "at least one is true"
    when: myotherlist is any

- debug:
    msg: "path is a directory"
  when: mypath is directory

- debug:
    msg: "path is a file"
  when: mypath is file

- debug:
    msg: "path is a symlink"
  when: mypath is link

- debug:
    msg: "path already exists"
  when: mypath is exists

- debug:
    msg: "path is {{ (mypath is abs)|ternary('absolute','relative')}}"

- debug:
    msg: "path is the same file as path2"
  when: mypath is same_file(path2)

- debug:
    msg: "path is a mount"
  when: mypath is mount

tasks:

- shell: /usr/bin/foo
  register: result
  ignore_errors: True

- debug: msg="it failed"
  when: result is failed

- debug: msg="it changed"
  when: result is changed

- debug: msg="it succeeded in Ansible >= 2.1"
  when: result is succeeded

- debug: msg="it succeeded"
  when: result is success

- debug: msg="it was skipped"
  when: result is skipped

# 获取文件内容
vars:
  motd_value: "{{ lookup('file', '/etc/motd') }}"
tasks:
  - debug:
      msg: "motd value is {{ motd_value }}"

ansible localhost -m debug -a "msg={%- if ansible_play_hosts.index(inventory_hostname) < 3 -%}master{%- else -%}slave{%- endif -%}" 

- debug:
      msg: >-
        {%- if ansible_play_hosts.index(inventory_hostname) < 3 -%}
          master
        {%- else -%}
          slave
        {%- endif -%}

ansible localhost -m debug -a "msg={%- for t in [1,2,3] -%}{{ t }}{%- endfor -%}"

- debug:
    msg: |-
      {%- for t in [1,2,3] -%}
        {{ t }}
      {%- endfor -%}

- hosts: target_host
  tasks:
  - name: Show debug
    debug: msg='条件满足你就会看到我。'
    when: '{% if def_a_var|d("abc") == "abc" %}{{ foo | d("true") }}{% endif %}'