Модуль f5networks.f5_modules.bigip_device_traffic_group — Управление группами трафика на 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_device_traffic_group.

Новое в f5networks.f5_modules 1.0.0

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

Описание

Поддерживает управление группами трафика и их атрибутами на BIG-IP.

Параметры

Параметр	Комментарии
auto_failback boolean	Указывает, возвращается ли группа трафика к первоначальному устройству, указанному в `ha_order`. Варианты: `false` `true`
auto_failback_time integer	Указывает количество секунд, в течение которого система ожидает, прежде чем вернуть группу трафика к первоначальному устройству, указанному в `ha_order`. Допустимый диапазон значений: `0 - 300`.
ha_group string	Указывает настроенную `HA group`, которая должна быть связана с группой трафика. После создания группы HA на устройстве и привязки группы HA к группе трафика необходимо создать группу HA и привязать ее к той же группе трафика на каждом устройстве в группе устройств. Чтобы отключить метод резервного копирования группы HA, укажите пустое строковое значение (`""`) для этого параметра. Отключение группы HA вернет устройство к использованию метода `Load Aware` (по умолчанию), если не настроен параметр `ha_order`. `auto_failback` и `auto_failback_time` несовместимы с `ha_group`.
ha_load_factor integer	Значение нагрузки, которую группа трафика представляет для системы по отношению к другим группам трафика. Этот параметр действует только при использовании метода резервного копирования `Load Aware`. Допустимый диапазон значений: `1 - 1000`.
ha_order list / elements=string	Указывает порядок назначения устройств для резервного копирования. Если этот параметр настроен, он должен быть настроен для каждой группы трафика в группе устройств. Значения должны быть именами устройств, принадлежащих к группе резервного копирования, настроенной ранее. Порядок расположения устройств в качестве аргументов этого параметра определяет их порядок HA на устройстве. Это означает, что изменение порядка одних и тех же элементов приведет к изменению на устройстве. Чтобы отключить метод резервного копирования HA по порядку, укажите пустое строковое значение (`""`) для этого параметра. Отключение порядка HA вернет устройство к использованию метода Load Aware (по умолчанию), если не настроен параметр `ha_group`. Имена устройств будут предваряться разделом модулем, поэтому вы можете указать либо полное имя в формате `/Common/bigip1`, либо просто строку с именем `bigip1`.
mac_address string	Указывает плавающий адрес управления доступом к среде (MAC) , связанный с плавающими IP-адресами, определенными для группы трафика. В первую очередь, адрес MAC маскировки минимизирует коммуникации ARP или потери пакетов в результате переключения. Адрес MAC маскировки гарантирует, что любой трафик, предназначенный для определенной группы трафика, достигнет доступного устройства после переключения, что происходит потому, что вместе с группой трафика адрес MAC маскировки переходит на доступное устройство. Без адреса MAC маскировки отправителю необходимо узнать MAC-адрес нового активного устройства, либо отправив запрос ARP, либо полагаясь на бесплатный ARP от нового активного устройства. Чтобы сбросить MAC-адрес, укажите пустое значение (`""`) для этого параметра.
name string / обязательно	Имя группы трафика.
partition string	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
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	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истек до завершения операции, модуль выдаст ошибку.

END_OF_DOCUMENT_MARKER

transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, управляемых вами, которые используют самозаверенные сертификаты. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
state string	Если `present`, гарантирует существование группы трафика. Если `absent`, гарантирует удаление группы трафика. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

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

Примеры

- name: Create a traffic group
  bigip_device_traffic_group:
    name: foo1
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create a traffic group with ha_group failover
  bigip_device_traffic_group:
    name: foo2
    state: present
    ha_group: foo_HA_grp
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create a traffic group with ha_order failover
  bigip_device_traffic_group:
    name: foo3
    state: present
    ha_order:
      - /Common/bigip1.lab.local
      - /Common/bigip2.lab.local
    auto_failback: true
    auto_failback_time: 40
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Change traffic group ha_order to ha_group
  bigip_device_traffic_group:
    name: foo3
    state: present
    ha_group: foo_HA_grp
    ha_order: ""
    auto_failback: false
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove traffic group
  bigip_device_traffic_group:
    name: foo
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ	Описание
auto_failback boolean	Указывает, возвращается ли группа трафика к первоначальному устройству, указанному в ha_order. Возвращаемое значение: changed Пример: `true`
auto_failback_time integer	Указывает количество секунд, в течение которых система ожидает перед возвратом. Возвращаемое значение: changed Пример: `60`
ha_group string	Настроенная группа HA, связанная с группой трафика. Возвращаемое значение: changed Пример: `"foo_HA_grp"`
ha_load_factor integer	Значение нагрузки, которую группа трафика представляет для системы относительно других групп трафика. Возвращаемое значение: changed Пример: `20`
ha_order list / элементы=строка	Указывает порядок, в котором устройства будут переключаться. Возвращаемое значение: changed Пример: `["/Common/bigip1", "/Common/bigip2"]`
mac_address string	Адрес MAC маскирования Возвращаемое значение: changed Пример: `"02:01:d7:93:35:08"`

Авторы

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_device_traffic_group_module.html