bigip_monitor_snmp_dca - Управляет мониторами агента сбора данных SNMP BIG-IP (DCA)
Введено в версии 2.5.
Обзор
- BIG-IP имеет агент сбора данных SNMP (DCA), который может запрашивать удалённые агенты SNMP различных типов, включая агент UC Davis (UCD) и агент Windows 2000 Server (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) | Объект словаря, содержащий детали подключения. | ||
| password обязательно | Пароль для учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если переменная окружения F5_PASSWORD задана.Псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER задана. | ||
| server_port | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER_PORT задана. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Можно опустить этот параметр, если переменная окружения F5_USER задана. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющими сертификатами. Можно опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS задана. | |
| timeout | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации соединения с удалённым устройством. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| 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 bool (добавлен в 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 строка | изменён | Новый тип агента, который будет использоваться монитором. Пример: UCD |
| community строка | изменён | Новая община для монитора. Пример: foobar |
| cpu_coefficient вещественное число | изменён | Новый коэффициент CPU. Пример: 2.4 |
| cpu_threshold целое число | изменён | Новый порог CPU. Пример: 85 |
| 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. Дополнительную информацию см. на странице Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/bigip_monitor_snmp_dca_module.html
