draft-ietf-netmod-syslog-model-24.txt   draft-ietf-netmod-syslog-model-25.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: September 07, 2018 Verizon Wireless Expires: September 13, 2018 Verizon Wireless
March 08, 2018 March 14, 2018
A YANG Data Model for Syslog Configuration A YANG Data Model for Syslog Configuration
draft-ietf-netmod-syslog-model-24 draft-ietf-netmod-syslog-model-25
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.
The YANG model in this document conforms to the Network Management The YANG model in this document conforms to the Network Management
Datastore Architecture defined in [draft-ietf-netmod-revised- Datastore Architecture defined in [draft-ietf-netmod-revised-
datastores]. datastores].
skipping to change at page 1, line 37 skipping to change at page 1, line 37
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 http://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 September 07, 2018. This Internet-Draft will expire on September 13, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 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 (http://trustee.ietf.org/ Provisions Relating to IETF Documents (http://trustee.ietf.org/
license-info) in effect on the date of publication of this document. license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights Please review these documents carefully, as they describe your rights
skipping to change at page 2, line 9 skipping to change at page 2, line 9
extracted from this document must include Simplified BSD License text extracted from this document must include Simplified BSD License text
as described in Section 4.e of the Trust Legal Provisions and are as described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License. provided without warranty as described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. NDMA Compliance . . . . . . . . . . . . . . . . . . . . . 3 1.3. NDMA Compliance . . . . . . . . . . . . . . . . . . . . . 3
1.4. Editorial Note (To be removed by RFC Editor) . . . . . . . 3 1.4. Editorial Note (To be removed by RFC Editor) . . . . . . . 3
2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 3 2. Design of the Syslog Model . . . . . . . . . . . . . . . . . . 3
3. Design of the Syslog Model . . . . . . . . . . . . . . . . . . 4 2.1. Syslog Module . . . . . . . . . . . . . . . . . . . . . . 5
3.1. Syslog Module . . . . . . . . . . . . . . . . . . . . . . 5 3. Syslog YANG Module . . . . . . . . . . . . . . . . . . . . . . 7
4. Syslog YANG Module . . . . . . . . . . . . . . . . . . . . . . 7 3.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . . 8
4.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . . 8 4. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . . 25
5. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . . 25 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 25
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 25 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26 6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 26
7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 26 6.2. The YANG Module Names Registry . . . . . . . . . . . . . . 26
7.2. The YANG Module Names Registry . . . . . . . . . . . . . . 26 7. Security Considerations . . . . . . . . . . . . . . . . . . . 26
8. Security Considerations . . . . . . . . . . . . . . . . . . . 26 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 27
9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 27 8.1. Normative References . . . . . . . . . . . . . . . . . . . 27
9.1. Normative References . . . . . . . . . . . . . . . . . . . 27 8.2. Informative References . . . . . . . . . . . . . . . . . . 29
9.2. Informative References . . . . . . . . . . . . . . . . . . 28 Appendix A. Implementer Guidelines . . . . . . . . . . . . . . . . 29
Appendix A. Implementor Guidelines . . . . . . . . . . . . . . . . 29
Appendix A.1. Extending Facilities . . . . . . . . . . . . . . 29 Appendix A.1. Extending Facilities . . . . . . . . . . . . . . 29
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 30 Appendix A.2. Syslog Terminal Output . . . . . . . . . . . . . 30
Appendix A.3. Syslog File Naming Convention . . . . . . . . . . 30
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 31
1. Introduction 1. Introduction
Operating systems, processes and applications generate messages This document defines a YANG [RFC7950] configuration data model that
indicating their own status or the occurrence of events. These may be used to configure the syslog feature running on a system.
messages are useful for managing and/or debugging the network and its YANG models can be used with network management protocols such as
services. The BSD syslog protocol is a widely adopted protocol that NETCONF [RFC6241] to install, manipulate, and delete the
is used for transmission and processing of the message. configuration of network devices.
Since each process, application and operating system was written The data model makes use of the YANG "feature" construct which allows
somewhat independently, there is little uniformity to the content of implementations to support only those syslog features that lie within
syslog messages. For this reason, no assumption is made upon the their capabilities.
formatting or contents of the messages. The protocol is simply
designed to transport these event messages. No acknowledgment of the This module can be used to configure the syslog application
receipt is made. conceptual layers as implemented on the target system.
Essentially, a syslog process receives messages (from the kernel, Essentially, a syslog process receives messages (from the kernel,
processes, applications or other syslog processes) and processes processes, applications or other syslog processes) and processes
them. The processing may involve logging to a local file, and/or them. The processing may involve logging to a local file, and/or
displaying on console, and/or relaying to syslog processes on other displaying on console, and/or relaying to syslog processes on other
machines. The processing is determined by the "facility" that machines. The processing is determined by the "facility" that
originated the message and the "severity" assigned to the message by originated the message and the "severity" assigned to the message by
the facility. the facility.
We are using definitions of syslog protocol from [RFC5424] in this Such definitions of syslog protocol are defined in [RFC5424], and are
RFC. used in this RFC.
1.1. Requirements Language 1.1. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
1.2. Terminology 1.2. Terminology
The term "originator" is defined in [RFC5424]: an "originator" The term "originator" is defined in [RFC5424]: an "originator"
generates syslog content to be carried in a message. generates syslog content to be carried in a message.
skipping to change at page 3, line 51 skipping to change at page 3, line 52
ietf-netconf-keystore ietf-netconf-keystore
o "I-D.ietf-netconf-tls-client-server" --> the assigned RFC value o "I-D.ietf-netconf-tls-client-server" --> the assigned RFC value
for draft-ietf-netconf-tls-client-server for draft-ietf-netconf-tls-client-server
o "zzzz" --> the assigned RFC value for this draft o "zzzz" --> the assigned RFC value for this draft
o I-D.ietf-netmod-revised-datastores --> the assigned RFC value for o I-D.ietf-netmod-revised-datastores --> the assigned RFC value for
draft-ietf-netmod-revised-datastores draft-ietf-netmod-revised-datastores
2. Problem Statement 2. Design of the Syslog Model
This document defines a YANG [RFC7950] configuration data model that
may be used to configure the syslog feature running on a system.
YANG models can be used with network management protocols such as
NETCONF [RFC6241] to install, manipulate, and delete the
configuration of network devices.
The data model makes use of the YANG "feature" construct which allows
implementations to support only those syslog features that lie within
their capabilities.
This module can be used to configure the syslog application
conceptual layers as implemented on the target system.
3. Design of the Syslog Model
The syslog model was designed by comparing various syslog features The syslog model was designed by comparing various syslog features
implemented by various vendors' in different implementations. implemented by various vendors' in different implementations.
This document addresses the common leafs between implementations and This document addresses the common leafs between implementations and
creates a common model, which can be augmented with proprietary creates a common model, which can be augmented with proprietary
features, if necessary. This model is designed to be very simple for features, if necessary. This model is designed to be very simple for
maximum flexibility. maximum flexibility.
Some optional features are defined in this document to specify Some optional features are defined in this document to specify
skipping to change at page 5, line 53 skipping to change at page 5, line 36
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
select messages with this single severity, or "equals-or-higher" to select messages with this single severity, or "equals-or-higher" to
select messages of the specified severity and higher. Actions are select messages of the specified severity and higher. Actions are
used to log the message or block the message from being logged. used to log the message or block the message from being logged.
Many vendors extend the list of facilities available for logging in Many vendors extend the list of facilities available for logging in
their implementation. An example is included in Extending Facilities their implementation. An example is included in Extending Facilities
(Appendix A.1). (Appendix A.1).
3.1. Syslog Module 2.1. Syslog Module
A simplified graphical representation of the data model is used in A simplified graphical representation of the data model is used in
this document. Please see [I-D.ietf-netmod-yang-tree-diagrams] for this document. Please see [I-D.ietf-netmod-yang-tree-diagrams] for
tree diagram notation, and [RFC8089] for URI notation. tree diagram notation.
module: ietf-syslog module: ietf-syslog
+--rw syslog! +--rw syslog!
+--rw actions +--rw actions
+--rw console! {console-action}? +--rw console! {console-action}?
| +--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
| | +--rw advanced-compare {select-adv-compare}? | | +--rw advanced-compare {select-adv-compare}?
skipping to change at page 7, line 56 skipping to change at page 7, line 56
+--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 3. Syslog YANG Module
4.1. The ietf-syslog Module 3.1. The ietf-syslog Module
This module imports typedefs from [RFC7223], groupings from This module imports typedefs from [RFC6991],
[I-D.ietf-netconf-keystore], [I-D.ietf-netmod-rfc7223bis], groupings from
and [I-D.ietf-netconf-tls-client-server], and it references [I-D.ietf-netconf-keystore], and
[RFC5424], [RFC5425], [RFC5426], [RFC5848], and [RFC8174], and [I-D.ietf-netconf-tls-client-server], and it references [RFC5424],
[RFC5425], [RFC5426], [RFC5848], [RFC8089], [RFC8174], and
[Std-1003.1-2008]. [Std-1003.1-2008].
<CODE BEGINS> file "ietf-syslog@2018-03-08.yang" <CODE BEGINS> file "ietf-syslog@2018-03-14.yang"
module ietf-syslog { module ietf-syslog {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-syslog"; namespace "urn:ietf:params:xml:ns:yang:ietf-syslog";
prefix syslog; prefix syslog;
import ietf-inet-types { import ietf-inet-types {
prefix inet; prefix inet;
reference reference
"RFC 6991: INET Types Model"; "RFC 6991: Common YANG Data Types";
} }
import ietf-interfaces { import ietf-interfaces {
prefix if; prefix if;
reference reference
"RFC 7223: Interfaces Model"; "I-D.ietf-netmod-rfc7223bis: A YANG Data Model
for Interface Management";
} }
import ietf-tls-client { import ietf-tls-client {
prefix tlsc; prefix tlsc;
reference reference
"I-D.ietf-netconf-tls-client-server: "I-D.ietf-netconf-tls-client-server:
TLS Client and Server Models"; YANG Groupings for TLS Clients and TLS Servers";
} }
import ietf-keystore { import ietf-keystore {
prefix ks; prefix ks;
reference reference
"I-D.ietf-netconf-keystore: Keystore Model"; "I-D.ietf-netconf-keystore: YANG Data Model for a
Keystore Mechanism";
} }
organization organization
"IETF NETMOD (Network Modeling) Working Group"; "IETF NETMOD (Network Modeling) Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netmod/> "WG Web: <http://tools.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org> WG List: <mailto:netmod@ietf.org>
Editor: Kiran Agrahara Sreenivasa Editor: Kiran Agrahara Sreenivasa
skipping to change at page 10, line 19 skipping to change at page 10, line 21
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as 'OPTIONAL' in the module text are to be interpreted as
described in RFC 2119 (http://tools.ietf.org/html/rfc2119). described in RFC 2119 (http://tools.ietf.org/html/rfc2119).
This version of this YANG module is part of RFC zzzz This version of this YANG module is part of RFC zzzz
(http://tools.ietf.org/html/rfczzzz); see the RFC itself for (http://tools.ietf.org/html/rfczzzz); see the RFC itself for
full legal notices."; full legal notices.";
revision 2018-03-08 { revision 2018-03-14 {
description description
"Initial Revision"; "Initial Revision";
reference reference
"RFC zzzz: Syslog YANG Model"; "RFC zzzz: Syslog YANG Model";
} }
feature console-action { feature console-action {
description description
"This feature indicates that the local console action is "This feature indicates that the local console action is
supported."; supported.";
skipping to change at page 11, line 38 skipping to change at page 11, line 40
feature signed-messages { feature signed-messages {
description description
"This feature represents the ability to configure signed "This feature represents the ability to configure signed
syslog messages."; syslog messages.";
reference reference
"RFC 5848: Signed Syslog Messages"; "RFC 5848: Signed Syslog Messages";
} }
typedef syslog-severity { typedef syslog-severity {
type enumeration { type enumeration {
enum "emergency" { enum "emergency" {
value 0; value 0;
description description
"The severity level 'Emergency' indicating that the "The severity level 'Emergency' indicating that the
system is unusable."; system is unusable.";
} }
enum "alert" { enum "alert" {
value 1; value 1;
description description
"The severity level 'Alert' indicating that an action "The severity level 'Alert' indicating that an action
skipping to change at page 12, line 38 skipping to change at page 12, line 41
value 7; value 7;
description description
"The severity level 'Debug' indicating a debug-level "The severity level 'Debug' indicating a debug-level
message."; message.";
} }
} }
description description
"The definitions for Syslog message severity. "The definitions for Syslog message severity.
Note that a lower value is a higher severity. Comparisons of Note that a lower value is a higher severity. Comparisons of
equal-or-higher severity mean equal or lower numeric value"; equal-or-higher severity mean equal or lower numeric value";
reference reference
"RFC 5424: The Syslog Protocol"; "RFC 5424: The Syslog Protocol";
} }
identity syslog-facility { identity syslog-facility {
description description
"This identity is used as a base for all syslog facilities."; "This identity is used as a base for all syslog facilities.";
reference reference
"RFC 5424: The Syslog Protocol"; "RFC 5424: The Syslog Protocol";
} }
skipping to change at page 16, line 37 skipping to change at page 16, line 38
grouping severity-filter { grouping severity-filter {
description description
"This grouping defines the processing used to select "This grouping defines the processing used to select
log messages by comparing syslog message severity using log messages by comparing syslog message severity using
the following processing rules: the following processing rules:
- if 'none', do not match. - if 'none', do not match.
- if 'all', match. - if 'all', match.
- else compare message severity with the specified severity - else compare message severity with the specified severity
according to the default compare rule (all messages of the according to the default compare rule (all messages of the
specified severity and greater match) or if the specified severity and greater match) or if the
select-adv-compare feature is present, the advance-compare select-adv-compare feature is present, use the
rule."; advance-compare rule.";
leaf severity { leaf severity {
type union { type union {
type syslog-severity; type syslog-severity;
type enumeration { type enumeration {
enum none { enum none {
value 2147483647; value 2147483647;
description description
"This enum describes the case where no severities "This enum describes the case where no severities
are selected."; are selected.";
} }
skipping to change at page 18, line 5 skipping to change at page 18, line 7
"The action can be used to specify if the message should "The action can be used to specify if the message should
be logged or blocked based on the outcome of the compare be logged or blocked based on the outcome of the compare
operation."; operation.";
} }
description description
"This container describes additional severity compare "This container describes additional severity compare
operations that can be used in place of the default operations that can be used in place of the default
severity comparison. The compare leaf specifies the type of severity comparison. The compare leaf specifies the type of
the compare that is done and the action leaf specifies the the compare that is done and the action leaf specifies the
intended result. intended result.
Example: compare->equals and action->no-match means Example: compare->equals and action->block means
messages that have a severity that is not equal to the messages that have a severity that are equal to the
specified severity will be logged."; specified severity will not be logged.";
} }
} }
grouping selector { grouping selector {
description description
"This grouping defines a syslog selector which is used to "This grouping defines a syslog selector which is used to
select log messages for the log-actions (console, file, select log messages for the log-actions (console, file,
remote, etc.). Choose one or both of the following: remote, etc.). Choose one or both of the following:
facility [<facility> <severity>...] facility [<facility> <severity>...]
pattern-match regular-expression-match-string pattern-match regular-expression-match-string
skipping to change at page 20, line 4 skipping to change at page 20, line 6
is assumed that the local implementation defined limits is assumed that the local implementation defined limits
will be used."; will be used.";
list log-file { list log-file {
key "name"; key "name";
description description
"This list describes a collection of local logging "This list describes a collection of local logging
files."; files.";
leaf name { leaf name {
type inet:uri { type inet:uri {
pattern 'file:.*'; pattern 'file:.*';
} }
description description
"This leaf specifies the name of the log file which "This leaf specifies the name of the log file which
MUST use the uri scheme file:."; MUST use the uri scheme file:.";
reference
"RFC 8089: The file URI Scheme";
} }
uses selector; uses selector;
uses structured-data; uses structured-data;
container file-rotation { container file-rotation {
description description
"This container describes the configuration "This container describes the configuration
parameters for log file rotation."; parameters for log file rotation.";
leaf number-of-files { leaf number-of-files {
if-feature file-limit-size; if-feature file-limit-size;
type uint32; type uint32;
skipping to change at page 24, line 54 skipping to change at page 25, line 4
Signature Block, resend it. A value of 0 means Signature Block, resend it. A value of 0 means
that you don't resend based on the number of that you don't resend based on the number of
messages."; messages.";
} }
} }
} }
} }
} }
} }
} }
} }
<CODE ENDS> <CODE ENDS>
Figure 3. ietf-syslog Module Figure 3. ietf-syslog Module
5. Usage Examples 4. Usage Examples
Requirement: Requirement:
Enable console logging of syslogs of severity critical Enable console logging of syslogs of severity critical
<syslog xmlns="urn:ietf:params:xml:ns:yang:ietf-syslog"> <syslog xmlns="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>
skipping to change at page 25, line 47 skipping to change at page 25, line 52
<severity>error</severity> <severity>error</severity>
</facility-list> </facility-list>
</facility-filter> </facility-filter>
</destination> </destination>
</remote> </remote>
</actions> </actions>
</syslog> </syslog>
Figure 4. ietf-syslog Examples Figure 4. ietf-syslog Examples
6. Acknowledgements 5. 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, Martin Bjorklund, Alex Campbell, Alex Clemm, Francis Andy Bierman, Martin Bjorklund, Alex Campbell, Alex Clemm, Francis
Dupont, Jim Gibson, Jeffrey Haas, Bob Harold, John Heasley, Giles Dupont, Jim Gibson, Jeffrey Haas, Bob Harold, John Heasley, Giles
Heron, Lisa Huang, Mahesh Jethanandani, Warren Kumari, Jeffrey K Heron, Lisa Huang, Mahesh Jethanandani, Warren Kumari, Jeffrey K
Lange, Jan Lindblad, Chris Lonvick, Alexey Melnikov, Kathleen Lange, Jan Lindblad, Chris Lonvick, Alexey Melnikov, Kathleen
Moriarty, Tom Petch, Juergen Schoenwaelder, Phil Shafer, Yaron Moriarty, Tom Petch, Adam Roach, Juergen Schoenwaelder, Phil Shafer,
Sheffer, Jason Sterne, Peter Van Horne, Kent Watsen, Bert Wijnen, Yaron Sheffer, Jason Sterne, Peter Van Horne, Kent Watsen, Bert
Dale R Worley, and Aleksandr Zhdankin. Wijnen, Dale R Worley, and Aleksandr Zhdankin.
7. IANA Considerations 6. IANA Considerations
7.1. The IETF XML Registry 6.1. The IETF XML Registry
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 IESG. Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
7.2. The YANG Module Names Registry 6.2. 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 following registry [RFC7895]. Following the format in [RFC7950], the following
registration is requested: 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 7. 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
via YANG based management protocols, such as NETCONF [RFC6241] and via YANG based management protocols, such as NETCONF [RFC6241] and
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.
skipping to change at page 27, line 48 skipping to change at page 27, line 48
about other hosts in the network, and the TLS transport about other hosts in the network, and the TLS transport
certificate properties if TLS is selected as the transport certificate properties if TLS is selected as the transport
protocol. protocol.
remote/destination/signing: This subtree contains information remote/destination/signing: This subtree contains information
about the syslog message signing properties including signing about the syslog message signing properties including signing
certificate information. certificate information.
There are no RPC operations defined in this YANG module. There are no RPC operations defined in this YANG module.
9. References 8. References
9.1. Normative References 8.1. Normative References
[I-D.ietf-netconf-keystore] [I-D.ietf-netconf-keystore]
Watsen, K., "YANG Data Model for a "Keystore" Mechanism", Watsen, K., "YANG Data Model for a "Keystore" Mechanism",
Internet-Draft draft-ietf-netconf-keystore-04, October Internet-Draft draft-ietf-netconf-keystore-04, October
2017. 2017.
[I-D.ietf-netconf-tls-client-server] [I-D.ietf-netconf-tls-client-server]
Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and
TLS Servers", Internet-Draft draft-ietf-netconf-tls- TLS Servers", Internet-Draft draft-ietf-netconf-tls-
client-server-05, October 2017. client-server-05, October 2017.
[I-D.ietf-netmod-rfc7223bis]
Bjorklund, M., "A YANG Data Model for Interface
Management", Internet-Draft draft-ietf-netmod-
rfc7223bis-03, January 2018.
[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, DOI 10.17487/ Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/
RFC2119, March 1997, <http://www.rfc-editor.org/info/ RFC2119, March 1997, <http://www.rfc-editor.org/info/
rfc2119>. rfc2119>.
[RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424, DOI [RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424, DOI
10.17487/RFC5424, March 2009, <http://www.rfc-editor.org/ 10.17487/RFC5424, March 2009, <http://www.rfc-editor.org/
info/rfc5424>. info/rfc5424>.
[RFC5425] Miao, F., Ed., Ma, Y.Ed., and J. Salowey, Ed., "Transport [RFC5425] Miao, F., Ed., Ma, Y.Ed., and J. Salowey, Ed., "Transport
skipping to change at page 28, line 30 skipping to change at page 28, line 35
editor.org/info/rfc5425>. 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, <http://www RFC 5426, DOI 10.17487/RFC5426, March 2009, <http://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,
<http://www.rfc-editor.org/info/rfc5848>. <http://www.rfc-editor.org/info/rfc5848>.
[RFC7223] Bjorklund, M., "A YANG Data Model for Interface [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC
Management", RFC 7223, DOI 10.17487/RFC7223, May 2014, 6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-
<http://www.rfc-editor.org/info/rfc7223>. editor.org/info/rfc6991>.
[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,
<http://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, <http://www RFC 7950, DOI 10.17487/RFC7950, August 2016, <http://www
.rfc-editor.org/info/rfc7950>. .rfc-editor.org/info/rfc7950>.
[RFC8089] Kerwin, M., "The "file" URI Scheme", RFC 8089, DOI [RFC8089] Kerwin, M., "The "file" URI Scheme", RFC 8089, DOI
skipping to change at page 28, line 56 skipping to change at page 29, line 9
[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, <http://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, <http:// 1003.1-2008, 2016 Edition.", September 2016, <http://
pubs.opengroup.org/onlinepubs/9699919799/>. pubs.opengroup.org/onlinepubs/9699919799/>.
9.2. Informative References 8.2. Informative References
[I-D.ietf-netmod-revised-datastores] [I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K. Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.
and R. Wilton, "Network Management Datastore and R. Wilton, "Network Management Datastore
Architecture", Internet-Draft draft-ietf-netmod-revised- Architecture", Internet-Draft draft-ietf-netmod-revised-
datastores-10, January 2018. datastores-10, January 2018.
[I-D.ietf-netmod-yang-tree-diagrams] [I-D.ietf-netmod-yang-tree-diagrams]
Bjorklund, M. and L. Berger, "YANG Tree Diagrams", Bjorklund, M. and L. Berger, "YANG Tree Diagrams",
Internet-Draft draft-ietf-netmod-yang-tree-diagrams-06, Internet-Draft draft-ietf-netmod-yang-tree-diagrams-06,
skipping to change at page 29, line 34 skipping to change at page 29, line 40
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, DOI Protocol (NETCONF) Access Control Model", RFC 6536, DOI
10.17487/RFC6536, March 2012, <https://www.rfc-editor.org/ 10.17487/RFC6536, March 2012, <https://www.rfc-editor.org/
info/rfc6536>. 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. Implementer Guidelines
Appendix 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
skipping to change at page 30, line 44 skipping to change at page 30, line 44
"Adding vendor specific type 1 to syslog-facility"; "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 description
"Adding vendor specific type 2 to syslog-facility"; "Adding vendor specific type 2 to syslog-facility";
} }
} }
Appendix A.2. Syslog Terminal Output
Terminal output with requirements more complex than the console
subtree currently provides, are expected to be supported via vendor
extensions rather than handled via the file subtree.
Appendix A.3. Syslog File Naming Convention
The syslog/file/log-file/file-rotation container contains
configuration parameters for syslog file rotation. This section
describes how these fields might be used by an implementer to name
syslog files in a rotation process. This information is offered as
an informative guide only.
When an active syslog file with a name specified by log-file/name,
reaches log-file/max-file-size and/or syslog events arrive after the
period specified by log-file/rollover, the logging system can close
the file, can compresses it, and can name the archive file <log-file/
name>.0.gz. The logging system can then open a new active syslog
file <log-file/name>.
When the new syslog file reaches either of the size limits referenced
above, <log-file/name>.0.gz can be renamed <log-file/name>.1.gz and
the new syslog file can be closed, compressed and renamed <log-file/
name>.0.gz. Each time that a new syslog file is closed, each of the
prior syslog archive files named <log-file/name>.<n>.gz can be
renamed to <log-file/name>.<n + 1>.gz.
Removal of archive log files could occur when either or both:
- log-file/number-of-files specified - the logging system can create
up to log-file/number-of-files syslog archive files after which, the
contents of the last archived file could be overwritten.
- log-file/retention specified - the logging system can remove those
syslog archive files whose file expiration time (file creation time
plus the specified log-file/retention time) is prior to the current
time.
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
 End of changes. 41 change blocks. 
88 lines changed or deleted 122 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/