f5networks.f5_modules.bigip_data_group – Управление группами данных на BIG-IP
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_data_group.
Введено в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Позволяет управлять группами данных на BIG-IP. Группы данных предоставляют способ хранения наборов значений на BIG-IP для последующего использования в таких элементах, как правила LTM, iRules и политики ASM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| delete_data_group_file логический |
| Когда yes, гарантирует удаление файла группы данных на удаленном устройстве.Этот параметр актуален только когда state равен absent и internal равно no. | |
| description строка | Описание группы данных. | ||
| external_file_name строка | При создании новой группы данных, это указывает имя файла внешней группы данных на BIG-IP. Этот параметр игнорируется, когда internal равно yes.Этот параметр можно использовать для выбора существующего файла группы данных для использования с существующей внешней группой данных. Если это значение не предоставлено, оно получит значение, указанное в name, и, следовательно, будет соответствовать имени группы данных.Это значение может содержать только буквы, цифры, символы подчеркивания, дефисы или точку. | ||
| internal логический |
| Тип этой группы данных. Вы должны устанавливать это значение только в случаях, когда точно знаете, что делаете, или работаете с предварительно созданной внутренней группой данных. Помните, что если вы намеренно зададите этому параметру значение yes, и у вас большое количество записей или большой общий размер записей, это большое количество данных будет отражено в вашей конфигурации BIG-IP. Это может привести к большим задержкам загрузки конфигурации системы из-за разбора и проверки большой конфигурации.При значении этого параметра yes, ограничение для загрузок составляет либо 4 мегабайта, либо 65 000 записей (в зависимости от более ограниченного значения).Это значение нельзя изменить после создания группы данных. | |
| name строка / обязательно | Указывает имя группы данных. | ||
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| provider словарь добавлен в 1.0.0 модуля f5networks.f5_modules | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика авторизации для получения маркеров авторизации с удалённого устройства. Этот параметр реально используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логический |
| Если yes, данные телеметрии TEEM не отправляются в F5.Можно опустить этот параметр, установив переменную окружения F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Можно опустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| timeout целое число | Устанавливает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль вернёт ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Можно опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs логический |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами.Можно опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| records список / элементы=сырые | Указывает записи, которые вы хотите добавить в группу данных. Если у вас большое количество записей, рекомендуется использовать records_src вместо ввода всех записей здесь.Технические ограничения, либо 1. количество записей, либо 2. общий размер всех записей, зависят от размера общих ресурсов вашей системы; в частности, ОЗУ. Когда internal равно no, по крайней мере одна запись должна быть указана в records или records_src.Когда type равно ip, address, addr, если адреса используют домен маршрутизации, отличное от по умолчанию, они должны быть явными, то есть должны содержать обозначение домена маршрутизации %, например, 10.10.1.1%11. Это справедливо независимо от того, находится ли группа данных в разделе или нет. | ||
| key строка / обязательно | Ключ, описывающий запись в группе данных. Ключ будет использоваться для проверки параметра type для этого модуля. | ||
| value сырые данные | Значение ключа, описывающего запись в группе данных. | ||
| records_src путь | Путь к файлу с записями. Файл должен быть правильно сформирован. Это означает, что он содержит записи, по одной на строке, которые похожи на следующий формат «ключ разделитель значение». Например, foo := bar.BIG-IP жёстко следует этому формату, но этот модуль немного более гибкий. Он позволит вам включать произвольное количество (включая ноль) пробелов по обе стороны от разделителя. Для иллюстрации этого, см. раздел Примеры. Ключи записей ограничены длиной не более 65520 символов. Значения ключей записей ограничены длиной не более 65520 символов. Общее количество записей, которое вы можете иметь в BIG-IP, ограничено памятью самого BIG-IP. Формат этого содержимого немного отличается в зависимости от того, указали ли вы type типа address, integer, или string . См. раздел Примеры для примеров различных типов форматов полезной нагрузки, ожидаемых в файле вашей группы данных.Когда internal равно no, по крайней мере одна запись должна быть указана в records или records_src. | ||
| separator строка | По умолчанию: ":=" | При указании records_src, это строка символов, которая будет использоваться для разделения записей в records_src на пары «ключ/значение».По умолчанию значение этого параметра равно :=.Это значение нельзя изменить после установки. Этот параметр актуален только когда internal равно no и игнорируется в остальных случаях. | |
| state строка |
| Если state равно present, гарантирует существование группы данных.Если state равно absent, гарантирует удаление группы данных.Использование параметра state в данном модуле относится к всей группе данных, а не к её членам. | |
| type строка |
| Тип записей в этой группе данных. Этот параметр особенно важен, потому что он заставляет BIG-IP хранить ваши данные по-разному для оптимизации доступа к ним. Например, было бы неправильно указать список записей, содержащих IP-адреса, но назвать их типом string.Это значение нельзя изменить после создания группы данных. | |
Примечания
Примечание
- Этот модуль НЕ поддерживает атомное обновление членов группы данных в группе данных типа
internal. - Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохранится на диске, убедитесь, что включён хотя бы один task, использующий модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create a data group of addresses
bigip_data_group:
name: foo
internal: yes
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: yes
records:
- key: caddy
value: ""
- key: cafeteria
value: ""
- key: cactus
value: ""
type: str
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: yes
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_data_group_module.html