Add quotes to elemens of the list in jinja2 (ansible)

Question

I have very simple line in the template:

ip={{ip|join(', ')}}

And I have list for ip:

ip:
 - 1.1.1.1
 - 2.2.2.2
 - 3.3.3.3

But application wants IPs with quotes (ip='1.1.1.1', '2.2.2.2').

I can do it like this:

ip:
 - "'1.1.1.1'"
 - "'2.2.2.2'"
 - "'3.3.3.3'"

But it is very ugly. Is any nice way to add quotes on each element of the list in ansible?

Thanks!

score 29 · Answer 1 · edited May 31 '18 at 06:17

29

This will work :

ip={{ '\"' + ip|join('\", \"') + '\"' }}

A custom filter plugin will also work. In ansible.cfg uncomment filter_plugins and give it a path, where we put this

def wrap(list):
    return [ '"' + x + '"' for x in list]

class FilterModule(object):
    def filters(self):
        return {
            'wrap': wrap
        }

in a file called core.py. Like this. Then you can simply use

ip|wrap|join(', ')

And it should produce comma seperated list with each ip wrapped in quotes.

edited May 31 '18 at 06:17

Craig Scott

9,238
5
56
85

answered Apr 11 '15 at 03:02

Zasz

12,330
9
43
63

1

This works like a charm. And if you want this just for one project / playbook, simply put a `filter_plugins` folder in your project and call the file, as already mentioned, `core.py`. – incredibleholg Apr 07 '17 at 06:53
2

Shouldn't it be `ip={{ '\"' + ip|join('\", \"') + '\"'}}` ? – LoicAG Aug 01 '17 at 13:46

score 26 · Accepted Answer · answered Mar 13 '18 at 11:34

26

Actually there is a very simple method to achieve this:

{{ mylist | map('quote') | join(', ') }}

The filter map iterates over every item and let quote process it. Afterwards you can easily join them together.

answered Mar 13 '18 at 11:34

Max

904
8
15

11

the `quote` filter seems to be a part of ansible and not jinja2's core. – jkr Nov 13 '18 at 18:07
12

for some reason map('quote') never works for me in ansible, it does nothing – zzzeek Dec 14 '18 at 15:23
3

Ansible's `map('quote')` quotes for shell only – gadamiak Feb 20 '19 at 15:13
2

map('quote') quotes for shell variables (wont work for j2 templates), and it decides if quoting is needed (based on content of the string). Take Away: Use a for loop instead. – Basil Musa Aug 08 '19 at 13:50
For the record, quoting works for the `command` module. – Richlv Aug 17 '21 at 16:46

score 13 · Answer 3 · answered Apr 09 '15 at 16:08

13

try:

- hosts: localhost
  tags: s20
  gather_facts: no
  vars:
    ip:
      - 1.1.1.1
      - 2.2.2.2
      - 3.3.3.3
    joined_ip: "'{{ \"', '\".join(ip)}}'"
  tasks:
  - debug: msg="(ip={{joined_ip}})"

PS: ansible supports a bit of python code execution within {{}}, which is what i'm misusing here.

answered Apr 09 '15 at 16:08

Kashyap

15,354
13
64
103

This one works for me while the other not. Thanks a lot for sharing this. – Jérôme B Apr 26 '19 at 14:12

f-society · Answer 4 · 2018-06-22T22:44:16.347

6

Following worked for me

('{{ iplist | join('\',\'') }}')

Ex:

Inventory

[ips]
1.1.1.1
2.2.2.2
3.3.3.3

#cat temp.sh.j2 

 "ips": (ip='{{ groups['zoo'] | join('\',\'') }}') 

result:

#cat temp.sh

 "ips": (ip='1.1.1.1','2.2.2.2','3.3.3.3')

Hope it would help someone.

edited Jun 22 '18 at 22:44

answered Jun 22 '18 at 22:34

f-society

2,898
27
18

works good for not empty list. but for empty array, it will result with [''] – elprup Nov 19 '18 at 05:55
If you want tp use double quotes (it's also a bit clear for me): `("{{ iplist | join('\",\"') }}")` – Xabs Oct 05 '22 at 07:22

ninjaconcombre · Answer 5 · 2022-05-19T09:40:45.247

6

As mentioned in this blog: https://medium.com/opsops/how-enquote-list-elements-faab833e25fe

Use to_json filter. This will double quote every string of the list:

list_of_string | map("to_json")

The problem with the "quote" filter is that it does not quote elements that dont need to be quoted from a bash perspective (no space in the string). But for windows commands sometimes strings must be quoted anyway.

edited May 19 '22 at 09:40

answered May 19 '22 at 09:02

ninjaconcombre

456
4
15

seems that the `to_json` has been changed to `tojson` – lowzhao Apr 20 '23 at 18:39

score 2 · Answer 6 · answered Apr 06 '18 at 11:50

NOTE This is similar to Kashyap's answer, but i needed a slightly different version: Using it to double quote each items in a bash array), eg. result should be:

SOME_LIST=( "Johnny" "Joey" "Dee Dee" "Tommy" )

projects/ansible/expand_list.yml

---
- hosts: localhost
  connection: local

  vars:
    some_list:
      - Johnny
      - Joey
      - Dee Dee
      - Tommy

  tasks:
    - name: "Expand the ramones band members list."
      template:
        src: "templates/expand_list.conf.j2"
        dest: "/var/tmp/ramones.conf"

projects/ansible/templates/expand_list.conf.j2

SOME_LIST=( "{{ '" "'.join(some_list) }}" )

score 2 · Answer 7 · answered May 11 '19 at 05:03

2

I found the simplest way to do this with an existing Ansible filter is using regex_replace.

{{ ip | map("regex_replace","(.+)","\'\\1\'") | join(',')}}

answered May 11 '19 at 05:03

Notabee

51
2

score 1 · Answer 8 · answered Oct 12 '16 at 12:21

I've developed a custom wrap filter

def wrap(value, wrapper = '"'):
  return wrapper + value + wrapper

class FilterModule(object):
  def filters(self):
    return {
      'wrap': wrap
    }

As you can see wrapper is customizable and defaults to "

You can use it this way

ip={{ ip | map('wrap') | join(', ') }}

Disclaimer: I'm a python and ansible newbie

score 1 · Answer 9 · answered Nov 26 '19 at 13:59

You can use regex_replace, f.e. in a j2 template file:

(ip={{ip | map('regex_replace', '(.*)', "'\\1'") | join(',')}})

If you do this inline in a play, do not forget to escape the double quotes. Here is a full example:

- hosts: localhost
  gather_facts: no
  vars:
    ip:
    - 1.1.1.1
    - 2.2.2.2
    - 3.3.3.3
    ip_result: "{{ip | map('regex_replace', '(.*)', \"'\\1'\") | join(',')}}"
  tasks:
  - debug: msg="(ip={{ip_result}})"
  - copy: content="(ip={{ip_result}})" dest=./ip_result.txt

Content of ip_result.txt:

$ cat ip_result.txt
(ip='1.1.1.1','2.2.2.2','3.3.3.3')

Add quotes to elemens of the list in jinja2 (ansible)

9 Answers9

Linked