module ietf-syslog {
namespace "urn:ietf:params:xml:ns:yang:ietf-syslog";
prefix syslog;
import ietf-inet-types {
prefix inet;
}
import ietf-interfaces {
prefix if;
}
import ietf-syslog-types {
prefix syslogtypes;
}
organization "IETF NETMOD (NETCONF Data Modeling Language)
Working Group";
contact
"WG Web:
WG List:
WG Chair: Tom Nadeau
WG Chair: Kent Watsen
Editor: Ladislav Lhotka
";
description
"This module contains a collection of YANG definitions
for Syslog configuration.";
revision 2015-11-09 {
description
"Initial Revision";
reference
"RFC 5424: The Syslog Protocol
RFC 5848: Signed Syslog Messages";
}
feature buffer-limit-bytes {
description
"This feature indicates that local memory logging buffers
are limited in size using a limit expressed in bytes.";
}
feature buffer-limit-messages {
description
"This feature indicates that local memory logging buffers
are limited in size using a limit expressed in number
of messages.";
}
feature structured-data-config {
description
"This feature represents the ability to log messages
in structured-data format as per RFC 5424.";
}
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 terminal-facility-user-logging-config {
description
"This feature represents the ability to adjust
log message settings for individual terminal
devices.";
}
feature session-facility-user-logging-config {
description
"This feature represents the ability to adjust
log message settings for individual user sessions.";
}
feature selector-severity-operator-config {
description
"This feature represents the ability to select messages
using the additional operators equal to, or not equal to
when comparing the Syslog message severity.";
}
feature selector-match-processing-config {
description
"This feature represents the ability to select messages based
on a Posix 1003.2 regular expression pattern match.";
}
feature signed-messages-config {
description
"This feature represents the ability to configure signed
syslog messages according to RFC 5848.";
}
grouping syslog-severity {
description
"This grouping defines the Syslog severity which is used to
select log messages.";
leaf severity {
type union {
type syslogtypes:severity;
type enumeration {
enum all {
value -1;
description
"This enum describes the case where all severities
are requested.";
}
enum none {
value -2;
description
"This enum describes the case where no severities
are requested.";
}
}
}
mandatory true;
description
"This leaf specifies the Syslog message severity. When
severity is specified, the default severity comparison
is all messages of the specified severity and greater are
logged. 'all' is a special case which means all severities
are requested. 'none' is a special case which means that
no severity selection should occur.";
}
leaf severity-operator {
if-feature selector-severity-operator-config;
type enumeration {
enum equals-or-higher {
description
"This enum specifies all messages of the specified
severity and higher are logged according to the
given log-action";
}
enum equals {
description
"This enum specifies all messages that are for
the specified severity are logged according to the
given log-action";
}
enum not-equals {
description
"This enum specifies all messages that are not for
the specified severity are logged according to the
given log-action";
}
}
default equals-or-higher;
description
"This leaf describes the option to specify how the
severity comparison is performed.";
}
}
grouping syslog-selector {
description
"This grouping defines a Syslog selector which is used to
select log messages for the log-action (buffer, file,
etc). Choose one of the following:
no-log-facility
log-facility [ ...]";
container log-selector {
description
"This container describes the log selector parameters
for Syslog.";
choice selector-facility {
mandatory true;
description
"This choice describes the option to specify no
facilities, or a specific facility which can be
all for all facilities.";
case no-log-facility {
description
"This case specifies no facilities will match when
comparing the Syslog message facility. This is a
method that can be used to effectively disable a
particular log-action (buffer, file, etc).";
leaf no-facilities {
type empty;
description
"This leaf specifies that no facilities are selected
for this log-action.";
}
}
case log-facility {
description
"This case specifies one or more specified facilities
will match when comparing the Syslog message facility.";
list log-facility {
key facility;
description
"This list describes a collection of Syslog
facilities and severities.";
leaf facility {
type union {
type identityref {
base syslogtypes: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 syslog-severity;
}
}
}
leaf pattern-match {
if-feature selector-match-processing-config;
type string;
description
"This leaf desribes a Posix 1003.2 regular expression
string that can be used to select a Syslog message for
logging. The match is performed on the RFC 5424
SYSLOG-MSG field.";
}
}
}
container syslog {
description
"This container describes the configuration parameters for
Syslog.";
container log-actions {
description
"This container describes the log-action parameters
for Syslog.";
container console {
presence "Enables logging console configuration";
description
"This container describes the configuration parameters for
console logging.";
uses syslog-selector;
}
container buffer {
description
"This container describes the configuration parameters for
local memory buffer logging. The buffer is circular in
nature, so newer messages overwrite older messages after
the buffer is filled.";
list log-buffer {
key name;
description
"This list describes a collection of local logging
memory buffers.";
leaf name {
type string;
description
"This leaf specifies the name of the log buffer.";
}
uses syslog-selector;
leaf buffer-size-bytes {
if-feature buffer-limit-bytes;
type uint64;
units "bytes";
description
"This leaf configures the amount of memory
(in bytes) that will be dedicated to the local
memory logging buffer. The default value varies
by implementation.";
}
leaf buffer-size-messages {
if-feature buffer-limit-messages;
type uint64;
units "log messages";
description
"This leaf configures the amount number of log
messages that can be stored in the local memory
logging buffer. The default value varies by
implementation.";
}
}
}
container file {
description
"This container describes the configuration parameters for
file logging.";
list log-file {
key "name";
description
"This list describes a collection of local logging
files.";
leaf name {
type inet:uri;
description
"This leaf specifies the name of the log file which
MUST use the uri scheme file:.";
}
uses syslog-selector;
leaf structured-data {
if-feature structured-data-config;
type boolean;
default false;
description
"This leaf describes how log messages are written to
the log file. If true, messages will be written
with one or more STRUCTURED-DATA elements as per
RFC5424; if false, messages will be written with
STRUCTURED-DATA = NILVALUE.";
}
container file-archive {
description
"This container describes the configuration
parameters for log file archiving.";
leaf number-of-files {
if-feature file-limit-size;
type uint32;
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 uint64;
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 uint16;
units "hours";
description
"This leaf specifies the length of time that
completed/closed log event files should be stored
in the file system before they are deleted.";
}
}
}
}
container remote {
description
"This container describes the configuration parameters for
remote logging.";
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 tcp {
container tcp {
description
"This container describes the TCP transport
options.";
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 udp {
container udp {
description
"This container describes the UDP transport
options.";
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.";
}
}
}
}
uses syslog-selector;
leaf destination-facility {
type identityref {
base syslogtypes:syslog-facility;
}
default syslogtypes:local7;
description
"This leaf specifies the facility used in messages
delivered to the remote server.";
}
leaf source-interface {
type if:interface-ref;
description
"This leaf sets the source interface for the remote
Syslog server. Either the interface name or the
interface IP address can be specified. If not set,
messages sent to a remote syslog server will
contain the IP address of the interface the syslog
message uses to exit the network element";
}
container syslog-sign {
if-feature signed-messages-config;
presence
"If present, syslog-sign is activated.";
description
"This container describes the configuration
parameters for signed syslog messages as described
by RFC 5848.";
reference
"RFC 5848: Signed Syslog Messages";
leaf cert-initial-repeat {
type uint16;
mandatory true;
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 uint16;
mandatory true;
description
"This leaf specifies the maximum time delay in
seconds until resending the Certificate Block.";
}
leaf cert-resend-count {
type uint16;
mandatory true;
description
"This leaf specifies the maximum number of other
syslog messages to send until resending the
Certificate Block.";
}
leaf sig-max-delay {
type uint16;
mandatory true;
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 uint16;
mandatory true;
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 [RFC5426] is used.).";
}
leaf sig-resend-delay {
type uint16;
mandatory true;
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 uint16;
mandatory true;
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.";
}
}
}
}
container terminal {
description
"This container describes the configuration parameters for
the terminal logging configuration.";
choice terminal-scope {
mandatory true;
description
"This choice describes the option to specify all
terminals or a specific terminal. The all terminals
case implies that messages will be sent to all
sessions on that terminal";
case all-terminals {
description
"This case specifies all terminals.";
container all-terminals {
description
"This container describes the configuration
parameters for all terminals.";
uses syslog-selector;
}
}
case per-terminal {
if-feature terminal-facility-user-logging-config;
description
"This case specifies one or more terminals.";
list device-name {
key "dname";
description
"This list describes a collection of device names.";
leaf dname {
type string;
description
"This leaf uniquely describes a device name which
is the device to receive log messages.";
}
uses syslog-selector;
}
}
}
}
container session {
description
"This container describes the configuration parameters for
session logging configuration.";
choice user-scope {
mandatory true;
description
"This choice describes the option to specify all users
or a specific user. The all users case implies that
messages will be sent to all sessions";
case all-users {
description
"This case specifies all users.";
container all-users {
description
"This container describes the configuration
parameters for all users.";
uses syslog-selector;
}
}
case per-user {
if-feature session-facility-user-logging-config;
description
"This case specifies a specific user.";
list user-name {
key "uname";
description
"This list describes a collection of user names.";
leaf uname {
type string;
description
"This leaf uniquely describes a user name which
is the login name of the user whose session
is to receive log messages.";
}
uses syslog-selector;
}
}
}
}
}
}
}