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

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).

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

Для использования в книге задач укажите: cisco.meraki.meraki_snmp.

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

Обзор

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

Параметры

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

Примечания

Примечание

Дополнительную информацию об 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. Пожалуйста, обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки будет сообщать об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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 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		При включённом SNMPv3c и отсутствии указанной сети.	Автоматически сгенерированное имя пользователя для SNMPv3. Пример: o/8zd-JaSb

Авторы

Kevin Breit (@kbreit)

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