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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
active_bonus целое число			Указывает дополнительное значение, которое будет добавлено к оценке HA активного устройства. При создании группы HA системой, это значение устанавливается системой в `10`.
description строка			Описание группы HA, созданной пользователем.
enable логическое		Варианты: нет да ←	При установке значения `no`, система отключает функцию оценки HA.
name строка / обязательно			Имя группы HA для создания/управления.
password строка / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
pools список			Указывает пулы, которые будут вносить вклад в оценку HA. Пулы должны существовать на BIG-IP, в противном случае операция завершится ошибкой.
	attribute строка	Варианты: percent-up-members ←	Атрибут пула, который вносит вклад в оценку HA.
	minimum_threshold целое число		Ниже этого значения выбранный атрибут пула не вносит вклад в оценку HA. Это значение должно быть больше количества членов пула в пуле. В версиях TMOS 12.x этот атрибут называется `threshold`, однако он был устаревшим в версиях 13.x и выше. Указание этого атрибута в модуле, работающем с v12.x, сохранит такое же поведение, как если бы был установлен параметр `threshold`.
	partition строка	Значение по умолчанию: "Общие"	Раздел устройства, в котором существует указанный пул. Этот параметр игнорируется, если `pool_name` указан в полном формате пути.
	pool_name строка / обязательно		Имя пула, используемого для внесения вклада в оценку HA. Ссылка на пул может быть указана в полном формате пути, например, `/Common/pool_name`. Если пул указан в полном формате пути, то параметр `partition` игнорируется.
	weight целое число / обязательно		Максимальное значение, которое выбранный атрибут пула вносит в оценку HA.
provider словарь добавлен в 2.5			Объект словаря, содержащий данные о подключении.
	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 целое число	Значение по умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs логическое	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число добавлен в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
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.
user строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.

validate_certs

boolean

added in 2.0

Choices:

no
yes ←

If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.

You may omit this option by setting the environment variable F5_VALIDATE_CERTS.

Примечания

Примечание

Этот модуль не поддерживает атомарное удаление объектов группы 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 boolean		изменено	Включает или выключает функцию оценки 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.8/modules/bigip_device_ha_group_module.html