f5networks.f5_modules.bigip_gtm_wide_ip модуль – Управляет F5 BIG-IP GTM широким 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_gtm_wide_ip.

Добавлен в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет широким IP-адресом F5 BIG-IP GTM (теперь BIG-IP DNS).

Параметры

Параметр	Комментарии
aliases список / элементы=строка	Указывает альтернативные доменные имена для содержимого веб-сайта, который вы балансируете. Вы можете использовать те же символы подстановки для псевдонимов, что и для фактических имен Wide IP.
irules список / элементы=строка	Список правил, которые должны быть применены. Если вы хотите удалить все существующие iRules, укажите единственное пустое значение; `""`. См. документацию для примера.
last_resort_pool строка	Указывает, какой пул GTM система должна использовать в качестве резервного пула для Wide IP. Допустимыми пулами для этого параметра являются те, у которых `type` указано в этом модуле.
name псевдонимы: wide_ip строка / обязательно	Имя Wide IP. Это имя должно быть отформатировано как полностью квалифицированное доменное имя (FQDN). Вы также можете использовать псевдоним `wide_ip` , но это устарело и будет удалено в будущей версии Ansible.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
persist_cidr_ipv4 целое число	Указывает маску, используемую для группирования адресов IPv4 LDNS. Эта функция позволяет одному записям сохранения быть общим для адресов LDNS, соответствующих этой маске.
persist_cidr_ipv6 целое число	Указывает маску, используемую для группирования адресов IPv6 LDNS. Эта функция позволяет одному записям сохранения быть общим для адресов LDNS, соответствующих этой маске.
persistence логическое значение	Когда `true`, гарантирует, что при повторении запросов локальным DNS от имени клиента, система снова подключает клиента к тому же ресурсу, что и предыдущие запросы. Когда `false`, гарантирует, что повторяющиеся запросы не подключают клиента к тому же ресурсу. Варианты: `false` `true`
persistence_ttl целое число	Указывает время сохранения соединения между локальным DNS и конкретным виртуальным сервером.
pool_lb_method псевдонимы: lb_method строка	Указывает метод балансировки нагрузки, используемый для выбора пула в этом Wide IP. Это значение актуально только при наличии нескольких пулов для Wide IP. Варианты: `"round-robin"` `"ratio"` `"topology"` `"global-availability"`
pools список / элементы=словарь	Пулы, которые вы хотите связать с Wide IP. Если `ratio` не указан при создании нового Wide IP, значение по умолчанию будет 1.
name строка / обязательно	Имя пула для включения.
order целое число	Порядок пула по отношению к другим пулам, подключенным к этому Wide IP. Порядок пулов важен, когда используется метод балансировки Global Availability. Если `order` не указан, модуль присваивает ему значение `0`.
ratio целое число	Коэффициент для пула. Система использует это число с методом балансировки нагрузки Ratio. Если `ratio` не указан, модуль присваивает ему значение `0`.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как ее название было запутанным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.

server строка / обязательно	Хост BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение для подключения к удалённому устройству. Доступные значения: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs логическое	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Доступные значения: `false` `true` ← (по умолчанию)
state строка	При `present` или `enabled`, гарантирует, что Wide IP существует и включён. При `absent`, гарантирует, что Wide IP удалён. При `disabled`, гарантирует, что Wide IP существует и отключён. Доступные значения: `"present"` ← (по умолчанию) `"absent"` `"disabled"` `"enabled"`
type строка / обязательно	Определяет тип Wide IP. Wide IP GTM требуется ключевое значение по типу запроса помимо имени, так как членам пула требуется различная атрибутивная информация в зависимости от RDATA ответа, который они должны предоставлять. Доступные значения: `"a"` `"aaaa"` `"cname"` `"mx"` `"naptr"` `"srv"`

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохраняется на диске, убедитесь, что включён хотя бы один task, использующий модуль f5networks.f5_modules.bigip_config, для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Set lb method
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    type: a
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add iRules to the Wide IP
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    type: a
    irules:
      - irule1
      - irule2
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove one iRule from the Virtual Server
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    type: a
    irules:
      - irule1
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove all iRules from the Virtual Server
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    type: a
    irules: ""
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Assign a pool with ratio to the Wide IP
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    type: a
    pools:
      - name: pool1
        ratio: 100
        order: 2
      - name: pool1
        ratio: 100
        order: 1
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Assign a pool with persistence to the Wide IP
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    type: a
    pools:
      - name: pool1
        persistence: true
        persist_cidr_ipv4: 24
        persist_cidr_ipv6: 120
        persistence_ttl: 3500
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
aliases список / элементы=строка	Псевдонимы, заданные для широкого IP-адреса. Возвращено: изменено Пример: `["alias1.foo.com", "*.wildcard.domain"]`
irules список / элементы=строка	Наборы iRules, заданные для широкого IP-адреса. Возвращено: изменено Пример: `["/Common/irule1", "/Common/irule2"]`
lb_method строка	Новый метод балансировки нагрузки, используемый широким IP-адресом. Возвращено: изменено Пример: `"topology"`
persist_cidr_ipv4 целое число	Определяет маску, используемую для группировки адресов LDNS IPv4. Возвращено: изменено Пример: `32`
persist_cidr_ipv6 целое число	Определяет маску, используемую для группировки адресов LDNS IPv6. Возвращено: изменено Пример: `128`
persistence логическое	Указывается, будут ли сохраняться подключения к пулу. Возвращено: изменено Пример: `false`
persistence_ttl целое число	Устанавливает TTL сохранения соединения между локальным DNS и определенным виртуальным сервером. Возвращено: изменено Пример: `3600`
state строка	Новое состояние широкого IP-адреса. Возвращено: изменено Пример: `"disabled"`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 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_gtm_wide_ip_module.html