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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
cluster_name string added in community.vmware 3.11.0	Имя кластера. Все хост-системы из заданного кластера используются для управления агентом SNMP. Обязательный параметр, если `esxi_hostname` не установлен.
community list / elements=string	Список строк сообщества SNMP. Default: `[]`
esxi_hostname list / elements=string added in community.vmware 3.11.0	Список имен хостов ESXi для управления агентом SNMP. Обязательный параметр, если `cluster_name` не установлен.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
hw_source string	Источник событий оборудования от датчиков IPMI или указаний CIM. Встроенный агент SNMP получает события оборудования либо от датчиков IPMI `sensors` либо от указаний CIM `indications`. Choices: `"indications"` ← (default) `"sensors"`
log_level string	Уровень ведения журнала Syslog. Choices: `"debug"` `"info"` ← (default) `"warning"` `"error"`
password aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. Default: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все запросы HTTPS и передавать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать все запросы HTTPS и передавать их. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
send_trap boolean	Отправить тестовую ловушку для проверки конфигурации. Choices: `false` ← (default) `true`
snmp_port integer	Порт, используемый агентом SNMP. Default: `161`
state string	Включить, отключить или сбросить агент SNMP. Choices: `"disabled"` ← (default) `"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` для каждого целевого объекта ловушки. Default: `[]`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`.

validate_certs

boolean

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

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

Варианты:

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

Примечания

Примечание

Необходимо перезапустить агент (до заводских настроек), если требуется очистить все строки сообщества, целевые значения ловушек или фильтры
Конфигурация SNMP v3 пока не реализована
Все модули требуют доступ к API для записи и поэтому не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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 словарь	метаданные о конфигурации 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}`

Ключ

Описание

results

словарь

метаданные о конфигурации 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_host_snmp_module.html