bigip_monitor_snmp_dca - Управляет мониторами агента сбора данных SNMP BIG-IP (DCA)
Новая версия с 2.5.
Обзор
- BIG-IP имеет агент сбора данных SNMP (DCA), который может запрашивать удаленные агенты SNMP различных типов, включая агент UC Davis (UCD) и агент сервера Windows 2000 (WIN2000).
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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) | По умолчанию: None | Объект типа dict, содержащий данные подключения. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная среды F5_USER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, находящихся под вашим контролем, использующих самозаверяющие сертификаты. Можно опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| state (добавлено в 2.5) |
| Если 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 (добавлено в 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.
Примеры
- 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 |
| 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 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Tim Rupp (@caphrim007)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_monitor_snmp_dca_module.html
