bigip_monitor_snmp_dca – Управляет мониторами агента сбора данных SNMP (DCA) BIG-IP
Новая в версии 2.5.
Описание
- На BIG-IP установлен агент сбора данных SNMP (DCA), который может запросить удаленные агенты SNMP различных типов, включая агент UC Davis (UCD) и агент сервера Windows 2000 (WIN2000).
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| agent_type - |
| Указывает тип 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 | Значение по умолчанию: null | Объект словаря, содержащий данные подключения. | |
| 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 - / обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если 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, гарантирует удаление монитора. | |
| time_until_up - | Указывает количество секунд, которые нужно подождать после того, как ресурс впервые правильно ответил на запрос монитора, прежде чем установить для ресурса статус «включен». В течение этого интервала все ответы от ресурса должны быть корректными. После истечения интервала ресурс помечается как «включен». Значение 0 означает, что ресурс помечается как «включен» сразу после получения первого правильного ответа. По умолчанию при создании нового монитора — 0. | ||
| timeout - | Указывает количество секунд, в течение которых целевой ресурс должен ответить на запрос монитора. По умолчанию при создании нового монитора — 30 секунд. Если целевой ресурс отвечает в заданный период, он считается «включенным». Если целевой ресурс не отвечает в заданный период, он считается «выключенным». Если это значение установлено в 0 (ноль), система использует интервал родительского монитора. Обратите внимание, что timeout и time_until_up вместе контролируют, когда ресурс устанавливается в состояние «включен». | ||
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean added in 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, с использованием самозаверенных сертификатов.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| version - |
| Указывает версию SNMP, используемую хост-сервером. При создании нового монитора значение по умолчанию — v1. Если v1, указывает, что хост-сервер использует версию SNMP 1. Если v2c, указывает, что хост-сервер использует версию SNMP 2c. | |
Примечания
Примечание
- Требуется версия ПО BIG-IP >= 12
- Этот модуль не поддерживает параметр
variables, поскольку этот параметр некорректно работает в REST API и не функционирует должным образом вtmsh; например, вы не можете удалить пользовательские параметры. Поэтому его автоматическая настройка невозможна. - Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. в https://www.ansible.com/integrations/networks/f5.
- На хосте требуется пакет f5-sdk Python. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО BIG-IP >= 12.
- Модули F5 обрабатывают только текущую конфигурацию продукта F5. Для сохранения специфичной для BIG-IP конфигурации на диске убедитесь, что включен хотя бы один таск, использующий модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create SNMP DCS monitor
bigip_monitor_snmp_dca:
state: present
server: lb.mydomain.com
user: admin
password: secret
name: my_monitor
delegate_to: localhost
- name: Remove TCP Echo Monitor
bigip_monitor_snmp_dca:
state: absent
server: lb.mydomain.com
user: admin
password: secret
name: my_monitor
delegate_to: localhost
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| agent_type строка | changed | Новый тип агента, который будет использоваться монитором. Пример: UCD |
| community строка | changed | Новая община для монитора. Пример: foobar |
| cpu_coefficient вещественное число | changed | Новый коэффициент ЦП. Пример: 2.4 |
| cpu_threshold целое число | changed | Новый порог ЦП. Пример: 85 |
| description строка | changed | Описание монитора. Пример: Важный монитор |
| disk_coefficient вещественное число | changed | Новый коэффициент диска. Пример: 10.2 |
| disk_threshold целое число | changed | Новый порог диска. Пример: 34 |
| interval целое число | changed | Новый интервал для проверки монитора. Пример: 2 |
| memory_coefficient вещественное число | changed | Новый коэффициент памяти. Пример: 6.4 |
| memory_threshold целое число | changed | Новый порог памяти. Пример: 50 |
| parent строка | changed | Новая родительская шаблон монитора. Пример: snmp_dca |
| time_until_up целое число | changed | Новое время, в течение которого система будет считаться рабочей после первого успешного ответа. Пример: 2 |
| timeout целое число | changed | Новый тайм-аут, в течение которого удалённая система должна ответить на запрос монитора. Пример: 10 |
| version строка | changed | Новая версия SNMP, которая будет использоваться монитором. Пример: v2c |
Статус
- Гарантируется, что этот модуль будет иметь обратную совместимость. [preview]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- 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.7/modules/bigip_monitor_snmp_dca_module.html