draft-ietf-netmod-syslog-model-17.txt   draft-ietf-netmod-syslog-model-18.txt 
NETMOD WG C. Wildes, Ed. NETMOD WG C. Wildes, Ed.
Internet-Draft Cisco Systems Inc. Internet-Draft Cisco Systems Inc.
Intended status: Standards Track K. Koushik, Ed. Intended status: Standards Track K. Koushik, Ed.
Expires: March 12, 2018 Verizon Wireless Expires: June 13, 2018 Verizon Wireless
September 08, 2017 December 12, 2017
A YANG Data Model for Syslog Configuration A YANG Data Model for Syslog Configuration
draft-ietf-netmod-syslog-model-17 draft-ietf-netmod-syslog-model-18
Abstract Abstract
This document defines a YANG data model for the configuration of a This document defines a YANG data model for the configuration of a
syslog process. It is intended this model be used by vendors who syslog process. It is intended this model be used by vendors who
implement syslog in their systems. implement syslog in their systems.
Editorial Note (To be removed by RFC Editor) Editorial Note (To be removed by RFC Editor)
This draft contains many placeholder values that need to be replaced This draft contains many placeholder values that need to be replaced
skipping to change at page 1, line 35 skipping to change at page 1, line 35
Artwork in this document contains shorthand references to drafts in Artwork in this document contains shorthand references to drafts in
progress. Please apply the following replacements: progress. Please apply the following replacements:
o "xxxx" --> the assigned RFC value for draft-ietf-netconf-keystore o "xxxx" --> the assigned RFC value for draft-ietf-netconf-keystore
o "yyyy" --> the assigned RFC value for draft-ietf-netconf-tls- o "yyyy" --> the assigned RFC value for draft-ietf-netconf-tls-
client-server client-server
o "zzzz" --> the assigned RFC value for this draft o "zzzz" --> the assigned RFC value for this draft
Status of This Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on June 13, 2018.
This Internet-Draft will expire on March 12, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents (http://trustee.ietf.org/
(https://trustee.ietf.org/license-info) in effect on the date of license-info) in effect on the date of publication of this document.
publication of this document. Please review these documents Please review these documents carefully, as they describe your rights
carefully, as they describe your rights and restrictions with respect and restrictions with respect to this document. Code Components
to this document. Code Components extracted from this document must extracted from this document must include Simplified BSD License text
include Simplified BSD License text as described in Section 4.e of as described in Section 4.e of the Trust Legal Provisions and are
the Trust Legal Provisions and are provided without warranty as provided without warranty as described in the Simplified BSD License.
described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4 1.3. Tree Diagram Notation . . . . . . . . . . . . . . . . . . 3
2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4 2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4
3. Design of the Syslog Model . . . . . . . . . . . . . . . . . 5 3. Design of the Syslog Model . . . . . . . . . . . . . . . . . . 4
3.1. Syslog Module . . . . . . . . . . . . . . . . . . . . . . 6 3.1. Syslog Module . . . . . . . . . . . . . . . . . . . . . . 6
4. Syslog YANG Module . . . . . . . . . . . . . . . . . . . . . 8 4. Syslog YANG Module . . . . . . . . . . . . . . . . . . . . . . 9
4.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . 8 4.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . . 9
5. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . 26 5. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . . 26
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 28 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 27
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 29 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 28
7.1. The YANG Module Names Registry . . . . . . . . . . . . . 29 7.1. The YANG Module Names Registry . . . . . . . . . . . . . . 28
8. Security Considerations . . . . . . . . . . . . . . . . . . . 29 8. Security Considerations . . . . . . . . . . . . . . . . . . . 29
8.1. Resource Constraints . . . . . . . . . . . . . . . . . . 29 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 29
8.2. Inappropriate Configuration . . . . . . . . . . . . . . . 30 9.1. Normative References . . . . . . . . . . . . . . . . . . . 29
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 30 9.2. Informative References . . . . . . . . . . . . . . . . . . 31
9.1. Normative References . . . . . . . . . . . . . . . . . . 30 Appendix A. Implementor Guidelines . . . . . . . . . . . . . . . . 31
9.2. Informative References . . . . . . . . . . . . . . . . . 31 Appendix A.1. Extending Facilities . . . . . . . . . . . . . . 31
Appendix A. Implementor Guidelines . . . . . . . . . . . . . . . 32 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 32
A.1. Extending Facilities . . . . . . . . . . . . . . . . . . 32
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 33
1. Introduction 1. Introduction
Operating systems, processes and applications generate messages Operating systems, processes and applications generate messages
indicating their own status or the occurrence of events. These indicating their own status or the occurrence of events. These
messages are useful for managing and/or debugging the network and its messages are useful for managing and/or debugging the network and its
services. The BSD syslog protocol is a widely adopted protocol that services. The BSD syslog protocol is a widely adopted protocol that
is used for transmission and processing of the message. is used for transmission and processing of the message.
Since each process, application and operating system was written Since each process, application and operating system was written
skipping to change at page 4, line 5 skipping to change at page 3, line 39
The term "relay" is defined in [RFC5424]: a "relay" forwards The term "relay" is defined in [RFC5424]: a "relay" forwards
messages, accepting messages from originators or other relays and messages, accepting messages from originators or other relays and
sending them to collectors or other relays sending them to collectors or other relays
The term "collectors" is defined in [RFC5424]: a "collector" gathers The term "collectors" is defined in [RFC5424]: a "collector" gathers
syslog content for further analysis. syslog content for further analysis.
The term "action" refers to the processing that takes place for each The term "action" refers to the processing that takes place for each
syslog message received. syslog message received.
1.3. Tree Diagrams 1.3. Tree Diagram Notation
A simplified graphical representation of the data models is used in A simplified graphical representation of the data models is used in
this document. The meaning of the symbols in these diagrams is as this document. The meaning of the symbols in these diagrams is as
follows: follows:
o Brackets "[" and "]" enclose list keys. o Brackets "[" and "]" enclose list keys.
o Braces "{" and "}" enclose feature names, and indicate that the o Braces "{" and "}" enclose feature names, and indicate that the
named feature must be present for the subtree to be present. named feature must be present for the subtree to be present.
o Abbreviations before data node names: "rw" means configuration o Abbreviations before data node names: "rw" means configuration
(read-write) and "ro" state data (read-only). (read-write) and "ro" state data (read-only).
o Symbols after data node names: "?" means an optional node, "!" o Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list. means a presence container, and "*" denotes a list and leaf-list.
o Parentheses enclose choice and case nodes, and case nodes are also o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":"). marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not o Ellipsis ("...") stands for contents of subtrees that are not
shown. shown.
2. Problem Statement 2. Problem Statement
skipping to change at page 5, line 48 skipping to change at page 5, line 31
| |
+-------------+--------------+ +-------------+--------------+
| | | | | |
v v v v v v
Collectors Collectors
+----------+ +----------+ +----------------+ +----------+ +----------+ +----------------+
| | | Log | |Remote Relay(s)/| | | | Log | |Remote Relay(s)/|
| Console | | File(s) | |Collector(s) | | Console | | File(s) | |Collector(s) |
+----------+ +----------+ +----------------+ +----------+ +----------+ +----------------+
Figure 1. Syslog Processing Flow Figure 1. Syslog Processing Flow
Collectors are configured using the leaves in the syslog model Collectors are configured using the leaves in the syslog model
"actions" container which correspond to each message collector: "actions" container which correspond to each message collector:
console console
log file(s) log file(s)
remote relay(s)/collector(s) remote relay(s)/collector(s)
Within each action, a selector is used to filter syslog messages. A Within each action, a selector is used to filter syslog messages. A
selector consists of a list of one or more facility-severity matches, selector consists of a list of one or more facility-severity matches,
and, if supported via the select-match feature, an optional regular and, if supported via the select-match feature, an optional regular
expression pattern match that is performed on the [RFC5424] field. expression pattern match that is performed on the [RFC5424] field.
A syslog message is processed if: A syslog message is processed if:
There is an element of facility-list (F, S) where There is an element of facility-list (F, S) where
the message facility matches F the message facility matches F
and the message severity matches S and the message severity matches S
and/or the message text matches the regex pattern (if it is present) and/or the message text matches the regex pattern (if it
is present)
The facility is one of a specific syslog-facility, or all facilities. The facility is one of a specific syslog-facility, or all facilities.
The severity is one of type syslog-severity, all severities, or none. The severity is one of type syslog-severity, all severities, or none.
None is a special case that can be used to disable a filter. When None is a special case that can be used to disable a filter. When
filtering severity, the default comparison is that messages of the filtering severity, the default comparison is that messages of the
specified severity and higher are selected to be logged. This is specified severity and higher are selected to be logged. This is
shown in the model as "default equals-or-higher". This behavior can shown in the model as "default equals-or-higher". This behavior can
be altered if the select-adv-compare feature is enabled to specify a be altered if the select-adv-compare feature is enabled to specify a
compare operation and an action. Compare operations are: "equals" to compare operation and an action. Compare operations are: "equals" to
skipping to change at page 7, line 43 skipping to change at page 7, line 52
| | +--rw address? inet:host | | +--rw address? inet:host
| | +--rw port? inet:port-number | | +--rw port? inet:port-number
| +--:(udp) | +--:(udp)
| | +--rw udp | | +--rw udp
| | +--rw address? inet:host | | +--rw address? inet:host
| | +--rw port? inet:port-number | | +--rw port? inet:port-number
| +--:(tls) | +--:(tls)
| +--rw tls | +--rw tls
| +--rw address? inet:host | +--rw address? inet:host
| +--rw port? inet:port-number | +--rw port? inet:port-number
| +--rw server-auth
| | +--rw trusted-ca-certs? leafref
| | +--rw trusted-server-certs? leafref
| +--rw client-auth | +--rw client-auth
| | +--rw (auth-type)? | | +--rw (auth-type)?
| | +--:(certificate) | | +--:(certificate)
| | +--rw certificate? leafref | | +--rw certificate? leafref
| +--rw server-auth
| | +--rw pinned-ca-certs? leafref
| | +--rw pinned-server-certs? leafref
| +--rw hello-params | +--rw hello-params
| {tls-client-hello-params-config}? | {tls-client-hello-params-config}?
| +--rw tls-versions | +--rw tls-versions
| | +--rw tls-version* identityref | | +--rw tls-version* identityref
| +--rw cipher-suites | +--rw cipher-suites
| +--rw cipher-suite* identityref | +--rw cipher-suite* identityref
+--rw facility-filter +--rw facility-filter
| +--rw facility-list* [facility severity] | +--rw facility-list* [facility severity]
| +--rw facility union | +--rw facility union
| +--rw severity union | +--rw severity union
skipping to change at page 8, line 24 skipping to change at page 8, line 27
| +--rw action? enumeration | +--rw action? enumeration
+--rw pattern-match? string {select-match}? +--rw pattern-match? string {select-match}?
+--rw structured-data? boolean {structured-data}? +--rw structured-data? boolean {structured-data}?
+--rw facility-override? identityref +--rw facility-override? identityref
+--rw source-interface? if:interface-ref +--rw source-interface? if:interface-ref
| {remote-source-interface}? | {remote-source-interface}?
+--rw signing-options! {signed-messages}? +--rw signing-options! {signed-messages}?
+--rw cert-signers +--rw cert-signers
+--rw cert-signer* [name] +--rw cert-signer* [name]
| +--rw name string | +--rw name string
| +--rw certificate? leafref | +--rw certificate
| | +--rw algorithm?
| | | identityref
| | +--rw private-key?
| | | union
| | +--rw public-key?
| | | binary
| | +---x generate-private-key
| | | +---w input
| | | +---w algorithm identityref
| | +--rw certificates
| | | +--rw certificate* [name]
| | | +--rw name string
| | | +--rw value? binary
| | +---x generate-certificate-signing-request
| | +---w input
| | | +---w subject binary
| | | +---w attributes? binary
| | +--ro output
| | +--ro certificate-signing-request
| | binary
| +--rw hash-algorithm? enumeration | +--rw hash-algorithm? enumeration
+--rw cert-initial-repeat? uint32 +--rw cert-initial-repeat? uint32
+--rw cert-resend-delay? uint32 +--rw cert-resend-delay? uint32
+--rw cert-resend-count? uint32 +--rw cert-resend-count? uint32
+--rw sig-max-delay? uint32 +--rw sig-max-delay? uint32
+--rw sig-number-resends? uint32 +--rw sig-number-resends? uint32
+--rw sig-resend-delay? uint32 +--rw sig-resend-delay? uint32
+--rw sig-resend-count? uint32 +--rw sig-resend-count? uint32
Figure 2. ietf-syslog Module Tree Figure 2. ietf-syslog Module Tree
4. Syslog YANG Module 4. Syslog YANG Module
4.1. The ietf-syslog Module 4.1. The ietf-syslog Module
This module imports typedefs from [RFC6021], [RFC7223], groupings This module imports typedefs from [RFC6021], [RFC7223], groupings
from [RFC yyyy], and [RFC xxxx], and it references [RFC5424], from [RFC yyyy], and [RFC xxxx], and it references [RFC5424],
[RFC5425], [RFC5426], [RFC6587], and [RFC5848]. [RFC5425], [RFC5426], [RFC6587], and [RFC5848].
<CODE BEGINS> file "ietf-syslog.yang" <CODE BEGINS> file "ietf-syslog.yang@2017-12-12.yang"
module ietf-syslog { module ietf-syslog {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-syslog";
prefix syslog;
import ietf-inet-types { namespace "urn:ietf:params:xml:ns:yang:ietf-syslog";
prefix inet; prefix syslog;
reference
"RFC 6991: INET Types Model";
}
import ietf-interfaces { import ietf-inet-types {
prefix if; prefix inet;
reference reference
"RFC 7223: Interfaces Model"; "RFC 6991: INET Types Model";
} }
import ietf-tls-client { import ietf-interfaces {
prefix tlsc; prefix if;
reference reference
"RFC xxxx: Keystore Model"; "RFC 7223: Interfaces Model";
} }
import ietf-keystore { import ietf-tls-client {
prefix ks; prefix tlsc;
reference reference
"RFC yyyy: TLS Client and Server Models"; "RFC xxxx: Keystore Model";
} }
organization "IETF import ietf-keystore {
NETMOD (Network Modeling) Working Group"; prefix ks;
reference
"RFC yyyy: TLS Client and Server Models";
}
contact organization "IETF
"WG Web: <http://tools.ietf.org/wg/netmod/> NETMOD (Network Modeling) Working Group";
WG List: <mailto:netmod@ietf.org>
Editor: Kiran Agrahara Sreenivasa contact
<mailto:kirankoushik.agraharasreenivasa@ "WG Web: <http://tools.ietf.org/wg/netmod/>
verizonwireless.com> WG List: <mailto:netmod@ietf.org>
Editor: Clyde Wildes Editor: Kiran Agrahara Sreenivasa
<mailto:cwildes@cisco.com>"; <mailto:kirankoushik.agraharasreenivasa@
description verizonwireless.com>
"This module contains a collection of YANG definitions
for syslog configuration.
Copyright (c) 2016 IETF Trust and the persons identified as Editor: Clyde Wildes
authors of the code. All rights reserved. <mailto:cwildes@cisco.com>";
description
"This module contains a collection of YANG definitions
for syslog configuration.
Redistribution and use in source and binary forms, with or Copyright (c) 2017 IETF Trust and the persons identified as
without modification, is permitted pursuant to, and subject to authors of the code. All rights reserved.
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 Redistribution and use in source and binary forms, with or
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and without modification, is permitted pursuant to, and subject to
'OPTIONAL' in the module text are to be interpreted as the license terms contained in, the Simplified BSD License set
described in RFC 2119 (http://tools.ietf.org/html/rfc2119). forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC zzzz The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
(http://tools.ietf.org/html/rfczzzz); see the RFC itself for NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
full legal notices."; 'OPTIONAL' in the module text are to be interpreted as
described in RFC 2119 (http://tools.ietf.org/html/rfc2119).
revision 2017-09-08 { This version of this YANG module is part of RFC zzzz
description (http://tools.ietf.org/html/rfczzzz); see the RFC itself for
"Initial Revision"; full legal notices.";
reference
"RFC zzzz: Syslog YANG Model";
}
feature console-action { revision 2017-12-12 {
description description
"This feature indicates that the local console action is "Initial Revision";
supported."; reference
} "RFC zzzz: Syslog YANG Model";
}
feature file-action { feature console-action {
description description
"This feature indicates that the local file action is "This feature indicates that the local console action is
supported."; supported.";
} }
feature file-limit-size { feature file-action {
description description
"This feature indicates that file logging resources "This feature indicates that the local file action is
are managed using size and number limits."; supported.";
} }
feature file-limit-duration { feature file-limit-size {
description description
"This feature indicates that file logging resources "This feature indicates that file logging resources
are managed using time based limits."; are managed using size and number limits.";
} }
feature remote-action { feature file-limit-duration {
description description
"This feature indicates that the remote server action is "This feature indicates that file logging resources
supported."; are managed using time based limits.";
} }
feature remote-source-interface {
description
"This feature indicates that source-interface is supported
supported for the remote-action.";
}
feature select-adv-compare { feature remote-action {
description description
"This feature represents the ability to select messages "This feature indicates that the remote server action is
using the additional comparison operators when comparing supported.";
the syslog message severity."; }
}
feature select-match { feature remote-source-interface {
description description
"This feature represents the ability to select messages "This feature indicates that source-interface is supported
based on a Posix 1003.2 regular expression pattern match."; supported for the remote-action.";
} }
feature structured-data { feature select-adv-compare {
description description
"This feature represents the ability to log messages "This feature represents the ability to select messages
in structured-data format as per RFC 5424."; using the additional comparison operators when comparing
} the syslog message severity.";
}
feature signed-messages { feature select-match {
description description
"This feature represents the ability to configure signed "This feature represents the ability to select messages
syslog messages according to RFC 5848."; based on a Posix 1003.2 regular expression pattern match.";
} }
typedef syslog-severity { feature structured-data {
type enumeration { description
enum "emergency" { "This feature represents the ability to log messages
value 0; in structured-data format.";
description reference
"The severity level 'Emergency' indicating that the "RFC 5424: The Syslog Protocol";
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 as per RFC 5424.";
}
identity syslog-facility { feature signed-messages {
description description
"This identity is used as a base for all syslog facilities as "This feature represents the ability to configure signed
per RFC 5424."; syslog messages.";
} reference
"RFC 5848: Signed Syslog Messages";
}
identity kern { typedef syslog-severity {
base syslog-facility; type enumeration {
description enum "emergency" {
"The facility for kernel messages (0) as defined in RFC 5424."; 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 user { identity kern {
base syslog-facility; base syslog-facility;
description description
"The facility for user-level messages (1) as defined in "The facility for kernel messages (0).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity mail { identity user {
base syslog-facility; base syslog-facility;
description description
"The facility for the mail system (2) as defined in RFC 5424."; "The facility for user-level messages (1).";
}
identity daemon { reference
base syslog-facility; "RFC 5424: The Syslog Protocol";
description
"The facility for the system daemons (3) as defined in
RFC 5424.";
} }
identity auth { identity mail {
base syslog-facility; base syslog-facility;
description description
"The facility for security/authorization messages (4) as "The facility for the mail system (2).";
defined in RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity syslog { identity daemon {
base syslog-facility; base syslog-facility;
description description
"The facility for messages generated internally by syslogd "The facility for the system daemons (3).";
facility (5) as defined in RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity lpr { identity auth {
base syslog-facility; base syslog-facility;
description description
"The facility for the line printer subsystem (6) as defined "The facility for security/authorization messages (4).";
in RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity news { identity syslog {
base syslog-facility; base syslog-facility;
description description
"The facility for the network news subsystem (7) as defined "The facility for messages generated internally by syslogd
in RFC 5424."; 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 uucp { identity news {
base syslog-facility; base syslog-facility;
description description
"The facility for the UUCP subsystem (8) as defined in "The facility for the network news subsystem (7).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity cron { identity uucp {
base syslog-facility; base syslog-facility;
description description
"The facility for the clock daemon (9) as defined in "The facility for the UUCP subsystem (8).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity authpriv { identity cron {
base syslog-facility; base syslog-facility;
description description
"The facility for privileged security/authorization messages "The facility for the clock daemon (9).";
(10) as defined in RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity ftp { identity authpriv {
base syslog-facility; base syslog-facility;
description description
"The facility for the FTP daemon (11) as defined in RFC 5424."; "The facility for privileged security/authorization messages
} (10).";
reference
"RFC 5424: The Syslog Protocol";
}
identity ntp { identity ftp {
base syslog-facility; base syslog-facility;
description description
"The facility for the NTP subsystem (12) as defined in "The facility for the FTP daemon (11).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity audit { identity ntp {
base syslog-facility; base syslog-facility;
description description
"The facility for log audit messages (13) as defined in "The facility for the NTP subsystem (12).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity console { identity audit {
base syslog-facility; base syslog-facility;
description description
"The facility for log alert messages (14) as defined in "The facility for log audit messages (13).";
RFC 5424."; 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) as defined in
RFC 5424.";
}
identity local0 { identity cron2 {
base syslog-facility; base syslog-facility;
description description
"The facility for local use 0 messages (16) as defined in "The facility for the second clock daemon (15).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity local1 { identity local0 {
base syslog-facility; base syslog-facility;
description description
"The facility for local use 1 messages (17) as defined in "The facility for local use 0 messages (16).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity local2 { identity local1 {
base syslog-facility; base syslog-facility;
description description
"The facility for local use 2 messages (18) as defined in "The facility for local use 1 messages (17).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity local3 { identity local2 {
base syslog-facility; base syslog-facility;
description description
"The facility for local use 3 messages (19) as defined in "The facility for local use 2 messages (18).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity local4 { identity local3 {
base syslog-facility; base syslog-facility;
description description
"The facility for local use 4 messages (20) as defined in "The facility for local use 3 messages (19).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity local5 { identity local4 {
base syslog-facility; base syslog-facility;
description description
"The facility for local use 5 messages (21) as defined in "The facility for local use 4 messages (20).";
RFC 5424."; reference
} "RFC 5424: The Syslog Protocol";
}
identity local6 { identity local5 {
base syslog-facility; base syslog-facility;
description description
"The facility for local use 6 messages (22) as defined in "The facility for local use 5 messages (21).";
RFC 5424.";
}
identity local7 { reference
base syslog-facility; "RFC 5424: The Syslog Protocol";
description }
"The facility for local use 7 messages (23) as defined in
RFC 5424.";
}
grouping severity-filter { identity local6 {
description base syslog-facility;
"This grouping defines the processing used to select description
log messages by comparing syslog message severity using "The facility for local use 6 messages (22).";
the following processing rules: reference
- if 'none', do not match. "RFC 5424: The Syslog Protocol";
- 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.";
} identity local7 {
description base syslog-facility;
"This container describes additional severity compare description
operations that can be used in place of the default "The facility for local use 7 messages (23).";
severity comparison. The compare leaf specifies the type of reference
the compare that is done and the action leaf specifies the "RFC 5424: The Syslog Protocol";
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 { grouping severity-filter {
description description
"This grouping defines a syslog selector which is used to "This grouping defines the processing used to select
select log messages for the log-actions (console, file, log messages by comparing syslog message severity using
remote, etc.). Choose one or both of the following: the following processing rules:
facility [<facility> <severity>...] - if 'none', do not match.
pattern-match regular-expression-match-string - if 'all', match.
If both facility and pattern-match are specified, both must - else compare message severity with the specified severity
match in order for a log message to be selected."; according to the default compare rule (all messages of the
container facility-filter { specified severity and greater match) or if the
description select-adv-compare feature is present, the advance-compare
"This container describes the syslog filter parameters."; rule.";
list facility-list { leaf severity {
key "facility severity"; type union {
ordered-by user; type syslog-severity;
description type enumeration {
"This list describes a collection of syslog enum none {
facilities and severities."; value 2147483647;
leaf facility { description
type union { "This enum describes the case where no severities
type identityref { are selected.";
base syslog-facility; }
} enum all {
type enumeration { value -2147483648;
enum all { description
description "This enum describes the case where all severities
"This enum describes the case where all are selected.";
facilities are requested."; }
} }
}
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 description
"The leaf uniquely identifies a syslog facility."; "This enum specifies that if the compare operation is
} true the message will not be logged.";
uses severity-filter; }
}
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
leaf pattern-match { "This grouping defines a syslog selector which is used to
if-feature select-match; select log messages for the log-actions (console, file,
type string; remote, etc.). Choose one or both of the following:
description facility [<facility> <severity>...]
"This leaf describes a Posix 1003.2 regular expression pattern-match regular-expression-match-string
string that can be used to select a syslog message for If both facility and pattern-match are specified, both must
logging. The match is performed on the RFC 5424 match in order for a log message to be selected.";
SYSLOG-MSG field."; 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";
}
}
grouping structured-data { container syslog {
description presence "Enables logging.";
"This grouping defines the syslog structured data option description
which is used to select the format used to write log "This container describes the configuration parameters for
messages."; syslog.";
leaf structured-data { container actions {
if-feature structured-data; description
type boolean; "This container describes the log-action parameters
default false; for syslog.";
description container console {
"This leaf describes how log messages are written. if-feature console-action;
If true, messages will be written with one or more presence "Enables logging to the console";
STRUCTURED-DATA elements as per RFC 5424; if false, description
messages will be written with STRUCTURED-DATA = "This container describes the configuration parameters
NILVALUE."; 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 "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 {
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 tcp {
container tcp {
description
"This container describes the TCP transport
options.";
reference
"RFC 6587: Transmission of Syslog Messages over
TCP";
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.";
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 sent to a remote syslog server will
contain the IP address of the interface the syslog
message uses to exit the network element";
}
container signing-options {
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 certificate {
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.";
container syslog { }
presence "Enables logging."; }
description leaf cert-initial-repeat {
"This container describes the configuration parameters for type uint32;
syslog."; default 3;
container actions { description
description "This leaf specifies the number of times each
"This container describes the log-action parameters Certificate Block should be sent before the first
for syslog."; message is sent.";
container console { }
if-feature console-action; leaf cert-resend-delay {
presence "Enables logging to the console"; type uint32;
description units "seconds";
"This container describes the configuration parameters default 3600;
for console logging."; description
uses selector; "This leaf specifies the maximum time delay in
} seconds until resending the Certificate Block.";
container file { }
if-feature file-action; leaf cert-resend-count {
description type uint32;
"This container describes the configuration parameters for default 0;
file logging. If file-archive limits are not supplied, it description
is assumed that the local implementation defined limits "This leaf specifies the maximum number of other
will be used."; syslog messages to send until resending the
list log-file { Certificate Block.";
key "name"; }
description leaf sig-max-delay {
"This list describes a collection of local logging type uint32;
files."; units "seconds";
leaf name { default 60;
type inet:uri { description
pattern 'file:.*'; "This leaf specifies when to generate a new
} Signature Block. If this many seconds have
description elapsed since the message with the first message
"This leaf specifies the name of the log file which number of the Signature Block was sent, a new
MUST use the uri scheme file:."; Signature Block should be generated.";
} }
uses selector; leaf sig-number-resends {
uses structured-data; type uint32;
container file-rotation { default 0;
description description
"This container describes the configuration "This leaf specifies the number of times a
parameters for log file rotation."; Signature Block is resent. (It is recommended to
leaf number-of-files { select a value of greater than 0 in particular
if-feature file-limit-size; when the UDP transport RFC 5426 is used.).";
type uint32; }
default 1; leaf sig-resend-delay {
description type uint32;
"This leaf specifies the maximum number of log units "seconds";
files retained. Specify 1 for implementations default 5;
that only support one log file."; description
} "This leaf specifies when to send the next
leaf max-file-size { Signature Block transmission based on time. If
if-feature file-limit-size; this many seconds have elapsed since the previous
type uint32; sending of this Signature Block, resend it.";
units "megabytes"; }
description leaf sig-resend-count {
"This leaf specifies the maximum log file size."; type uint32;
} default 0;
leaf rollover { description
if-feature file-limit-duration; "This leaf specifies when to send the next
type uint32; Signature Block transmission based on a count.
units "minutes"; If this many other syslog messages have been
description sent since the previous sending of this
"This leaf specifies the length of time that log Signature Block, resend it. A value of 0 means
events should be written to a specific log file. that you don't resend based on the number of
Log events that arrive after the rollover period messages.";
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 "hours"; }
description }
"This leaf specifies the length of time that <CODE ENDS>
completed/closed log event files should be stored
in the file system before they are deleted.";
}
}
}
}
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 tcp {
container tcp {
description
"This container describes the TCP transport
options.";
reference
"RFC 6587: Transmission of Syslog Messages over
TCP";
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.";
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 sent to a remote syslog server will
contain the IP address of the interface the syslog
message uses to exit the network element";
}
container signing-options {
if-feature signed-messages;
presence
"If present, syslog-signing options is activated.";
description
"This container describes the configuration
parameters for signed syslog messages as described
by RFC 5848.";
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.";
}
leaf certificate {
type leafref {
path "/ks:keystore/ks:keys/ks:key/ks:certificates"
+ "/ks:certificate/ks:name";
}
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.";
}
}
}
}
}
}
}
}
<CODE ENDS>
Figure 3. ietf-syslog Module Figure 3. ietf-syslog Module
5. Usage Examples 5. Usage Examples
Requirement: Requirement:
Enable console logging of syslogs of severity critical Enable console logging of syslogs of severity critical
Here is the example syslog configuration xml: Here is the example syslog configuration xml:
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <syslog xmlns="urn:ietf:params:xml:ns:yang:ietf-syslog"
<syslog xmlns="urn:ietf:params:xml:ns:yang:ietf-syslog" xmlns:syslog="urn:ietf:params:xml:ns:yang:ietf-syslog">
xmlns:syslog="urn:ietf:params:xml:ns:yang:ietf-syslog"> <actions>
<actions> <console>
<console> <facility-filter>
<facility-filter> <facility-list>
<facility-list> <facility>all</facility>
<facility>all</facility> <severity>critical</severity>
<severity>critical</severity> </facility-list>
</facility-list> </facility-filter>
</facility-filter> </console>
</console> </actions>
</actions> </syslog>
</syslog>
</config>
Enable remote logging of syslogs to udp destination 2001:db8:a0b:12f0::1 Enable remote logging of syslogs to udp destination
for facility auth, severity error 2001:db8:a0b:12f0::1 for facility auth, severity error
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <syslog xmlns="urn:ietf:params:xml:ns:yang:ietf-syslog"
<syslog xmlns="urn:ietf:params:xml:ns:yang:ietf-syslog" xmlns:syslog="urn:ietf:params:xml:ns:yang:ietf-syslog">
xmlns:syslog="urn:ietf:params:xml:ns:yang:ietf-syslog"> <actions>
<actions> <remote>
<remote> <destination>
<destination> <name>remote1</name>
<name>remote1</name> <udp>
<udp> <address>foo.eample.com</address>
<address>2001:db8:a0b:12f0::1</address> </udp>
</udp> <facility-filter>
<facility-filter> <facility-list>
<facility-list> <facility>auth</facility>
<facility>auth</facility> <severity>error</severity>
<severity>error</severity> </facility-list>
</facility-list> </facility-filter>
</facility-filter> </destination>
</destination> </remote>
</remote> </actions>
</actions> </syslog>
</syslog>
</config>
Figure 4. ietf-syslog Examples Figure 4. ietf-syslog Examples
6. Acknowledgements 6. Acknowledgements
The authors wish to thank the following who commented on this The authors wish to thank the following who commented on this
proposal: proposal:
Andy Bierman Andy Bierman
skipping to change at page 29, line 11 skipping to change at page 28, line 48
Dale R Worley Dale R Worley
Aleksandr Zhdankin Aleksandr Zhdankin
7. IANA Considerations 7. IANA Considerations
This document registers one URI in the IETF XML registry [RFC3688]. This document registers one URI in the IETF XML registry [RFC3688].
Following the format in [RFC3688], the following registration is Following the format in [RFC3688], the following registration is
requested: requested:
URI: urn:ietf:params:xml:ns:yang:ietf-syslog URI: urn:ietf:params:xml:ns:yang:ietf-syslog
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
7.1. The YANG Module Names Registry 7.1. The YANG Module Names Registry
This document registers one YANG module in the YANG Module Names This document registers one YANG module in the YANG Module Names
registry [RFC7895]/>. Following the format in [RFC7950]/>, the the registry [RFC7895]/>. Following the format in [RFC7950]/>, the the
following registration is requested: following registration is requested:
name: ietf-syslog name: ietf-syslog
namespace: urn:ietf:params:xml:ns:yang:ietf-syslog namespace: urn:ietf:params:xml:ns:yang:ietf-syslog
prefix: ietf-syslog prefix: ietf-syslog
reference: RFC zzzz reference: RFC zzzz
8. Security Considerations 8. Security Considerations
The YANG module defined in this document is designed to be accessed The YANG module defined in this document is designed to be accessed
skipping to change at page 29, line 40 skipping to change at page 29, line 24
RESTCONF [RFC8040]. Both of these protocols have mandatory-to- RESTCONF [RFC8040]. Both of these protocols have mandatory-to-
implement secure transport layers (e.g., SSH, TLS) with mutual implement secure transport layers (e.g., SSH, TLS) with mutual
authentication. authentication.
The NETCONF access control model (NACM) [RFC6536] provides the means The NETCONF access control model (NACM) [RFC6536] provides the means
to restrict access for particular users to a pre-configured subset of to restrict access for particular users to a pre-configured subset of
all available protocol operations and content. all available protocol operations and content.
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config) in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative to these data nodes without proper protection can have a negative
effect on network operations. effect on network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability:
8.1. Resource Constraints
It is the responsibility of the network administrator to ensure that
the configured message flow does not overwhelm system resources.
Network administrators must take the time to estimate the appropriate facility-filter/pattern-match: When writing this node,
storage capacity caused by the configuration of actions/file using implementations MUST ensure that the regular expression pattern
file-archive attributes to limit storage used. match is not constructed to cause a regular expression denial
of service attack due to a pattern that causes the regular
expression implementation to work very slowly (exponentially
related to input size).
8.2. Inappropriate Configuration Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes.
It is the responsibility of the network administrator to ensure that There are no RPC operations defined in this YANG module.
the messages are actually going to the intended recipients.
9. References 9. References
9.1. Normative References 9.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/
DOI 10.17487/RFC2119, March 1997, RFC2119, March 1997, <http://www.rfc-editor.org/info/
<https://www.rfc-editor.org/info/rfc2119>. rfc2119>.
[RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424, [RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424, DOI
DOI 10.17487/RFC5424, March 2009, 10.17487/RFC5424, March 2009, <http://www.rfc-editor.org/
<https://www.rfc-editor.org/info/rfc5424>. info/rfc5424>.
[RFC5425] Miao, F., Ed., Ma, Y.Ed., and J. Salowey, Ed., "Transport
Layer Security (TLS) Transport Mapping for Syslog", RFC
5425, DOI 10.17487/RFC5425, March 2009, <https://www.rfc-
editor.org/info/rfc5425>.
[RFC5426] Okmianski, A., "Transmission of Syslog Messages over UDP", [RFC5426] Okmianski, A., "Transmission of Syslog Messages over UDP",
RFC 5426, DOI 10.17487/RFC5426, March 2009, RFC 5426, DOI 10.17487/RFC5426, March 2009, <http://www
<https://www.rfc-editor.org/info/rfc5426>. .rfc-editor.org/info/rfc5426>.
[RFC5848] Kelsey, J., Callas, J., and A. Clemm, "Signed Syslog [RFC5848] Kelsey, J., Callas, J. and A. Clemm, "Signed Syslog
Messages", RFC 5848, DOI 10.17487/RFC5848, May 2010, Messages", RFC 5848, DOI 10.17487/RFC5848, May 2010,
<https://www.rfc-editor.org/info/rfc5848>. <http://www.rfc-editor.org/info/rfc5848>.
[RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6021, DOI 10.17487/RFC6021, October 2010,
<https://www.rfc-editor.org/info/rfc6021>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012,
<https://www.rfc-editor.org/info/rfc6536>.
[RFC6587] Gerhards, R. and C. Lonvick, "Transmission of Syslog [RFC6587] Gerhards, R. and C. Lonvick, "Transmission of Syslog
Messages over TCP", RFC 6587, DOI 10.17487/RFC6587, April Messages over TCP", RFC 6587, DOI 10.17487/RFC6587, April
2012, <https://www.rfc-editor.org/info/rfc6587>. 2012, <http://www.rfc-editor.org/info/rfc6587>.
[RFC6691] Borman, D., "TCP Options and Maximum Segment Size (MSS)",
RFC 6691, DOI 10.17487/RFC6691, July 2012, <https://www
.rfc-editor.org/info/rfc6691>.
[RFC7223] Bjorklund, M., "A YANG Data Model for Interface [RFC7223] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 7223, DOI 10.17487/RFC7223, May 2014, Management", RFC 7223, DOI 10.17487/RFC7223, May 2014,
<https://www.rfc-editor.org/info/rfc7223>. <http://www.rfc-editor.org/info/rfc7223>.
[RFC7895] Bierman, A., Bjorklund, M., and K. Watsen, "YANG Module [RFC7895] Bierman, A., Bjorklund, M. and K. Watsen, "YANG Module
Library", RFC 7895, DOI 10.17487/RFC7895, June 2016, Library", RFC 7895, DOI 10.17487/RFC7895, June 2016,
<https://www.rfc-editor.org/info/rfc7895>. <http://www.rfc-editor.org/info/rfc7895>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016, <http://www
<https://www.rfc-editor.org/info/rfc7950>. .rfc-editor.org/info/rfc7950>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <http://www.rfc-editor.org/info/rfc8174>.
[Std-1003.1-2008] [Std-1003.1-2008]
The Open Group, ""Chapter 9: Regular Expressions". The The Open Group, ""Chapter 9: Regular Expressions". The
Open Group Base Specifications Issue 6, IEEE Std Open Group Base Specifications Issue 6, IEEE Std
1003.1-2008, 2016 Edition.", September 2016, 1003.1-2008, 2016 Edition.", September 2016, <http://
<http://pubs.opengroup.org/onlinepubs/9699919799/>. pubs.opengroup.org/onlinepubs/9699919799/>.
[draft-ietf-netconf-keystore-04.txt]
Juniper Networks, "YANG Data Model for a "Keystore"
Mechanism draft-ietf-netconf-keystore-04", October 2017,
<https://tools.ietf.org/html/draft-ietf-netconf-
keystore-04>.
[draft-ietf-netconf-tls-client-server-05.txt]
Juniper Networks, Cisco Systems, "YANG Groupings for TLS
Clients and TLS Servers draft-ietf-netconf-tls-client-
server-05", October 2017, <https://tools.ietf.org/html/
draft-ietf-netconf-tls-client-server-05>.
9.2. Informative References 9.2. Informative References
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004, <http://www.rfc-
<https://www.rfc-editor.org/info/rfc3688>. editor.org/info/rfc3688>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J.Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <http://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, Protocol (NETCONF) Access Control Model", RFC 6536, DOI
<https://www.rfc-editor.org/info/rfc6242>. 10.17487/RFC6536, March 2012, <https://www.rfc-editor.org/
info/rfc6536>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M. and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
Appendix A. Implementor Guidelines Appendix A. Implementor Guidelines
A.1. Extending Facilities Appendix A.1. Extending Facilities
Many vendors extend the list of facilities available for logging in Many vendors extend the list of facilities available for logging in
their implementation. Additional facilities may not work with the their implementation. Additional facilities may not work with the
syslog protocol as defined in [RFC5424] and hence such facilities syslog protocol as defined in [RFC5424] and hence such facilities
apply for local syslog-like logging functionality. apply for local syslog-like logging functionality.
The following is an example that shows how additional facilities The following is an example that shows how additional facilities
could be added to the list of available facilities (in this example could be added to the list of available facilities (in this example
two facilities are added): two facilities are added):
skipping to change at page 32, line 46 skipping to change at page 32, line 33
revision 2017-08-11 { revision 2017-08-11 {
description description
"Version 1.0"; "Version 1.0";
reference reference
"Vendor SYSLOG Types: SYSLOG YANG Model"; "Vendor SYSLOG Types: SYSLOG YANG Model";
} }
identity vendor_specific_type_1 { identity vendor_specific_type_1 {
base syslogtypes:syslog-facility; base syslogtypes:syslog-facility;
description
"Adding vendor specific type 1 to syslog-facility";
} }
identity vendor_specific_type_2 { identity vendor_specific_type_2 {
base syslogtypes:syslog-facility; base syslogtypes:syslog-facility;
description
"Adding vendor specific type 2 to syslog-facility";
} }
} }
Authors' Addresses Authors' Addresses
Clyde Wildes (editor) Clyde Wildes, editor
Cisco Systems Inc. Cisco Systems Inc.
170 West Tasman Drive 170 West Tasman Drive
San Jose, CA 95134 San Jose, CA 95134
US US
Phone: +1 408 527-2672 Phone: +1 408 527-2672
EMail: cwildes@cisco.com Email: cwildes@cisco.com
Kiran Koushik, editor
Kiran Koushik (editor)
Verizon Wireless Verizon Wireless
500 W Dove Rd. 500 W Dove Rd.
Southlake, TX 76092 Southlake, TX 76092
US US
Phone: +1 512 650-0210 Phone: +1 512 650-0210
EMail: kirankoushik.agraharasreenivasa@verizonwireless.com Email: kirankoushik.agraharasreenivasa@verizonwireless.com
 End of changes. 110 change blocks. 
941 lines changed or deleted 1006 lines changed or added

This html diff was produced by rfcdiff 1.46. The latest version is available from http://tools.ietf.org/tools/rfcdiff/