Spec-Zone.ru › Ansible 2.6

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

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_key
Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения MERAKI_KEY не задана.
host
строка
По умолчанию:
"api.meraki.com"
Имя хоста для панели управления Meraki
Полезно только для внутренних разработчиков Meraki
org_id
Идентификатор организации.
org_name
Название организации.

Псевдонимы: организация
output_level
    Варианты:
  • normal ←
  • debug
Устанавливает объем отладочной информации во время выполнения модуля
peer_ips
Список IP-адресов, разделенных точкой с запятой, которые могут выполнять запросы SNMP.
state
    Варианты:
  • запрос
  • present ←
Указывает, следует ли запрашивать или изменять информацию SNMP.
timeout
целое
По умолчанию:
30
Время ожидания для HTTP-запросов.
use_https
логическое
    Варианты:
  • нет
  • да ←
Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.
Полезно только для внутренних разработчиков Meraki
use_proxy
логическое
    Варианты:
  • нет
  • да
Если no, прокси не будет использоваться, даже если он определен в переменной среды целевых хостов.
v2c_enabled
логическое
    Варианты:
  • нет
  • да
Указывает, включен ли SNMPv2c.
v3_auth_mode
    Варианты:
  • MD5
  • SHA
Устанавливает режим аутентификации для SNMPv3.
v3_auth_pass
Пароль аутентификации для SNMPv3.
Длина пароля должна быть не менее 8 символов.
v3_enabled
логическое
    Варианты:
  • нет
  • да
Указывает, включен ли SNMPv3.
v3_priv_mode
    Варианты:
  • DES
  • AES128
Указывает режим конфиденциальности для SNMPv3.
v3_priv_pass
Пароль конфиденциальности для SNMPv3.
Длина пароля должна быть не менее 8 символов.
validate_certs
логическое
    Варианты:
  • нет
  • да ←
Требовать проверку HTTP-сертификатов.

Примечания

Примечание

  • Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
  • Некоторые параметры, вероятно, используются только для разработчиков Meraki.

Примеры

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

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

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

Ключ Возвращено Описание
data
сложный
всегда
Информация о настройках SNMP.

hostname
строка
успех
Имя хоста сервера SNMP.

Пример:
n1.meraki.com
peerIps
строка
успех
Список IP-адресов, разделенных точкой с запятой, которые могут получать данные SNMP.

Пример:
192.0.1.1
port
строка
успех
Порт SNMP.

Пример:
16100
v2cEnabled
логическое
успех
Показывает состояние включения SNMPv2c

Пример:
True
v3Enabled
логическое
успех
Показывает состояние включения SNMPv3

Пример:
True
v3AuthMode
строка
успех
Режим аутентификации SNMP версии 3, либо MD5, либо SHA.

Пример:
SHA
v3PrivMode
строка
успех
Режим конфиденциальности SNMP версии 3, DES или AES128.

Пример:
AES128
v2CommunityString
строка
При включенном SNMPv2c.
Автоматически сгенерированная строка сообщества для SNMPv2c.

Пример:
o/8zd-JaSb
v3User
строка
При включенном SNMPv3c.
Автоматически сгенерированное имя пользователя для SNMPv3.

Пример:
o/8zd-JaSb


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/meraki_snmp_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API