Модуль f5networks.f5_modules.bigip_data_group — управление группами данных на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_data_group.

Добавлено в f5networks.f5_modules 1.0.0

Краткое описание
Параметры
Примечания
Примеры

Краткое описание

Позволяет управлять группами данных на BIG-IP. Группы данных предоставляют возможность хранить коллекции значений на BIG-IP для последующего использования, например, в правилах LTM, iRules и политиках ASM.

Параметры

Параметр	Комментарии
delete_data_group_file boolean	Если `true`, обеспечивает удаление файла удалённой группы данных. Этот параметр применяется только в том случае, если `state` равно `absent`, а `internal` равно `false`. Варианты: `false` ← (по умолчанию) `true`
description string	Описание группы данных.
external_file_name string	При создании новой группы данных этот параметр задаёт имя файла внешней группы данных на BIG-IP. Этот параметр игнорируется, если `internal` равно `true`. Этот параметр можно использовать для выбора существующего файла группы данных для имеющейся внешней группы данных. Если значение не указано, ему будет присвоено значение, заданное в `name`, и поэтому оно будет совпадать с именем группы данных. Это значение может содержать только буквы, цифры, символы подчёркивания, дефисы и точки.
internal boolean	Тип этой группы данных. Устанавливайте это значение только в том случае, если вы точно знаете, что делаете, или работаете с уже существующей внутренней группой данных. Обратите внимание: если вы намеренно зададите для этого параметра значение `true` и у вас будет большое количество записей или большой общий размер записей, этот большой объём данных будет отражён в конфигурации BIG-IP. Это может привести к длительной загрузке конфигурации системы из-за разбора и проверки большой конфигурации. Если для этого параметра задано значение `true`, действует ограничение на загрузку: 4 мегабайта или 65 000 записей — в зависимости от того, какое ограничение строже. Это значение нельзя изменить после создания группы данных. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Задаёт имя группы данных.
partition string	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
provider dictionary добавлен в f5networks.f5_modules 1.0.0	Объект dict с данными для подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
records list / элементы=any	Задаёт записи, которые нужно добавить в группу данных. Если записей много, рекомендуется использовать `records_src`, а не вводить их все здесь. Техническое ограничение на количество записей или их общий размер зависит от объёма ресурсов системы, в частности от объёма оперативной памяти. Если `internal` равно `false`, необходимо указать хотя бы одну запись в `records` или `records_src`. Если `type` равно: `ip`, `address`, `addr`, для адресов, использующих нестандартный домен маршрутизации, его необходимо указывать явно, то есть адреса должны содержать обозначение домена маршрутизации `%`, например 10.10.1.1%11. Это правило действует независимо от того, находится ли группа данных в разделе.
key string / обязательный	Ключ, описывающий запись в группе данных. Ключ используется для проверки параметра `type` этого модуля.
value any	Значение ключа, описывающего запись в группе данных.
records_src path	Путь к файлу с записями. Файл должен иметь корректный формат. Это означает, что он должен содержать по одной записи на строку в формате «ключ разделитель значение». Например, `foo := bar`. BIG-IP строго требует соблюдения этого формата, однако этот модуль допускает некоторые отклонения. Он позволяет добавлять любое количество пробелов (в том числе ни одного) с обеих сторон разделителя. Пример см. в разделе «Примеры». Длина ключей записей не должна превышать 65520 символов. Длина значений ключей записей не должна превышать 65520 символов. Общее количество записей на BIG-IP ограничено объёмом памяти самого BIG-IP. Формат этого содержимого немного различается в зависимости от того, указан ли `type` типа `address`, `integer` или `string`. Примеры ожидаемых форматов данных в файле группы данных см. в разделе «Примеры». Если `internal` равно `false`, необходимо указать хотя бы одну запись в `records` или `records_src`.
separator string	При указании `records_src` эта строка символов используется для разделения записей в `records_src` на пары «ключ/значение». По умолчанию для этого параметра используется значение `:=`. Это значение нельзя изменить после установки. Этот параметр применяется только в том случае, если `internal` равно `false`. В противном случае он игнорируется. По умолчанию: `":="`
state string	Если `state` равно `present`, обеспечивает наличие группы данных. Если `state` равно `absent`, обеспечивает удаление группы данных. В этом модуле параметр state относится ко всей группе данных, а не к её элементам. Варианты: `"present"` ← (по умолчанию) `"absent"`
type string	Тип записей в этой группе данных. Этот параметр важен, поскольку BIG-IP хранит данные разными способами, чтобы оптимизировать доступ к ним. Например, неверно указывать список записей с IP-адресами, но задавать для них тип `string`. Это значение нельзя изменить после создания группы данных. Варианты: `"address"` `"addr"` `"ip"` `"string"` ← (по умолчанию) `"integer"` `"int"`

Примечания

Примечание

Этот модуль НЕ поддерживает атомарное обновление элементов группы данных типа internal.
Добавлять и удалять элементы группы данных типа external следует только с помощью модулей Ansible. Если изменения внесены вручную, модуль Ansible их не обнаружит.
Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. по адресу https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы изменения конфигурации BIG-IP сохранялись на диске, добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в его документации.

Примеры

- name: Create a data group of addresses
  bigip_data_group:
    name: foo
    internal: true
    records:
      - key: 0.0.0.0/32
        value: External_NAT
      - key: 10.10.10.10
        value: No_NAT
    type: address
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a data group of strings
  bigip_data_group:
    name: foo
    internal: true
    records:
      - key: caddy
        value: ""
      - key: cafeteria
        value: ""
      - key: cactus
        value: ""
    type: string
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a data group of IP addresses from a file
  bigip_data_group:
    name: foo
    records_src: /path/to/dg-file
    type: address
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update an existing internal data group of strings
  bigip_data_group:
    name: foo
    internal: true
    records:
      - key: caddy
        value: ""
      - key: cafeteria
        value: ""
      - key: cactus
        value: ""
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Show the data format expected for records_content - address 1
  copy:
    dest: /path/to/addresses.txt
    content: |
      network 10.0.0.0 prefixlen 8 := "Network1",
      network 172.16.0.0 prefixlen 12 := "Network2",
      network 192.168.0.0 prefixlen 16 := "Network3",
      network 2402:9400:1000:0:: prefixlen 64 := "Network4",
      host 192.168.20.1 := "Host1",
      host 172.16.1.1 := "Host2",
      host 172.16.1.1 := "Host3",
      host 2001:0db8:85a3:0000:0000:8a2e:0370:7334 := "Host4",
      host 2001:0db8:85a3:0000:0000:8a2e:0370:7334 := "Host5"

- name: Show the data format expected for records_content - address 2
  copy:
    dest: /path/to/addresses.txt
    content: |
      10.0.0.0/8 := "Network1",
      172.16.0.0/12 := "Network2",
      192.168.0.0/16 := "Network3",
      2402:9400:1000:0::/64 := "Network4",
      192.168.20.1 := "Host1",
      172.16.1.1 := "Host2",
      172.16.1.1/32 := "Host3",
      2001:0db8:85a3:0000:0000:8a2e:0370:7334 := "Host4",
      2001:0db8:85a3:0000:0000:8a2e:0370:7334/128 := "Host5"

- name: Show the data format expected for records_content - string
  copy:
    dest: /path/to/strings.txt
    content: |
      a := alpha,
      b := bravo,
      c := charlie,
      x := x-ray,
      y := yankee,
      z := zulu,

- name: Show the data format expected for records_content - integer
  copy:
    dest: /path/to/integers.txt
    content: |
      1 := bar,
      2 := baz,
      3,
      4,

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)
Greg Crosby (@crosbygw)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_data_group_module.html