ansible custom filters demo

1.my_filter.py

#place the file in your ansible playbook director under filter_plugins
#/home/user/my_playbook.yml
#/home/user/filter_plugins/my_filters.py

#!/usr/bin/python
class FilterModule(object):
    def filters(self):
        return {
            'a_filter': self.a_filter,
            'another_filter': self.b_filter
        }
 
    def a_filter(self, a_variable):
        a_new_variable = a_variable + ' CRAZY NEW FILTER'
        return a_new_variable

2.my_playbook.yml

---
- hosts: localhost
  connection: local
  tasks:
    - name: Print a message
      debug:
        msg: "{{'test'|a_filter}}"

3.ansible_run_output.txt

user@ansibletest:~$ ansible-playbook my_playbook.yml
 
PLAY ***************************************************************************
 
TASK [setup] *******************************************************************
ok: [localhost]
 
TASK [Print a message] *********************************************************
ok: [localhost] => {
    "msg": "test CRAZY NEW FILTER"
}
 
PLAY RECAP *********************************************************************
localhost                  : ok=2    changed=0    unreachable=0    failed=0
 

4.my_filter2.py

#!/usr/bin/python
class FilterModule(object):
    def filters(self):
        return {
            'a_filter': self.a_filter,
            'another_filter': self.b_filter
        }
 
    def a_filter(self, a_variable):
        a_new_variable = a_variable + ' CRAZY NEW FILTER'
        return a_new_variable
 
    def b_filter(self, a_variable, another_variable, yet_another_variable):
        a_new_variable = a_variable + ' - ' + another_variable + ' - ' + yet_another_variable
        return a_new_variable

5.my_playbook2.yml

---
- hosts: localhost
  connection: local
  tasks:
    - name: Print a message
      debug:
        msg: "{{'test'|another_filter('the','filters')}}"