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

Примечание

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

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

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

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

Обзор

Позволяет создавать и управлять серверами 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. Пожалуйста, обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления и сравнивает изменения с этим загруженным результатом. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в API для проверки изменения.

Примеры

- 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 сложное			информация	Информация о созданном или измененном объекте.
	servers сложное		информация	Список серверов syslog.
		host строка	успех	Имя хоста или IP-адрес сервера syslog. Пример: 192.0.1.1
		port строка	успех	Порт для связи syslog. Пример: 443
		roles список / элементы=строка	успех	Список ролей, назначенных серверу syslog. Пример: Лог событий беспроводной сети, URL-адреса

Авторы

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.10/collections/cisco/meraki/meraki_syslog_module.html