f5networks.f5_modules.bigip_gtm_server – Управляет серверами F5 BIG-IP GTM
Примечание
Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач укажите: f5networks.f5_modules.bigip_gtm_server.
Новое в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Управляет конфигурацией серверов BIG-IP GTM (теперь BIG-IP DNS). Этот модуль способен манипулировать определениями серверов в BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| availability_requirements словарь | Если активировано более одного монитора состояния, указывает количество мониторов состояния, которые должны получить успешные ответы, чтобы ссылка считалась доступной. | ||
| at_least целое число | Указывает минимальное количество активных мониторов состояния, которые должны дать успешный результат, прежде чем ссылка будет считаться активной. Этот параметр имеет значение только при использовании type at_least. Этот параметр будет проигнорирован, если используется тип all или require. | ||
| number_of_probers целое число | Указывает количество зондировщиков, которые должны быть использованы при запуске зондирования. При создании нового виртуального сервера, если этот параметр указан, необходимо также указать параметр number_of_probes.Значение этого параметра должно быть всегда больше или равно значению number_of_probers.Этот параметр имеет значение только при использовании type require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| number_of_probes целое число | Указывает минимальное количество проверок, которые должны завершиться успешно, чтобы этот сервер был объявлен активным. При создании нового виртуального сервера, если этот параметр указан, необходимо также указать параметр number_of_probers.Значение этого параметра должно быть всегда меньше или равно значению number_of_probers.Этот параметр имеет значение только при использовании type require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| type строка / обязательно |
| Тип правила мониторинга, когда указан monitors.При создании нового пула, если это значение не указано, по умолчанию будет использоваться all. | |
| datacenter строка | ЦОД, к которому принадлежит сервер. При создании нового сервера GTM это значение обязательно. | ||
| devices сырой | Перечисляет собственные IP-адреса и переводы для каждого устройства. При создании нового сервера GTM это значение обязательно. Этот список — сложный список, который определяет ряд ключей. Ключ name указывает имя устройства. Имя устройства должно быть уникальным для каждого сервера. Этот ключ обязателен.Ключ address содержит IP-адрес или список IP-адресов целевого сервера. Этот ключ обязателен.Ключ translation содержит IP-адрес для перевода значения address выше. Этот ключ необязателен.Указание дублирующих полей name — это поддерживаемый способ предоставления адресов устройств. В этом случае адреса будут назначены в список адресов name. | ||
| iquery_options словарь | Указывает, использует ли Global Traffic Manager этот BIG-IP-систему для проведения различных зондирований перед делегированием трафика на него. | ||
| allow_path булево |
| Указывает, что система проверяет логический маршрут сети между сервером ЦОД и локальным DNS-сервером. | |
| allow_service_check булево |
| Указывает, что система проверяет, работает ли приложение на сервере, дистанционно запуская приложение с помощью внешней программы проверки сервиса. | |
| allow_snmp булево |
| Указывает, что система проверяет производительность сервера, на котором работает SNMP-агент. | |
| limits словарь | Указывает пороговые значения ресурсов или требования к ограничениям на уровне члена пула. Когда включены одно или несколько ограничений, система использует эти данные для включения и выключения членов в сервисе. Можно определить ограничения для любых или всех настроек ограничений. Однако, когда член не соответствует требованию порогового значения ресурса, система помечает члена как недоступный и направляет трафик балансировки нагрузки на другой ресурс. | ||
| bits_enabled булево |
| Включено ли ограничение на биты или нет. Этот параметр позволяет включить или выключить действие ограничения. | |
| bits_limit целое число | Указывает максимальную допустимую скорость пропускной способности данных для члена в битах в секунду. Если объем сетевого трафика превысит это значение, система помечает члена как недоступный. | ||
| connections_enabled булево |
| Включено ли ограничение на текущие соединения или нет. Этот параметр позволяет включить или выключить действие ограничения. | |
| connections_limit целое число | Указывает максимальное количество одновременных соединений, объединенных, для всех членов. Если соединения превысят это значение, система помечает сервер как недоступный. | ||
| cpu_enabled булево |
| Включено ли ограничение на процессор или нет. Этот параметр позволяет включить или выключить действие ограничения. | |
| cpu_limit целое число | Указывает процент использования процессора. Если процент использования процессора превысит лимит, система помечает сервер как недоступный. | ||
| memory_enabled булево |
| Включено ли ограничение на память или нет. Этот параметр позволяет включить или выключить действие ограничения. | |
| memory_limit целое число | Указывает объем доступной памяти, необходимой виртуальным серверам на сервере. Если доступная память опустится ниже этого значения, система помечает сервер как недоступный. | ||
| packets_enabled булево |
| Включено ли ограничение на пакеты или нет. Этот параметр позволяет включить или выключить действие ограничения. | |
| packets_limit целое число | Указывает максимальную допустимую скорость передачи данных для члена в пакетах в секунду. Если объем сетевого трафика превысит это значение, система помечает члена как недоступный. | ||
| link_discovery строка |
| Указывает, автоматически ли система обнаруживает ссылки для данного сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию disabled.Если вы установите этот параметр в значение enabled или enabled-no-delete, вы также должны убедиться, что параметр virtual_server_discovery также установлен в enabled или enabled-no-delete. | |
| monitors список / элементы=строка | Указывает мониторы состояния, которые система в настоящее время использует для мониторинга этого ресурса. Когда availability_requirements.type равно require, в списке monitors может быть только один монитор. | ||
| name строка / обязательно | Имя сервера. | ||
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| prober_fallback строка |
| Указывает тип зондировщика, который используется для мониторинга ресурсов этого сервера, когда предпочтительный зондировщик недоступен. Этот параметр игнорируется в версии TMOS 12.x.Начиная с версии TMOS 13.x, при установке prober_preference в pool, необходимо указать параметр prober_pool.Варианты взаимоисключают параметр prober_preference, за исключением any-available или none. | |
| пробер_пул строка | Указывает имя пула проберов, используемого для мониторинга ресурсов этого сервера. В версии TMOS 13.x и более поздних, этот параметр является обязательным, когда prober_preference установлен в pool. Формат имени может быть префиксным с разделом ( /Common/foo) или указан просто как имя объекта (foo).В версии TMOS 12.x, пробер_пул может быть установлен в пустую строку, чтобы вернуться к значению по умолчанию inherit. | ||
| пробер_предпочтение строка |
| Указывает тип пробера, используемого для мониторинга ресурсов этого сервера. Этот параметр игнорируется в версии TMOS 12.x.С версии TMOS 13.x и выше, когда prober_preference установлен в pool, должен быть указан параметр prober_pool. | |
| провайдер словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные подключения. | ||
| аутентификатор строка | Настраивает провайдера аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| нет_f5_теем булево |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете опустить этот параметр, установив переменную среды F5_TEEM. | |
| пароль строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| сервер строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| порт_сервера целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| таймаут целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | ||
| транспорт строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| валидировать_сертификаты булево |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| тип_сервера строка |
| Указывает тип сервера. Тип сервера определяет метрики, которые система может собирать с сервера. При создании нового сервера GTM используется значение по умолчанию bigip.псевдонимы: продукт | |
| состояние строка |
| Состояние сервера. Если absent, модуль пытается удалить сервер. Это удастся только если этот сервер не используется виртуальным сервером. present создаёт сервер и включает его. Если enabled, включает сервер, если он существует. Если disabled, создаёт сервер при необходимости и устанавливает состояние в disabled. | |
| открытие_виртуального_сервера строка |
| Указывает, автоматически ли система обнаруживает виртуальные серверы для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию disabled. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 манипулируют только активной конфигурацией продукта F5. Для сохранения специфичной для BIG-IP конфигурации на диске, убедитесь, что в задачи включён модуль f5networks.f5_modules.bigip_config для сохранения активной конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения активной конфигурации.
Примеры
- name: Create server "GTM_Server"
bigip_gtm_server:
name: GTM_Server
datacenter: /Common/New York
server_type: bigip
link_discovery: disabled
virtual_server_discovery: disabled
devices:
- name: server_1
address: 1.1.1.1
- name: server_2
address: 2.2.2.1
translation: 192.168.2.1
- name: server_2
address: 2.2.2.2
- name: server_3
addresses:
- address: 3.3.3.1
- address: 3.3.3.2
- name: server_4
addresses:
- address: 4.4.4.1
translation: 192.168.14.1
- address: 4.4.4.2
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Create server "GTM_Server" with expanded keys
bigip_gtm_server:
server: lb.mydomain.com
user: admin
password: secret
name: GTM_Server
datacenter: /Common/New York
server_type: bigip
link_discovery: disabled
virtual_server_discovery: disabled
devices:
- name: server_1
address: 1.1.1.1
- name: server_2
address: 2.2.2.1
translation: 192.168.2.1
- name: server_2
address: 2.2.2.2
- name: server_3
addresses:
- address: 3.3.3.1
- address: 3.3.3.2
- name: server_4
addresses:
- address: 4.4.4.1
translation: 192.168.14.1
- address: 4.4.4.2
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| bits_enabled булево | изменено | Включена ли лимитная настройка битов. Пример: True |
| bits_limit целое число | изменено | Новый предел для битов. Пример: 100 |
| connections_enabled булево | изменено | Включен ли лимит соединений. Пример: True |
| connections_limit целое число | изменено | Новый предел для соединений. Пример: 100 |
| датацентр строка | изменено | Новый datacenter, к которому принадлежит сервер.Пример: datacenter01 |
| открытие_соединения строка | изменено | Новая настройка link_discovery на удалённом устройстве.Пример: включено |
| мониторы список / элементы=строка | изменено | Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2'] |
| packets_enabled булево | изменено | Включен ли лимит пакетов. Пример: True |
| packets_limit целое число | изменено | Новый предел для пакетов. Пример: 100 |
| тип_сервера строка | изменено | Новый тип сервера. Пример: bigip |
| открытие_виртуального_сервера строка | изменено | Новое имя virtual_server_discovery для пункта назначения ловушки.Пример: выключено |
Авторы
- Robert Teller (@r-teller)
- Tim Rupp (@caphrim007)
- 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_gtm_server_module.html
