Syslog

Location in GUI: Admin » External Data Collectors » Monitoring Destinations » Syslog

Diagram

Classes

monitoring (apic.fabric_policies)

Name	Type	Constraint	Mandatory	Default Value
syslogs	List	`[syslogs]`	No

syslogs (apic.fabric_policies.monitoring)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
audit	Boolean	`true`, `false`	No	`true`
events	Boolean	`true`, `false`	No	`true`
faults	Boolean	`true`, `false`	No	`true`
session	Boolean	`true`, `false`	No	`false`
minimum_severity	Choice	`emergencies`, `alerts`, `critical`, `errors`, `warnings`, `notifications`, `information`, `debugging`	No	`warnings`
admin_state	Boolean	`true`, `false`	No	`true`
format	Choice	`aci`, `nxos`, `enhanced-log`	No	`aci`
show_millisecond	Boolean	`true`, `false`	No	`false`
show_timezone	Boolean	`true`, `false`	No	`false`
local_admin_state	Boolean	`true`, `false`	No	`true`
local_severity	Choice	`emergencies`, `alerts`, `critical`, `errors`, `warnings`, `notifications`, `information`, `debugging`	No	`information`
console_admin_state	Boolean	`true`, `false`	No	`true`
console_severity	Choice	`emergencies`, `alerts`, `critical`, `errors`, `warnings`, `notifications`, `information`, `debugging`	No	`alerts`
destinations	List	`[destinations]`	No

destinations (apic.fabric_policies.monitoring.syslogs)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
hostname_ip	Any	String[Regex: `^[a-zA-Z0-9:][a-zA-Z0-9.:-]{0,254}$`] or IP	Yes
protocol	Choice	`udp`, `tcp`, `ssl`	No
port	Integer	min: `1`, max: `65535`	No	`514`
admin_state	Boolean	`true`, `false`	No	`true`
facility	Choice	`local0`, `local1`, `local2`, `local3`, `local4`, `local5`, `local6`, `local7`	No	`local7`
severity	Choice	`emergencies`, `alerts`, `critical`, `errors`, `warnings`, `notifications`, `information`, `debugging`	No	`warnings`
mgmt_epg	Choice	`inb`, `oob`	No	`inb`

Examples

Example-1: This data model creates a syslog policy named syslog_policy_simple. The policy has a single syslog destination server defined using an IP address over udp/514 (udp is default). The log messages that have a severity level of warning or higher for facility local7 will be sent to syslog server using the oob management EPG.

apic:
  fabric_policies:
    monitoring:
      syslogs:
        - name: syslog_policy_simple
          description: Simple Syslog Example
          destinations:
            - hostname_ip: 10.0.0.100
              name: syslog_server_1
              port: 514
              facility: local7
              severity: warnings
              mgmt_epg: oob

Example-2: This data model creates a syslog policy named syslog_policy_advanced. The policy has a single syslog destination server defined using an FQDN over tcp/1468. The log messages that have a severity level of information or higher for facility local7 will be sent to syslog server using the inb management epg. The log format is configured to use the nxos log format with timestamps that include milliseconds and show the timezone. This policy also disables alerts on the console.

apic:
  fabric_policies:
    monitoring:
      syslogs:
        - name: syslog_policy_advanced
          description: Advanced Syslog Example
          format: nxos
          show_millisecond: true
          show_timezone: true
          console_admin_state: false
          destinations:
            - hostname_ip: syslogserver.example.com
              name: syslog_server_2
              protocol: tcp
              port: 1468
              facility: local7
              severity: information
              mgmt_epg: inb