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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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	Объект словаря, содержащий данные соединения.
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` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

records список / элементы=любой	Указывает записи, которые вы хотите добавить в группу данных. Если у вас большое количество записей, мы рекомендуем использовать `records_src` вместо ввода всех этих записей здесь. Технические ограничения на количество записей или общий размер всех записей. Зависит от размера общих ресурсов вашей системы; в частности, от ОЗУ. Когда `internal` является `false`, необходимо указать хотя бы одну запись либо в `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` является `false`, необходимо указать хотя бы одну запись либо в `records`, либо в `records_src`.
separator строка	При указании `records_src`, это строка символов, которая будет использоваться для разделения записей в `records_src` на пары «ключ/значение». По умолчанию значение этого параметра равно `:=`. Это значение не может быть изменено после его установки. Этот параметр актуален только когда `internal` является `false`. В противном случае он будет проигнорирован. По умолчанию: `":="`
state строка	Когда `state` является `present`, гарантирует, что группа данных существует. Когда `state` является `absent`, гарантирует, что группа данных удалена. Использование параметра state в этом модуле относится ко всей группе данных, а не к ее членам. Варианты: `"present"` ← (по умолчанию) `"absent"`
type строка	Тип записей в этой группе данных. Этот параметр важен, потому что он заставляет 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_data_group_module.html