Модуль cisco.meraki.meraki_snmp — Управление организациями в облаке Meraki

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

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

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

Чтобы использовать её в сценарии, укажите: cisco.meraki.meraki_snmp.

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версия 3.0.0
Причина:: Выпущены обновлённые модули с расширенной функциональностью
Альтернатива:: cisco.meraki.networks_snmp

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

Позволяет управлять настройками SNMP для Meraki.

Параметры

Параметр	Комментарии
access string	Тип доступа SNMP. Варианты: `"community"` `"none"` `"users"`
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная окружения `MERAKI_KEY`.
community_string string	Строка сообщества SNMP. Применимо только, если для `access` задано значение `community`.
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повтора запроса, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
net_id string	Идентификатор сети.
net_name string	Имя сети.
org_id string	Идентификатор организации.
org_name псевдонимы: organization string	Имя организации.
output_format string	Указывает модулю, использовать ли для ключей ответа snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт уровень отладочного вывода во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
peer_ips list / элементы=string	Список IP-адресов, с которых можно выполнять SNMP-запросы.
rate_limit_retry_time integer	Количество секунд до повтора запроса при срабатывании ограничителя частоты запросов. По умолчанию: `165`
state string	Указывает, следует ли запрашивать или изменять сведения SNMP. Варианты: `"query"` `"present"` ← (по умолчанию)
timeout integer	Время ожидания истечения срока выполнения HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
users list / элементы=dictionary	Сведения о пользователях с доступом к SNMP. Применимо только, если для `access` задано значение `users`.
passphrase string	Парольная фраза для доступа пользователя к SNMP.
username string	Имя пользователя, имеющего доступ.
v2c_enabled boolean	Указывает, включён ли SNMPv2c. Варианты: `false` `true`
v3_auth_mode string	Задаёт режим аутентификации для SNMPv3. Варианты: `"MD5"` `"SHA"`
v3_auth_pass string	Пароль аутентификации для SNMPv3. Длина должна составлять не менее 8 символов.
v3_enabled boolean	Указывает, включён ли SNMPv3. Варианты: `false` `true`
v3_priv_mode string	Задаёт режим конфиденциальности для SNMPv3. Варианты: `"DES"` `"AES128"`
v3_priv_pass string	Пароль конфиденциальности для SNMPv3. Длина должна составлять не менее 8 символов.
validate_certs boolean	Проверять ли HTTP-сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Дополнительные сведения об API Meraki см. на странице https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в snake case. Чтобы использовать camel case, задайте для переменной окружения ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 модули Meraki перестанут поддерживать вывод в camel case. Обновите свои сценарии.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с загруженными данными. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправляет изменения в API для проверки.

Примеры

- name: Query SNMP values
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Enable SNMPv2
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    v2c_enabled: true
  delegate_to: localhost

- name: Disable SNMPv2
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    v2c_enabled: false
  delegate_to: localhost

- name: Enable SNMPv3
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    v3_enabled: true
    v3_auth_mode: SHA
    v3_auth_pass: ansiblepass
    v3_priv_mode: AES128
    v3_priv_pass: ansiblepass
    peer_ips: 192.0.1.1;192.0.1.2
  delegate_to: localhost

- name: Set network access type to community string
  meraki_snmp:
    auth_key: abc1235
    org_name: YourOrg
    net_name: YourNet
    state: present
    access: community
    community_string: abc123
  delegate_to: localhost

- name: Set network access type to username
  meraki_snmp:
    auth_key: abc1235
    org_name: YourOrg
    net_name: YourNet
    state: present
    access: users
    users:
      - username: ansibleuser
        passphrase: ansiblepass
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Сведения о настройках SNMP. Возвращается: всегда
access string	Тип доступа SNMP. Возвращается: при успешном выполнении, если указана сеть
community_string string	Строка сообщества SNMP. Применимо только, если для `access` задано значение `community`. Возвращается: при успешном выполнении, если указана сеть
hostname string	Имя хоста сервера SNMP. Возвращается: при успешном выполнении, если сеть не указана. Пример: `"n1.meraki.com"`
peer_ips string	Список IP-адресов, разделённых точкой с запятой, с которых можно опрашивать сведения SNMP. Возвращается: при успешном выполнении, если сеть не указана. Пример: `"192.0.1.1"`
port string	Номер порта SNMP. Возвращается: при успешном выполнении, если сеть не указана. Пример: `"16100"`
users complex	Сведения о пользователях с доступом к SNMP. Применимо только, если для `access` задано значение `users`. Возвращается: при успешном выполнении
passphrase string	Парольная фраза для доступа пользователя к SNMP. Возвращается: при успешном выполнении, если указана сеть
username string	Имя пользователя, имеющего доступ. Возвращается: при успешном выполнении, если указана сеть
v2_community_string string	Автоматически сгенерированная строка сообщества для SNMPv2c. Возвращается: если SNMPv2c включён и сеть не указана. Пример: `"o/8zd-JaSb"`
v2c_enabled boolean	Показывает, включён ли SNMPv2c. Возвращается: при успешном выполнении, если сеть не указана. Пример: `true`
v3_auth_mode string	Режим аутентификации SNMP версии 3: MD5 или SHA. Возвращается: при успешном выполнении, если сеть не указана. Пример: `"SHA"`
v3_enabled boolean	Показывает, включён ли SNMPv3. Возвращается: при успешном выполнении, если сеть не указана. Пример: `true`
v3_priv_mode string	Режим конфиденциальности SNMP версии 3: DES или AES128. Возвращается: при успешном выполнении, если сеть не указана. Пример: `"AES128"`
v3_user string	Автоматически сгенерированное имя пользователя для SNMPv3. Возвращается: если SNMPv3c включён и сеть не указана. Пример: `"o/8zd-JaSb"`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

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

© 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/cisco/meraki/meraki_snmp_module.html