bigip_data_group – Управление группами данных на BIG-IP
Новая в версии 2.6.
Описание
- Позволяет управлять группами данных на BIG-IP. Группы данных предоставляют способ хранения наборов значений на BIG-IP для последующего использования в таких элементах, как правила LTM, iRules и политики ASM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| delete_data_group_file boolean |
| При yes, будет обеспечено удаление файла группы данных удалённого устройства.Этот параметр актуален только когда state равен absent и internal равен no. | |
| external_file_name - | При создании новой группы данных, это указывает имя файла внешней группы данных на BIG-IP. Этот параметр игнорируется, когда internal равен yes.Этот параметр можно использовать для выбора существующего файла группы данных для использования с существующей внешней группой данных. Если это значение не указано, оно получит значение, указанное в name, и, следовательно, будет соответствовать имени группы данных.Это значение может содержать только буквы, цифры, символы подчеркивания, дефисы или точку. | ||
| internal boolean |
| Тип этой группы данных. Вы должны учитывать установку этого значения только в тех случаях, когда вы точно знаете, что делаете, или работаете с предварительно созданной внутренней группой данных. Помните, что если вы намеренно установите этот параметр в yes, и у вас большое количество записей или большой общий размер записей, это большое количество данных будет отражено в конфигурации BIG-IP. Это может привести к длительным задержкам загрузки конфигурации системы из-за необходимости анализа и проверки большой конфигурации.При установке этого параметра в yes ограничение на загрузку составляет 4 мегабайта или 65 000 записей (в зависимости от более жёсткого ограничения).После создания группы данных это значение изменить нельзя. | |
| name - / обязательно | Указывает имя группы данных. | ||
| partition - | Значение по умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| password - / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| provider - добавлен в 2.5 | Значение по умолчанию: null | Объект словаря, содержащий данные подключения. | |
| password - / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| server - / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER. | ||
| server_port - | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER_PORT. | |
| ssh_keyfile - | Указывает файл SSH-ключа для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Этот параметр можно опустить, установив переменную окружения F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами.Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS. | |
| records - | Указывает записи, которые нужно добавить в группу данных. Если у вас большое количество записей, рекомендуется использовать records_content вместо ввода всех этих записей здесь.Техническое ограничение, которое зависит от размера ваших ресурсов, в частности оперативной памяти, выражается либо в количестве записей, либо в их общем размере. Когда internal равно no, хотя бы одна запись должна быть указана в records или records_content. | ||
| key - / обязательно | Ключ, описывающий запись в группе данных. Ваш ключ будет использован для проверки параметра type для данного модуля. | ||
| value - | Значение ключа, описывающего запись в группе данных. | ||
| records_src - | Путь к файлу с записями. Файл должен быть корректным. Это означает, что он содержит записи, по одной на строке, имеющие формат "ключ разделитель значение". Например, foo := bar.BIG-IP строго следует этому формату, но этот модуль несколько более лоялен. Он позволит вам включать любое количество (включая нулевое) пустых пробелов по обе стороны разделителя. Пример этого вы найдёте в разделе Примеры. Длина ключей записей ограничена 65520 символами. Длина значений ключей записей ограничена 65520 символами. Общее количество записей, которое вы можете иметь на BIG-IP, ограничено объёмом памяти BIG-IP. Формат этого содержимого немного отличается в зависимости от того, какой type равен address, integer, или string.. Примеры различных форматов данных, ожидаемых в файле вашей группы данных, вы найдете в разделе Примеры.Когда internal равно no, хотя бы одна запись должна быть указана в records или records_content. | ||
| separator - | Значение по умолчанию: ":=" | При указании records_content, это строка символов, которая будет использоваться для разделения записей в records_content на пары ключ/значение.По умолчанию значение этого параметра :=.Это значение нельзя изменить после установки. Этот параметр актуален только если internal равно no. В противном случае он будет проигнорирован. | |
| server - / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER. | ||
| server_port - добавлен в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER_PORT. | |
| Состояние - |
| Когда state равно present, гарантирует существование группы данных.Когда state равно absent, гарантирует удаление группы данных. | |
| Тип - |
| Тип записей в этой группе данных. Этот параметр особенно важен, потому что он заставляет BIG-IP хранить ваши данные различными способами, чтобы оптимизировать доступ к ним. Например, неправильно было бы указать список записей, содержащих IP-адреса, но обозначить их как тип string. Это значение нельзя изменить после создания группы данных. | |
| Пользователь - / обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean добавлено в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с использованием самоподписанных сертификатов.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы гарантировать сохранение конфигурации, специфичной для BIG-IP, на диске, убедитесь, что вы включили хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create a data group of addresses
bigip_data_group:
name: foo
password: secret
server: lb.mydomain.com
state: present
user: admin
records:
- key: 0.0.0.0/32
value: External_NAT
- key: 10.10.10.10
value: No_NAT
type: address
delegate_to: localhost
- name: Create a data group of strings
bigip_data_group:
name: foo
password: secret
server: lb.mydomain.com
state: present
user: admin
records:
- key: caddy
value: ""
- key: cafeteria
value: ""
- key: cactus
value: ""
type: string
delegate_to: localhost
- name: Create a data group of IP addresses from a file
bigip_data_group:
name: foo
password: secret
server: lb.mydomain.com
state: present
user: admin
records_src: /path/to/dg-file
type: address
delegate_to: localhost
- name: Update an existing internal data group of strings
bigip_data_group:
name: foo
password: secret
server: lb.mydomain.com
state: present
internal: yes
user: admin
records:
- key: caddy
value: ""
- key: cafeteria
value: ""
- key: cactus
value: ""
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)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_data_group_module.html