cisco.ios.ios_logging_global 模块 – 配置日志记录的资源模块。
注意
此模块是 cisco.ios 集合 (版本 9.0.3) 的一部分。
如果您使用的是 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它,请运行 ansible-galaxy collection list。
要安装它,请使用: ansible-galaxy collection install cisco.ios。
要在playbook中使用它,请指定: cisco.ios.ios_logging_global。
cisco.ios 2.2.0 中的新增功能
摘要
- 此模块管理Cisco IOS网络设备的日志记录属性 
参数
| 参数 | 注释 | 
|---|---|
| 日志选项的字典 | |
| 设置缓冲日志参数 | |
| 建立MD-Buffer关联 | |
| 启用过滤日志 选项 
 | |
| 日志严重性级别 对于值“debugging”,此属性不保持幂等性,因为此值未显示在运行配置中。 选项 
 | |
| 日志缓冲区大小 | |
| 启用将XML日志记录到XML日志缓冲区 选项 
 | |
| 启用buginf日志记录以进行调试 选项 
 | |
| 设置CNS事件日志记录级别 选项 
 | |
| 设置控制台日志参数 | |
| 建立MD-Buffer关联 | |
| 启用过滤日志 选项 
 | |
| 日志严重性级别 选项 
 | |
| 启用将XML日志记录到XML日志缓冲区 选项 
 | |
| 统计每个日志消息并记录最后一次出现的时间戳 选项 
 | |
| 将分隔符附加到syslog消息 | |
| 通过TCP将分隔符附加到syslog消息 选项 
 | |
| 创建或修改消息鉴别器 | |
| DMVPN配置 | |
| 速率(消息/分钟),默认为600消息/分钟(1-10000) | |
| 设置ESM过滤器限制 | |
| 允许/拒绝来自ESM过滤器的配置更改 选项 
 | |
| 限制异常刷新输出的大小(4096-2147483647) | |
| syslog消息的facility参数 选项 
 | |
| 指定日志过滤器 | |
| 传递给过滤器模块的参数。 | |
| 过滤器执行顺序 | |
| 过滤器统一资源定位符 | |
| 配置syslog历史表 | |
| 日志严重性级别 对于值“debugging”,此属性不保持幂等性,因为此值未显示在运行配置中。 选项 
 | |
| 日志缓冲区大小 | |
| 设置syslog服务器IP地址和参数 | |
| 建立MD-Buffer关联 | |
| 启用过滤日志 选项 
 | |
| syslog服务器的IP地址 | |
| 配置IPv6 syslog服务器 | |
| 在syslog消息中包含会话序列号标签 选项 
 | |
| 指定syslog消息会话ID标记 | |
| 在会话ID标签中包含主机名 选项 
 | |
| 在会话ID标签中包含自定义字符串 | |
| 此服务器应仅接收来自编号流的消息 | |
| 指定传输协议(默认=UDP) | |
| 传输控制协议 | |
| 为IOS防火墙审计日志记录设置此主机 选项 
 | |
| 建立MD-Buffer关联 | |
| 启用过滤日志 选项 
 | |
| 指定TCP端口号(默认=601)(1-65535) | |
| 在syslog消息中包含会话序列号标签 选项 
 | |
| 指定syslog消息会话ID标记 | |
| 在会话ID标签中包含主机名 选项 
 | |
| 在会话ID标签中包含自定义字符串 | |
| 此服务器应仅接收来自编号流的消息 | |
| 启用将XML日志记录到XML日志缓冲区 选项 
 | |
| 用户数据报协议 | |
| 建立MD-Buffer关联 | |
| 启用过滤日志 选项 
 | |
| 指定UDP端口号(默认=514)(1-65535) | |
| 在syslog消息中包含会话序列号标签 选项 
 | |
| 指定syslog消息会话ID标记 | |
| 在会话ID标签中包含主机名 选项 
 | |
| 在会话ID标签中包含自定义字符串 | |
| 此服务器应仅接收来自编号流的消息 | |
| 启用将XML日志记录到XML日志缓冲区 选项 
 | |
| 设置VRF选项 | |
| 启用将XML日志记录到XML日志缓冲区 选项 
 | |
| 启用对所有已启用目标的日志记录 选项 
 | |
| 配置日志消息以包含特定计数器值 选项 
 | |
| 设置终端线路(监控)日志参数 | |
| 建立MD-Buffer关联 | |
| 启用过滤日志 选项 
 | |
| 日志严重性级别 对于值“debugging”,此属性不保持幂等性,因为此值未显示在运行配置中。 选项 
 | |
| 启用将XML日志记录到XML日志缓冲区 选项 
 | |
| 向syslog消息添加源ID | |
| 在会话ID标签中包含主机名 选项 
 | |
| 在会话ID标签中包含自定义字符串 | |
| 设置持久日志参数 | |
| 设置写入持久存储的批次大小(4096-2142715904) | |
| 设置单个日志文件的大小(4096-2142715904) | |
| 立即将日志条目写入存储(无缓冲)。 选项 
 | |
| 在激活show logging [persistent]时发出通知。 选项 
 | |
| 消除对logging-persistent文件的操作。 选项 
 | |
| 设置用于写入日志消息的磁盘空间(4096-2142715904) | |
| 设置持久日志的阈值 | |
| 存储日志消息的URL | |
| 防火墙配置 | |
| (0-3600) 秒,默认为30秒。 | |
| 设置日志记录器消息队列大小 | |
| (100-2147483647) 设置新的队列大小 | |
| (100-2147483647) 设置新的队列大小 | |
| (100-2147483647) 设置新的队列大小 | |
| 设置每秒消息限制 | |
| (1-10000) 每秒消息数 选项 
 | |
| (1-10000) 每秒消息数 选项 
 | |
| 此严重性或更高严重性的消息 选项 
 | |
| (1-10000) 每秒消息数 | |
| 设置重新加载日志级别 | |
| 消息数量(1-4294967295) | |
| 日志严重性级别 对于值“debugging”,此属性不保持幂等性,因为此值未显示在运行配置中。 选项 
 | |
| 在第一次配置时启用为syslog服务器发送ARP请求 选项 
 | |
| 设置用于发送snmp陷阱的syslog级别 选项 
 | |
| 指定日志记录事务中源地址的接口 | |
| 带有编号的接口名称 | |
| VPN路由/转发实例名称 | |
| 设置syslog服务器日志级别 选项 
 | |
| 启用在启用特权模式时记录用户信息 选项 
 | |
| 此选项仅与状态 *parsed* 一起使用。 此选项的值应是从IOS设备执行命令 **show running-config | include logging** 收到的输出。 状态 *parsed* 从  | |
| 配置应保留的状态 使用状态 *replaced*,对于列出的日志配置,这些配置位于运行配置中并且可以具有多个命令集,但不在任务中则被否定。 使用状态 *overridden*,所有在运行配置中但在任务中不存在的配置都将被否定。 请参阅示例了解更多详细信息。 选项 
 | 
注释
注意
- 已在CML上的Cisco IOSXE 17.3版本上进行了测试。 
- 此模块适用于连接 - network_cli。 请参见 https://docs.ansible.org.cn/ansible/latest/network/user_guide/platform_ios.html
- Cisco IOS网络设备的配置默认值可能会妨碍play的幂等行为。 
示例
# Using state: merged
# Before state:
# -------------
# router-ios#show running-config | section logging
# no logging exception
# no logging buffered
# no logging reload
# no logging rate-limit
# no logging console
# no logging monitor
# no logging cns-events
# no logging trap
- name: Apply the provided configuration
  cisco.ios.ios_logging_global:
    config:
      buffered:
        severity: notifications
        size: 5099
        xml: true
      console:
        severity: critical
        xml: true
      facility: local5
      hosts:
        - hostname: 172.16.1.12
        - hostname: 172.16.1.11
          xml: true
        - hostname: 172.16.1.10
          filtered: true
          stream: 10
        - hostname: 172.16.1.13
          transport:
            tcp:
              port: 514
      monitor:
        severity: warnings
      message_counter: log
      snmp_trap:
        - errors
      trap: errors
      userinfo: true
      policy_firewall:
        rate_limit: 10
      logging_on: enable
      exception: 4099
      dmvpn:
        rate_limit: 10
      cns_events: warnings
    state: merged
# Commands Fired:
# ---------------
# "commands": [
#       "logging buffered xml 5099 notifications",
#       "logging cns-events warnings",
#       "logging console xml critical",
#       "logging dmvpn rate-limit 10",
#       "logging exception 4099",
#       "logging facility local5",
#       "logging monitor warnings",
#       "logging on",
#       "logging policy-firewall rate-limit 10",
#       "logging trap errors",
#       "logging userinfo",
#       "logging host 172.16.1.12",
#       "logging host 172.16.1.10 filtered stream 10",
#       "logging host 172.16.1.13 transport tcp port 514",
#       "logging message-counter log",
#       "logging snmp-trap errors",
#       "logging host 172.16.1.11 xml"
#     ],
# After state:
# ------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging snmp-trap warnings
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# Using state: deleted
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
- name: Remove all existing configuration
  cisco.ios.ios_logging_global:
    state: deleted
# Commands Fired:
# ---------------
# "commands": [
#       "no logging message-counter log",
#       "no logging snmp-trap errors",
#       "no logging host 172.16.1.13",
#       "no logging host 172.16.1.11",
#       "no logging host 172.16.1.12",
#       "no logging host 172.16.1.10",
#       "no logging exception 4099",
#       "no logging userinfo",
#       "no logging buffered xml 5099 notifications",
#       "no logging console xml critical",
#       "no logging monitor warnings",
#       "no logging cns-events warnings",
#       "no logging policy-firewall rate-limit 10",
#       "no logging dmvpn rate-limit 10",
#       "no logging trap errors",
#       "no logging facility local5"
#     ],
# After state:
# ------------
# router-ios#show running-config | section logging
# no logging exception
# no logging buffered
# no logging reload
# no logging rate-limit
# no logging console
# no logging monitor
# no logging cns-events
# no logging trap
# Using state: overridden
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered 6000 critical
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local6
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.25 filtered
- name: Override commands with provided configuration
  cisco.ios.ios_logging_global:
    config:
      hosts:
        - hostname: 172.16.1.27
          filtered: true
    state: overridden
# Commands Fired:
# ---------------
# "commands": [
#         "no logging message-counter log",
#         "no logging host 172.16.1.12",
#         "no logging host 172.16.1.10",
#         "no logging host 172.16.1.13",
#         "no logging exception 4099",
#         "no logging userinfo",
#         "no logging console xml critical",
#         "no logging monitor warnings",
#         "no logging cns-events warnings",
#         "no logging policy-firewall rate-limit 10",
#         "no logging dmvpn rate-limit 10",
#         "no logging trap errors",
#         "no logging buffered 6000 critical",
#         "no logging facility local6",
#         "logging host 172.16.1.27 filtered",
#     ],
# After state:
# ------------
# router-ios#show running-config | section logging
# no logging exception
# no logging buffered
# no logging reload
# no logging rate-limit
# no logging console
# no logging monitor
# no logging cns-events
# no logging trap
# logging host 172.16.1.27 filtered
# Using state: replaced
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
- name: Replace commands with provided configuration
  cisco.ios.ios_logging_global:
    config:
      buffered:
        severity: alerts
        size: 6025
      facility: local6
      hosts:
        - hostname: 172.16.1.19
        - hostname: 172.16.1.10
          filtered: true
          stream: 15
    state: replaced
# Commands Fired:
# ---------------
# "commands": [
#         "no logging host 172.16.1.13",
#         "no logging host 172.16.1.11",
#         "no logging host 172.16.1.12",
#         "no logging host 172.16.1.10",
#         "logging host 172.16.1.19",
#         "logging host 172.16.1.10 filtered stream 15",
#         "logging buffered 6025 alerts",
#         "logging facility local6"
#     ],
# After state:
# ------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered 6025 alerts
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local6
# logging snmp-trap errors
# logging host 172.16.1.19
# Using state: gathered
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.25 filtered
- name: Gather listed logging config
  cisco.ios.ios_logging_global:
    state: gathered
# Module Execution Result:
# ------------------------
# "gathered": {
#     "buffered": {
#         "severity": "notifications",
#         "size": 5099,
#         "xml": true
#     },
#     "cns_events": "warnings",
#     "console": {
#         "severity": "critical",
#         "xml": true
#     },
#     "dmvpn": {
#         "rate_limit": 10
#     },
#     "exception": 4099,
#     "facility": "local5",
#     "hosts": [
#         {
#             "hostname": "172.16.1.11",
#             "xml": true
#         },
#         {
#             "hostname": "172.16.1.12"
#         },
#         {
#             "filtered": true,
#             "hostname": "172.16.1.10",
#             "stream": 10
#         },
#         {
#             "hostname": "172.16.1.13",
#             "transport": {
#                 "tcp": {
#                     "port": 514
#                 }
#             }
#         },
#         {
#             "filtered": true,
#             "hostname": "172.16.1.25"
#         }
#     ],
#     "message_counter": [
#         "log"
#     ],
#     "monitor": {
#         "severity": "warnings"
#     },
#     "policy_firewall": {
#         "rate_limit": 10
#     },
#     "snmp_trap": [
#         "errors"
#     ],
#     "trap": "errors",
#     "userinfo": true
# },
# After state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.25 filtered
# Using state: rendered
- name: Render the commands for provided configuration
  cisco.ios.ios_logging_global:
    config:
      buffered:
        severity: notifications
        size: 5099
        xml: true
      console:
        severity: critical
        xml: true
      facility: local5
      hosts:
        - hostname: 172.16.1.12
        - hostname: 172.16.1.11
          xml: true
        - hostname: 172.16.1.10
          filtered: true
          stream: 10
        - hostname: 172.16.1.13
          transport:
            tcp:
              port: 514
      monitor:
        severity: warnings
      message_counter: log
      snmp_trap: errors
      trap: errors
      userinfo: true
      policy_firewall:
        rate_limit: 10
      logging_on: enable
      exception: 10
      dmvpn:
        rate_limit: 10
      cns_events: warnings
    state: rendered
# Module Execution Result:
# ------------------------
# "rendered": [
#     "logging host 172.16.1.12",
#     "logging host 172.16.1.11 xml",
#     "logging host 172.16.1.10 filtered stream 10",
#     "logging host 172.16.1.13 transport tcp port 514",
#     "logging message-counter log",
#     "logging snmp-trap errors",
#     "logging buffered xml 5099 notifications",
#     "logging console xml critical",
#     "logging facility local5",
#     "logging monitor warnings",
#     "logging trap errors",
#     "logging userinfo",
#     "logging policy-firewall rate-limit 10",
#     "logging on",
#     "logging exception 10",
#     "logging dmvpn rate-limit 10",
#     "logging cns-events warnings"
#     ]
# Using state: parsed
# File: parsed.cfg
# ----------------
# logging on
# logging count
# logging userinfo
# logging trap errors
# logging reload alerts
# logging host 172.16.1.1
# logging exception 4099
# logging history alerts
# logging facility local5
# logging snmp-trap errors
# logging monitor warnings
# logging origin-id hostname
# logging host 172.16.1.11 xml
# logging cns-events warnings
# logging dmvpn rate-limit 10
# logging message-counter log
# logging console xml critical
# logging message-counter debug
# logging persistent batch 4444
# logging host 172.16.1.25 filtered
# logging source-interface GBit1/0
# logging source-interface CTunnel2
# logging policy-firewall rate-limit 10
# logging buffered xml 5099 notifications
# logging rate-limit all 2 except warnings
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.13 transport tcp port 514
# logging discriminator msglog01 severity includes 5
# logging filter tftp://172.16.2.18/ESM/elate.tcl args TESTInst2
# logging filter tftp://172.16.2.14/ESM/escalate.tcl args TESTInst
- name: Parse the provided configuration with the existing running configuration
  cisco.ios.ios_logging_global:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed
# Module Execution Result:
# ------------------------
# "parsed": {
#     "buffered": {
#         "severity": "notifications",
#         "size": 5099,
#         "xml": true
#     },
#     "cns_events": "warnings",
#     "console": {
#         "severity": "critical",
#         "xml": true
#     },
#     "count": true,
#     "discriminator": [
#         "msglog01 severity includes 5"
#     ],
#     "dmvpn": {
#         "rate_limit": 10
#     },
#     "exception": 4099,
#     "facility": "local5",
#     "filter": [
#         {
#             "args": "TESTInst2",
#             "url": "tftp://172.16.2.18/ESM/elate.tcl"
#         },
#         {
#             "args": "TESTInst",
#             "url": "tftp://172.16.2.14/ESM/escalate.tcl"
#         }
#     ],
#     "history": {
#         "severity": "alerts"
#     },
#     "hosts": [
#         {
#             "hostname": "172.16.1.1"
#         },
#         {
#             "hostname": "172.16.1.11",
#             "xml": true
#         },
#         {
#             "filtered": true,
#             "hostname": "172.16.1.25"
#         },
#         {
#             "filtered": true,
#             "hostname": "172.16.1.10",
#             "stream": 10
#         },
#         {
#             "hostname": "172.16.1.13",
#             "transport": {
#                 "tcp": {
#                     "port": 514
#                 }
#             }
#         }
#     ],
#     "logging_on": "enable",
#     "message_counter": [
#         "log",
#         "debug"
#     ],
#     "monitor": {
#         "severity": "warnings"
#     },
#     "origin_id": {
#         "tag": "hostname"
#     },
#     "persistent": {
#         "batch": 4444
#     },
#     "policy_firewall": {
#         "rate_limit": 10
#     },
#     "rate_limit": {
#         "all": true,
#         "except_severity": "warnings",
#         "size": 2
#     },
#     "reload": {
#         "severity": "alerts"
#     },
#     "snmp_trap": [
#         "errors"
#     ],
#     "source_interface": [
#         {
#             "interface": "GBit1/0"
#         },
#         {
#             "interface": "CTunnel2"
#         }
#     ],
#     "trap": "errors",
#     "userinfo": true
# }
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段:
| 键 | 描述 | 
|---|---|
| 生成的配置模型调用。 返回值:发生更改时 示例:  | |
| 模型调用之前的配置。 返回值:始终返回 示例:  | |
| 推送到远程设备的命令集。 返回值:始终返回 示例:  | 
