Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: 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
boolean
    Варианты:
  • нет ←
  • да
При yes, гарантирует удаление файла группы данных на удалённом устройстве.
Этот параметр актуален только когда state является absent и internal равно no.
description
string
Описание группы данных.
external_file_name
string
При создании новой группы данных, это указывает имя файла для внешнего файла группы данных на BIG-IP.
Этот параметр игнорируется, когда internal равно yes.
Этот параметр можно использовать для выбора существующего файла группы данных для использования с существующей внешней группой данных.
Если это значение не указано, оно будет присвоено значение, указанное в name, и, следовательно, соответствовать имени группы данных.
Это значение может содержать только буквы, цифры, символы нижнего подчёркивания, дефисы или точку.
internal
boolean
    Варианты:
  • нет ←
  • да
Тип этой группы данных.
Вы должны устанавливать это значение только в том случае, если точно знаете, что делаете, или работаете с предварительно созданной внутренней группой данных.
Обратите внимание, что если вы намеренно устанавливаете этот параметр в yes, и у вас большое количество записей или большой общий размер записей, этот большой объём данных отразится в вашей конфигурации BIG-IP. Это может привести к длительному времени загрузки конфигурации системы из-за анализа и проверки большой конфигурации.
При значении yes ограничение на загрузку составляет либо 4 мегабайта, либо 65 000 записей (в зависимости от того, какое ограничение жёстче).
Это значение нельзя изменить после создания группы данных.
name
string / обязательно
Указывает имя группы данных.
partition
string
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
provider
dictionary
добавлен в 1.0.0 f5networks.f5_modules
Объект словаря, содержащий сведения о подключении.
auth_provider
string
Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства.
Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem
boolean
    Варианты:
  • нет
  • да
Если yes, данные телеметрии TEEM не отправляются в F5.
Можно опустить этот параметр, установив переменную среды F5_TEEM.
password
string / обязательно
Пароль для учётной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
server
string / обязательно
Хост BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER.
server_port
integer
Значение по умолчанию:
443
Порт сервера BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT.
timeout
integer
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport
string
    Варианты:
  • rest ←
Настраивает транспортное соединение для использования при подключении к удалённому устройству.
user
string / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Можно опустить этот параметр, установив переменную среды F5_USER.
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами.
Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
records
list / elements=raw
Указывает записи, которые вы хотите добавить в группу данных.
Если у вас большое количество записей, рекомендуется использовать records_src вместо ввода всех этих записей здесь.
Техническое ограничение, либо 1. количество записей, либо 2. общий размер всех записей, варьируется в зависимости от размера общих ресурсов вашей системы; в частности, оперативной памяти.
Когда internal равно no, хотя бы одна запись должна быть указана в records или records_src.
Когда type равно ip, address, addr, если адреса используют домен маршрутизации, отличной от по умолчанию, они должны быть явно указаны, то есть должны содержать обозначение домена маршрутизации %, например, 10.10.1.1%11. Это верно независимо от того, находится ли группа данных в разделе или нет.
key
string / обязательно
Ключ, описывающий запись в группе данных.
Ключ будет использоваться для проверки параметра type для этого модуля.
value
raw
Значение ключа, описывающего запись в группе данных.
records_src
path
Путь к файлу с записями.
Файл должен быть правильно сформирован. Это означает, что он содержит записи, по одной на строке, которые похожи на следующий формат "ключ разделитель значение". Например, foo := bar.
BIG-IP жёстко требует этого формата, но этот модуль немного более гибкий. Он позволит вам включать произвольное количество (включая нулевое) пустого пространства по обе стороны от разделителя. Для иллюстрации этого, см. раздел Примеры.
Ключи записей ограничены по длине максимальным значением 65520 символов.
Значения ключей записей ограничены по длине максимальным значением 65520 символов.
Общее количество записей, которое вы можете иметь в BIG-IP, ограничено объёмом памяти самого BIG-IP.
Формат этого содержимого немного отличается в зависимости от того, указали ли вы type типа address, integer, или string. См. раздел Примеры для примеров разных типов форматов полезной нагрузки, которые ожидаются в вашем файле группы данных.
Когда internal равно no, хотя бы одна запись должна быть указана в records или records_src.
separator
string
Значение по умолчанию:
":="
При указании records_src, это строка символов, которая будет использоваться для разделения записей в records_src на пары ключ/значение.
По умолчанию значение этого параметра равно :=.
Это значение нельзя изменить после его установки.
Этот параметр актуален только при internal равно no. В противном случае он будет проигнорирован.
state
string
    Варианты:
  • present ←
  • absent
При state равно present, гарантирует существование группы данных.
При state равно absent, гарантирует удаление группы данных.
Использование state в этом модуле относится к всей группе данных, а не к её членам.
type
string
    Варианты:
  • address
  • addr
  • ip
  • string ←
  • str
  • integer
  • int
Тип записей в этой группе данных.
Этот параметр особенно важен, потому что он заставляет 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 для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
END_OF_DOCUMENT_MARKER

Примеры

- 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_data_group_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API