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

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.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.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access строка	Тип доступа SNMP. Варианты: `"community"` `"none"` `"users"`
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
community_string строка	Строка сообщества SNMP. Актуально только если `access` установлено в `community`.
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, например, Китаю. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части. По умолчанию: `60`
net_id строка	Идентификатор сети.
net_name строка	Название сети.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, следует ли использовать для ключей ответа нижний регистр со знаками подчёркивания (пример: `net_id`) или верхний регистр с дефисами (пример: `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Устанавливает объем отладочной информации во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
peer_ips список / элементы=строка	Список IP-адресов, которые могут выполнять запросы SNMP.
rate_limit_retry_time целое число	Количество секунд для повторной попытки, если ограничитель скорости срабатывает. По умолчанию: `165`
state строка	Указывает, следует ли запрашивать или изменять информацию SNMP. Варианты: `"query"` `"present"` ← (по умолчанию)
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https булево	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy булево	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
users список / элементы=словарь	Информация о пользователях с доступом к SNMP. Актуально только если `access` установлено в `users`.
passphrase строка	Пароль для доступа к SNMP пользователя.
username строка	Имя пользователя с доступом.
v2c_enabled булево	Указывает, включён ли 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.
Модули Meraki Ansible перестанут поддерживать вывод camel case в Ansible 2.13. Пожалуйста, обновите свои playbook'и.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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: yes
  delegate_to: localhost

- name: Disable SNMPv2
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    v2c_enabled: no
  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 сложное	Информация о настройках SNMP. Возвращается: всегда
access строка	Тип доступа SNMP. Возвращается: успех, когда указана сеть
community_string строка	Строка сообщества SNMP. Актуально только если `access` установлено в значение `community`. Возвращается: успех, когда указана сеть
hostname строка	Имя хоста сервера SNMP. Возвращается: при успехе и отсутствии указанной сети. Пример: `"n1.meraki.com"`
peer_ips строка	Список IP-адресов, разделённых точкой с запятой, которые могут запрашивать информацию SNMP. Возвращается: при успехе и отсутствии указанной сети. Пример: `"192.0.1.1"`
port строка	Номер порта SNMP. Возвращается: при успехе и отсутствии указанной сети. Пример: `"16100"`
users сложное	Информация о пользователях с доступом к SNMP. Актуально только если `access` установлено в `users`. Возвращается: при успехе
passphrase строка	Пароль для доступа к SNMP пользователя. Возвращается: при успехе, когда указана сеть
username строка	Имя пользователя с доступом. Возвращается: при успехе, когда указана сеть
v2_community_string строка	Автоматически сгенерированная строка сообщества для SNMPv2c. Возвращается: когда SNMPv2c включен и сеть не указана. Пример: `"o/8zd-JaSb"`
v2c_enabled логическое	Показывает состояние включения SNMPv2c Возвращается: при успехе и отсутствии указанной сети. Пример: `true`
v3_auth_mode строка	Режим аутентификации SNMP версии 3, либо MD5, либо SHA. Возвращается: при успехе и отсутствии указанной сети. Пример: `"SHA"`
v3_enabled логическое	Показывает состояние включения SNMPv3 Возвращается: при успехе и отсутствии указанной сети. Пример: `true`
v3_priv_mode строка	Режим конфиденциальности SNMP версии 3, DES или AES128. Возвращается: при успехе и отсутствии указанной сети. Пример: `"AES128"`
v3_user строка	Автоматически сгенерированное имя пользователя для SNMPv3. Возвращается: когда SNMPv3 включен и сеть не указана. Пример: `"o/8zd-JaSb"`

Статус

Этот модуль будет удален в версии 3.0.0. [устарел]
Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

Кевин Брайт (@kbreit)

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

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