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

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.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.

END_OF_DOCUMENT_MARKER

Параметры

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

Примечания

Примечание

Изменения существующих серверов syslog заменяют существующую конфигурацию. Если вам нужно добавить к существующей конфигурации, установите состояние в режим запроса, чтобы получить существующую конфигурацию, а затем измените или добавьте.
Дополнительную информацию о Meraki API можно найти по адресу 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'ы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесенных изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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 сложный	Информация о созданном или измененном объекте. Возвращаемое значение: информация
servers сложный	Список серверов syslog. Возвращаемое значение: информация
host строка	Имя хоста или IP-адрес сервера syslog. Возвращаемое значение: успех Пример: `"192.0.1.1"`
port строка	Порт для связи syslog. Возвращаемое значение: успех Пример: `"443"`
roles список / элементы=строка	Список ролей, назначенных серверу syslog. Возвращаемое значение: успех Пример: `["Wireless event log", " URLs"]`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарел]
Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

Kevin Breit (@kbreit)

Ссылки на сборки

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