bigip_monitor_snmp_dca – Управляет мониторами агента сбора данных SNMP (DCA) BIG-IP

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

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

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

BIG-IP имеет агент сбора данных SNMP (DCA), который может запрашивать у удаленных агентов SNMP различных типов, включая агент UC Davis (UCD) и агент Windows 2000 Server (WIN2000).

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
agent_type строка		Варианты: UCD WIN2000 GENERIC	Указывает SNMP-агент, работающий на сервере, за которым ведется мониторинг. При создании нового монитора значение по умолчанию — `UCD` (UC-Davis).
community строка			Указывает имя сообщества, которое система должна использовать для аутентификации с сервером хоста через SNMP. Значение по умолчанию при создании нового монитора — `public`. Обратите внимание, что это значение чувствительно к регистру.
cpu_coefficient строка			Указывает коэффициент, который система использует для расчета веса порога ЦП в алгоритме динамического балансирования нагрузки по соотношению. При создании нового монитора значение по умолчанию — `1.5`.
cpu_threshold целое число			Указывает максимальное допустимое использование ЦП на целевом сервере. При создании нового монитора значение по умолчанию — `80` процентов.
description строка			Указывает описательный текст, который идентифицирует монитор.
disk_coefficient строка			Указывает коэффициент, который система использует для расчета веса порога диска в алгоритме динамического балансирования нагрузки по соотношению. При создании нового монитора значение по умолчанию — `2.0`.
disk_threshold целое число			Указывает максимальное допустимое использование диска на целевом сервере. При создании нового монитора значение по умолчанию — `90` процентов.
interval целое число			Указывает частоту проверки монитора системой в секундах, когда ресурс недоступен или его статус неизвестен. При создании нового монитора значение по умолчанию — `10`.
memory_coefficient строка			Указывает коэффициент, который система использует для расчета веса порога памяти в алгоритме динамического балансирования нагрузки по соотношению. При создании нового монитора значение по умолчанию — `1.0`.
memory_threshold целое число			Указывает максимальное допустимое использование памяти на целевом сервере. При создании нового монитора значение по умолчанию — `70` процентов.
name строка / обязательно			Имя монитора.
parent строка		Значение по умолчанию: "/Common/snmp_dca"	Шаблон родителя для этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский шаблон `snmp_dca` на разделе `Common`.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
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 строка добавлен в 2.5		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
time_until_up целое число			Указывает количество секунд ожидания после того, как ресурс впервые правильно ответил на запрос монитора, прежде чем установить для ресурса состояние 'up'. В течение этого интервала все ответы от ресурса должны быть корректными. По истечении интервала ресурс помечается как 'up'. Значение 0 означает, что ресурс помечается как 'up' сразу после получения первого правильного ответа. При создании нового монитора значение по умолчанию — `0`.
timeout целое число			Указывает количество секунд, в течение которых цель должна ответить на запрос монитора. При создании нового монитора значение по умолчанию — `30` секунд. Если цель отвечает в течение заданного периода времени, она считается 'up'. Если цель не отвечает в течение заданного периода времени, она считается 'down'. Когда это значение установлено в 0 (ноль), система использует интервал родительского монитора. Обратите внимание, что `timeout` и `time_until_up` совместно управляют временем, когда ресурс устанавливается в состояние 'up'.
user строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды `F5_USER`.

validate_certs boolean added in 2.0		Choices: no yes ←	If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.
version string		Choices: v1 v2c	Specifies the version of SNMP, which the host server uses. When creating a new monitor, the default is `v1`. When `v1`, specifies that the host server uses SNMP version 1. When `v2c`, specifies that the host server uses SNMP version 2c.

Примечания

Примечание

Требуется версия программного обеспечения BIG-IP >= 12
Этот модуль не поддерживает опцию variables, так как эта опция неисправна в REST API и не работает должным образом в tmsh; например, вы не можете удалить параметры, определённые пользователем. Поэтому её автоматическая настройка невозможна.
Для получения дополнительной информации об использовании Ansible для управления устройствами F5 Networks см. https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create SNMP DCS monitor
  bigip_monitor_snmp_dca:
    name: my_monitor
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

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

Ключ	Возвращено	Описание
agent_type строка	изменено	Новый тип агента, который будет использоваться монитором. Пример: UCD
community строка	изменено	Новая общность для монитора. Пример: foobar
cpu_coefficient число с плавающей точкой	изменено	Новый коэффициент ЦП. Пример: 2.4
cpu_threshold целое число	изменено	Новый порог ЦП. Пример: 85
description строка	изменено	Описание монитора. Пример: Важный монитор
disk_coefficient число с плавающей точкой	изменено	Новый коэффициент диска. Пример: 10.2
disk_threshold целое число	изменено	Новый порог диска. Пример: 34
interval целое число	изменено	Новый интервал, в котором выполняется проверка монитора. Пример: 2
memory_coefficient число с плавающей точкой	изменено	Новый коэффициент памяти. Пример: 6.4
memory_threshold целое число	изменено	Новый порог памяти. Пример: 50
parent строка	изменено	Новая родительская шаблон монитора. Пример: snmp_dca
time_until_up целое число	изменено	Новое время, в течение которого система отмечается как активная после первого успешного ответа. Пример: 2
timeout целое число	изменено	Новый таймаут, в течение которого удалённая система должна ответить монитору. Пример: 10
version строка	изменено	Новая версия SNMP, которая будет использоваться монитором. Пример: v2c

Статус

Этот модуль не гарантирует обратной совместимости. [предварительная версия]
Этот модуль поддерживается партнёром 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_monitor_snmp_dca_module.html