f5networks.f5_modules.bigip_device_ha_group – Управление настройками группы HA на системе BIG-IP

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_device_ha_group.

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
active_bonus целое число			Указывает дополнительное значение, которое добавляется к баллу HA активного устройства. При создании группы HA система устанавливает это значение по умолчанию в `10`.
description строка			Описание группы HA, созданное пользователем.
enable булево		Варианты: no да ←	При установке в `no`, система отключает функцию подсчета балла HA.
name строка / обязательный			Имя группы HA для создания/управления.
pools список / элементы=словарь			Указывает пулы, которые вносят вклад в балл HA. Пулы должны существовать на BIG-IP, иначе операция завершится ошибкой.
	attribute строка	Варианты: percent-up-members ←	Атрибут пула, который вносит вклад в балл HA.
	minimum_threshold целое число		Ниже этого значения выбранный атрибут пула не вносит вклад в балл HA. Это значение должно быть больше количества членов пула. В TMOS версии 12.x этот атрибут называется `threshold`, однако он устарел в версиях 13.x и выше. Указание этого атрибута в модуле, работающем с v12.x, сохранит то же поведение, как если бы был установлен параметр `threshold`.
	partition строка	Значение по умолчанию: "Common"	Раздел устройства, где существует указанный пул. Этот параметр игнорируется, если `pool_name` указан в полном формате пути.
	pool_name строка / обязательный		Имя пула, используемого для внесения вклада в балл HA. Ссылка на пул может быть выполнена в полном формате пути, например `/Common/pool_name`. Когда пул ссылается в полном формате пути, параметр `partition` игнорируется.
	weight целое число / обязательный		Максимальное значение, которое выбранный атрибут пула вносит в балл HA.
provider словарь добавлен в 1.0.0 модуля f5networks.f5_modules			Объект словаря, содержащий данные соединения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются на F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password строка / обязательный		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательный		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательный		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует существование ресурса. Когда `absent`, гарантирует удаление ресурса.
trunks список / элементы=словарь			Указывает туннели, которые вносят вклад в балл HA. Туннели должны существовать на BIG-IP, иначе операция завершится ошибкой.
	attribute строка	Варианты: percent-up-members ←	Атрибут туннеля, который вносит вклад в балл HA.
	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: no
    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, созданное пользователем. Пример: Некоторая Группа
enable булево		изменённое	Включает или отключает функцию подсчёта баллов HA. Пример: True
name строка		изменённое	Имя группы HA. Пример: foo_HA
pools сложный		изменённое	Пулы, которые вносят вклад в балл HA. Пример: хеш/словарь значений
	attribute строка	изменённое	Атрибут пула, который вносит вклад в балл HA. Пример: percent-up-members
	minimum_threshold целое число	изменённое	Ниже этого значения выбранный атрибут пула не вносит вклад в балл HA. Пример: 2
	partition строка	изменённое	Раздел устройства, в котором существует указанный пул. Пример: Common
	pool_name строка	изменённое	Название пула, которое используется для вклада в балл HA. Пример: foo_pool
	weight целое число	изменённое	Максимальное значение, которое выбранный атрибут пула вносит в балл HA. Пример: 40
trunks сложный		изменённое	Штуцеры, которые вносят вклад в балл HA. Пример: хеш/словарь значений
	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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_device_ha_group_module.html