ipaddr filter

ipaddr() — это фильтр Jinja2, предназначенный для предоставления интерфейса к пакету Python netaddr внутри Ansible. Он может работать со строками или списками элементов, проверять различные данные на предмет того, являются ли они валидными IP-адресами, и изменять входные данные для извлечения запрошенной информации. ipaddr() работает как с IPv4, так и с IPv6 адресами в различных форматах. Также доступны дополнительные функции для работы с IP-подсетями и MAC-адресами.

Для использования этого фильтра в Ansible необходимо установить библиотеку Python netaddr на компьютере, на котором вы используете Ansible (на удаленных хостах это не требуется). Обычно её можно установить с помощью системного менеджера пакетов или с помощью pip.

pip install netaddr

• Основные проверки
• Фильтрация списков
• Оборачивание IPv6 адресов в квадратные скобки [ ]
• Основные запросы
• Получение информации об узлах и сетях
• Получение информации из значений хост/префикс
• Преобразование масок подсетей в CIDR-нотацию
• Преобразование IP-адресов
• Преобразование IPv4 адреса в 6to4 адрес
• Работа с подсетями
• Слияние подсетей
• Фильтр MAC-адресов

Основные проверки

ipaddr() предназначен для возврата входного значения, если запрос верен, и False, если запрос ложен. Таким образом, его можно легко использовать в цепочках фильтров. Для использования фильтра, передайте строку:

{{ '192.0.2.0' | ipaddr }}

Вы также можете передать значения как переменные:

{{ myvar | ipaddr }}

Ниже приведены примеры результатов проверок для различных входных строк:

# These values are valid IP addresses or network ranges
'192.168.0.1'       -> 192.168.0.1
'192.168.32.0/24'   -> 192.168.32.0/24
'fe80::100/10'      -> fe80::100/10
45443646733         -> ::a:94a7:50d
'523454/24'         -> 0.7.252.190/24

# Values that are not valid IP addresses or network ranges
'localhost'         -> False
True                -> False
'space bar'         -> False
False               -> False
''                  -> False
':'                 -> False
'fe80:/10'          -> False

Иногда вам нужны либо IPv4, либо IPv6 адреса. Для фильтрации только по определённому типу, фильтр ipaddr() имеет два «псевдонима», ipv4() и ipv6().

Пример использования фильтра IPv4:

{{ myvar | ipv4 }}

Аналогичный пример фильтра IPv6:

{{ myvar | ipv6 }}

Вот результаты проверок на поиск IPv4 адресов:

'192.168.0.1'       -> 192.168.0.1
'192.168.32.0/24'   -> 192.168.32.0/24
'fe80::100/10'      -> False
45443646733         -> False
'523454/24'         -> 0.7.252.190/24

И те же данные, отфильтрованные по IPv6 адресам:

'192.168.0.1'       -> False
'192.168.32.0/24'   -> False
'fe80::100/10'      -> fe80::100/10
45443646733         -> ::a:94a7:50d
'523454/24'         -> False

Фильтрация списков

Вы можете фильтровать целые списки — ipaddr() вернёт список со значениями, которые подходят для определенного запроса:

# Example list of values
test_list = ['192.24.2.1', 'host.fqdn', '::1', '192.168.32.0/24', 'fe80::100/10', True, '', '42540766412265424405338506004571095040/64']

# {{ test_list | ipaddr }}
['192.24.2.1', '::1', '192.168.32.0/24', 'fe80::100/10', '2001:db8:32c:faad::/64']

# {{ test_list | ipv4 }}
['192.24.2.1', '192.168.32.0/24']

# {{ test_list | ipv6 }}
['::1', 'fe80::100/10', '2001:db8:32c:faad::/64']

Оборачивание IPv6 адресов в квадратные скобки [ ]

Некоторые конфигурационные файлы требуют, чтобы IPv6-адреса были «оборачены» в квадратные скобки ([ ]). Для этого можно использовать фильтр ipwrap(). Он обернёт все IPv6-адреса и оставит неизменными другие строки:

# {{ test_list | ipwrap }}
['192.24.2.1', 'host.fqdn', '[::1]', '192.168.32.0/24', '[fe80::100]/10', True, '', '[2001:db8:32c:faad::]/64']

Как видно, ipwrap() не отфильтровал не-IP-адресные значения, что обычно нужно, когда, например, вы смешиваете IP-адреса с именами хостов. Если вы всё ещё хотите отфильтровать все не-IP-адресные значения, вы можете объединить оба фильтра:

# {{ test_list | ipaddr | ipwrap }}
['192.24.2.1', '[::1]', '192.168.32.0/24', '[fe80::100]/10', '[2001:db8:32c:faad::]/64']

Основные запросы

Вы можете передать один аргумент каждому фильтру ipaddr(). Фильтр будет обрабатывать его как запрос и возвращать изменённые значения. В списке будут только те значения, которые вы запрашиваете.

Типы запросов включают:

• запрос по имени: ipaddr('address'), ipv4('network');
• запрос по CIDR-диапазону: ipaddr('192.168.0.0/24'), ipv6('2001:db8::/32');
• запрос по номеру индекса: ipaddr('1'), ipaddr('-1');

Если тип запроса не распознаётся, Ansible выдаст ошибку.

Получение информации об узлах и сетях

Вот наш тестовый список снова:

# Example list of values
test_list = ['192.24.2.1', 'host.fqdn', '::1', '192.168.32.0/24', 'fe80::100/10', True, '', '42540766412265424405338506004571095040/64']

Давайте возьмём список выше и получим только те элементы, которые являются IP-адресами узлов, а не диапазонами сетей:

# {{ test_list | ipaddr('address') }}
['192.24.2.1', '::1', 'fe80::100']

Как видите, хотя некоторые значения имели адрес узла с префиксом CIDR, они были отброшены фильтром. Если вы хотите адреса узлов с их правильными префиксами CIDR (как это обычно бывает с IPv6 адресацией), вы можете использовать фильтр ipaddr('host'):

# {{ test_list | ipaddr('host') }}
['192.24.2.1/32', '::1/128', 'fe80::100/10']

Фильтрация по типу IP-адреса также работает:

# {{ test_list | ipv4('address') }}
['192.24.2.1']

# {{ test_list | ipv6('address') }}
['::1', 'fe80::100']

Вы можете проверить, доступны ли IP-адреса или диапазоны сетей в открытом интернете или находятся ли они в частных сетях:

# {{ test_list | ipaddr('public') }}
['192.24.2.1', '2001:db8:32c:faad::/64']

# {{ test_list | ipaddr('private') }}
['192.168.32.0/24', 'fe80::100/10']

Вы можете проверить, какие значения являются конкретно диапазонами сетей:

# {{ test_list | ipaddr('net') }}
['192.168.32.0/24', '2001:db8:32c:faad::/64']

Вы также можете проверить, сколько IP-адресов может быть в определенном диапазоне:

# {{ test_list | ipaddr('net') | ipaddr('size') }}
[256, 18446744073709551616L]

Указав диапазон сети как запрос, вы можете проверить, находится ли данное значение в этом диапазоне:

# {{ test_list | ipaddr('192.0.0.0/8') }}
['192.24.2.1', '192.168.32.0/24']

Если вы укажете положительное или отрицательное целое число как запрос, ipaddr() будет рассматривать это как индекс и вернёт конкретный IP-адрес из диапазона сети в формате «хост/префикс»:

# First IP address (network address)
# {{ test_list | ipaddr('net') | ipaddr('0') }}
['192.168.32.0/24', '2001:db8:32c:faad::/64']

# Second IP address (usually the gateway host)
# {{ test_list | ipaddr('net') | ipaddr('1') }}
['192.168.32.1/24', '2001:db8:32c:faad::1/64']

# Last IP address (the broadcast address in IPv4 networks)
# {{ test_list | ipaddr('net') | ipaddr('-1') }}
['192.168.32.255/24', '2001:db8:32c:faad:ffff:ffff:ffff:ffff/64']

Вы также можете выбрать IP-адреса из диапазона по их индексу, начиная с начала или конца диапазона:

# Returns from the start of the range
# {{ test_list | ipaddr('net') | ipaddr('200') }}
['192.168.32.200/24', '2001:db8:32c:faad::c8/64']

# Returns from the end of the range
# {{ test_list | ipaddr('net') | ipaddr('-200') }}
['192.168.32.56/24', '2001:db8:32c:faad:ffff:ffff:ffff:ff38/64']

# {{ test_list | ipaddr('net') | ipaddr('400') }}
['2001:db8:32c:faad::190/64']

Получение информации из значений хост/префикс

Вы часто используете комбинацию IP-адресов и префиксов подсети («CIDR»), это ещё более распространено с IPv6. Фильтр ipaddr() может извлекать полезные данные из этих префиксов.

Вот пример набора из двух значений хост/префикс (с некоторыми «контрольными» значениями):

host_prefix = ['2001:db8:deaf:be11::ef3/64', '192.0.2.48/24', '127.0.0.1', '192.168.0.0/16']

Сначала убедимся, что мы работаем только с корректными значениями хост/префикс, а не просто с подсетями или одиночными IP-адресами:

# {{ host_prefix | ipaddr('host/prefix') }}
['2001:db8:deaf:be11::ef3/64', '192.0.2.48/24']

В системах на базе Debian конфигурация сети, хранящаяся в файле /etc/network/interfaces, использует комбинацию IP-адреса, сетевого адреса, маски сети и адреса широковещательной рассылки для настройки IPv4 сетевого интерфейса. Мы можем получить эти значения из одного значения «хост/префикс»:

# Jinja2 template
{% set ipv4_host = host_prefix | unique | ipv4('host/prefix') | first %}
iface eth0 inet static
    address   {{ ipv4_host | ipaddr('address') }}
    network   {{ ipv4_host | ipaddr('network') }}
    netmask   {{ ipv4_host | ipaddr('netmask') }}
    broadcast {{ ipv4_host | ipaddr('broadcast') }}

# Generated configuration file
iface eth0 inet static
    address   192.0.2.48
    network   192.0.2.0
    netmask   255.255.255.0
    broadcast 192.0.2.255

В примере выше, нам нужно было учесть, что значения хранились в списке, что необычно в IPv4 сетях, где может быть задан только один IP-адрес на интерфейсе. Однако IPv6 сети могут иметь несколько IP-адресов, установленных на интерфейсе:

.. code-block:: jinja

  # Jinja2 template
  iface eth0 inet6 static
    {% set ipv6_list = host_prefix | unique | ipv6('host/prefix') %}
    address {{ ipv6_list[0] }}
    {% if ipv6_list | length > 1 %}
    {% for subnet in ipv6_list[1:] %}
    up   /sbin/ip address add {{ subnet }} dev eth0
    down /sbin/ip address del {{ subnet }} dev eth0
    {% endfor %}
    {% endif %}

  # Generated configuration file
  iface eth0 inet6 static
    address 2001:db8:deaf:be11::ef3/64

При необходимости вы можете извлечь информацию о подсети и префиксе из значения «хост/префикс»:

# {{ host_prefix | ipaddr('host/prefix') | ipaddr('subnet') }}
['2001:db8:deaf:be11::/64', '192.0.2.0/24']

# {{ host_prefix | ipaddr('host/prefix') | ipaddr('prefix') }}
[64, 24]

Преобразование масок подсетей в CIDR-нотацию

При наличии подсети в виде сетевого адреса и маски подсети, фильтр ipaddr() может преобразовать её в CIDR-нотацию. Это может быть полезно для преобразования фактов Ansible, собранных о конфигурации сети из масок подсетей в формат CIDR:

ansible_default_ipv4: {
    address: "192.168.0.11",
    alias: "eth0",
    broadcast: "192.168.0.255",
    gateway: "192.168.0.1",
    interface: "eth0",
    macaddress: "fa:16:3e:c4:bd:89",
    mtu: 1500,
    netmask: "255.255.255.0",
    network: "192.168.0.0",
    type: "ether"
}

Сначала конкатенируйте сеть и маску:

net_mask = "{{ ansible_default_ipv4.network }}/{{ ansible_default_ipv4.netmask }}"
'192.168.0.0/255.255.255.0'

Этот результат можно преобразовать в каноническую форму с помощью ipaddr(), чтобы получить подсеть в формате CIDR:

# {{ net_mask | ipaddr('prefix') }}
'24'

# {{ net_mask | ipaddr('net') }}
'192.168.0.0/24'

Преобразование IP-адресов

Вот наш тестовый список снова:

# Example list of values
test_list = ['192.24.2.1', 'host.fqdn', '::1', '192.168.32.0/24', 'fe80::100/10', True, '', '42540766412265424405338506004571095040/64']

Вы можете преобразовать IPv4 адреса в IPv6 адреса:

# {{ test_list | ipv4('ipv6') }}
['::ffff:192.24.2.1/128', '::ffff:192.168.32.0/120']

Преобразование из IPv6 в IPv4 работает очень редко:

# {{ test_list | ipv6('ipv4') }}
['0.0.0.1/32']

Но мы можем сделать двойное преобразование, если это необходимо:

# {{ test_list | ipaddr('ipv6') | ipaddr('ipv4') }}
['192.24.2.1/32', '0.0.0.1/32', '192.168.32.0/24']

Вы можете преобразовать IP-адреса в целые числа, так же как вы можете преобразовать целые числа в IP-адреса:

# {{ test_list | ipaddr('address') | ipaddr('int') }}
[3222798849, 1, '3232243712/24', '338288524927261089654018896841347694848/10', '42540766412265424405338506004571095040/64']

Вы можете преобразовать IP-адреса в записи PTR:

# {% for address in test_list | ipaddr %}
# {{ address | ipaddr('revdns') }}
# {% endfor %}
1.2.24.192.in-addr.arpa.
1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa.
0.32.168.192.in-addr.arpa.
0.0.1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.e.f.ip6.arpa.
0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.d.a.a.f.c.2.3.0.8.b.d.0.1.0.0.2.ip6.arpa.

Преобразование IPv4 адреса в 6to4 адрес

Туннель 6to4 — это способ доступа к интернету IPv6 из сети только с IPv4. Если у вас есть публичный IPv4 адрес, вы можете автоматически настроить его IPv6 эквивалент в сети 2002::/16. После преобразования вы получите доступ к подсети 2002:xxxx:xxxx::/48, которая может быть разделена на 65535 /64 подсетей при необходимости.

Для преобразования вашего IPv4 адреса просто передайте его через фильтр '6to4'. Он будет автоматически преобразован в адрес маршрутизатора (с адресом узла ::1/48):

# {{ '193.0.2.0' | ipaddr('6to4') }}
2002:c100:0200::1/48

Работа с подсетями

Фильтр ipsubnet() может использоваться для манипулирования сетевыми подсетями различными способами.

Вот пример IP-адреса и подсети:

address = '192.168.144.5'
subnet  = '192.168.0.0/16'

Чтобы проверить, является ли данная строка подсетью, передайте её через фильтр без аргументов. Если заданная строка является IP-адресом, она будет преобразована в подсеть:

# {{ address | ipsubnet }}
192.168.144.5/32

# {{ subnet | ipsubnet }}
192.168.0.0/16

Если вы укажете размер подсети как первый параметр фильтра ipsubnet(), и размер подсети меньше текущего, вы получите количество подсетей, на которые можно разделить данную подсеть:

# {{ subnet | ipsubnet(20) }}
16

Второй аргумент фильтра ipsubnet() — номер индекса; указав его, вы можете получить новую подсеть с указанным размером:

# First subnet
# {{ subnet | ipsubnet(20, 0) }}
192.168.0.0/20

# Last subnet
# {{ subnet | ipsubnet(20, -1) }}
192.168.240.0/20

# Fifth subnet
# {{ subnet | ipsubnet(20, 5) }}
192.168.80.0/20

# Fifth to last subnet
# {{ subnet | ipsubnet(20, -5) }}
192.168.176.0/20

Если вы укажете IP-адрес вместо подсети и зададите размер подсети как первый аргумент, фильтр ipsubnet() вместо этого вернёт самую большую подсеть, содержащую этот IP-адрес:

# {{ address | ipsubnet(20) }}
192.168.128.0/20

Указав номер индекса как второй аргумент, вы можете выбрать всё меньшие и меньшие подсети:

# First subnet
# {{ address | ipsubnet(18, 0) }}
192.168.128.0/18

# Last subnet
# {{ address | ipsubnet(18, -1) }}
192.168.144.4/31

# Fifth subnet
# {{ address | ipsubnet(18, 5) }}
192.168.144.0/23

# Fifth to last subnet
# {{ address | ipsubnet(18, -5) }}
192.168.144.0/27

Указав другую подсеть как второй аргумент, если вторая подсеть включает первую, вы можете определить ранг первой подсети во второй

# The rank of the IP in the subnet (the IP is the 36870nth /32 of the subnet)
# {{ address | ipsubnet(subnet) }}
36870

# The rank in the /24 that contain the address
# {{ address | ipsubnet('192.168.144.0/24') }}
6

# An IP with the subnet in the first /30 in a /24
# {{ '192.168.144.1/30' | ipsubnet('192.168.144.0/24') }}
1

# The fifth subnet /30 in a /24
# {{ '192.168.144.16/30' | ipsubnet('192.168.144.0/24') }}
5

Если вторая подсеть не включает первую подсеть, фильтр ipsubnet() вызывает ошибку.

Вы можете использовать фильтр ipsubnet() с фильтром ipaddr() для, например, разделения заданного префикса /48 на более мелкие /64 подсети:

# {{ '193.0.2.0' | ipaddr('6to4') | ipsubnet(64, 58820) | ipaddr('1') }}
2002:c100:200:e5c4::1/64

Из-за размера IPv6 подсетей итерация по всем из них для поиска нужной может занять некоторое время на медленных компьютерах, в зависимости от разницы в размерах подсетей.

Слияние подсетей

Фильтр cidr_merge() можно использовать для слияния подсетей или отдельных адресов в их минимальное представление, объединяя перекрывающиеся подсети и смежные, где это возможно:

{{ ['192.168.0.0/17', '192.168.128.0/17', '192.168.128.1' ] | cidr_merge }}
# => ['192.168.0.0/16']

{{ ['192.168.0.0/24', '192.168.1.0/24', '192.168.3.0/24'] | cidr_merge }}
# => ['192.168.0.0/23', '192.168.3.0/24']

Изменение действия с «слияние» на «объединение» вернёт вместо этого самую маленькую подсеть, которая содержит все входные данные:

{{ ['192.168.0.0/24', '192.168.3.0/24'] | cidr_merge('span') }}
# => '192.168.0.0/22'

{{ ['192.168.1.42', '192.168.42.1'] | cidr_merge('span') }}
# => '192.168.0.0/18'

Фильтр MAC-адресов

Вы можете использовать фильтр hwaddr() для проверки, является ли заданная строка MAC-адресом, или преобразовать её между различными форматами. Примеры:

# Example MAC address
macaddress = '1a:2b:3c:4d:5e:6f'

# Check if given string is a MAC address
# {{ macaddress | hwaddr }}
1a:2b:3c:4d:5e:6f

# Convert MAC address to PostgreSQL format
# {{ macaddress | hwaddr('pgsql') }}
1a2b3c:4d5e6f

# Convert MAC address to Cisco format
# {{ macaddress | hwaddr('cisco') }}
1a2b.3c4d.5e6f