Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_host_snmp — настройка SNMP в системе хоста ESXi

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

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

Для установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать коллекцию в плейбуке, укажите: community.vmware.vmware_host_snmp.

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

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

  • Этот модуль можно использовать для настройки встроенного агента SNMP на хосте ESXi.

Параметры

Параметр

Комментарии

cluster_name

string

добавлен в community.vmware 3.11.0

Имя кластера.

Для управления агентом SNMP используются все хосты из указанного кластера.

Обязательный параметр, если не задан esxi_hostname.

community

list / elements=string

Список строк сообществ SNMP.

По умолчанию: []

esxi_hostname

list / elements=string

добавлен в community.vmware 3.11.0

Список имен хостов ESXi для управления агентом SNMP.

Обязательный параметр, если не задан cluster_name.

hostname

string

Имя хоста или IP-адрес сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST.

hw_source

string

Источник аппаратных событий: датчики IPMI или индикации CIM.

Встроенный агент SNMP получает аппаратные события либо от датчиков IPMI sensors, либо от индикаций CIM indications.

Варианты:

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

log_level

string

Уровень журналирования Syslog.

Варианты:

  • "debug"
  • "info" ← (по умолчанию)
  • "warning"
  • "error"

password

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

string

Пароль сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD.

port

integer

Номер порта сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PORT.

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

proxy_host

string

Адрес прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы.

Формат: имя хоста или IP-адрес.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_HOST.

proxy_port

integer

Порт HTTP-прокси, который будет принимать и перенаправлять все HTTPS-запросы.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_PORT.

send_trap

boolean

Отправить тестовую ловушку, чтобы проверить конфигурацию.

Варианты:

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

snmp_port

integer

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

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

state

string

Включить, отключить или сбросить агент SNMP.

Варианты:

  • "disabled" ← (по умолчанию)
  • "enabled"
  • "reset"

sys_contact

string

Контактное лицо, ответственное за систему.

sys_location

string

Расположение системы.

trap_filter

list / elements=string

Список OID ловушек, которые агент не должен отправлять, например [ 1.3.6.1.4.1.6876.4.1.1.0, 1.3.6.1.4.1.6876.4.1.1.1 ]

Чтобы очистить настройки, используйте значение reset.

trap_targets

list / elements=dictionary

Список получателей ловушек.

Для каждого получателя ловушек необходимо использовать hostname, port и community.

По умолчанию: []

username

псевдонимы: admin, user

string

Имя пользователя сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER.

validate_certs

boolean

Разрешает подключение при недействительных SSL-сертификатах. Установите значение false, если сертификатам нельзя доверять.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

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

Примечания

Примечание

  • Чтобы удалить все строки сообществ, получателей ловушек или фильтры, необходимо сбросить агент до заводских настроек.
  • Настройка SNMP v3 пока не реализована.
  • Для всех модулей требуется доступ к записи через API, поэтому они не поддерживаются бесплатной лицензией ESXi.
  • Все переменные и имена объектов VMware чувствительны к регистру.
  • Модули могут использовать библиотеку Python «requests», которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной среды REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной может в некоторых случаях привести к тому, что значение «false» параметра «validate_certs» будет проигнорировано. Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

- name: Enable and configure SNMP community on standalone ESXi host
  community.vmware.vmware_host_snmp:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    community: [ test ]
    state: enabled
  delegate_to: localhost

- name: Configure SNMP traps and filters on cluster
  community.vmware.vmware_host_snmp:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    community: [ test ]
    trap_targets:
      - hostname: 192.168.1.100
        port: 162
        community: test123
      - hostname: 192.168.1.101
        port: 162
        community: test1234
    trap_filter:
      - 1.3.6.1.4.1.6876.4.1.1.0
      - 1.3.6.1.4.1.6876.4.1.1.1
    state: enabled
  delegate_to: localhost

- name: Enable and configure SNMP system contact and location on simple ESXi host in vCenter
  community.vmware.vmware_host_snmp:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    sys_contact: "admin@testemail.com"
    sys_location: "Austin, USA"
    state: enabled
  delegate_to: localhost

- name: Disable SNMP on standalone ESXi host
  community.vmware.vmware_host_snmp:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    state: disabled
  delegate_to: localhost

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

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

Ключ

Описание

results

dictionary

Метаданные о конфигурации SNMP системы хоста

Возвращается: всегда

Пример: {"changed": true, "esx01.example.local": {"changed": true, "community": ["test"], "community_previous": [], "hw_source": "indications", "log_level": "info", "log_level_previous": "warning", "msg": "SNMP state, community list, log level, sys contact, and sys location changed", "port": 161, "state": "enabled", "state_previous": "disabled", "sys_contact_previous": "", "sys_location_previous": "", "trap_filter": null, "trap_targets": []}, "failed": false}

Авторы

  • Christian Kotte (@ckotte)
  • Alexander Nikitin (@ihumster)

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

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

© 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/community/vmware/vmware_host_snmp_module.html

Spec-Zone.ru

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