Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_virtual_address — управление виртуальными адресами LTM на BIG-IP

Примечание

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

string

Задает виртуальный адрес. Это значение нельзя изменить после его установки.

Если вы не создавали виртуальный адрес, но создали виртуальные серверы, для каждого виртуального сервера автоматически создавался виртуальный адрес. Имя этого виртуального адреса совпадает со значением его IP-адреса.

arp

boolean

Указывает, принимает ли система запросы ARP.

Если задано false, система не принимает запросы ARP.

Если задано true, пакеты отбрасываются.

Чтобы виртуальные серверы переадресации, использующие этот виртуальный адрес, могли переадресовывать пакеты ICMP, необходимо отключить и ARP, и эхо-запросы ICMP.

При создании виртуального адреса, если этот параметр не указан, используется значение по умолчанию true.

Варианты:

  • false
  • true

auto_delete

boolean

Указывает, удаляет ли система виртуальный адрес автоматически при удалении последнего связанного с ним виртуального сервера. Если задано false, система сохраняет виртуальный адрес, даже если все связанные с ним виртуальные серверы удалены. При создании виртуального адреса используется значение по умолчанию true.

Варианты:

  • false
  • true

availability_calculation

псевдонимы: advertise_route

string

Указывает, какие маршруты виртуального адреса объявляет система. При значении when_any_available маршрут объявляется, если доступен любой виртуальный сервер. При значении when_all_available маршрут объявляется, если доступны все виртуальные серверы. При значении (always) маршрут объявляется всегда, независимо от доступности виртуальных серверов.

Варианты:

  • "always"
  • "when_all_available"
  • "when_any_available"

connection_limit

integer

Указывает количество одновременных подключений, разрешенное системой для этого виртуального адреса.

icmp_echo

string

Указывает, как система отвечает на эхо-запросы (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

string

Имя виртуального адреса.

Если этот параметр не указан, система использует значение address.

netmask

string

Указывает маску подсети заданного виртуального адреса. Это значение нельзя изменить после его установки.

При создании виртуального адреса, если этот параметр не указан, для адресов IPv4 используется значение по умолчанию 255.255.255.255, а для адресов IPv6 — ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff.

partition

string

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

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 ← (по умолчанию)

route_advertisement

string

Указывает, использует ли система объявление маршрутов для этого виртуального адреса.

Если параметр отключен, система не объявляет маршруты для этого виртуального адреса.

Большинство этих параметров поддерживаются только в версиях 13.0.0-HF1 и выше. В более ранних версиях все варианты, кроме disabled, соответствуют значению enabled.

При значении always система BIG-IP всегда объявляет маршрут для виртуального адреса независимо от его статуса доступности. Для этого требуется виртуальный адрес enabled.

При значении enabled система BIG-IP объявляет маршрут для доступного виртуального адреса в соответствии с методом расчета, заданным в параметре availability_calculation.

При значении disabled система BIG-IP не объявляет маршрут для виртуального адреса независимо от его статуса доступности.

При значении selective можно также выборочно включать ответы на эхо-запросы ICMP; в этом случае система BIG-IP включает или отключает ответы внутри системы в зависимости от состояния виртуальных серверов.

При значении any система BIG-IP объявляет маршрут для виртуального адреса, если доступен любой виртуальный сервер.

При значении all система BIG-IP объявляет маршрут для виртуального адреса, если доступны все виртуальные серверы.

Варианты:

  • "disabled"
  • "enabled"
  • "always"
  • "selective"
  • "any"
  • "all"

route_domain

string

Домен маршрутизации для address, который требуется использовать.

Это значение нельзя изменить после его установки.

spanning

boolean

Разрешает всем системам BIG-IP в группе устройств прослушивать и обрабатывать трафик для одного и того же виртуального адреса.

Режим Spanning для виртуального адреса включается путем активации параметра spanning на устройстве и последующей синхронизации виртуального адреса с другими участниками группы устройств.

Для работы Spanning также требуется, чтобы вышестоящий маршрутизатор распределял потоки приложений между системами BIG-IP с помощью маршрутов ECMP. ECMP задает маршрут к виртуальному адресу, используя отдельные плавающие self-IP-адреса, настроенные на каждой системе BIG-IP.

При включенном режиме Spanning необходимо также настроить MAC-адреса masquerade и отключить 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

integer

Адрес виртуального адреса.

Возвращается: created

Пример: 2345

arp

boolean

Новый способ обработки виртуальным адресом запросов ARP.

Возвращается: changed

Пример: true

auto_delete

boolean

Новое значение параметра автоматического удаления виртуального адреса.

Возвращается: changed

Пример: true

availability_calculation

string

Указывает, какие маршруты виртуального адреса объявляет система.

Возвращается: changed

Пример: "always"

connection_limit

integer

Новое ограничение количества подключений для виртуального адреса.

Возвращается: changed

Пример: 1000

icmp_echo

string

Новое значение параметра эхо-запросов ICMP, примененное к виртуальному адресу.

Возвращается: changed

Пример: "disabled"

netmask

integer

Маска подсети виртуального адреса.

Возвращается: created

Пример: 2345

spanning

string

Включен ли режим Spanning.

Возвращается: changed

Пример: "disabled"

state

string

Новое состояние виртуального адреса.

Возвращается: changed

Пример: "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_virtual_address_module.html

Spec-Zone.ru

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