f5networks.f5_modules.bigip_virtual_address модуль — Управление виртуальными адресами LTM на 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_virtual_address.

Новое в f5networks.f5_modules 1.0.0

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

Обзор

Управление виртуальными адресами LTM на системе BIG-IP.

Параметры

Параметр	Комментарии
address строка	Указывает виртуальный адрес. Это значение нельзя изменить после его установки. Если виртуальный адрес никогда не создавался, но были созданы виртуальные серверы, для каждого виртуального сервера автоматически создавался виртуальный адрес. Имя этого виртуального адреса — его значение IP-адреса.
arp логическое	Указывает, принимает ли система запросы ARP. Когда `false`, указывает, что система не принимает запросы ARP. Когда `true`, пакеты отбрасываются. Для того, чтобы виртуальные серверы, использующие этот виртуальный адрес, пересылали пакеты ICMP, необходимо отключить как ARP, так и ICMP Echo. При создании нового виртуального адреса, если этот параметр не указан, значение по умолчанию — `true`. Варианты: `false` `true`
auto_delete логическое	Указывает, автоматически ли удаляется виртуальный адрес при удалении последнего связанного виртуального сервера. Когда `false`, система оставляет виртуальный адрес, даже если все связанные виртуальные серверы были удалены. При создании виртуального адреса значение по умолчанию — `true`. Варианты: `false` `true`
availability_calculation псевдонимы: advertise_route строка	Указывает, какие маршруты виртуального адреса система публикует. При `when_any_available`, маршрут публикуется, когда доступен любой виртуальный сервер. При `when_all_available`, маршрут публикуется, когда доступны все виртуальные серверы. При (всегда) маршрут всегда публикуется независимо от доступности виртуальных серверов. Варианты: `"always"` `"when_all_available"` `"when_any_available"`
connection_limit целое число	Указывает количество одновременных подключений, разрешенных системой для этого виртуального адреса.
icmp_echo строка	Указывает, как система отправляет ответы на запросы (ICMP) эхо на основе виртуального адреса для включения публикации маршрутов. При `enabled`, система BIG-IP перехватывает пакеты запросов ICMP эхо и отвечает на них напрямую. При `disabled`, система BIG-IP передает запросы ICMP эхо бэкенд-серверам. При (selective), система BIG-IP внутренне включает или отключает ответы, основываясь на состоянии виртуальных серверов; `when_any_available`, `when_all_available, or C(always`, независимо от состояния каких-либо виртуальных серверов. Варианты: `"enabled"` `"disabled"` `"selective"`
name строка	Имя виртуального адреса. Если этот параметр не указан, система использует значение `address`.
netmask строка	Указывает маску сети для предоставленного виртуального адреса. Это значение нельзя изменить после его установки. При создании нового виртуального адреса, если этот параметр не указан, значение по умолчанию — `255.255.255.255` для IPv4-адресов и `ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff` для IPv6-адресов.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
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 string	Настраивает транспортное подключение для соединения с удаленным устройством. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
route_advertisement string	Указывает, использует ли система объявление маршрутов для этого виртуального адреса. При отключении система не объявляет маршруты для этого виртуального адреса. Большинство этих параметров поддерживаются только в версиях 13.0.0-HF1 и выше. В версиях ниже указанной все варианты, кроме `disabled`, переводятся в `enabled`. Когда `always`, система BIG-IP всегда объявляет маршрут для виртуального адреса, независимо от состояния доступности. Для этого требуется `enabled` виртуальный адрес. Когда `enabled`, система BIG-IP объявляет маршрут для доступного виртуального адреса, основываясь на методе расчета в вычислении доступности. Когда `disabled`, система BIG-IP не объявляет маршрут для виртуального адреса, независимо от состояния доступности. Когда `selective`, вы также можете выборочно включить ответы ICMP echo, что заставляет систему BIG-IP внутренне включать или отключать ответы, основываясь на состоянии виртуального сервера. Когда `any`, система BIG-IP объявляет маршрут для виртуального адреса, когда доступен любой виртуальный сервер. Когда `all`, система BIG-IP объявляет маршрут для виртуального адреса, когда все виртуальные серверы доступны. Варианты: `"disabled"` `"enabled"` `"always"` `"selective"` `"any"` `"all"`
route_domain string	Домен маршрутизации `address`, который вы хотите использовать. Это значение нельзя изменить после его установки.
spanning boolean	Включает все системы BIG-IP в группе устройств для прослушивания и обработки трафика по одному виртуальному адресу. Распространение для виртуального адреса происходит, когда вы включаете опцию `spanning` на устройстве, а затем синхронизируете виртуальный адрес с другими членами группы устройств. Распространение также зависит от маршрутизатора вышестоящего уровня для распределения потоков приложений по системам BIG-IP с использованием маршрутов ECMP. ECMP определяет маршрут к виртуальному адресу с использованием отдельных плавающих адресов self-IP, настроенных на каждой системе BIG-IP. Необходимо также настроить адреса MAC-маскирования и отключить `arp` на виртуальном адресе при включенном Распространении. При создании нового виртуального адреса, если этот параметр не указан, значение по умолчанию `false`. Варианты: `false` `true`
state string	Состояние виртуального адреса. Если `absent`, система пытается удалить виртуальный адрес. Это удастся только в том случае, если этот виртуальный адрес не используется виртуальным сервером. `present` создает виртуальный адрес и включает его. Если `enabled`, включает виртуальный адрес, если он существует. Если `disabled`, создает виртуальный адрес при необходимости и устанавливает состояние в `disabled`. Варианты: `"present"` ← (по умолчанию) `"absent"` `"enabled"` `"disabled"`
traffic_group string	Группа трафика для виртуального адреса. При создании нового адреса, если это значение не указано, значение по умолчанию `/Common/traffic-group-1`.

Примечания

Примечание

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

Примеры

- name: Add virtual address
  bigip_virtual_address:
    state: present
    partition: Common
    address: 10.10.10.10
    provider:
      server: lb.mydomain.net
      user: admin
      password: secret
  delegate_to: localhost

- name: Enable route advertisement on the virtual address
  bigip_virtual_address:
    state: present
    address: 10.10.10.10
    route_advertisement: any
    provider:
      server: lb.mydomain.net
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Описание
address целое число	Адрес виртуального адреса. Возвращается: создан Пример: `2345`
arp логическое	Новый способ обработки запросов ARP виртуальным адресом. Возвращается: изменён Пример: `true`
auto_delete логическое	Новое значение для автоматического удаления виртуального адреса. Возвращается: изменён Пример: `true`
availability_calculation строка	Определяет, какие маршруты виртуального адреса система рекламирует. Возвращается: изменён Пример: `"always"`
connection_limit целое число	Новый предел подключений виртуального адреса. Возвращается: изменён Пример: `1000`
icmp_echo строка	Новое значение ICMP echo, применённое к виртуальному адресу. Возвращается: изменён Пример: `"disabled"`
netmask целое число	Маска сети виртуального адреса. Возвращается: создан Пример: `2345`
spanning строка	Включена ли функция spanning. Возвращается: изменён Пример: `"disabled"`
state строка	Новое состояние виртуального адреса. Возвращается: изменён Пример: `"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_virtual_address_module.html