f5networks.f5_modules.bigip_monitor_ftp – Управление мониторами FTP на BIG-IP
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач укажите: f5networks.f5_modules.bigip_monitor_ftp.
Добавлено в версии 1.1.0: модуля f5networks.f5_modules
Обзор
- Управление мониторами FTP на устройстве BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| app_service строка | Служба iApp, которая будет связана с этим профилем. Если служба не указана, значение по умолчанию — None. | ||
| debug логический тип |
| Определяет, отправляет ли монитор сообщения об ошибках и дополнительную информацию в лог-файл, созданный и обозначенный специально для этого монитора. Когда yes, система перенаправляет сообщения об ошибках и дополнительную информацию в файл /var/log/monitors/<monitor_name>-<node_name>-<port>.log. | |
| description строка | Описание монитора. | ||
| filename строка | Указывает полный путь и имя файла, который система пытается загрузить. Проверка работоспособности считается успешной, если система может загрузить файл. | ||
| interval целое число | Интервал, определяющий частоту выполнения экземпляра монитора этого шаблона. Это значение должно быть меньше значения timeout. При создании нового монитора, если этот параметр не указан, будет использовано значение по умолчанию 5. | ||
| ip строка | Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — «*». | ||
| manual_resume логический тип |
| Определяет, автоматически ли система изменяет состояние ресурса на enabled при следующей успешной проверке монитора. Если вы установите этот параметр в yes, вам необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки.При создании нового монитора, если этот параметр не указан, значение по умолчанию — no. Когда yes, указывает, что необходимо вручную повторно включить ресурс после неудачной проверки монитора.Когда no, указывает, что система автоматически меняет статус ресурса на enabled при следующей успешной проверке монитора. | |
| mode строка |
| Определяет режим процесса передачи данных (DTP). Когда passive, монитор отправляет запрос на передачу данных на сервер FTP. Когда сервер FTP получает запрос, сервер FTP инициирует и устанавливает соединение для передачи данных.Когда port, монитор инициирует и устанавливает соединение для передачи данных с сервером FTP. | |
| name строка / обязательно | Указывает имя монитора. | ||
| parent строка | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. При создании нового монитора, если этот параметр не указан, значение по умолчанию — системный монитор ftp. | ||
| partition строка | Значение по умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| port строка | Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — «*». Если вы указываете IP-адрес, вы должны использовать значение от 1 до 65535. | ||
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные соединения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логический тип |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете опустить этот параметр, установив переменную среды F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логический тип |
| Если no, сертификаты SSL не будут проверяться. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| state строка |
| Когда present, гарантирует существование монитора.Когда absent, гарантирует удаление монитора. | |
| target_password строка | Указывает пароль, если мониторируемый объект требует аутентификации. | ||
| target_username строка | Указывает имя пользователя, если мониторируемый объект требует аутентификации. | ||
| time_until_up целое число | Указывает количество времени в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения от него валидного ответа.Если этот параметр не указан при создании нового монитора, то значение по умолчанию будет 0. | ||
| timeout целое число | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение установленного периода времени, он считается активным. Если целевой объект не отвечает в течение установленного периода времени, он считается неактивным. Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 31. | ||
| up_interval целое число | Указывает интервал, через который система выполняет проверку работоспособности, когда ресурс активен. Когда 0, указывает, что система использует интервал, указанный в interval, для проверки работоспособности ресурса.При любом другом значении вы можете указать другой интервал для проверки работоспособности активного ресурса. При создании нового монитора, если этот параметр не указан, значение по умолчанию — 0. | ||
| update_password строка |
| always обновит пароли, если target_password указан.on_create будет устанавливать пароль только для вновь созданных мониторов. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 обрабатывают только текущую конфигурацию продукта F5. Для сохранения конфигурации BIG-IP на диске, убедитесь, что включён хотя бы один task, использующий модуль f5networks.f5_modules.bigip_config, для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля, позволяющего сохранить текущую конфигурацию.
Примеры
- name: Create FTP Monitor
bigip_monitor_ftp:
state: present
ip: 10.10.10.10
name: my_ft_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove FTP Monitor
bigip_monitor_ftp:
state: absent
name: my_ftp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Include a username and password in the FTP monitor
bigip_monitor_ftp:
state: absent
name: my_ftp_monitor
target_username: monitor_user
target_password: monitor_pass
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, ниже представлены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| app_service строка | changed | Служба iApp, связанная с данным монитором. Пример: /Common/good_service.app/good_service |
| debug логическое | changed | Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для данного монитора. |
| description строка | changed | Описание монитора. Пример: Важный монитор |
| filename строка | changed | Указывает полный путь и имя файла, который система пытается загрузить. Пример: /ftp/var/health.txt |
| interval целое число | changed | Новый интервал для выполнения проверки монитора. Пример: 2 |
| ip строка | changed | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| manual_resume логическое | changed | Указывает, автоматически ли система изменяет статус ресурса на «включено» при следующей успешной проверке монитором. Пример: True |
| mode строка | changed | Указывает режим процесса передачи данных (DTP). Пример: passive |
| parent строка | changed | Родительский монитор. Пример: /Common/foo_ftp |
| port строка | changed | Псевдоним порта или службы для проверки монитором от имени пулов или членов пулов, с которыми связан монитор. Пример: 80 |
| time_until_up целое число | changed | Новое время, в течение которого система будет отмечать систему как «включенную» после первого успешного ответа. Пример: 2 |
| timeout целое число | changed | Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора. Пример: 10 |
| up_interval целое число | changed | Интервал, который система использует для выполнения проверки работоспособности, когда ресурс включен. |
Авторы
- 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_monitor_ftp_module.html
