f5networks.f5_modules.bigip_monitor_ftp – Управление мониторами FTP на BIG-IP
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач, укажите: f5networks.f5_modules.bigip_monitor_ftp.
Новое в версии 1.1.0: of 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-сервер получает запрос, он инициирует и устанавливает соединение данных.Когда port, монитор инициирует и устанавливает соединение данных с FTP-сервером. | |
| name строка / обязательно | Указывает имя монитора. | ||
| parent строка | Родительский шаблон данного шаблона монитора. После установки этого значения его нельзя изменить. При создании нового монитора, если этот параметр не указан, используется системный монитор ftp. | ||
| partition строка | Значение по умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| port строка | Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. Если вы указываете IP-адрес, вам нужно использовать значение от 1 до 65535. | ||
| provider словарь добавлен в 1.0.0 of 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, сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль 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 строка | изменено | Сервис iApp, связанный с этим монитором. Пример: /Common/good_service.app/good_service |
| debug логическое значение | изменено | Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. |
| description строка | изменено | Описание монитора. Пример: Важный монитор |
| filename строка | изменено | Указывает полный путь и имя файла, который система пытается загрузить. Пример: /ftp/var/health.txt |
| interval целое число | изменено | Новый интервал, с которым нужно выполнять проверку монитора. Пример: 2 |
| ip строка | изменено | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| manual_resume логическое значение | изменено | Указывает, автоматически ли система изменяет статус ресурса на «включен» при следующей успешной проверке монитора. Пример: True |
| mode строка | изменено | Указывает режим процесса передачи данных (DTP). Пример: пассивный |
| parent строка | изменено | Родительский монитор. Пример: /Common/foo_ftp |
| port строка | изменено | Псевдоним порта или сервиса для проверки монитором от имени пулов или членов пулов, с которыми ассоциирован монитор. Пример: 80 |
| time_until_up целое число | изменено | Новое время, в течение которого система отмечает систему как «включенную» после первого успешного ответа. Пример: 2 |
| timeout целое число | изменено | Новый тайм-аут, в течение которого удаленная система должна ответить монитору. Пример: 10 |
| up_interval целое число | изменено | Интервал, который система использует для выполнения проверки работоспособности, когда ресурс включен. |
Авторы
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_monitor_ftp_module.html
