bigip_gtm_monitor_firepass – Управление мониторами F5 BIG-IP GTM FirePass

Новая версия с 2.6.

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

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
cipher_list строка			Указывает список шифров для этого монитора. Элементы в списке шифров разделены символом двоеточия `:`. При создании нового монитора, если этот параметр не указан, используется список по умолчанию `HIGH:!ADH`.
concurrency_limit целое число			Указывает максимальный процент лицензированных подключений, используемых в настоящее время, при котором монитор помечает систему Secure Access Manager как активную. Например, значение 95 процентов означает, что монитор помечает систему Secure Access Manager как активную до тех пор, пока используется 95 процентов лицензированных подключений. Когда количество используемых лицензированных подключений превышает 95 процентов, монитор помечает систему Secure Access Manager как неактивную. При создании нового монитора, если этот параметр не указан, значение по умолчанию равно `95`.
ignore_down_response логическое значение		Варианты: no yes	Указывает, что монитор допускает более одной попытки зондирования в течение интервала. Когда `yes`, указывает, что монитор игнорирует ответы «неактивно» в течение времени ожидания монитора. После достижения времени ожидания монитора без получения ответа «активно» система помечает объект как неактивный. Когда `no`, указывает, что монитор сразу помечает объект как неактивный при получении ответа «неактивно». При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
interval целое число			Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, то необходимо указать `port` число.
max_load_average целое число			Указывает число, которое монитор использует для пометки системы Secure Access Manager как активной или неактивной. Система сравнивает значение параметра Max Load Average со средним значением загрузки системы Secure Access Manager за одну минуту. Когда средняя нагрузка системы Secure Access Manager находится в указанном диапазоне Max Load Average, монитор помечает систему Secure Access Manager как активную. Когда среднее значение превышает заданное значение, монитор помечает систему как неактивную. При создании нового монитора, если этот параметр не указан, значение по умолчанию равно `12`.
name строка / обязательно			Имя монитора.
parent строка		По умолчанию: "/Common/firepass_gtm"	Родительский шаблон для этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский элемент `tcp` на раздела `Common`.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
port строка			Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535.
probe_timeout целое число			Указывает количество секунд, после которого система отменяет запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `5`.
provider словарь добавлено в 2.5			Объект словаря, содержащий данные подключения.
	password строка / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число добавлено в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
target_password строка			Указывает пароль, если для мониторируемого объекта требуется аутентификация.
target_username строка			Указывает имя пользователя, если для мониторируемого объекта требуется аутентификация.

timeout целое число		Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое желаемое, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 90.
update_password строка	Выбор: всегда ← при_создании	`always` будет обновлять пароли, если `target_password` указан. `on_create` будет устанавливать пароль только для вновь созданных мониторов.
user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs логическое значение добавлено в 2.0	Выбор: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, которыми вы управляете лично, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, обязательно включите хотя бы одну задачу, использующую модуль 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 строка	изменено	Новое значение списка шифров. Пример: +3DES:+kEDH
concurrency_limit целое число	изменено	Новое значение ограничения одновременности. Пример: 95
ignore_down_response логическое значение	изменено	Игнорировать ли ответ о неактивности. Пример: True
interval целое число	изменено	Новый интервал для выполнения проверки монитора. Пример: 2
ip строка	изменено	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
max_load_average целое число	изменено	Новое значение максимальной средней загрузки. Пример: 12
parent строка	изменено	Новая родительская шаблон монитора. Пример: firepass_gtm
port строка	изменено	Новый порт, на котором монитор проверяет ресурс. Пример: 8080
probe_timeout целое число	изменено	Новый таймаут, в течение которого система будет ждать отклика зондирования монитора. Пример: 10
timeout целое число	изменено	Новый таймаут, в течение которого удаленная система должна ответить на монитор. Пример: 10

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

Tim Rupp (@caphrim007)
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.8/modules/bigip_gtm_monitor_firepass_module.html