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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — ‘*’.
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	Объект словаря, содержащий данные подключения.
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 integer	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах под собственным контролем с самозаверяющимися сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
state string	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует, что монитор удалён. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password string	Указывает пароль, если контролируемый целевой объект требует аутентификации.
target_username string	Указывает имя пользователя, если контролируемый целевой объект требует аутентификации.
time_until_up integer	Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение `0` приведет к тому, что узел будет сразу отмечен как активный после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, будет использовано значение по умолчанию `0`.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, по умолчанию будет использовано значение `31`.
up_interval integer	Указывает интервал, в котором система выполняет проверку работоспособности, когда ресурс активен. Когда `0`, система использует интервал, указанный в `interval`, для проверки работоспособности ресурса. В ином случае, вы можете указать другой интервал для проверки работоспособности активного ресурса. При создании нового монитора, если этот параметр не указан, будет использовано значение по умолчанию `0`.
update_password string	`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, связанная с этим монитором. Возвращается: changed Пример: `"/Common/good_service.app/good_service"`
debug boolean	Отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Возвращается: changed Пример: `false`
description string	Описание монитора. Возвращается: changed Пример: `"Important Monitor"`
filename string	Указывает полный путь и имя файла, который система пытается загрузить. Возвращается: changed Пример: `"/ftp/var/health.txt"`
interval integer	Новый интервал для выполнения проверки монитором. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес определения IP/порт. Возвращается: changed Пример: `"10.12.13.14"`
manual_resume boolean	Указывает, автоматически ли система изменяет статус ресурса на «доступен» при следующей успешной проверке монитором. Возвращается: changed Пример: `true`
mode string	Указывает режим процесса передачи данных (DTP). Возвращается: changed Пример: `"passive"`
parent string	Родительский монитор. Возвращается: changed Пример: `"/Common/foo_ftp"`
port string	Псевдоним порта или службы для проверки монитором от имени пулов или участников пулов, с которыми связан монитор. Возвращается: changed Пример: `"80"`
time_until_up integer	Новое время, в течение которого система должна быть помечена как доступная после первого успешного ответа. Возвращается: changed Пример: `2`
timeout integer	Новое время ожидания, в течение которого удаленная система должна ответить на запрос монитора. Возвращается: changed Пример: `10`
up_interval integer	Интервал, который система использует для выполнения проверки работоспособности, когда ресурс доступен. Возвращается: changed Пример: `0`

Авторы

Wojciech Wypior (@wojtek0806)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_ftp_module.html