meraki_syslog – Управление настройками сервера syslog в облаке Meraki

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

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

Описание

Позволяет создавать и управлять серверами Syslog в Meraki.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения MERAKI_KEY не задана.
host строка		Значение по умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число		Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
net_id строка			Идентификационный номер сети.
net_name строка			Название сети. псевдонимы: name, network
org_id строка			Идентификатор организации.
org_name строка			Название организации. псевдонимы: organization
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: debug normal ←	Устанавливает количество отладочных выводов во время выполнения модуля.
rate_limit_retry_time целое число		Значение по умолчанию: 165	Количество секунд для повторной попытки, если триггер лимита скорости.
servers -			Список настроек сервера syslog
	host -		IP-адрес или имя хоста сервера syslog.
	port -	Значение по умолчанию: "514"	Порт, на котором сервер syslog прослушивает.
	roles -	Варианты: Журнал событий беспроводной сети Журнал событий устройства Журнал событий коммутатора События Air Marshal Потоки URL-адреса События IDS События безопасности	Список применимых ролей сервера syslog.
state строка		Варианты: present ← query	Запрос или редактирование серверов syslog Для удаления сервера syslog, не включайте сервер в список серверов
timeout целое число		Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логический тип		Варианты: нет да ←	Если `no`, он будет использовать HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логический тип		Варианты: нет да	Если `no`, он не будет использовать прокси-сервер, даже если он определен в переменной окружения на целевых хостах.
validate_certs логический тип		Варианты: нет да ←	Выполнять ли проверку сертификатов HTTP.

Примечания

Примечание

Изменения существующих серверов syslog заменяют существующую конфигурацию. Если вам нужно добавить к существующей конфигурации, установите state в query, чтобы собрать существующую конфигурацию, а затем измените или добавьте.
Дополнительную информацию об 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 syslog configurations on network named MyNet in the YourOrg organization
  meraki_syslog:
    auth_key: abc12345
    status: query
    org_name: YourOrg
    net_name: MyNet
  delegate_to: localhost

- name: Add single syslog server with Appliance event log role
  meraki_syslog:
    auth_key: abc12345
    status: query
    org_name: YourOrg
    net_name: MyNet
    servers:
      - host: 192.0.1.2
        port: 514
        roles:
          - Appliance event log
  delegate_to: localhost

- name: Add multiple syslog servers
  meraki_syslog:
    auth_key: abc12345
    status: query
    org_name: YourOrg
    net_name: MyNet
    servers:
      - host: 192.0.1.2
        port: 514
        roles:
          - Appliance event log
      - host: 192.0.1.3
        port: 514
        roles:
          - Appliance event log
          - Flows
  delegate_to: localhost

Значения возврата

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

Ключ		Возвращаемое значение	Описание
data сложное		info	Информация о созданном или измененном объекте.
	host строка	success	Имя хоста или IP-адрес сервера syslog. Пример: 192.0.1.1
	port строка	success	Порт для связи syslog. Пример: 443
	roles список	success	Список ролей, назначенных серверу syslog. Пример: Журнал событий беспроводной сети, URL-адреса

Статус

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

Авторы

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_syslog_module.html