Logging

Logging provides comprehensive event recording and monitoring capabilities that capture, categorize, and distribute system messages based on configurable severity levels from emergency to debugging. It supports multiple output destinations including console, buffer, file storage, and remote syslog servers with flexible transport options including UDP, TCP, and secure TLS connections. Logging configuration enables centralized log collection, real-time monitoring, forensic analysis, and compliance reporting by providing detailed visibility into device operations, security events, and network behavior patterns.

Diagram

Classes

configuration (iosxe.devices)

Name	Type	Constraint	Mandatory	Default Value
logging	Class	`[logging]`	No

logging (iosxe.devices.configuration)

Name	Type	Constraint	Mandatory
monitor_severity	String		No
buffered_size	Integer	min: `4096`, max: `2147483647`	No
buffered_severity	String		No
console_severity	String		No
facility	Choice	`auth`, `cron`, `daemon`, `kern`, `local0`, `local1`, `local2`, `local3`, `local4`, `local5`, `local6`, `local7`, `lpr`, `mail`, `news`, `sys10`, `sys11`, `sys12`, `sys13`, `sys14`, `sys9`, `syslog`, `user`, `uucp`	No
history_size	Integer	min: `0`, max: `65535`	No
history_severity	String		No
trap	Boolean	`true`, `false`	No
trap_severity	String		No
origin_id_type	Choice	`hostname`, `ip`, `ipv6`	No
origin_id_name	String		No
file_name	String		No
file_max_size	Integer	min: `0`, max: `4294967295`	No
file_min_size	Integer	min: `0`, max: `4294967295`	No
file_severity	String		No
source_interface_type	Choice	`Loopback`, `Vlan`, `GigabitEthernet`, `TwoGigabitEthernet`, `FiveGigabitEthernet`, `TenGigabitEthernet`, `TwentyFiveGigabitEthernet`, `FortyGigabitEthernet`, `HundredGigabitEthernet`	No
source_interface_id	String		No
source_interfaces_vrf	List	`[source_interfaces_vrf]`	No
hosts	List	`[hosts]`	No

source_interfaces_vrf (iosxe.devices.configuration.logging)

Name	Type	Constraint	Mandatory
vrf	String		Yes
interface_type	Choice	`Loopback`, `Vlan`, `GigabitEthernet`, `TwoGigabitEthernet`, `FiveGigabitEthernet`, `TenGigabitEthernet`, `TwentyFiveGigabitEthernet`, `FortyGigabitEthernet`, `HundredGigabitEthernet`	No
interface_id	String		No

hosts (iosxe.devices.configuration.logging)

Name	Type	Constraint	Mandatory
ip	IP		Yes
vrf	String		No
transport_udp_ports	List	Integer[min: `1`, max: `65535`]	No
transport_tcp_ports	List	Integer[min: `1`, max: `65535`]	No
transport_tls_ports	List	`[transport_tls_ports]`	No

transport_tls_ports (iosxe.devices.configuration.logging.hosts)

Name	Type	Constraint	Mandatory	Default Value
port	Integer	min: `1025`, max: `65535`	Yes
profile	String		No

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        logging:
          monitor_severity: informational
          buffered_size: 16000
          buffered_severity: informational
          console_severity: warnings
          facility: local0
          history_size: 100
          history_severity: informational
          trap: true
          trap_severity: informational
          origin_id_type: hostname
          origin_id_name: CORE-SW-01
          source_interface_type: Loopback
          source_interface_id: "0"
          file_name: device-logs.txt
          file_max_size: 1000000
          file_severity: debugging
          source_interfaces_vrf:
            - vrf: MGMT
              interface_type: Vlan
              interface_id: "100"
          hosts:
            - ip: 2001::1
              transport_udp_ports:
                - 514
                - 10000
              transport_tcp_ports:
                - 10001
                - 10003
              transport_tls_ports:
                - port: 6514
                  profile: TLS-PROFILE-1
            - ip: 192.168.5.24
              vrf: MGMT
              transport_udp_ports:
                - 514