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

Simple example:

apic:
  fabric_policies:
    monitoring:
      syslogs:
        - name: syslog1
          destinations:
            - hostname_ip: 2.2.2.2

Full example:

apic:
  fabric_policies:
    monitoring:
      syslogs:
        - name: syslog1
          description: desc1
          admin_state: false
          format: nxos
          show_millisecond: true
          show_timezone: true
          local_admin_state: false
          local_severity: emergencies
          console_admin_state: false
          console_severity: alerts
          destinations:
            - hostname_ip: 2.2.2.2
              name: dest1
              protocol: tcp
              port: 1234
              admin_state: false
              facility: local0
              severity: emergencies
              mgmt_epg: inb
            - hostname_ip: 2.2.2.3