f5networks.f5_modules.bigip_device_ha_group модуль — Управление настройками группы HA на системе 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_ha_group.

Новая функция в f5networks.f5_modules 1.0.0

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

Описание

Управление настройками группы HA (высокой доступности) на системе BIG-IP.

Параметры

Параметр	Комментарии
active_bonus целое число	Указывает дополнительное значение, которое будет добавлено к баллу HA активного устройства. При создании группировки HA система устанавливает это значение в `10`.
description строка	Описание группы HA, созданное пользователем.
enable логическое значение	Если установлено значение `false`, система отключает функцию оценки HA. Варианты: `false` `true` ← (по умолчанию)
name строка / обязательное	Имя группы HA для создания/управления.
pools список / элементы=словарь	Указывает пулы, которые вносят вклад в балл HA. Пулы должны существовать на BIG-IP, в противном случае операция завершится ошибкой.
attribute строка	Атрибут пула, который вносит вклад в балл HA. Варианты: `"percent-up-members"` ← (по умолчанию)
minimum_threshold целое число	При значении ниже этого порога, выбранный атрибут пула не вносит вклад в балл HA. Это значение должно быть больше количества членов пула, присутствующих в пуле. В версиях TMOS 12.x этот атрибут называется `threshold`, но он устарел в версиях 13.x и выше. Указание этого атрибута в модуле, работающем с v12.x, сохранит такое же поведение, как если бы был установлен параметр `threshold`.
partition строка	Раздел устройства, где существует указанный пул. Этот параметр игнорируется, если `pool_name` указан в полном формате пути. По умолчанию: `"Common"`
pool_name строка / обязательное	Имя пула, используемого для вклада в балл HA. Ссылка на пул может быть выполнена в полном формате пути, например, `/Common/pool_name`. Если пул указан в полном формате пути, параметр `partition` игнорируется.
weight целое число / обязательное	Максимальное значение, вносимое выбранным атрибутом пула в балл HA.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект типа dict, содержащий данные подключения.
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"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с использованием собственных сертификатов. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
state string	Когда `present`, гарантирует, что ресурс существует. Когда `absent`, гарантирует удаление ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`
trunks список / элементы=словарь	Указывает каналы, которые вносят вклад в оценку HA. Каналы должны существовать на BIG-IP, иначе операция завершится неудачей.
attribute строка	Атрибут канала, который вносит вклад в оценку HA. Варианты: `"percent-up-members"` ← (по умолчанию)
minimum_threshold целое число	Ниже этого значения выбранный атрибут канала не вносит вклад в оценку HA. Это значение должно быть больше числа членов канала. В версиях TMOS 12.x этот атрибут называется `threshold`, однако он устарел в версиях 13.x и выше. Указание этого атрибута в модуле, работающем с v12.x, сохранит такое же поведение, как если бы был установлен параметр `threshold`.
trunk_name строка / обязательно	Имя канала, используемое для внесения вклада в оценку HA.
weight целое число / обязательно	Максимальное значение, которое выбранный атрибут канала вносит в оценку HA.

Примечания

Примечание

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

Примеры

- name: Create HA group no members, not active
  bigip_device_ha_group:
    name: foo_ha
    description: empty_foo
    active_bonus: 20
    enable: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create HA group with pools and trunks
  bigip_device_ha_group:
    name: baz_ha
    description: non_empty_baz
    active_bonus: 15
    pools:
      - pool_name: foopool
        weight: 30
        minimum_threshold: 1
    trunks:
      - trunk_name: footrunk
        weight: 70
        minimum_threshold: 2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create HA group pools using full_path format
  bigip_device_ha_group:
    name: bar_ha
    description: non_empty_bar
    active_bonus: 12
    pools:
      - pool_name: /Baz/foopool
        weight: 30
        minimum_threshold: 1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove HA group
  bigip_device_ha_group:
    name: foo_ha
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
active_bonus целое число	Дополнительное значение, которое будет добавлено к баллу HA активного устройства. Возвращаемое значение: изменённое Пример: `20`
description строка	Описание группы HA, созданное пользователем. Возвращаемое значение: изменённое Пример: `"Some Group"`
enable булево	Включает или отключает функцию оценки HA. Возвращаемое значение: изменённое Пример: `true`
name строка	Имя группы HA. Возвращаемое значение: изменённое Пример: `"foo_HA"`
pools сложное	Бассейны, которые вносят вклад в оценку HA. Возвращаемое значение: изменённое Пример: `"hash/dictionary of values"`
attribute строка	Атрибут пула, который вносит вклад в оценку HA. Возвращаемое значение: изменённое Пример: `"percent-up-members"`
minimum_threshold целое число	При значении ниже этого порога выбранный атрибут пула не вносит вклад в оценку HA. Возвращаемое значение: изменённое Пример: `2`
partition строка	Раздел устройства, где существует указанный пул. Возвращаемое значение: изменённое Пример: `"Common"`
pool_name строка	Имя пула, используемое для вклада в оценку HA. Возвращаемое значение: изменённое Пример: `"foo_pool"`
weight целое число	Максимальное значение, которое выбранный атрибут пула вносит в оценку HA. Возвращаемое значение: изменённое Пример: `40`
trunks сложное	Каналы, которые вносят вклад в оценку HA. Возвращаемое значение: изменённое Пример: `"hash/dictionary of values"`
attribute строка	Атрибут канала, который вносит вклад в оценку HA. Возвращаемое значение: изменённое Пример: `"percent-up-members"`
minimum_threshold целое число	При значении ниже этого порога, выбранный атрибут канала не вносит вклад в оценку HA. Возвращаемое значение: изменённое Пример: `2`
trunk_name строка	Имя канала, используемое для вклада в оценку HA. Возвращаемое значение: изменённое Пример: `"foo_trunk"`
weight целое число	Максимальное значение, которое выбранный атрибут канала вносит в оценку HA. Возвращаемое значение: изменённое Пример: `40`

Авторы

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