Spec-Zone.ru › Ansible 2.9

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
строка
добавлено в 2.8
Описание группы данных.
external_file_name
строка
При создании новой группы данных, это указывает имя файла внешней группы данных на BIG-IP.
Этот параметр игнорируется, когда internal равно yes.
Этот параметр можно использовать для выбора существующего файла группы данных для использования с существующей внешней группой данных.
Если это значение не указано, оно получит значение, указанное в name, и, следовательно, будет совпадать с именем группы данных.
Это значение может содержать только буквы, цифры, символы подчёркивания, дефисы или точку.
internal
boolean
    Варианты:
  • нет ←
  • да
Тип этой группы данных.
Вы должны устанавливать это значение только в тех случаях, когда вы точно знаете, что делаете, или когда работаете с существующей внутренней группой данных.
Обратите внимание, что если вы намеренно установите этот параметр в yes, и у вас большое количество записей или большой общий размер записей, это большое количество данных будет отражено в вашей конфигурации BIG-IP. Это может привести к длительным временам загрузки конфигурации системы из-за необходимости парсить и проверять большую конфигурацию.
При установке этого параметра в yes, существует ограничение в 4 мегабайта или 65 000 записей (в зависимости от более жёсткого ограничения) для загрузки.
Это значение нельзя изменить после создания группы данных.
name
строка / обязательно
Указывает имя группы данных.
partition
строка
Значение по умолчанию:
"Общие"
Раздел устройства для управления ресурсами.
provider
словарь
добавлено в 2.5
Объект словаря, содержащий данные подключения.
auth_provider
строка
Настраивает поставщика авторизации для получения маркеров аутентификации от удалённого устройства.
Этот параметр используется, когда работают с устройствами BIG-IQ.
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
целое число
Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Можно опустить этот параметр, задав переменную среды F5_USER.
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых лично, с самоподписанными сертификатами.
Можно опустить этот параметр, задав переменную среды F5_VALIDATE_CERTS.
records
список
Указывает записи, которые нужно добавить в группу данных.
Если у вас большое количество записей, рекомендуется использовать records_content вместо ввода всех этих записей здесь.
Технические ограничения по количеству записей или общему объёму записей зависят от размера общих ресурсов на вашей системе, в частности, от оперативной памяти.
При internal равно no, хотя бы одна запись должна быть указана либо в records, либо в records_content.
При type равно ip, address, addr, если адреса используют домен маршрутизации, отличной от стандартной, они должны быть явными, то есть должны содержать обозначение домена маршрутизации %, например, 10.10.1.1%11. Это справедливо независимо от того, находится ли группа данных в разделе или нет.
key
строка / обязательно
Ключ, описывающий запись в группе данных.
Ваш ключ будет использоваться для проверки параметра type для этого модуля.
value
сырые данные
Значение ключа, описывающего запись в группе данных.
records_src
путь
Путь к файлу со записями.
Файл должен быть правильно сформирован. Это означает, что он включает записи, по одной на строке, которые напоминают следующий формат: "ключ разделитель значение". Например, foo := bar.
BIG-IP строго соблюдает этот формат, но этот модуль немного более лоялен. Он позволит включить произвольные количества (включая нулевое) пустого пространства по обе стороны от разделителя. Для иллюстрации этого, обратитесь к разделу Примеры.
Ключи записей ограничены по длине максимум 65 520 символами.
Значения ключей записей ограничены по длине максимум 65 520 символами.
Общее количество записей, которое может быть в BIG-IP, ограничено памятью BIG-IP.
Формат этого содержимого немного отличается в зависимости от того, указан ли type типа address, integer, или string . Смотрите раздел Примеры для примеров различных типов форматов содержимого, ожидаемых в файле группы данных.
При internal равно no, хотя бы одна запись должна быть указана либо в records, либо в records_content.
separator
строка
Значение по умолчанию:
":="
При указании records_content, это строка символов, которые будут использоваться для разделения записей в records_content на пары ключ/значение.
По умолчанию значение этого параметра :=.
Это значение нельзя изменить после его установки.
Этот параметр актуален только при internal равно no и игнорируется в противном случае.
state
строка
    Варианты:
  • present ←
  • absent
При state равно present, гарантирует существование группы данных.
При state равно absent, гарантирует удаление группы данных.
Использование state в этом модуле относится к всей группе данных, а не к её членам.
Тип
строка
    Варианты:
  • адрес
  • addr
  • ip
  • строка ←
  • str
  • целое число
  • int
Тип записей в этой группе данных.
Этот параметр особенно важен, потому что он заставляет BIG-IP хранить ваши данные различными способами для оптимизации доступа к ним. Например, неправильно указать список записей, содержащих IP-адреса, но маркировать их как тип string.
Это значение нельзя изменить после создания группы данных.

Примечания

Примечание

  • Этот модуль НЕ поддерживает атомарные обновления членов группы данных в группе данных типа 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)
  • 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.9/modules/bigip_data_group_module.html

Spec-Zone.ru

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