bigip_gtm_monitor_firepass – Управляет мониторами F5 BIG-IP GTM FirePass
Новое в версии 2.6.
Краткое описание
- Управляет мониторами F5 BIG-IP GTM FirePass.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| cipher_list - | Указывает список шифров для этого монитора. Элементы в списке шифров разделяются символом двоеточие :. При создании нового монитора, если этот параметр не указан, используется список по умолчанию HIGH:!ADH. | ||
| concurrency_limit - | Указывает максимальный процент лицензированных подключений, используемых в настоящий момент, при котором монитор отмечает систему Secure Access Manager как активную. Например, значение 95 процентов означает, что монитор отмечает систему Secure Access Manager как активную до тех пор, пока не будет использовано 95 процентов лицензированных подключений. Когда количество используемых лицензированных подключений превышает 95 процентов, монитор отмечает систему Secure Access Manager как неактивную. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию 95. | ||
| ignore_down_response boolean |
| Указывает, что монитор позволяет более одной попытки запроса за интервал. Если yes, указывает, что монитор игнорирует ответы о неактивности в течение времени таймаута монитора. После истечения времени таймаута монитора без получения ответа об активности система отмечает объект как неактивный.Если no, указывает, что монитор сразу отмечает объект как неактивный при получении ответа о неактивности.При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| interval - | Интервал, указывающий, насколько часто будет выполняться экземпляр монитора данной шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения timeout. | ||
| ip - | Часть IP-адреса определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение является IP-адресом, то должно быть указано значение port. | ||
| max_load_average - | Указывает число, которое монитор использует для обозначения системы Secure Access Manager как активной или неактивной. Система сравнивает значение Max Load Average с усреднённой за одну минуту нагрузкой системы Secure Access Manager. Когда средняя нагрузка системы Secure Access Manager находится в пределах указанного Max Load Average, монитор отмечает систему Secure Access Manager как активную. Когда среднее значение превышает заданное значение, монитор отмечает систему как неактивную. При создании нового монитора, если этот параметр не указан, значение по умолчанию — 12. | ||
| name - / обязательно | Имя монитора. | ||
| parent - | По умолчанию: "/Common/firepass_gtm" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский шаблон tcp на разбиении Common. | |
| partition - | По умолчанию: "Common" | Разбиение устройства для управления ресурсами. | |
| password - / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| port - | Адрес порта в определении IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если вы указываете IP-адрес, должно быть указано значение от 1 до 65535. | ||
| probe_timeout - | Указывает количество секунд, после которых система отменяет запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию — 5. | ||
| provider - добавлено в 2.5 | По умолчанию: null | Объект типа dict, содержащий данные подключения. | |
| 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 - / обязательно |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах, использующих самозаверенные сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port - добавлено в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state - |
| Если present, гарантирует, что монитор существует.Если absent, гарантирует удаление монитора. | |
| target_password - | Указывает пароль, если контролируемый объект требует аутентификации. | ||
| target_username - | Указывает имя пользователя, если контролируемый объект требует аутентификации. | ||
| timeout - | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое нужное вам число, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 90. | ||
| update_password - |
| always будет обновлять пароли, если target_password указан.on_create будет устанавливать пароль только для вновь созданных мониторов. | |
| user - / required | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs boolean added in 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах, контролируемых лично, использующих самозаверяющие сертификаты.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 манипулируют только активной конфигурацией продукта F5. Чтобы гарантировать, что конфигурация BIG-IP сохранится на диске, убедитесь, что включён хотя бы один task, использующий модуль bigip_config для сохранения активной конфигурации. Обратитесь к документации модуля за правильным использованием модуля для сохранения активной конфигурации.
Примеры
- name: Create a GTM FirePass monitor
bigip_gtm_monitor_firepass:
name: my_monitor
ip: 1.1.1.1
port: 80
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Remove FirePass Monitor
bigip_gtm_monitor_firepass:
name: my_monitor
state: absent
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add FirePass monitor for all addresses, port 514
bigip_gtm_monitor_firepass:
name: my_monitor
server: lb.mydomain.com
user: admin
port: 514
password: secret
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cipher_list строка | изменено | Новое значение для списка шифров. Пример: +3DES:+kEDH |
| concurrency_limit целое число | изменено | Новое значение для лимита одновременности. Пример: 95 |
| ignore_down_response логическое значение | изменено | Игнорировать ли ответ о недоступности? Пример: True |
| interval целое число | изменено | Новый интервал для выполнения проверки монитора. Пример: 2 |
| ip строка | изменено | Новый IP-адрес для определения IP/порт. Пример: 10.12.13.14 |
| max_load_average целое число | изменено | Новое значение для максимальной средней нагрузки. Пример: 12 |
| parent строка | изменено | Новая родительская шаблон монитора. Пример: firepass_gtm |
| port строка | изменено | Новый порт, на котором монитор проверяет ресурс. Пример: 8080 |
| probe_timeout целое число | изменено | Новый таймаут, в течение которого система будет приостанавливать запрос монитора. Пример: 10 |
| timeout целое число | изменено | Новый таймаут, в течение которого удалённая система должна ответить на монитор. Пример: 10 |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_gtm_monitor_firepass_module.html
