Модуль f5networks.f5_modules.bigip_gtm_pool — управление пулами F5 BIG-IP GTM
Примечание
Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_gtm_pool.
Добавлено в f5networks.f5_modules 1.0.0
Краткое описание
- Управляет пулами F5 BIG-IP GTM (ныне BIG-IP DNS).
Параметры
Параметр | Описание |
|---|---|
alternate_lb_method string | Режим балансировки нагрузки, который система использует, если Варианты:
|
availability_requirements dictionary | Если активировано несколько мониторов работоспособности, указывает количество мониторов, которые должны получить успешные ответы, чтобы канал считался доступным. |
|
at_least integer |
Указывает минимальное количество активных мониторов работоспособности, которые должны успешно пройти проверку, чтобы канал считался работающим. Этот параметр имеет значение только при использовании Этот параметр игнорируется, если используется тип |
|
number_of_probers integer |
Указывает количество проберов, используемых при выполнении проверок. При создании нового виртуального сервера, если указан этот параметр, необходимо также указать параметр Значение этого параметра всегда должно быть больше или равно значению Этот параметр имеет значение только при использовании Этот параметр игнорируется, если используется тип |
|
number_of_probes integer |
Указывает минимальное количество успешных проверок, необходимых для признания этого сервера работающим. При создании нового виртуального сервера, если указан этот параметр, необходимо также указать параметр Значение этого параметра всегда должно быть меньше или равно значению Этот параметр имеет значение только при использовании Этот параметр игнорируется, если используется тип |
|
type string / обязательный |
Тип правила мониторинга, если указан При создании нового пула, если это значение не указано, будет использоваться значение по умолчанию «all». Варианты:
|
fallback_ip string | Указывает адрес IPv4 или IPv6 сервера, на который система перенаправляет запросы, если не может использовать для этого один из своих пулов. Обратите внимание: система использует резервный IP-адрес только при выборе метода балансировки нагрузки |
fallback_lb_method string | Режим балансировки нагрузки, который система использует, если ни Варианты:
|
max_answers_returned integer | Указывает максимальное количество доступных виртуальных серверов, перечисляемых системой в ответе. Максимальное значение — 500. |
members list / элементы=dictionary | Участники, добавляемые в пул. Порядок участников в этом списке определяет порядок их отображения в пуле. |
|
server string / обязательный |
Имя сервера, частью которого является участник пула. |
|
virtual_server string / обязательный |
Имя виртуального сервера, связанного с сервером, частью которого является участник пула. |
monitors list / элементы=string | Указывает мониторы работоспособности, которые система в данный момент использует для контроля этого ресурса. Если |
name string / обязательный | Имя пула GTM. |
partition string | Раздел устройства, в котором будут управляться ресурсы. По умолчанию: |
preferred_lb_method string | Режим балансировки нагрузки, который система пробует первым. Варианты:
|
provider dictionary добавлено в f5networks.f5_modules 1.0.0 | Объект dict, содержащий сведения для подключения. |
|
auth_provider string |
Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ. |
|
no_f5_teem boolean |
Если Этот параметр можно не указывать, задав переменную окружения Ранее использовавшаяся переменная Варианты:
|
|
password псевдонимы: pass, pwd string / обязательный |
Пароль учётной записи, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения |
|
server string / обязательный |
Хост BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения |
|
server_port integer |
Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения По умолчанию: |
|
timeout integer |
Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке команд. Если время ожидания истекает до завершения операции, модуль выдаёт ошибку. |
|
transport string |
Настраивает транспортное соединение, используемое для подключения к удалённому устройству. Варианты:
|
|
user string / обязательный |
Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения |
|
validate_certs boolean |
Если Этот параметр можно не указывать, задав переменную окружения Варианты:
|
state string | Состояние пула. Если указано Варианты:
|
ttl integer | Указывает, в течение скольких секунд найденный IP-адрес остаётся действительным. |
type string / обязательный | Тип создаваемого пула GTM. Варианты:
|
Примечания
Примечание
- Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диске, обязательно добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в документации к нему.
Примеры
- name: Create a GTM pool
bigip_gtm_pool:
name: my_pool
type: a
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Disable pool
bigip_gtm_pool:
state: disabled
name: my_pool
type: a
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
alternate_lb_method string | Новый альтернативный метод балансировки нагрузки для пула. Возвращается: при изменении Пример: |
fallback_ip string | Новый резервный IP-адрес, используемый при балансировке нагрузки методом Возвращается: при изменении Пример: |
fallback_lb_method string | Новый резервный метод балансировки нагрузки для пула. Возвращается: при изменении Пример: |
max_answers_returned integer | Новое значение параметра «Максимальное количество возвращаемых ответов». Возвращается: при изменении Пример: |
members complex | Список участников пула. Возвращается: при изменении |
|
server string |
Имя сервера, указанного в участнике. Возвращается: при изменении |
|
virtual_server string |
Имя виртуального сервера, указанного в участнике. Возвращается: при изменении |
monitors list / элементы=string | Новый список мониторов ресурса. Возвращается: при изменении Пример: |
preferred_lb_method string | Новый предпочтительный метод балансировки нагрузки для пула. Возвращается: при изменении Пример: |
Ссылки на коллекцию
© 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_gtm_pool_module.html