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

Новая версия 2.8.

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
active_bonus целое число			Указывает дополнительное значение, которое будет добавлено к баллу HA активного устройства. При создании группы HA система устанавливает это значение в `10`.
description строка			Описание группы HA, созданной пользователем.
enable логическое значение		Варианты: no yes ←	При установке в `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 словарь добавлен в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	password строка / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортных протоколов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернет ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `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 на диске убедитесь, что вы включили по крайней мере одну задачу, использующую модуль 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

Состояние

Не гарантируется обратная совместимость данного модуля. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицирован]

Авторы

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.9/modules/bigip_device_ha_group_module.html