Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_monitor_snmp_dca.

Добавлено в f5networks.f5_modules 1.0.0

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

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

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

Параметры

Параметр

Комментарии

agent_type

string

Задаёт агент SNMP, работающий на отслеживаемом сервере. При создании монитора по умолчанию используется UCD (UC-Davis).

Варианты:

  • "UCD"
  • "WIN2000"
  • "GENERIC"

community

string

Задаёт имя сообщества, которое система должна использовать для аутентификации на хост-сервере по протоколу SNMP. При создании монитора по умолчанию используется значение public. Значение чувствительно к регистру.

cpu_coefficient

string

Задаёт коэффициент, который система использует для расчёта веса порогового значения загрузки ЦП в алгоритме балансировки нагрузки с динамическим соотношением. При создании монитора по умолчанию используется 1.5.

cpu_threshold

integer

Задаёт максимально допустимую загрузку ЦП на целевом сервере. При создании монитора по умолчанию используется значение 80 процентов.

description

string

Задаёт текстовое описание монитора.

disk_coefficient

string

Задаёт коэффициент, который система использует для расчёта веса порогового значения использования диска в алгоритме балансировки нагрузки с динамическим соотношением. При создании монитора по умолчанию используется 2.0.

disk_threshold

integer

Задаёт максимально допустимое использование диска на целевом сервере. При создании монитора по умолчанию используется значение 90 процентов.

interval

integer

Задаёт интервал в секундах между проверками монитора, когда ресурс не работает или его состояние неизвестно. При создании монитора по умолчанию используется 10.

memory_coefficient

string

Задаёт коэффициент, который система использует для расчёта веса порогового значения использования памяти в алгоритме балансировки нагрузки с динамическим соотношением. При создании монитора по умолчанию используется 1.0.

memory_threshold

integer

Задаёт максимально допустимое использование памяти на целевом сервере. При создании монитора по умолчанию используется значение 70 процентов.

name

string / обязательный

Имя монитора.

parent

string

Родительский шаблон этого шаблона монитора. После задания этого значения его нельзя изменить. По умолчанию используется родительский объект snmp_dca в разделе Common.

По умолчанию: "/Common/snmp_dca"

partition

string

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict с параметрами подключения.

auth_provider

string

Настраивает поставщика аутентификации, который получает токены аутентификации от удалённого устройства.

Этот параметр используется главным образом при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную окружения F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM устарела, так как её название вводило в заблуждение.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_PASSWORD.

server

string / обязательный

Хост BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечёт до завершения операции, модуль сообщит об ошибке.

transport

string

Настраивает транспортное соединение для подключения к удалённому устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве.

Этот параметр можно не указывать, задав переменную окружения F5_USER.

validate_certs

boolean

Если no, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами ресурсах с самоподписанными сертификатами.

Этот параметр можно не указывать, задав переменную окружения F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

state

string

Если задано значение present, гарантирует, что монитор существует.

Если задано значение absent, гарантирует, что монитор удалён.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

time_until_up

integer

Задаёт время в секундах, которое нужно выждать после первого корректного ответа ресурса на запрос монитора, прежде чем присвоить ресурсу статус «работает». В течение этого интервала все ответы ресурса должны быть корректными. По истечении интервала ресурсу присваивается статус «работает». Значение 0 означает, что ресурс получает статус «работает» сразу после первого корректного ответа. При создании монитора по умолчанию используется 0.

timeout

integer

Задаёт время в секундах, в течение которого целевой сервер должен ответить на запрос монитора. При создании монитора значение по умолчанию — 30 секунд. Если целевой сервер отвечает в установленный период, он считается работающим. Если он не отвечает в установленный период, он считается неработающим. Если задано значение 0 (ноль), система использует интервал родительского монитора. Обратите внимание: параметры timeout и time_until_up совместно определяют, когда ресурсу присваивается статус «работает».

version

string

Задаёт версию SNMP, используемую хост-сервером. При создании монитора по умолчанию используется v1. Если задано значение v1, хост-сервер использует SNMP версии 1. Если задано значение v2c, хост-сервер использует SNMP версии 2c.

Варианты:

  • "v1"
  • "v2c"

Примечания

Примечание

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

string

Новый тип агента, используемый монитором.

Возвращается: изменено

Пример: "UCD"

community

string

Новое сообщество монитора.

Возвращается: изменено

Пример: "foobar"

cpu_coefficient

float

Новое значение коэффициента ЦП.

Возвращается: изменено

Пример: 2.4

cpu_threshold

integer

Новое пороговое значение для ЦП.

Возвращается: изменено

Пример: 85

description

string

Описание монитора.

Возвращается: изменено

Пример: "Important Monitor"

disk_coefficient

float

Новое значение коэффициента диска.

Возвращается: изменено

Пример: 10.2

disk_threshold

integer

Новое пороговое значение для диска.

Возвращается: изменено

Пример: 34

interval

integer

Новый интервал между проверками монитора.

Возвращается: изменено

Пример: 2

memory_coefficient

float

Новое значение коэффициента памяти.

Возвращается: изменено

Пример: 6.4

memory_threshold

integer

Новое пороговое значение для памяти.

Возвращается: изменено

Пример: 50

parent

string

Новый родительский шаблон монитора.

Возвращается: изменено

Пример: "snmp_dca"

time_until_up

integer

Новое время ожидания перед присвоением системе статуса «работает» после первого успешного ответа.

Возвращается: изменено

Пример: 2

timeout

integer

Новое время ожидания ответа удалённой системы на запрос монитора.

Возвращается: изменено

Пример: 10

version

string

Новая версия SNMP, используемая монитором.

Возвращается: изменено

Пример: "v2c"

Авторы

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_snmp_dca_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API