Модуль f5networks.f5_modules.bigip_gtm_wide_ip — управление Wide IP F5 BIG-IP GTM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управляет Wide IP F5 BIG-IP GTM (теперь BIG-IP DNS).

Параметры

Параметр	Комментарии
aliases list / elements=string	Указывает альтернативные доменные имена для содержимого веб-сайта, для которого выполняется балансировка нагрузки. Для псевдонимов можно использовать те же подстановочные символы, что и для фактических имен Wide IP.
irules list / elements=string	Список правил для применения. Чтобы удалить все существующие iRules, укажите одно пустое значение; `""`. Пример см. в документации.
last_resort_pool string	Указывает, какой пул GTM система должна использовать в качестве резервного пула для Wide IP. Допустимы пулы, для которых в этом модуле указано значение `type`.
name aliases: wide_ip string / обязательный	Имя Wide IP. Оно должно быть указано в формате полного доменного имени (FQDN). Также можно использовать псевдоним `wide_ip`, однако он считается устаревшим и будет удален в будущей версии Ansible.
partition string	Раздел устройства, в котором следует управлять ресурсами. По умолчанию: `"Common"`
persist_cidr_ipv4 integer	Указывает маску для группировки адресов LDNS IPv4. Эта функция позволяет совместно использовать одну запись о сохранении соединения для адресов LDNS, соответствующих этой маске.
persist_cidr_ipv6 integer	Указывает маску для группировки адресов LDNS IPv6. Эта функция позволяет совместно использовать одну запись о сохранении соединения для адресов LDNS, соответствующих этой маске.
persistence boolean	Если `true`, при повторных запросах локального DNS от имени клиента система повторно подключает клиента к тому же ресурсу, что и при предыдущих запросах. Если `false`, повторные запросы не подключают клиента к тому же ресурсу. Варианты: `false` `true`
persistence_ttl integer	Указывает время сохранения соединения между локальным DNS и определенным виртуальным сервером.
pool_lb_method псевдонимы: lb_method string	Указывает метод балансировки нагрузки, используемый для выбора пула в этой Wide IP. Этот параметр имеет значение только при настройке нескольких пулов для Wide IP. Варианты: `"round-robin"` `"ratio"` `"topology"` `"global-availability"`
pools list / elements=dictionary	Пулы, которые необходимо связать с Wide IP. Если при создании новой Wide IP параметр `ratio` не указан, по умолчанию ему будет присвоено значение 1.
name string / обязательный	Имя включаемого пула.
order integer	Порядок пула относительно других пулов, связанных с этой Wide IP. Порядок пулов имеет значение при использовании метода балансировки нагрузки Global Availability. Если `order` не указан, модуль присваивает ему значение `0`.
ratio integer	Коэффициент для пула. Система использует это значение при выборе метода балансировки нагрузки Ratio. Если `ratio` не указан, модуль присваивает ему значение `0`.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с данными для подключения.
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` ← (по умолчанию)
state string	Если `present` или `enabled`, обеспечивает наличие и включенное состояние Wide IP. Если `absent`, обеспечивает удаление Wide IP. Если `disabled`, обеспечивает наличие и отключенное состояние Wide IP. Варианты: `"present"` ← (по умолчанию) `"absent"` `"disabled"` `"enabled"`
type string / обязательный	Указывает тип 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, обязательно включите как минимум одну задачу, использующую модуль 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 list / elements=string	Псевдонимы, заданные для Wide IP. Возвращается: при изменении Пример: `["alias1.foo.com", "*.wildcard.domain"]`
irules list / elements=string	iRules, заданные для Wide IP. Возвращается: при изменении Пример: `["/Common/irule1", "/Common/irule2"]`
lb_method string	Новый метод балансировки нагрузки, используемый Wide IP. Возвращается: при изменении Пример: `"topology"`
persist_cidr_ipv4 integer	Указывает маску для группировки адресов LDNS IPv4. Возвращается: при изменении Пример: `32`
persist_cidr_ipv6 integer	Указывает маску для группировки адресов LDNS IPv6. Возвращается: при изменении Пример: `128`
persistence boolean	Указывает, сохраняются ли соединения с пулом. Возвращается: при изменении Пример: `false`
persistence_ttl integer	Указывает TTL сохранения соединения между локальным DNS и определенным виртуальным сервером. Возвращается: при изменении Пример: `3600`
state string	Новое состояние Wide IP. Возвращается: при изменении Пример: `"disabled"`

Авторы

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

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_wide_ip_module.html