module ietf-syslog {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-syslog";
prefix syslog;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: INET Types Model";
}
import ietf-interfaces {
prefix if;
reference
"RFC 7223: Interfaces Model";
}
import ietf-tls-client {
prefix tlsc;
reference
"I-D.ietf-netconf-tls-client-server:
TLS Client and Server Models";
}
import ietf-keystore {
prefix ks;
reference
"I-D.ietf-netconf-keystore: Keystore Model";
}
organization
"IETF NETMOD (Network Modeling) Working Group";
contact
"WG Web:
WG List:
Editor: Kiran Agrahara Sreenivasa
Editor: Clyde Wildes
";
description
"This module contains a collection of YANG definitions
for syslog configuration.
Copyright (c) 2018 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as
described in RFC 2119 (http://tools.ietf.org/html/rfc2119).
This version of this YANG module is part of RFC zzzz
(http://tools.ietf.org/html/rfczzzz); see the RFC itself for
full legal notices.";
revision 2018-02-21 {
description
"Initial Revision";
reference
"RFC zzzz: Syslog YANG Model";
}
feature console-action {
description
"This feature indicates that the local console action is
supported.";
}
feature file-action {
description
"This feature indicates that the local file action is
supported.";
}
feature file-limit-size {
description
"This feature indicates that file logging resources
are managed using size and number limits.";
}
feature file-limit-duration {
description
"This feature indicates that file logging resources
are managed using time based limits.";
}
feature remote-action {
description
"This feature indicates that the remote server action is
supported.";
}
feature remote-source-interface {
description
"This feature indicates that source-interface is supported
supported for the remote-action.";
}
feature select-adv-compare {
description
"This feature represents the ability to select messages
using the additional comparison operators when comparing
the syslog message severity.";
}
feature select-match {
description
"This feature represents the ability to select messages
based on a Posix 1003.2 regular expression pattern match.";
}
feature structured-data {
description
"This feature represents the ability to log messages
in structured-data format.";
reference
"RFC 5424: The Syslog Protocol";
}
feature signed-messages {
description
"This feature represents the ability to configure signed
syslog messages.";
reference
"RFC 5848: Signed Syslog Messages";
}
typedef syslog-severity {
type enumeration {
enum "emergency" {
value 0;
description
"The severity level 'Emergency' indicating that the
system is unusable.";
}
enum "alert" {
value 1;
description
"The severity level 'Alert' indicating that an action
must be taken immediately.";
}
enum "critical" {
value 2;
description
"The severity level 'Critical' indicating a critical
condition.";
}
enum "error" {
value 3;
description
"The severity level 'Error' indicating an error
condition.";
}
enum "warning" {
value 4;
description
"The severity level 'Warning' indicating a warning
condition.";
}
enum "notice" {
value 5;
description
"The severity level 'Notice' indicating a normal but
significant condition.";
}
enum "info" {
value 6;
description
"The severity level 'Info' indicating an informational
message.";
}
enum "debug" {
value 7;
description
"The severity level 'Debug' indicating a debug-level
message.";
}
}
description
"The definitions for Syslog message severity.";
reference
"RFC 5424: The Syslog Protocol";
}
identity syslog-facility {
description
"This identity is used as a base for all syslog facilities.";
reference
"RFC 5424: The Syslog Protocol";
}
identity kern {
base syslog-facility;
description
"The facility for kernel messages (0).";
reference
"RFC 5424: The Syslog Protocol";
}
identity user {
base syslog-facility;
description
"The facility for user-level messages (1).";
reference
"RFC 5424: The Syslog Protocol";
}
identity mail {
base syslog-facility;
description
"The facility for the mail system (2).";
reference
"RFC 5424: The Syslog Protocol";
}
identity daemon {
base syslog-facility;
description
"The facility for the system daemons (3).";
reference
"RFC 5424: The Syslog Protocol";
}
identity auth {
base syslog-facility;
description
"The facility for security/authorization messages (4).";
reference
"RFC 5424: The Syslog Protocol";
}
identity syslog {
base syslog-facility;
description
"The facility for messages generated internally by syslogd
facility (5).";
reference
"RFC 5424: The Syslog Protocol";
}
identity lpr {
base syslog-facility;
description
"The facility for the line printer subsystem (6).";
reference
"RFC 5424: The Syslog Protocol";
}
identity news {
base syslog-facility;
description
"The facility for the network news subsystem (7).";
reference
"RFC 5424: The Syslog Protocol";
}
identity uucp {
base syslog-facility;
description
"The facility for the UUCP subsystem (8).";
reference
"RFC 5424: The Syslog Protocol";
}
identity cron {
base syslog-facility;
description
"The facility for the clock daemon (9).";
reference
"RFC 5424: The Syslog Protocol";
}
identity authpriv {
base syslog-facility;
description
"The facility for privileged security/authorization messages
(10).";
reference
"RFC 5424: The Syslog Protocol";
}
identity ftp {
base syslog-facility;
description
"The facility for the FTP daemon (11).";
reference
"RFC 5424: The Syslog Protocol";
}
identity ntp {
base syslog-facility;
description
"The facility for the NTP subsystem (12).";
reference
"RFC 5424: The Syslog Protocol";
}
identity audit {
base syslog-facility;
description
"The facility for log audit messages (13).";
reference
"RFC 5424: The Syslog Protocol";
}
identity console {
base syslog-facility;
description
"The facility for log alert messages (14).";
reference
"RFC 5424: The Syslog Protocol";
}
identity cron2 {
base syslog-facility;
description
"The facility for the second clock daemon (15).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local0 {
base syslog-facility;
description
"The facility for local use 0 messages (16).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local1 {
base syslog-facility;
description
"The facility for local use 1 messages (17).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local2 {
base syslog-facility;
description
"The facility for local use 2 messages (18).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local3 {
base syslog-facility;
description
"The facility for local use 3 messages (19).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local4 {
base syslog-facility;
description
"The facility for local use 4 messages (20).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local5 {
base syslog-facility;
description
"The facility for local use 5 messages (21).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local6 {
base syslog-facility;
description
"The facility for local use 6 messages (22).";
reference
"RFC 5424: The Syslog Protocol";
}
identity local7 {
base syslog-facility;
description
"The facility for local use 7 messages (23).";
reference
"RFC 5424: The Syslog Protocol";
}
grouping severity-filter {
description
"This grouping defines the processing used to select
log messages by comparing syslog message severity using
the following processing rules:
- if 'none', do not match.
- if 'all', match.
- else compare message severity with the specified severity
according to the default compare rule (all messages of the
specified severity and greater match) or if the
select-adv-compare feature is present, the advance-compare
rule.";
leaf severity {
type union {
type syslog-severity;
type enumeration {
enum none {
value 2147483647;
description
"This enum describes the case where no severities
are selected.";
}
enum all {
value -2147483648;
description
"This enum describes the case where all severities
are selected.";
}
}
}
mandatory true;
description
"This leaf specifies the syslog message severity.";
}
container advanced-compare {
when '../severity != "all" and
../severity != "none"' {
description
"The advanced compare container is not applicable for
severity 'all' or severity 'none'";
}
if-feature select-adv-compare;
leaf compare {
type enumeration {
enum equals {
description
"This enum specifies that the severity comparison
operation will be equals.";
}
enum equals-or-higher {
description
"This enum specifies that the severity comparison
operation will be equals or higher.";
}
}
default equals-or-higher;
description
"The compare can be used to specify the comparison
operator that should be used to compare the syslog message
severity with the specified severity.";
}
leaf action {
type enumeration {
enum log {
description
"This enum specifies that if the compare operation is
true the message will be logged.";
}
enum block {
description
"This enum specifies that if the compare operation is
true the message will not be logged.";
}
}
default log;
description
"The action can be used to spectify if the message should
be logged or blocked based on the outcome of the compare
operation.";
}
description
"This container describes additional severity compare
operations that can be used in place of the default
severity comparison. The compare leaf specifies the type of
the compare that is done and the action leaf specifies the
intended result.
Example: compare->equals and action->no-match means
messages that have a severity that is not equal to the
specified severity will be logged.";
}
}
grouping selector {
description
"This grouping defines a syslog selector which is used to
select log messages for the log-actions (console, file,
remote, etc.). Choose one or both of the following:
facility [ ...]
pattern-match regular-expression-match-string
If both facility and pattern-match are specified, both must
match in order for a log message to be selected.";
container facility-filter {
description
"This container describes the syslog filter parameters.";
list facility-list {
key "facility severity";
ordered-by user;
description
"This list describes a collection of syslog
facilities and severities.";
leaf facility {
type union {
type identityref {
base syslog-facility;
}
type enumeration {
enum all {
description
"This enum describes the case where all
facilities are requested.";
}
}
}
description
"The leaf uniquely identifies a syslog facility.";
}
uses severity-filter;
}
}
leaf pattern-match {
if-feature select-match;
type string;
description
"This leaf describes a Posix 1003.2 regular expression
string that can be used to select a syslog message for
logging. The match is performed on the SYSLOG-MSG field.";
reference
"RFC 5424: The Syslog Protocol
Std-1003.1-2008 Regular Expressions";
}
}
grouping structured-data {
description
"This grouping defines the syslog structured data option
which is used to select the format used to write log
messages.";
leaf structured-data {
if-feature structured-data;
type boolean;
default false;
description
"This leaf describes how log messages are written.
If true, messages will be written with one or more
STRUCTURED-DATA elements; if false, messages will be
written with STRUCTURED-DATA = NILVALUE.";
reference
"RFC 5424: The Syslog Protocol";
}
}
container syslog {
presence "Enables logging.";
description
"This container describes the configuration parameters for
syslog.";
container actions {
description
"This container describes the log-action parameters
for syslog.";
container console {
if-feature console-action;
presence "Enables logging to the console";
description
"This container describes the configuration parameters
for console logging.";
uses selector;
}
container file {
if-feature file-action;
description
"This container describes the configuration parameters for
file logging. If file-archive limits are not supplied, it
is assumed that the local implementation defined limits
will be used.";
list log-file {
key "name";
description
"This list describes a collection of local logging
files.";
leaf name {
type inet:uri {
pattern 'file:.*';
}
description
"This leaf specifies the name of the log file which
MUST use the uri scheme file:.";
}
uses selector;
uses structured-data;
container file-rotation {
description
"This container describes the configuration
parameters for log file rotation.";
leaf number-of-files {
if-feature file-limit-size;
type uint32;
default 1;
description
"This leaf specifies the maximum number of log
files retained. Specify 1 for implementations
that only support one log file.";
}
leaf max-file-size {
if-feature file-limit-size;
type uint32;
units "megabytes";
description
"This leaf specifies the maximum log file size.";
}
leaf rollover {
if-feature file-limit-duration;
type uint32;
units "minutes";
description
"This leaf specifies the length of time that log
events should be written to a specific log file.
Log events that arrive after the rollover period
cause the current log file to be closed and a new
log file to be opened.";
}
leaf retention {
if-feature file-limit-duration;
type uint32;
units "minutes";
description
"This leaf specifies the length of time that
completed/closed log event files should be stored
in the file system before they are removed.";
}
}
}
}
container remote {
if-feature remote-action;
description
"This container describes the configuration parameters
for forwarding syslog messages to remote relays or
collectors.";
list destination {
key "name";
description
"This list describes a collection of remote logging
destinations.";
leaf name {
type string;
description
"An arbitrary name for the endpoint to connect to.";
}
choice transport {
mandatory true;
description
"This choice describes the transport option.";
case udp {
container udp {
description
"This container describes the UDP transport
options.";
reference
"RFC 5426: Transmission of Syslog Messages over
UDP";
leaf address {
type inet:host;
description
"The leaf uniquely specifies the address of
the remote host. One of the following must be
specified: an ipv4 address, an ipv6 address,
or a host name.";
}
leaf port {
type inet:port-number;
default 514;
description
"This leaf specifies the port number used to
deliver messages to the remote server.";
}
}
}
case tls {
container tls {
description
"This container describes the TLS transport
options.";
reference
"RFC 5425: Transport Layer Security (TLS)
Transport Mapping for Syslog ";
leaf address {
type inet:host;
description
"The leaf uniquely specifies the address of
the remote host. One of the following must be
specified: an ipv4 address, an ipv6 address,
or a host name.";
}
leaf port {
type inet:port-number;
default 6514;
description
"TCP port 6514 has been allocated as the default
port for syslog over TLS.";
}
uses tlsc:tls-client-grouping;
}
}
}
uses selector;
uses structured-data;
leaf facility-override {
type identityref {
base syslog-facility;
}
description
"If specified, this leaf specifies the facility used
to override the facility in messages delivered to
the remote server.";
}
leaf source-interface {
if-feature remote-source-interface;
type if:interface-ref;
description
"This leaf sets the source interface to be used to
send messages to the remote syslog server. If not
set, messages can be sent on any interface.";
}
container signing {
if-feature signed-messages;
presence
"If present, syslog-signing options is activated.";
description
"This container describes the configuration
parameters for signed syslog messages.";
reference
"RFC 5848: Signed Syslog Messages";
container cert-signers {
description
"This container describes the signing certificate
configuration for Signature Group 0 which covers
the case for administrators who want all Signature
Blocks to be sent to a single destination.";
list cert-signer {
key "name";
description
"This list describes a collection of syslog
message signers.";
leaf name {
type string;
description
"This leaf specifies the name of the syslog
message signer.";
}
container cert {
uses ks:private-key-grouping;
uses ks:certificate-grouping;
description
"This is the certificate that is periodically
sent to the remote receiver. Selection of the
certificate also implicitly selects the private
key used to sign the syslog messages.";
}
leaf hash-algorithm {
type enumeration {
enum SHA1 {
value 1;
description
"This enum describes the SHA1 algorithm.";
}
enum SHA256 {
value 2;
description
"This enum describes the SHA256 algorithm.";
}
}
description
"This leaf describes the syslog signer hash
algorithm used.";
}
}
leaf cert-initial-repeat {
type uint32;
default 3;
description
"This leaf specifies the number of times each
Certificate Block should be sent before the first
message is sent.";
}
leaf cert-resend-delay {
type uint32;
units "seconds";
default 3600;
description
"This leaf specifies the maximum time delay in
seconds until resending the Certificate Block.";
}
leaf cert-resend-count {
type uint32;
default 0;
description
"This leaf specifies the maximum number of other
syslog messages to send until resending the
Certificate Block.";
}
leaf sig-max-delay {
type uint32;
units "seconds";
default 60;
description
"This leaf specifies when to generate a new
Signature Block. If this many seconds have
elapsed since the message with the first message
number of the Signature Block was sent, a new
Signature Block should be generated.";
}
leaf sig-number-resends {
type uint32;
default 0;
description
"This leaf specifies the number of times a
Signature Block is resent. (It is recommended to
select a value of greater than 0 in particular
when the UDP transport RFC 5426 is used.).";
}
leaf sig-resend-delay {
type uint32;
units "seconds";
default 5;
description
"This leaf specifies when to send the next
Signature Block transmission based on time. If
this many seconds have elapsed since the previous
sending of this Signature Block, resend it.";
}
leaf sig-resend-count {
type uint32;
default 0;
description
"This leaf specifies when to send the next
Signature Block transmission based on a count.
If this many other syslog messages have been
sent since the previous sending of this
Signature Block, resend it. A value of 0 means
that you don't resend based on the number of
messages.";
}
}
}
}
}
}
}
}