cisco.meraki.meraki_syslog 模块 – 管理 Meraki 云中的 syslog 服务器设置。

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定： cisco.meraki.meraki_syslog。

已弃用

在以下版本中移除：

3.0.0 版本

原因：

发布了具有增强功能的更新模块

替代方案：

cisco.meraki.networks_syslog_servers

概要

• 允许在 Meraki 中创建和管理 Syslog 服务器。

参数

参数	注释
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	网络的 ID 号。
net_name 别名：name, network 字符串	网络名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键应该是蛇形命名法 (例如 net_id) 还是驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间调试输出的数量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
servers 列表 / 元素=字典	syslog 服务器设置列表
host 字符串	syslog 服务器的 IP 地址或主机名。
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 服务器的更改将替换现有配置。如果您需要添加到现有配置中，请将状态设置为 query 以收集现有配置，然后修改或添加。

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。若要使用驼峰命名法，请将ANSIBLE_MERAKI_FORMAT环境变量设置为camelcase。

• Ansible 的 Meraki 模块将在 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

返回值

常见返回值已在此处记录，以下是此模块独有的字段

键	描述
数据 复杂数据	有关已创建或操作的对象的信息。 返回：信息
servers 复杂数据	syslog 服务器列表。 返回：信息
host 字符串	syslog 服务器的主机名或 IP 地址。 返回：成功 示例："192.0.1.1"
port 字符串	syslog 通信的端口号。 返回：成功 示例："443"
roles 列表 / 元素=字符串	分配给 syslog 服务器的角色列表。 返回：成功 示例：["无线事件日志", "URLs"]

状态

• 此模块将在 3.0.0 版本中删除。[已弃用]

• 更多信息请参见已弃用。

作者

• Kevin Breit (@kbreit)

收藏链接

• 问题跟踪器
• 代码库（源代码）