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

Новая версия с 2.6.

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access строка добавлено в 2.9		Варианты: community none users	Тип доступа SNMP.
auth_key строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
community_string строка добавлено в 2.9			Строка сообщества SNMP. Актуально только если `access` установлено в `community`.
host строка		По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, например, в Китае.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд для повторного запроса, если сервер возвращает ошибку внутренней серверной части.
net_id строка добавлено в 2.9			Идентификатор сети.
net_name строка добавлено в 2.9			Имя сети.
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 список добавлено в 2.9			Информация о пользователях с доступом к SNMP. Актуально только если `access` установлено в `users`.
	passphrase строка добавлено в 2.9		Пароль для доступа пользователя к SNMP.
	username строка добавлено в 2.9		Имя пользователя с доступом.
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. Обновите свои playbook.

Примеры

- 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
	peerIps строка		успех и сеть не указана.	Список 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 строка		При включенном SNMPv3c и отсутствии указанной сети.	Автоматически сгенерированное имя пользователя для SNMPv3. Пример: o/8zd-JaSb

Статус

Данный модуль не гарантирует обратной совместимости. [превью]
Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Kevin Breit (@kbreit)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/meraki_snmp_module.html