Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/lxhunter/ansible-filter-plugins

Documentation of all ansible filters and some custom ones
https://github.com/lxhunter/ansible-filter-plugins
ansible ansible-filters
Last synced: 3 days ago
JSON representation
Documentation of all ansible filters and some custom ones
Host: GitHub
URL: https://github.com/lxhunter/ansible-filter-plugins
Owner: lxhunter
Created: 2015-08-06T14:43:19.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2023-02-18T09:51:30.000Z (almost 2 years ago)
Last Synced: 2024-12-11T21:51:32.129Z (11 days ago)
Topics: ansible, ansible-filters
Language: Python
Homepage:
Size: 91.8 KB
Stars: 154
Watchers: 13
Forks: 42
Open Issues: 1
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        
# Ansible Filters

## Setup

Check the filters out to a directory of your choice:

```bash

$ hub clone lxhunter/ansible-filter-plugins /usr/local/src/ansible-filter-plugins

# or

$ git clone https://github.com/lxhunter/ansible-filter-plugins.git /usr/local/src/ansible-filter-plugins

```

**Pro-Tip:** I use [fresh](https://freshshell.com) for this:

```bash

$ fresh lxhunter/ansible-filter-plugins . --file=/usr/local/src/ansible-filter-plugins

```

The easiest way to make use of the libaries is to checkout this project somewhere on your ansible host,

and configure `ansible.cfg` to point the filters directory variable to the checkout directory:

```bash

$ filter_plugins = /usr/local/src/ansible-filter-plugins

```

More details can be found here:

[http://docs.ansible.com/ansible/developing_plugins.html#filter-plugins](http://docs.ansible.com/ansible/developing_plugins.html#filter-plugins)

### Requirements

For the ip address utilites you need the python `netaddr` package:

```shell

$ pip install netaddr

```

For pprint you will need the python `pretty` package:

```shell

$ pip install pretty

```

## Testing

```shell

$ python -m unittest -v string_utils

# or

$ nodemon -e 'py' --exec "python -m unittest -v string_utils"

# or

$ molecule test

```

## Overview

### Collection Utilities

* [batch](docs/jinja_functions.md#batch) - A filter that batches items.

* [chop] - see [batch](docs/jinja_functions.md#batch)

* [decapitalize]

* [dictsort](docs/jinja_functions.md#dictsort) - Sort a dict and yield (key, value) pairs.

* [difference](docs/ansible_functions.md#difference) - To get the difference of 2 lists.

* [first](docs/jinja_functions.md#first) - Return the first item of a sequence.

* [groupby](docs/jinja_functions.md#groupby) - Group a sequence of objects by a common attribute.

* [intersect](docs/ansible_functions.md#intersect) - Get the intersection of 2 lists

* [join](docs/jinja_functions.md#join) - Return a string which is the concatenation of the strings in the sequence.

* [last](docs/jinja_functions.md#last) - Return the last item of a sequence.

* [length](docs/jinja_functions.md#length) - Return the number of items of a sequence or mapping.

* [lines]

* [map](docs/jinja_functions.md#map) - Applies a filter on a sequence of objects or looks up an attribute.

* [naturalCmp] - see either [sort](docs/jinja_functions.md#sort) or [dictsort](docs/jinja_functions.md#dictsort)

* [random](docs/jinja_functions.md#random) - Return a random item from the sequence.

* [reject](docs/jinja_functions.md#reject) - Filters a sequence of objects by applying a test to the object and rejecting the ones with the test succeeding.

* [reverse](docs/jinja_functions.md#reverse) - Reverse the object or return an iterator that iterates over it the other way round.

* [select](docs/jinja_functions.md#select) - Filters a sequence of objects by applying a test to the object and only selecting the ones with the test succeeding.

* [shuffle](docs/ansible_functions.md#shuffle) - Randomize an existing list, giving a different order every invocation.

* [slice](docs/jinja_functions.md#slice) - Filters a sequence of objects by applying a test to the object and only selecting the ones with the test succeeding.

* [sort](docs/jinja_functions.md#sort) - Sort an iterable.

* [symmetric_difference](docs/ansible_functions.md#symmetric_difference) - To get the symmetric difference of 2 lists

* [union](docs/ansible_functions.md#union) - Get a union of two lists

* [unique](docs/ansible_functions.md#unique) - Get a unique set from a list

### Debug Utilities

* [pprint](docs/jinja_functions.md#pprint) - Pretty print a variable.

* [to_nice_json](docs/ansible_functions.md#to_nice_json) - Convert string into human readable JSON

* [to_nice_yaml](docs/ansible_functions.md#to_nice_yaml) - Convert value into human readable YAML

### Hashing / encoding / ID generation Utilities

* [b64decode](docs/ansible_functions.md#b64decode) - Decode a Base64 encoded string.

* [b64encode](docs/ansible_functions.md#b64encode) - Encode a string use Base64.

* [checksum](docs/ansible_functions.md#checksum) - Get a checksum for a string

* [from_json](docs/ansible_functions.md#from_json) - Reading in some JSON formatted data

* [from_yaml](docs/ansible_functions.md#from_yaml) - Reading in YAML formatted data

* [hash](docs/ansible_functions.md#hash) - Get the hash (md5, sha1, sha224, sha256, sha384, sha512) of a string

* [password_hash](docs/ansible_functions.md#password_hash) - Get a password hash (md5, sha256, sha512) for a string

* [to_json](docs/ansible_functions.md#to_json) - Convert value into JSON

* [to_uuid](docs/ansible_functions.md#to_uuid) - Create a UUID from a string

* [to_yaml](docs/ansible_functions.md#to_yaml) - Convert value into YAML

### IP Utilities

* [hwaddr](docs/ansible_functions.md#hwaddr) - Check if a given string is a MAC address or convert it between various formats.

* [ipaddr](docs/ansible_functions.md#ipaddr) - Returns the input value if a query is True, and False if query is False.

* [ipsubnet](docs/ansible_functions.md#ipsubnet) - Can be used to manipulate network subnets in several ways.

* [ipv4](docs/ansible_functions.md#ipv4) - To test if a string is a valid IPv4 address.

* [ipv6](docs/ansible_functions.md#ipv6) - To test if a string is a valid ipv6 address.

* [ipwrap](docs/ansible_functions.md#ipwrap) - Some configuration files require IPv6 addresses to be “wrapped” in square brackets ([ ]).

### Number / Math Utilities

* [abs](docs/jinja_functions.md#abs) - Return the absolute value of the argument.

* [float](docs/jinja_functions.md#float) - Convert the value into a floating point number.

* [int](docs/jinja_functions.md#int) - Convert the value into an integer.

* [log](docs/ansible_functions.md#log) - Get the logarithm

* [pow](docs/ansible_functions.md#pow) - Get the power of

* [root](docs/ansible_functions.md#root) - Square root or root

* [round](docs/jinja_functions.md#round) - Round the number to a given precision.

* [sum](docs/jinja_functions.md#sum) - Returns the sum of a sequence.

### Object Utilities

* [attr](docs/jinja_functions.md#attr) - Get an attribute of an object.

* [default](docs/jinja_functions.md#default) - Set a default value

* [rejectattr](docs/jinja_functions.md#rejectattr) - Filters a sequence of objects by applying a test to an attribute of an object or the attribute and rejecting the ones with the test succeeding.

* [selectattr](docs/jinja_functions.md#selectattr) - Slice an iterator and return a list of lists containing those items.

### Path Utilities

* [basename](docs/ansible_functions.md#basename) - Return the base name of pathname path.

* [dirname](docs/ansible_functions.md#dirname) - Return the directory name of pathname path.

* [expanduser](docs/ansible_functions.md#expanduser) - Expand a path containing a tilde (~) character

* [realpath](docs/ansible_functions.md#realpath) - Get the real path of a link

* [relpath](docs/ansible_functions.md#relpath) - Get the relative path of a link, from a start point.

* [splitext](docs/ansible_functions.md#splitext) - To get the root and extension of a path or filename.

### String Utilities

* [camelize](docs/string_util_functions.md#camelize) - Converts underscored or dasherized string to a camelized one.

* [capitalize](docs/jinja_functions.md#capitalize) - Capitalize a String.

* [center](docs/jinja_functions.md#center) - Centers the value in a field of a given width.

* [chars] - See [list](docs/jinja_functions.md#list)

* [classify](docs/string_util_functions.md#classify) - Converts string to camelized class name. First letter is always upper case.

* [clean](docs/string_util_functions.md#clean) - Trim and replace multiple spaces with a single space.

* [count](docs/string_util_functions.md#count) - Counts the number of times needle is in haystack.

* [dasherize](docs/string_util_functions.md#dasherize) - Converts a underscored or camelized string into an dasherized one.

* [decapitalize](docs/string_util_functions.md#decapitalize) - Converts first letter of the string to lowercase.

* [dedent](docs/string_util_functions.md#dedent) - Converts first letter of the string to lowercase.

* [ends_with](docs/string_util_functions.md#ends_with) - Dedent unnecessary indentation.

* [escape](docs/jinja_functions.md#escape) - Convert the chars to HTML-safe sequences.

* [escape_html](docs/string_util_functions.md#escape_html) - Converts HTML special characters to their entity equivalents.

* [filesizeformat](docs/jinja_functions.md#filesizeformat) - Format file sizes into ‘human-readable’

* [forceescape](docs/jinja_functions.md#forceescape) - Enforce HTML escaping.

* [format](docs/jinja_functions.md#format) - Apply python string formatting on an object.

* [humanize](docs/string_util_functions.md#humanize) - Converts an underscored, camelized, or dasherized string into a humanized one.

* [indent](docs/jinja_functions.md#indent) - Indent a string.

* [insert](docs/string_util_functions.md#insert) - Insert word in string at the defined position.

* [list](docs/jinja_functions.md#list) - Convert the value into a list.

* [lower](docs/jinja_functions.md#lower) - Convert a value to lowercase.

* [lpad](docs/string_util_functions.md#lpad) - Return the string left justified in a string of length width.

* [lrpad] - See [center](docs/jinja_functions.md#center)

* [ltrim](docs/string_util_functions.md#ltrim) - Return a copy of the string with leading characters removed.

* [predecessor] - do not know how to implement this

* [prune] - see [truncate](docs/jinja_functions.md#truncate)

* [quote](docs/ansible_functions.md#quote) - Add quotes for shell usage

* [regex_escape](docs/ansible_functions.md#regex_escape) - Escape special characters within a regex

* [regex_replace](docs/ansible_functions.md#regex_replace) - Replace text in a string with a regex

* [repeat](docs/string_util_functions.md#repeat) - Repeats a string count times, can be seperated by separator.

* [replace](docs/jinja_functions.md#replace) - Search for needle in haystack and replace it with substitute.

* [replaceAll] - See [replace](docs/jinja_functions.md#replace)

* [reverse](docs/jinja_functions.md#reverse) - Reverse the object or return an iterator that iterates over it the other way round.

* [rpad](docs/string_util_functions.md#rpad) - Return the string right justified in a string of length width.

* [rtrim](docs/string_util_functions.md#rtrim) - Return a copy of the string with trailing characters removed.

* [safe](docs/jinja_functions.md#safe) - Make all potentionally dangerous chars safe. - safety is a illusion, so beware!

* [splice](docs/string_util_functions.md#splice) - Return the string right justified in a string of length width.

* [sprintf] - see [format](docs/jinja_functions.md#format)

* [starts_with](docs/string_util_functions.md#starts_with) - Checks whether the string begins with the needle at position (default: 0).

* [string](docs/jinja_functions.md#string) - Make a string unicode.

* [striptags](docs/jinja_functions.md#striptags) - Strip SGML/XML tags and replace adjacent whitespace by one space.

* [strLeft]()

* [strLeftBack]

* [strRight]

* [strRightBack]

* [successor]

* [surround]

* [swap_case]

* [title](docs/jinja_functions.md#title) - Return a titlecased version of the value.

* [toSentence]

* [toSentenceSerial]

* [transliterate]

* [trim](docs/jinja_functions.md#trim) - Strip leading and trailing whitespace.

* [truncate](docs/jinja_functions.md#truncate) - Return a truncated copy of the string.

* [underscore]

* [unescapeHTML]

* [unquote]

* [upper](docs/jinja_functions.md#upper) - Convert a value to uppercase.

* [urlencode](docs/jinja_functions.md#urlencode) - Escape strings for use in URLs.

* [urlize](docs/jinja_functions.md#urlize) - Converts URLs in plain text into clickable links.

* [wordcount](docs/jinja_functions.md#wordcount) - Count the words in that string.

* [words]

* [wordwrap](docs/jinja_functions.md#wordwrap) - Return a copy of the string passed to the filter wrapped after n characters.

* [xmlattr](docs/jinja_functions.md#xmlattr) - Create an SGML/XML attribute string based on the items in a dict.

### Tests

* [bool](docs/ansible_functions.md#bool) - Check if the value is a boolean

* [callable](docs/jinja_tests.md#callable) - Return whether the object is callable

* [defined](docs/jinja_tests.md#defined) - Return true if the variable is defined

* [divisibleby](docs/jinja_tests.md#divisibleby) - Check if a variable is divisible by a number.

* [equalto](docs/jinja_tests.md#equalto) - Check if an object has the same value as another object.

* [escaped](docs/jinja_tests.md#escaped) - Check if the value is escaped.

* [even](docs/jinja_tests.md#even) - Return true if the variable is even.

* [includes](docs/string_util_functions.md#includes) - Tests if string contains a substring.

* [is_camel_case]

* [is_credit_card]

* [is_email]

* [is_ip]

* [is_snake_case]

* [is_url]

* [is_uuid]

* [isBlank]

* [isnan](docs/ansible_functions.md#isnan) - To see if something is actually a number

* [iterable](docs/jinja_tests.md#iterable) - Check if it’s possible to iterate over an object.

* [lower](docs/jinja_tests.md#lower) - Return true if the variable is lowercased.

* [mapping](docs/jinja_tests.md#mapping) - Return true if the object is a mapping (dict etc.).

* [none](docs/jinja_tests.md#none) - Return true if the variable is none.

* [number](docs/jinja_tests.md#number) - Return true if the variable is a number.

* [odd](docs/jinja_tests.md#odd) - Return true if the variable is odd.

* [sameas](docs/jinja_tests.md#sameas) - Check if an object points to the same memory address than another object.

* [sequence](docs/jinja_tests.md#sequence) - Return true if the variable is a sequence.

* [string](docs/jinja_tests.md#string) - Return true if the object is a string.

* [ternary](docs/ansible_functions.md#ternary) - Use one value on true and another on false

* [undefined](docs/jinja_tests.md#undefined) - Like defined() but the other way round.

* [upper](docs/jinja_tests.md#upper) - Return true if the variable is uppercased.

* [version_compare](docs/ansible_functions.md#version_compare) - To compare a version number

### Type Conversion Utilities

* [toBoolean]

* [toNumber]

## Credit

Builtin Jinja functions:

- [Documentation](http://jinja.pocoo.org/docs/dev/templates/#builtin-filters)

- [Filter Test](https://github.com/mitsuhiko/jinja2/blob/master/tests/test_filters.py)

- [Test Tests](https://github.com/mitsuhiko/jinja2/blob/master/tests/test_tests.py)

Builtin Ansible functions:

- [Documentation](http://docs.ansible.com/ansible/playbooks_filters.html)

- [Developing Plugins](http://docs.ansible.com/ansible/developing_plugins.html)

- [Math Filter](https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/filter/mathstuff.py)

- [Ipaddr Filter Documentation](http://docs.ansible.com/ansible/playbooks_filters_ipaddr.html)

- [Ipaddr Filter Tests](https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/filter/ipaddr.py)

## Quote

> Look deep into nature, and then you will understand everything better.

- Albert Einstein

## Contribute

[Tutorial](http://kbroman.github.io/github_tutorial/pages/fork.html)

## License and Author

Author:: [Alexander Jäger](https://github.com/lxhunter)

Copyright 2018

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.