community.vmware.vmware_host_snmp – Настройка SNMP на хост-системе ESXi

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.7.0).

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

Для использования в книге задач укажите: community.vmware.vmware_host_snmp.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
community список / элементы=строка		Список строк сообщества SNMP.
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
hw_source строка	Варианты: indications ← sensors	Источник событий аппаратного обеспечения от датчиков IPMI или показаний CIM. Встроенный агент SNMP получает события аппаратного обеспечения либо от датчиков IPMI `sensors`, либо от показаний CIM `indications`.
log_level строка	Варианты: debug info ← warning error	Уровень ведения журнала Syslog.
password строка		Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. Псевдонимы: pass, pwd
port целое число	По умолчанию: 443	Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_PORT`.
send_trap булево	Варианты: no ← yes	Отправить тестовый запрос для проверки настройки.
snmp_port целое число	По умолчанию: 161	Порт, используемый агентом SNMP.
state строка	Варианты: disabled ← enabled reset	Включить, отключить или сбросить агент SNMP.
trap_filter список / элементы=строка		Список идентификаторов ловушек для ловушек, которые не должны отправляться агентом, например [ 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 список / элементы=словарь	По умолчанию: []	Список целей ловушек. Для каждой цели ловушки необходимо использовать `hostname`, `port`, и `community`.
username строка		Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. Псевдонимы: admin, user
validate_certs булево	Варианты: no yes ←	Позволяет подключиться, когда сертификаты SSL недействительны. Установите значение `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

Проверено на vSphere 6.5
Необходимо сбросить агент (до заводских настроек), если требуется очистить все строки сообщества, цели ловушек или фильтры.
Настройка SNMP v3 пока не реализована

Примеры

- name: Enable and configure SNMP community
  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
  community.vmware.vmware_host_snmp:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    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: Disable SNMP
  community.vmware.vmware_host_snmp:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    state: disabled
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
results словарь	всегда	Метаданные о конфигурации SNMP хост-системы Пример: {'esxi01': {'changed': False, 'community': ['test'], 'hw_source': 'indications', 'msg': 'SNMP уже правильно настроен', 'port': 161, 'state': 'enabled', 'trap_targets': []}}

Авторы

Christian Kotte (@ckotte)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_host_snmp_module.html