Ansible.Utils

Collection version 4.1.0

Description 

Ansible Collection with utilities to ease the management, manipulation, and validation of data within a playbook

Author:

Ansible Community

Supported ansible-core versions:

2.14.0 or newer

ansible.utils Scenario Guide 

Using the ipaddr filter

Plugin Index 

These are the plugins in the ansible.utils collection:

Modules

cli_parse module – Parse cli output or text using a variety of parsers
fact_diff module – Find the difference between currently set facts
update_fact module – Update currently set facts
validate module – Validate data with provided criteria

Filter Plugins

cidr_merge filter – This filter can be used to merge subnets or individual addresses.
consolidate filter – Consolidate facts together on common attributes.
fact_diff filter – Find the difference between currently set facts
from_xml filter – Convert given XML string to native python dictionary.
get_path filter – Retrieve the value in a variable using a path
hwaddr filter – HWaddr / MAC address filters
index_of filter – Find the indices of items in a list matching some criteria
ip4_hex filter – This filter is designed to convert IPv4 address to Hexadecimal notation with optional delimiter.
ipaddr filter – This filter is designed to return the input value if a query is True, else False.
ipcut filter – This filter is designed to get 1st or last few bits of IP address.
ipmath filter – This filter is designed to do simple IP math/arithmetic.
ipsubnet filter – This filter can be used to manipulate network subnets in several ways.
ipv4 filter – To filter only Ipv4 addresses Ipv4 filter is used.
ipv6 filter – To filter only Ipv6 addresses Ipv6 filter is used.
ipv6form filter – This filter is designed to convert ipv6 address in different formats. For example expand, compressetc.
ipwrap filter – This filter is designed to Wrap IPv6 addresses in [ ] brackets.
keep_keys filter – Keep specific keys from a data recursively.
macaddr filter – macaddr / MAC address filters
network_in_network filter – This filter returns whether an address or a network passed as argument is in a network.
network_in_usable filter – The network_in_usable filter returns whether an address passed as an argument is usable in a network.
next_nth_usable filter – This filter returns the next nth usable ip within a network described by value.
nthhost filter – This filter returns the nth host within a network described by value.
param_list_compare filter – Generate the final param list combining/comparing base and provided parameters.
previous_nth_usable filter – This filter returns the previous nth usable ip within a network described by value.
reduce_on_network filter – This filter reduces a list of addresses to only the addresses that match a given network.
remove_keys filter – Remove specific keys from a data recursively.
replace_keys filter – Replaces specific keys with their after value from a data recursively.
slaac filter – This filter returns the SLAAC address within a network for a given HW/MAC address.
to_paths filter – Flatten a complex object into a dictionary of paths and values
to_xml filter – Convert given JSON string to XML
usable_range filter – Expand the usable IP addresses
validate filter – Validate data with provided criteria

Lookup Plugins

get_path lookup – Retrieve the value in a variable using a path
index_of lookup – Find the indices of items in a list matching some criteria
to_paths lookup – Flatten a complex object into a dictionary of paths and values
validate lookup – Validate data with provided criteria

Test Plugins

in_any_network test – Test if an IP or network falls in any network
in_network test – Test if IP address falls in the network
in_one_network test – Test if IP address belongs in any one of the networks in the list
ip test – Test if something in an IP address or network
ip_address test – Test if something in an IP address
ipv4 test – Test if something is an IPv4 address or network
ipv4_address test – Test if something is an IPv4 address
ipv4_hostmask test – Test if an address is a valid hostmask
ipv4_netmask test – Test if an address is a valid netmask
ipv6 test – Test if something is an IPv6 address or network
ipv6_address test – Test if something is an IPv6 address
ipv6_ipv4_mapped test – Test if something appears to be a mapped IPv6 to IPv4 mapped address
ipv6_sixtofour test – Test if something appears to be a 6to4 address
ipv6_teredo test – Test if something appears to be an IPv6 teredo address
loopback test – Test if an IP address is a loopback
mac test – Test if something appears to be a valid MAC address
multicast test – Test for a multicast IP address
private test – Test if an IP address is private
public test – Test if an IP address is public
reserved test – Test for a reserved IP address
resolvable test – Test if an IP or name can be resolved via /etc/hosts or DNS
subnet_of test – Test if a network is a subnet of another network
supernet_of test – Test if a network is a supernet of another network
unspecified test – Test for an unspecified IP address
validate test – Validate data with provided criteria