Модуль f5networks.f5_modules.bigip_monitor_ftp — управление FTP-мониторами на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_monitor_ftp.

Добавлено в f5networks.f5_modules 1.1.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управление FTP-мониторами на устройстве BIG-IP.

Параметры

Параметр	Комментарии
app_service строка	Служба iApp, с которой будет связан этот профиль. Если служба не указана, по умолчанию используется None.
debug логическое значение	Определяет, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Если `true`, система перенаправляет сообщения об ошибках и дополнительную информацию в файл `/var/log/monitors/<monitor_name>-<node_name>-<port>.log`. Варианты: `false` `true`
description строка	Описание монитора.
filename строка	Указывает полный путь и имя файла, который система пытается загрузить. Проверка работоспособности считается успешной, если системе удаётся загрузить файл.
interval целое число	Интервал, определяющий частоту запуска экземпляра монитора на основе этого шаблона. Это значение должно быть меньше значения `timeout`. При создании монитора, если этот параметр не задан, используется значение по умолчанию `5`.
ip строка	IP-адрес в определении IP-адреса и порта. Если при создании монитора этот параметр не задан, по умолчанию используется значение «*».
manual_resume логическое значение	Определяет, изменяет ли система автоматически состояние ресурса на включено при следующей успешной проверке монитора. Если установить этот параметр в `true`, необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки соединений. При создании монитора, если этот параметр не задан, используется значение по умолчанию `false`. Если `true`, указывает, что после неудачной проверки монитора ресурс необходимо включить повторно вручную. Если `false`), указывает, что система автоматически изменяет состояние ресурса на включено при следующей успешной проверке монитора. Варианты: `false` `true`
mode строка	Указывает режим процесса передачи данных (DTP). Если `passive`, монитор отправляет FTP-серверу запрос на передачу данных. Получив запрос, FTP-сервер инициирует и устанавливает соединение для передачи данных. Если `port`, монитор инициирует и устанавливает соединение для передачи данных с FTP-сервером. Варианты: `"passive"` `"port"`
name строка / обязательный	Указывает имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После задания это значение нельзя изменить. При создании монитора, если этот параметр не задан, по умолчанию используется поставляемый системой монитор `ftp`.
partition строка	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
port строка	Порт в определении IP-адреса и порта. Если при создании монитора этот параметр не задан, по умолчанию используется значение «*». При указании IP-адреса необходимо использовать значение от 1 до 65535.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict с параметрами подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server строка / обязательный	Имя узла BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задаёт время ожидания в секундах при обмене данными с сетевым устройством — как при подключении, так и при отправке команд. Если операция не завершится до истечения времени ожидания, модуль завершится с ошибкой.
transport строка	Настраивает транспортное соединение, используемое при подключении к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs логическое значение	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах под вашим контролем, использующих самоподписанные сертификаты. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
state строка	Если `present`, обеспечивает наличие монитора. Если `absent`, обеспечивает удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password строка	Указывает пароль, если для проверяемого объекта требуется аутентификация.
target_username строка	Указывает имя пользователя, если для проверяемого объекта требуется аутентификация.
time_until_up целое число	Указывает время в секундах после первого успешного ответа, по истечении которого узел будет помечен как доступный. Значение `0` приведёт к тому, что узел будет помечен как доступный сразу после получения от него корректного ответа. Если при создании монитора этот параметр не задан, используется значение по умолчанию `0`.
timeout целое число	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного периода времени, он считается доступным. Если целевой объект не отвечает в течение заданного периода времени, он считается недоступным. Это значение можно изменить на любое число, однако оно должно быть равно тройному значению интервала в секундах плюс одна секунда. Если при создании монитора этот параметр не задан, используется значение по умолчанию `31`.
up_interval целое число	Указывает интервал, с которым система выполняет проверку работоспособности ресурса, когда он доступен. Если `0`, система использует интервал, указанный в `interval`, для проверки работоспособности ресурса. При указании любого другого числа можно задать интервал, отличный от стандартного, для проверки работоспособности доступного ресурса. При создании монитора, если этот параметр не задан, используется значение по умолчанию `0`.
update_password строка	Значение `always` обновит пароли, если указан параметр `target_password`. Значение `on_create` задаст пароль только для вновь созданных мониторов. Варианты: `"always"` ← (по умолчанию) `"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 string	Служба iApp, связанная с этим монитором. Возвращается: изменено Пример: `"/Common/good_service.app/good_service"`
debug boolean	Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и предназначенный специально для этого монитора. Возвращается: изменено Пример: `false`
description string	Описание монитора. Возвращается: изменено Пример: `"Important Monitor"`
filename string	Указывает полный путь и имя файла, который система пытается загрузить. Возвращается: изменено Пример: `"/ftp/var/health.txt"`
interval integer	Новый интервал запуска проверки монитора. Возвращается: изменено Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: изменено Пример: `"10.12.13.14"`
manual_resume boolean	Указывает, переводит ли система ресурс в состояние «работает» автоматически при следующей успешной проверке монитора. Возвращается: изменено Пример: `true`
mode string	Указывает режим процесса передачи данных (DTP). Возвращается: изменено Пример: `"passive"`
parent string	Родительский монитор. Возвращается: изменено Пример: `"/Common/foo_ftp"`
port string	Псевдоним порта или службы, проверяемой монитором для пулов или участников пулов, с которыми связан монитор. Возвращается: изменено Пример: `"80"`
time_until_up integer	Новое время, по истечении которого система будет отмечена как работающая после первого успешного ответа. Возвращается: изменено Пример: `2`
timeout integer	Новый тайм-аут, в течение которого удалённая система должна ответить монитору. Возвращается: изменено Пример: `10`
up_interval integer	Интервал, используемый системой для проверки работоспособности ресурса, когда он находится в рабочем состоянии. Возвращается: изменено Пример: `0`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 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_monitor_ftp_module.html