bigip_data_group – Управление группами данных на BIG-IP
Новая в версии 2.6.
Описание
- Позволяет управлять группами данных на BIG-IP. Группы данных предоставляют способ хранения наборов значений на BIG-IP для последующего использования в таких элементах, как правила LTM, iRules и политики ASM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| delete_data_group_file boolean |
| Когда yes, будет гарантировать удаление файла группы данных на удалённом устройстве.Этот параметр актуален только когда state равно absent и internal равно no. | |
| description string добавлено в 2.8 | Описание группы данных. | ||
| external_file_name string | При создании новой группы данных, это указывает имя файла внешней группы данных на BIG-IP. Этот параметр игнорируется, когда internal равно yes.Этот параметр можно использовать для выбора существующего файла группы данных для использования с существующей внешней группой данных. Если это значение не указано, оно получит значение, указанное в name, и, следовательно, будет соответствовать имени группы данных.Это значение может содержать только буквы, цифры, нижние подчеркивания, дефисы или точки. | ||
| internal boolean |
| Тип этой группы данных. Вы должны учитывать установку этого значения только в случаях, когда вы точно знаете, что делаете, или работаете с предварительно созданной внутренней группой данных. Обратите внимание, что если вы намеренно установите этот параметр в yes, и у вас есть большое количество записей или большой общий размер записей, это большое количество данных будет отражено в вашей конфигурации BIG-IP. Это может привести к длинным временам загрузки конфигурации системы из-за необходимости парсить и проверять большую конфигурацию.При значении этого параметра yes, ограничение на загрузку составляет либо 4 мегабайта, либо 65 000 записей (в зависимости от того, что более ограничительно).Это значение нельзя изменить после создания группы данных. | |
| name string / обязательно | Указывает имя группы данных. | ||
| partition string | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password string / обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| provider dictionary добавлено в 2.5 | Объект dict, содержащий данные подключения. | ||
| password string / обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server string / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port integer | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| transport string |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user string / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| records list | Указывает записи, которые вы хотите добавить в группу данных. Если у вас большое количество записей, рекомендуется использовать records_content вместо ввода всех записей вручную.Техническое ограничение, либо 1. количество записей, либо 2. общий размер всех записей, зависит от размера общих ресурсов вашей системы, в частности, ОЗУ. Когда internal равно no, хотя бы одна запись должна быть указана в records или records_content. | ||
| key string / обязательно | Ключ, описывающий запись в группе данных. Ваш ключ будет использован для валидации параметра type для этого модуля. | ||
| value raw | Значение ключа, описывающего запись в группе данных. | ||
| records_src путь | Путь к файлу с записями. Файл должен быть правильно сформирован. Это означает, что он содержит записи, по одной на строку, имеющие следующий формат "ключ разделитель значение". Например, foo := bar.BIG-IP строго соблюдает этот формат, но этот модуль немного более лоялен. Он позволит вам включить произвольные количества (включая ноль) пробелов по обе стороны разделителя. Пример этого вы найдете в разделе Примеры. Ключи записей ограничены по длине не более 65520 символов. Значения ключей записей ограничены по длине не более 65520 символов. Общее количество записей, которые вы можете иметь в BIG-IP, ограничено памятью BIG-IP. Формат этого содержимого немного отличается в зависимости от того, укажете ли вы type типа address, integer, или string. Примеры различных типов ожидаемых форматов данных в файле вашей группы данных вы найдете в разделе Примеры.Когда internal равно no, хотя бы одна запись должна быть указана в records или records_content. | ||
| separator string | По умолчанию: ":=" | При указании records_content, это строка символов, которая будет использоваться для разделения записей в records_content на пары ключ/значение.По умолчанию значение этого параметра :=.Это значение нельзя изменить после его установки. Этот параметр актуален только когда internal равно no. В противном случае он будет проигнорирован. | |
| server string / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port integer добавлено в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| состояние строка |
| Когда state равно present, гарантирует, что группа данных существует.Когда state равно absent, гарантирует удаление группы данных.Использование состояния в этом модуле относится к всей группе данных, а не к её членам. | |
| тип строка |
| Тип записей в этой группе данных. Этот параметр особенно важен, потому что он заставляет BIG-IP хранить ваши данные различными способами, чтобы оптимизировать доступ к ним. Например, было бы неправильно указать список записей, содержащих IP-адреса, но пометить их как тип string. Это значение нельзя изменить после создания группы данных. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs булево добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, находящихся под вашим контролем, использующих самозаверенные сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Этот модуль НЕ поддерживает атомарные обновления членов группы данных в группе данных типа
internal. - Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что специфическая конфигурация BIG-IP сохраняется на диск, убедитесь, что вы включили хотя бы одну задачу, использующую модуль 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/32 := "Host3",
host 2001:0db8:85a3:0000:0000:8a2e:0370:7334 := "Host4",
host 2001:0db8:85a3:0000:0000:8a2e:0370:7334/128 := "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,
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_data_group_module.html