Модуль cisco.meraki.meraki_syslog — управление настройками серверов syslog в облаке Meraki.

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.meraki.meraki_syslog.

УСТАРЕЛО
Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенной функциональностью
Альтернатива:: cisco.meraki.networks_syslog_servers

Описание

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

Параметры

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

Примечания

Примечание

При изменении существующих серверов syslog их текущая конфигурация заменяется.
Чтобы дополнить существующую конфигурацию, задайте для state значение query, чтобы получить текущую конфигурацию, а затем измените её или добавьте новые параметры.
Дополнительную информацию об API Meraki можно найти на странице https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 модули Meraki в Ansible перестанут поддерживать вывод в формате camel case. Обновите плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправляет изменения в API для проверки.

Примеры

- name: Query syslog configurations on network named MyNet in the YourOrg organization
  meraki_syslog:
    auth_key: abc12345
    state: 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
    state: present
    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
    state: present
    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 complex	Информация о созданном или изменённом объекте. Возвращается: info
servers complex	Список серверов syslog. Возвращается: info
host string	Имя хоста или IP-адрес сервера syslog. Возвращается: при успешном выполнении Пример: `"192.0.1.1"`
port string	Номер порта для обмена данными syslog. Возвращается: при успешном выполнении Пример: `"443"`
roles list / элементы=строка	Список ролей, назначенных серверу syslog. Возвращается: при успешном выполнении Пример: `["Wireless event log", " URLs"]`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/meraki_syslog_module.html