Модуль f5networks.f5_modules.bigip_device_ha_group — Управление параметрами группы HA в системе BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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 integer	Указывает дополнительное значение, которое добавляется к оценке HA активного устройства. При создании системой группы HA это значение устанавливается в `10`.
description string	Описание группы HA, заданное пользователем.
enable boolean	Если задано значение `false`, система отключает функцию оценки HA. Варианты: `false` `true` ← (по умолчанию)
name string / обязательный	Имя создаваемой или управляемой группы HA.
pools list / элементы=dictionary	Указывает пулы, учитываемые при расчёте оценки HA. Пулы должны существовать на BIG-IP, иначе операция завершится ошибкой.
attribute string	Атрибут пула, учитываемый при расчёте оценки HA. Варианты: `"percent-up-members"` ← (по умолчанию)
minimum_threshold integer	Если значение ниже этого порога, выбранный атрибут пула не учитывается при расчёте оценки HA. Это значение должно быть больше количества участников пула. В версиях TMOS 12.x этот атрибут называется `threshold`, однако в версиях 13.x и выше он объявлен устаревшим. При указании этого атрибута в модуле, выполняемом для v12.x, сохраняется такое же поведение, как при установке параметра `threshold`.
partition string	Раздел устройства, в котором существует указанный пул. Этот параметр игнорируется, если `pool_name` задан в формате полного пути. По умолчанию: `"Common"`
pool_name string / обязательный	Имя пула, учитываемого при расчёте оценки HA. Пул можно указать в формате полного пути, например `/Common/pool_name`. Если пул указан в формате полного пути, параметр `partition` игнорируется.
weight integer / обязательный	Максимальное значение, которое выбранный атрибут пула может добавить к оценке HA.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с данными для подключения.
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	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечёт до завершения операции, модуль сообщит об ошибке.
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"`
trunks list / элементы=dictionary	Указывает транки, учитываемые при расчёте оценки HA. Транки должны существовать на BIG-IP, иначе операция завершится ошибкой.
attribute string	Атрибут транка, учитываемый при расчёте оценки HA. Варианты: `"percent-up-members"` ← (по умолчанию)
minimum_threshold integer	Если значение ниже этого порога, выбранный атрибут транка не учитывается при расчёте оценки HA. Это значение должно быть больше количества участников транка. В версиях TMOS 12.x этот атрибут называется `threshold`, однако в версиях 13.x и выше он объявлен устаревшим. При указании этого атрибута в модуле, выполняемом для v12.x, сохраняется такое же поведение, как при установке параметра `threshold`.
trunk_name string / обязательный	Имя транка, учитываемого при расчёте оценки HA.
weight integer / обязательный	Максимальное значение, которое выбранный атрибут транка может добавить к оценке 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 integer	Дополнительное значение, которое добавляется к оценке HA активного устройства. Возвращается: changed Пример: `20`
description string	Описание группы HA, заданное пользователем. Возвращается: changed Пример: `"Some Group"`
enable boolean	Включает или отключает функцию оценки HA. Возвращается: changed Пример: `true`
name string	Имя группы HA. Возвращается: changed Пример: `"foo_HA"`
pools complex	Пулы, учитываемые при расчёте оценки HA. Возвращается: changed Пример: `"hash/dictionary of values"`
attribute string	Атрибут пула, учитываемый при расчёте оценки HA. Возвращается: changed Пример: `"percent-up-members"`
minimum_threshold integer	Если значение ниже этого порога, выбранный атрибут пула не учитывается при расчёте оценки HA. Возвращается: changed Пример: `2`
partition string	Раздел устройства, в котором существует указанный пул. Возвращается: changed Пример: `"Common"`
pool_name string	Имя пула, учитываемого при расчёте оценки HA. Возвращается: changed Пример: `"foo_pool"`
weight integer	Максимальное значение, которое выбранный атрибут пула может добавить к оценке HA. Возвращается: changed Пример: `40`
trunks complex	Транки, учитываемые при расчёте оценки HA. Возвращается: changed Пример: `"hash/dictionary of values"`
attribute string	Атрибут транка, учитываемый при расчёте оценки HA. Возвращается: changed Пример: `"percent-up-members"`
minimum_threshold integer	Если значение ниже этого порога, выбранный атрибут транка не учитывается при расчёте оценки HA. Возвращается: changed Пример: `2`
trunk_name string	Имя транка, учитываемого при расчёте оценки HA. Возвращается: changed Пример: `"foo_trunk"`
weight integer	Максимальное значение, которое выбранный атрибут транка может добавить к оценке HA. Возвращается: changed Пример: `40`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_device_ha_group_module.html