Модуль f5networks.f5_modules.bigip_gtm_monitor_firepass — управление мониторами F5 BIG-IP GTM FirePass

Примечание

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

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

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

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

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

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

Описание

Управление мониторами F5 BIG-IP GTM (теперь BIG-IP DNS) FirePass.

Параметры

Параметр	Комментарии
cipher_list string	Задаёт список шифров для этого монитора. Элементы списка шифров разделяются символом двоеточия `:`. При создании монитора, если этот параметр не указан, используется список по умолчанию `HIGH:!ADH`.
concurrency_limit integer	Задаёт максимальный процент используемых в данный момент лицензированных подключений, при котором монитор считает систему Secure Access Manager работоспособной. Например, значение 95 процентов означает, что монитор считает систему Secure Access Manager работоспособной, пока используется не более 95 процентов лицензированных подключений. Если количество используемых лицензированных подключений превышает 95 процентов, монитор считает систему Secure Access Manager неработоспособной. При создании монитора, если этот параметр не указан, используется значение по умолчанию `95`.
ignore_down_response boolean	Указывает, что монитор может выполнять более одной попытки проверки за интервал. Если задано значение `true`, монитор игнорирует ответы о неработоспособности в течение времени ожидания монитора. Если время ожидания монитора истекает, а система так и не получает ответ о работоспособности, она помечает объект как неработоспособный. Если задано значение `no`, монитор немедленно помечает объект как неработоспособный при получении соответствующего ответа. При создании монитора, если этот параметр не указан, используется значение по умолчанию `false`. Варианты: `false` `true`
interval integer	Интервал, определяющий частоту запуска экземпляра монитора на основе этого шаблона. При создании монитора, если этот параметр не указан, используется значение по умолчанию 30. Это значение должно быть меньше значения `timeout`.
ip string	IP-адрес в определении IP/порта. При создании монитора, если этот параметр не указан, используется значение по умолчанию «*». Если задано значение IP-адреса, необходимо указать номер `port`.
max_load_average integer	Задаёт значение, которое монитор использует, чтобы пометить систему Secure Access Manager как работоспособную или неработоспособную. Система сравнивает значение параметра Max Load Average со средней нагрузкой на систему Secure Access Manager за одну минуту. Если средняя нагрузка на систему Secure Access Manager не превышает указанное значение Max Load Average, монитор помечает систему как работоспособную. Если средняя нагрузка превышает указанное значение, монитор помечает систему как неработоспособную. При создании монитора, если этот параметр не указан, используется значение по умолчанию `12`.
name string / обязательный	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить. По умолчанию используется родительский шаблон `tcp` в разделе `Common`. По умолчанию: `"/Common/firepass_gtm"`
partition string	Раздел устройства, в котором следует управлять ресурсами. По умолчанию: `"Common"`
port string	Номер порта в определении IP/порта. При создании монитора, если этот параметр не указан, используется значение по умолчанию «*». Обратите внимание: если указан IP-адрес, необходимо задать значение от 1 до 65535.
probe_timeout integer	Задаёт количество секунд, по истечении которых система прекращает ожидание ответа на запрос проверки. При создании монитора, если этот параметр не указан, используется значение по умолчанию `5`.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с данными для подключения.
auth_provider string	Настраивает провайдера аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр предназначен для работы с устройствами BIG-IQ.
no_f5_teem boolean	Если задано значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, так как её название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера 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	Задаёт имя пользователя, если для проверяемой цели требуется аутентификация.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если цель отвечает в установленный период времени, она считается работоспособной. Если цель не отвечает в установленный период времени, она считается неработоспособной. Можно задать любое значение, однако оно должно равняться трём интервалам в секундах плюс одна секунда. При создании монитора, если этот параметр не указан, используется значение по умолчанию 90.
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 a GTM FirePass monitor
  bigip_gtm_monitor_firepass:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove FirePass Monitor
  bigip_gtm_monitor_firepass:
    name: my_monitor
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add FirePass monitor for all addresses, port 514
  bigip_gtm_monitor_firepass:
    name: my_monitor
    port: 514
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
cipher_list string	Новое значение списка шифров. Возвращается: changed Пример: `"+3DES:+kEDH"`
concurrency_limit integer	Новое значение ограничения одновременных подключений. Возвращается: changed Пример: `95`
ignore_down_response boolean	Указывает, следует ли игнорировать ответ о неработоспособности. Возвращается: changed Пример: `true`
interval integer	Новый интервал выполнения проверки монитора. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: changed Пример: `"10.12.13.14"`
max_load_average integer	Новое значение максимальной средней нагрузки. Возвращается: changed Пример: `12`
parent string	Новый родительский шаблон монитора. Возвращается: changed Пример: `"firepass_gtm"`
port string	Новый порт, на котором монитор проверяет ресурс. Возвращается: changed Пример: `"8080"`
probe_timeout integer	Новое время ожидания, по истечении которого система прекращает ожидание ответа на проверку монитора. Возвращается: changed Пример: `10`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: changed Пример: `10`

Авторы

Tim Rupp (@caphrim007)
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_gtm_monitor_firepass_module.html