draft-ietf-netmod-syslog-model-20.txt   draft-ietf-netmod-syslog-model-21.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: August 13, 2018 Verizon Wireless Expires: August 18, 2018 Verizon Wireless
February 09, 2018 February 14, 2018
A YANG Data Model for Syslog Configuration A YANG Data Model for Syslog Configuration
draft-ietf-netmod-syslog-model-20 draft-ietf-netmod-syslog-model-21
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
Datastore Architecture defined in [I-D.ietf-netmod-revised-
datastores].
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 document contains many placeholder values that need to be
with finalized values at the time of publication. This note replaced with finalized values at the time of publication. This note
summarizes all of the substitutions that are needed. No other RFC summarizes all of the substitutions that are needed. No other RFC
Editor instructions are specified elsewhere in this document. Editor instructions are specified elsewhere in this document.
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 "I-D.ietf-netconf-keystore" --> the assigned RFC value for draft- o "I-D.ietf-netconf-keystore" --> the assigned RFC value for draft-
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
skipping to change at page 2, line 10 skipping to change at page 2, line 12
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 https://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 August 13, 2018. This Internet-Draft will expire on August 18, 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 Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 32 skipping to change at page 2, line 34
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are 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 . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. NDMA Compliance . . . . . . . . . . . . . . . . . . . . . 4
2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4 2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4
3. Design of the Syslog Model . . . . . . . . . . . . . . . . . 4 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 . . . . . . . . . . . . . . . . . . . . . 8
4.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . 8 4.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . 8
5. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . 27 5. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . 27
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 27 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 27
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 28 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 28
7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 28 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 28
7.2. The YANG Module Names Registry . . . . . . . . . . . . . 28 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 28
skipping to change at page 4, line 5 skipping to change at page 4, line 5
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. NDMA Compliance
The YANG model in this document conforms to the Network Management
Datastore Architecture defined in [I-D.ietf-netmod-revised-
datastores].
2. Problem Statement 2. Problem Statement
This document defines a YANG [RFC7950] configuration data model that This document defines a YANG [RFC7950] configuration data model that
may be used to configure the syslog feature running on a system. may be used to configure the syslog feature running on a system.
YANG models can be used with network management protocols such as YANG models can be used with network management protocols such as
NETCONF [RFC6241] to install, manipulate, and delete the NETCONF [RFC6241] to install, manipulate, and delete the
configuration of network devices. configuration of network devices.
The data model makes use of the YANG "feature" construct which allows The data model makes use of the YANG "feature" construct which allows
implementations to support only those syslog features that lie within implementations to support only those syslog features that lie within
their capabilities. their capabilities.
This module can be used to configure the syslog application This module can be used to configure the syslog application
conceptual layers as implemented on the target system. conceptual layers as implemented on the target system.
3. Design of the Syslog Model 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 draft 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
functionality that is present in specific vendor configurations. functionality that is present in specific vendor configurations.
Syslog consists of originators and collectors. The following diagram Syslog consists of originators and collectors. The following diagram
shows syslog messages flowing from originators, to collectors where shows syslog messages flowing from originators, to collectors where
filtering can take place. filtering can take place.
skipping to change at page 8, line 46 skipping to change at page 8, line 46
+--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 [RFC7223], groupings from [I- This module imports typedefs from [RFC7223], groupings from
D.ietf-netconf-keystore], and [I-D.ietf-netconf-tls-client-server], [I-D.ietf-netconf-keystore], and
and it references [RFC5424], [RFC5425], [RFC5426], and [RFC5848] and [I-D.ietf-netconf-tls-client-server], and it references [RFC5424],
[Std-1003.1-2008]. [RFC5425], [RFC5426], and [RFC5848] and [Std-1003.1-2008].
<CODE BEGINS> file "ietf-syslog@2018-02-09.yang" <CODE BEGINS> file "ietf-syslog@2018-02-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: INET Types Model";
skipping to change at page 10, line 24 skipping to change at page 10, line 24
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-02-09 { revision 2018-02-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 29, line 35 skipping to change at page 29, line 35
[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",
draft-ietf-netconf-keystore-04 (work in progress), October draft-ietf-netconf-keystore-04 (work in progress), 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", draft-ietf-netconf-tls-client-server-05 TLS Servers", draft-ietf-netconf-tls-client-server-05
(work in progress), October 2017. (work in progress), October 2017.
[I-D.ietf-netmod-yang-tree-diagrams]
Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft-
ietf-netmod-yang-tree-diagrams-05 (work in progress),
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, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424, [RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424,
DOI 10.17487/RFC5424, March 2009, DOI 10.17487/RFC5424, March 2009,
<https://www.rfc-editor.org/info/rfc5424>. <https://www.rfc-editor.org/info/rfc5424>.
[RFC5425] Miao, F., Ed., Ma, Y., Ed., and J. Salowey, Ed., [RFC5425] Miao, F., Ed., Ma, Y., Ed., and J. Salowey, Ed.,
skipping to change at page 30, line 42 skipping to change at page 30, line 33
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://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://pubs.opengroup.org/onlinepubs/9699919799/>. <http://pubs.opengroup.org/onlinepubs/9699919799/>.
9.2. Informative References 9.2. Informative References
[I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-10
(work in progress), January 2018.
[I-D.ietf-netmod-yang-tree-diagrams]
Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft-
ietf-netmod-yang-tree-diagrams-05 (work in progress),
January 2018.
[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,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-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>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
 End of changes. 13 change blocks. 
18 lines changed or deleted 35 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/