--- 1/draft-ietf-netconf-netconf-client-server-06.txt 2018-09-20 19:13:18.043145539 -0700
+++ 2/draft-ietf-netconf-netconf-client-server-07.txt 2018-09-20 19:13:18.163148395 -0700
@@ -1,19 +1,18 @@
NETCONF Working Group K. Watsen
Internet-Draft Juniper Networks
-Intended status: Standards Track G. Wu
-Expires: December 6, 2018 Cisco Networks
- June 4, 2018
+Intended status: Standards Track September 20, 2018
+Expires: March 24, 2019
NETCONF Client and Server Models
- draft-ietf-netconf-netconf-client-server-06
+ draft-ietf-netconf-netconf-client-server-07
Abstract
This document defines two YANG modules, one module to configure a
NETCONF client and the other module to configure a NETCONF server.
Both modules support both the SSH and TLS transport protocols, and
support both standard NETCONF and NETCONF Call Home connections.
Editorial Note (To be removed by RFC Editor)
@@ -40,42 +39,42 @@
o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-ssh-client-
server
o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-tls-client-
server
Artwork in this document contains placeholder values for the date of
publication of this draft. Please apply the following replacement:
- o "2018-06-04" --> the publication date of this draft
+ o "2018-09-20" --> the publication date of this draft
The following Appendix section is to be removed prior to publication:
o Appendix A. Change Log
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
- This Internet-Draft will expire on December 6, 2018.
+ This Internet-Draft will expire on March 24, 2019.
Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
@@ -84,57 +83,58 @@
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
- 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 9
- 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 11
- 4. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 22
- 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 22
- 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 28
- 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 33
- 5. Design Considerations . . . . . . . . . . . . . . . . . . . . 44
- 5.1. Support all NETCONF transports . . . . . . . . . . . . . 45
- 5.2. Enable each transport to select which keys to use . . . . 45
- 5.3. Support authenticating NETCONF clients certificates . . . 45
+ 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 11
+ 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 14
+ 4. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 24
+ 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 25
+ 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 32
+ 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 37
+ 5. Design Considerations . . . . . . . . . . . . . . . . . . . . 49
+ 5.1. Support all NETCONF transports . . . . . . . . . . . . . 49
+ 5.2. Enable each transport to select which keys to use . . . . 49
+ 5.3. Support authenticating NETCONF clients certificates . . . 49
5.4. Support mapping authenticated NETCONF client certificates
- to usernames . . . . . . . . . . . . . . . . . . . . . . 45
- 5.5. Support both listening for connections and call home . . 45
- 5.6. For Call Home connections . . . . . . . . . . . . . . . . 46
- 5.6.1. Support more than one NETCONF client . . . . . . . . 46
- 5.6.2. Support NETCONF clients having more than one endpoint 46
- 5.6.3. Support a reconnection strategy . . . . . . . . . . . 46
- 5.6.4. Support both persistent and periodic connections . . 46
- 5.6.5. Reconnection strategy for periodic connections . . . 46
- 5.6.6. Keep-alives for persistent connections . . . . . . . 47
- 5.6.7. Customizations for periodic connections . . . . . . . 47
- 6. Security Considerations . . . . . . . . . . . . . . . . . . . 47
- 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 48
- 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 48
- 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 48
- 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 49
- 8.1. Normative References . . . . . . . . . . . . . . . . . . 49
- 8.2. Informative References . . . . . . . . . . . . . . . . . 50
- Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 51
- A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 51
- A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 51
- A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 51
- A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 51
- A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 51
- A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 52
- Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 52
- Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 52
+ to usernames . . . . . . . . . . . . . . . . . . . . . . 49
+ 5.5. Support both listening for connections and call home . . 50
+ 5.6. For Call Home connections . . . . . . . . . . . . . . . . 50
+ 5.6.1. Support more than one NETCONF client . . . . . . . . 50
+ 5.6.2. Support NETCONF clients having more than one endpoint 50
+ 5.6.3. Support a reconnection strategy . . . . . . . . . . . 50
+ 5.6.4. Support both persistent and periodic connections . . 50
+ 5.6.5. Reconnection strategy for periodic connections . . . 51
+ 5.6.6. Keep-alives for persistent connections . . . . . . . 51
+ 5.6.7. Customizations for periodic connections . . . . . . . 51
+ 6. Security Considerations . . . . . . . . . . . . . . . . . . . 51
+ 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 52
+ 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 52
+ 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 53
+ 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 53
+ 8.1. Normative References . . . . . . . . . . . . . . . . . . 53
+ 8.2. Informative References . . . . . . . . . . . . . . . . . 54
+ Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 56
+ A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 56
+ A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 56
+ A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 56
+ A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 56
+ A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 56
+ A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 57
+ A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 57
+ Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 57
+ Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 57
1. Introduction
This document defines two YANG [RFC7950] modules, one module to
configure a NETCONF [RFC6241] client and the other module to
configure a NETCONF server. Both modules support both NETCONF over
SSH [RFC6242] and NETCONF over TLS [RFC7589] and NETCONF Call Home
connections [RFC8071].
2. Terminology
@@ -159,282 +159,385 @@
All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to
advertise which parts of the model the NETCONF client supports.
3.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-netconf-client" module. Just the container is
- displayed below, but there is also a reuable grouping by the same
- name that the container is using.
+ displayed below, but there is also a reusable grouping called
+ "netconf-client-grouping" that the container is using.
[Note: '\' line wrapping for formatting only]
module: ietf-netconf-client
+--rw netconf-client
+--rw initiate! {initiate}?
| +--rw netconf-server* [name]
| +--rw name string
| +--rw endpoints
| | +--rw endpoint* [name]
| | +--rw name string
| | +--rw (transport)
| | +--:(ssh) {ssh-initiate}?
| | | +--rw ssh
| | | +--rw address? inet:host
- | | | +--rw port? inet:port-number\
-
+ | | | +--rw port? inet:port-number
| | | +--rw client-identity
| | | | +--rw username? string
| | | | +--rw (auth-type)
| | | | +--:(password)
| | | | | +--rw password? string
| | | | +--:(public-key)
| | | | | +--rw public-key
| | | | | +--rw (local-or-keystore)
| | | | | +--:(local)
- | | | | | | +--rw algorithm
+ | | | | | | {local-keys-suppor\
+ ted}?
+ | | | | | | +--rw algorithm?
| | | | | | | ct:key-algorithm\
-ref
- | | | | | | +--rw public-key bin\
- ary
- | | | | | | +--rw private-key uni\
- on
+ | | | | | | +--rw public-key?
+ | | | | | | | binary
+ | | | | | | +--rw private-key?
+ | | | | | | | union
+ | | | | | | +---x generate-hidden-key
+ | | | | | | | +---w input
+ | | | | | | | +---w algorithm
+ | | | | | | | ct:key-alg\
+ orithm-ref
+ | | | | | | +---x install-hidden-key
+ | | | | | | +---w input
+ | | | | | | +---w algorithm
+ | | | | | | | ct:key-alg\
+ orithm-ref
+ | | | | | | +---w public-key?
+ | | | | | | | binary
+ | | | | | | +---w private-key?
+ | | | | | | binary
| | | | | +--:(keystore)
- | | | | | {keystore-implemen\
- ted}?
- | | | | | +--rw reference
+ | | | | | {keystore-supporte\
+ d}?
+ | | | | | +--rw reference?
| | | | | ks:asymmetric-ke\
y-ref
| | | | +--:(certificate)
| | | | +--rw certificate
| | | | {sshcmn:ssh-x509-certs}?
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
- | | | | | +--rw algorithm
+ | | | | | {local-keys-suppor\
+ ted}?
+ | | | | | +--rw algorithm?
| | | | | | ct:key-algorithm\
-ref
- | | | | | +--rw public-key
+ | | | | | +--rw public-key?
| | | | | | binary
- | | | | | +--rw private-key
+ | | | | | +--rw private-key?
| | | | | | union
+ | | | | | +---x generate-hidden-key
+ | | | | | | +---w input
+ | | | | | | +---w algorithm
+ | | | | | | ct:key-alg\
+ orithm-ref
+ | | | | | +---x install-hidden-key
+ | | | | | | +---w input
+ | | | | | | +---w algorithm
+ | | | | | | | ct:key-alg\
+ orithm-ref
+ | | | | | | +---w public-key?
+ | | | | | | | binary
+ | | | | | | +---w private-key?
+ | | | | | | binary
| | | | | +--rw cert
| | | | | | ct:end-entity-ce\
rt-cms
| | | | | +---n certificate-expira\
tion
| | | | | +-- expiration-date?
| | | | | yang:date-and\
-time
| | | | +--:(keystore)
- | | | | {keystore-implemen\
- ted}?
- | | | | +--rw reference
+ | | | | {keystore-supporte\
+ d}?
+ | | | | +--rw reference?
| | | | ks:asymmetric-ke\
y-certificate-ref
| | | +--rw server-auth
| | | | +--rw pinned-ssh-host-keys?
| | | | | ta:pinned-host-keys-ref
+ | | | | | {ta:ssh-host-keys}?
| | | | +--rw pinned-ca-certs?
| | | | | ta:pinned-certificates-ref
- | | | | | {sshcmn:ssh-x509-certs}?
+ | | | | | {sshcmn:ssh-x509-certs,ta:x509-\
+ certificates}?
| | | | +--rw pinned-server-certs?
| | | | ta:pinned-certificates-ref
- | | | | {sshcmn:ssh-x509-certs}?
+ | | | | {sshcmn:ssh-x509-certs,ta:x509-\
+ certificates}?
| | | +--rw transport-params
| | | {ssh-client-transport-params-confi\
g}?
| | | +--rw host-key
| | | | +--rw host-key-alg* identityref
| | | +--rw key-exchange
- | | | | +--rw key-exchange-alg* identityre\
- f
+ | | | | +--rw key-exchange-alg* identityref
| | | +--rw encryption
| | | | +--rw encryption-alg* identityref
| | | +--rw mac
| | | +--rw mac-alg* identityref
| | +--:(tls) {tls-initiate}?
| | +--rw tls
| | +--rw address? inet:host
| | +--rw port? inet:port-number
| | +--rw client-identity
| | | +--rw (auth-type)
| | | +--:(certificate)
| | | +--rw certificate
| | | +--rw (local-or-keystore)
| | | +--:(local)
- | | | | +--rw algorithm
+ | | | | {local-keys-suppor\
+ ted}?
+ | | | | +--rw algorithm?
| | | | | ct:key-algorithm\
-ref
- | | | | +--rw public-key
+ | | | | +--rw public-key?
| | | | | binary
- | | | | +--rw private-key
+ | | | | +--rw private-key?
| | | | | union
+ | | | | +---x generate-hidden-key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | ct:key-alg\
+ orithm-ref
+ | | | | +---x install-hidden-key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | | ct:key-alg\
+ orithm-ref
+ | | | | | +---w public-key?
+ | | | | | | binary
+ | | | | | +---w private-key?
+ | | | | | binary
| | | | +--rw cert
| | | | | ct:end-entity-ce\
rt-cms
| | | | +---n certificate-expira\
tion
| | | | +-- expiration-date?
| | | | yang:date-and\
-time
| | | +--:(keystore)
- | | | {keystore-implemen\
- ted}?
- | | | +--rw reference
+ | | | {keystore-supporte\
+ d}?
+ | | | +--rw reference?
| | | ks:asymmetric-ke\
+
y-certificate-ref
| | +--rw server-auth
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
+ | | | | {ta:x509-certificates}?
| | | +--rw pinned-server-certs?
| | | ta:pinned-certificates-ref
+ | | | {ta:x509-certificates}?
| | +--rw hello-params
| | {tls-client-hello-params-config}?
| | +--rw tls-versions
| | | +--rw tls-version* identityref
| | +--rw cipher-suites
| | +--rw cipher-suite* identityref
| +--rw connection-type
- | | +--rw (connection-type)?
+ | | +--rw (connection-type)
| | +--:(persistent-connection)
| | | +--rw persistent!
- | | | +--rw idle-timeout? uint32
| | | +--rw keep-alives
| | | +--rw max-wait? uint16
| | | +--rw max-attempts? uint8
| | +--:(periodic-connection)
| | +--rw periodic!
+ | | +--rw period? uint16
+ | | +--rw anchor-time? yang:date-and-time
| | +--rw idle-timeout? uint16
- | | +--rw reconnect-timeout? uint16
| +--rw reconnect-strategy
| +--rw start-with? enumeration
| +--rw max-attempts? uint8
+--rw listen! {listen}?
+--rw idle-timeout? uint16
+--rw endpoint* [name]
+--rw name string
+--rw (transport)
+--:(ssh) {ssh-listen}?
| +--rw ssh
| +--rw address? inet:ip-address
| +--rw port? inet:port-number
| +--rw client-identity
| | +--rw username? string
| | +--rw (auth-type)
| | +--:(password)
| | | +--rw password? string
| | +--:(public-key)
| | | +--rw public-key
| | | +--rw (local-or-keystore)
- | | | +--:(local)
- | | | | +--rw algorithm
+ | | | +--:(local) {local-keys-supported\
+ }?
+ | | | | +--rw algorithm?
| | | | | ct:key-algorithm-ref
- | | | | +--rw public-key binary
- | | | | +--rw private-key union
- | | | +--:(keystore)
- | | | {keystore-implemented}?
- | | | +--rw reference
+ | | | | +--rw public-key?
+ | | | | | binary
+ | | | | +--rw private-key?
+ | | | | | union
+ | | | | +---x generate-hidden-key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | ct:key-algorithm\
+ -ref
+ | | | | +---x install-hidden-key
+ | | | | +---w input
+ | | | | +---w algorithm
+ | | | | | ct:key-algorithm\
+ -ref
+ | | | | +---w public-key? bin\
+ ary
+ | | | | +---w private-key? bin\
+ ary
+ | | | +--:(keystore) {keystore-supporte\
+ d}?
+ | | | +--rw reference?
| | | ks:asymmetric-key-ref
| | +--:(certificate)
| | +--rw certificate {sshcmn:ssh-x509-cert\
s}?
| | +--rw (local-or-keystore)
- | | +--:(local)
- | | | +--rw algorithm
+ | | +--:(local) {local-keys-supported\
+ }?
+ | | | +--rw algorithm?
| | | | ct:key-algorithm-ref
- | | | +--rw public-key
+ | | | +--rw public-key?
| | | | binary
- | | | +--rw private-key
+ | | | +--rw private-key?
| | | | union
+ | | | +---x generate-hidden-key
+ | | | | +---w input
+ | | | | +---w algorithm
+ | | | | ct:key-algorithm\
+ -ref
+ | | | +---x install-hidden-key
+ | | | | +---w input
+ | | | | +---w algorithm
+ | | | | | ct:key-algorithm\
+ -ref
+ | | | | +---w public-key? bin\
+ ary
+ | | | | +---w private-key? bin\
+ ary
| | | +--rw cert
- | | | | ct:end-entity-cert-cms\
-
+ | | | | ct:end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date?
| | | yang:date-and-time
- | | +--:(keystore)
- | | {keystore-implemented}?
- | | +--rw reference
+ | | +--:(keystore) {keystore-supporte\
+ d}?
+ | | +--rw reference?
| | ks:asymmetric-key-cert\
ificate-ref
| +--rw server-auth
| | +--rw pinned-ssh-host-keys?
| | | ta:pinned-host-keys-ref
+ | | | {ta:ssh-host-keys}?
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
- | | | {sshcmn:ssh-x509-certs}?
+ | | | {sshcmn:ssh-x509-certs,ta:x509-certif\
+ icates}?
| | +--rw pinned-server-certs?
| | ta:pinned-certificates-ref
- | | {sshcmn:ssh-x509-certs}?
+ | | {sshcmn:ssh-x509-certs,ta:x509-certif\
+ icates}?
| +--rw transport-params
| {ssh-client-transport-params-config}?
| +--rw host-key
| | +--rw host-key-alg* identityref
| +--rw key-exchange
| | +--rw key-exchange-alg* identityref
| +--rw encryption
| | +--rw encryption-alg* identityref
| +--rw mac
| +--rw mac-alg* identityref
+--:(tls) {tls-listen}?
+--rw tls
+--rw address? inet:ip-address
+--rw port? inet:port-number
+--rw client-identity
| +--rw (auth-type)
| +--:(certificate)
| +--rw certificate
| +--rw (local-or-keystore)
- | +--:(local)
- | | +--rw algorithm
+ | +--:(local) {local-keys-supported\
+ }?
+ | | +--rw algorithm?
| | | ct:key-algorithm-ref
- | | +--rw public-key
+ | | +--rw public-key?
| | | binary
- | | +--rw private-key
+ | | +--rw private-key?
| | | union
+ | | +---x generate-hidden-key
+ | | | +---w input
+ | | | +---w algorithm
+ | | | ct:key-algorithm\
+ -ref
+ | | +---x install-hidden-key
+ | | | +---w input
+ | | | +---w algorithm
+ | | | | ct:key-algorithm\
+ -ref
+ | | | +---w public-key? bin\
+ ary
+ | | | +---w private-key? bin\
+ ary
| | +--rw cert
- | | | ct:end-entity-cert-cms\
-
+ | | | ct:end-entity-cert-cms
| | +---n certificate-expiration
| | +-- expiration-date?
| | yang:date-and-time
- | +--:(keystore)
- | {keystore-implemented}?
- | +--rw reference
+ | +--:(keystore) {keystore-supporte\
+ d}?
+ | +--rw reference?
| ks:asymmetric-key-cert\
ificate-ref
+--rw server-auth
| +--rw pinned-ca-certs?
| | ta:pinned-certificates-ref
+ | | {ta:x509-certificates}?
| +--rw pinned-server-certs?
| ta:pinned-certificates-ref
+ | {ta:x509-certificates}?
+--rw hello-params
{tls-client-hello-params-config}?
+--rw tls-versions
| +--rw tls-version* identityref
+--rw cipher-suites
+--rw cipher-suite* identityref
3.2. Example Usage
The following example illustrates configuring a NETCONF client to
initiate connections, using both the SSH and TLS transport protocols,
as well as listening for call-home connections, again using both the
SSH and TLS transport protocols.
- This example is consistent with the examples presented in Section 2.2
+ This example is consistent with the examples presented in Section 3.2
of [I-D.ietf-netconf-keystore].
[Note: '\' line wrapping for formatting only]
+
corp-fw1
corp-fw1.example.com
@@ -516,43 +618,49 @@
3.3. YANG Module
This YANG module has normative references to [RFC6242], [RFC6991],
[RFC7589], [RFC8071], [I-D.ietf-netconf-ssh-client-server], and
[I-D.ietf-netconf-tls-client-server].
- file "ietf-netconf-client@2018-06-04.yang"
+ file "ietf-netconf-client@2018-09-20.yang"
module ietf-netconf-client {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client";
prefix "ncc";
+ import ietf-yang-types {
+ prefix yang;
+ reference
+ "RFC 6991: Common YANG Data Types";
+ }
+
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-ssh-client {
prefix ss;
- revision-date 2018-06-04; // stable grouping definitions
+ revision-date 2018-09-20; // stable grouping definitions
reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers";
}
import ietf-tls-client {
prefix ts;
- revision-date 2018-06-04; // stable grouping definitions
+ revision-date 2018-09-20; // stable grouping definitions
reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web:
WG List:
@@ -573,21 +681,21 @@
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
- revision "2018-06-04" {
+ revision "2018-09-20" {
description
"Initial version";
reference
"RFC XXXX: NETCONF Client and Server Models";
}
// Features
feature initiate {
description
@@ -635,26 +743,26 @@
feature tls-listen {
description
"The 'tls-listen' feature indicates that the NETCONF client
supports opening a port to listen for incoming NETCONF
server call-home TLS connections.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
container netconf-client {
- uses netconf-client;
+ uses netconf-client-grouping;
description
"Top-level container for NETCONF client configuration.";
}
- grouping netconf-client {
+ grouping netconf-client-grouping {
description
"Top-level grouping for NETCONF client configuration.";
container initiate {
if-feature initiate;
presence "Enables client to initiate TCP connections";
description
"Configures client initiating underlying TCP connections.";
list netconf-server {
key name;
@@ -757,61 +865,44 @@
}
} // end tls
}
}
}
container connection-type {
description
"Indicates the kind of connection to use.";
choice connection-type {
- default persistent-connection;
+ mandatory true;
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence
"Indicates that a persistent connection is to be
maintained.";
description
"Maintain a persistent connection to the NETCONF
server. If the connection goes down, immediately
start trying to reconnect to it, using the
reconnection strategy.
This connection type minimizes any NETCONF server
to NETCONF client data-transfer delay, albeit at
the expense of holding resources longer.";
- leaf idle-timeout {
- type uint32;
- units "seconds";
- default 86400; // one day;
- description
- "Specifies the maximum number of seconds that
- a NETCONF session may remain idle. A NETCONF
- session will be dropped if it is idle for an
- interval longer than this number of seconds.
- If set to zero, then the client will never
- drop a session because it is idle. Sessions
- that have a notification subscription active
- are never dropped.";
- }
container keep-alives {
description
"Configures the keep-alive policy, to
proactively test the aliveness of the SSH/TLS
server. An unresponsive SSH/TLS server will
be dropped after approximately max-attempts *
max-wait seconds.";
- reference
- "RFC 8071: NETCONF Call Home and RESTCONF Call
- Home, Section 3.1, item S6";
leaf max-wait {
type uint16 {
range "1..max";
}
units seconds;
default 30;
description
"Sets the amount of time in seconds after
which if no data has been received from the
SSH/TLS server, a SSH/TLS-level message will
@@ -830,55 +922,61 @@
}
}
}
}
case periodic-connection {
container periodic {
presence
"Indicates that a periodic connection is to be
maintained.";
description
- "Periodically connect to the NETCONF server, so
- that the NETCONF server may deliver messages
- pending for the NETCONF client. The NETCONF
- server must close the connection when it is
- ready to release it. Once the connection has
- been closed, the NETCONF client will restart
- its timer until the next connection.";
+ "Periodically connect to the NETCONF server. The
+ NETCONF server should close the connection upon
+ completing planned activities.
+
+ This connection type increases resource
+ utilization, albeit with increased delay in
+ NETCONF server to NETCONF client interactions.";
+ leaf period {
+ type uint16;
+ units "minutes";
+ default 60;
+ description
+ "Duration of time between periodic connections.";
+ }
+ leaf anchor-time {
+ type yang:date-and-time {
+ // constrained to minute-level granularity
+ pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}'
+ + '(Z|[\+\-]\d{2}:\d{2})';
+ }
+ description
+ "Designates a timestamp before or after which a
+ series of periodic connections are determined.
+ The periodic connections occur at a whole
+ multiple interval from the anchor time. For
+ example, for an anchor time is 15 minutes past
+ midnight and a period interval of 24 hours, then
+ a periodic connection will occur 15 minutes past
+ midnight everyday.";
+ }
leaf idle-timeout {
type uint16;
units "seconds";
- default 300; // five minutes
+ default 120; // two minutes
description
"Specifies the maximum number of seconds that
a NETCONF session may remain idle. A NETCONF
session will be dropped if it is idle for an
interval longer than this number of seconds.
- If set to zero, then the server will never
- drop a session because it is idle. Sessions
- that have a notification subscription active
- are never dropped.";
- }
- leaf reconnect-timeout {
- type uint16 {
- range "1..max";
-
- }
- units minutes;
- default 60;
- description
- "Sets the maximum amount of unconnected time
- the NETCONF client will wait before re-
- establishing a connection to the NETCONF
- server. The NETCONF client may initiate a
- connection before this time if desired
- (e.g., to set configuration).";
+ If set to zero, then the NETCONF client will
+ never drop a session because it is idle.";
}
}
}
}
}
container reconnect-strategy {
description
"The reconnection strategy directs how a NETCONF client
reconnects to a NETCONF server, after discovering its
connection to the server has dropped, even if due to a
@@ -895,20 +993,26 @@
}
enum last-connected {
description
"Indicates that reconnections should start with
the endpoint last connected to. If no previous
connection has ever been established, then the
first endpoint configured is used. NETCONF
clients SHOULD be able to remember the last
endpoint connected to across reboots.";
}
+ enum random-selection {
+ description
+ "Indicates that reconnections should start with
+ a random endpoint.";
+ }
+
}
default first-listed;
description
"Specifies which of the NETCONF server's endpoints
the NETCONF client should start with when trying
to connect to the NETCONF server.";
}
leaf max-attempts {
type uint8 {
range "1..max";
@@ -1046,22 +1150,22 @@
All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to
advertise which parts of the model the NETCONF server supports.
4.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-netconf-server" module. Just the container is
- displayed below, but there is also a reuable grouping by the same
- name that the container is using.
+ displayed below, but there is also a reusable grouping called
+ "netconf-server-grouping" that the container is using.
[Note: '\' line wrapping for formatting only]
module: ietf-netconf-server
+--rw netconf-server
+--rw listen! {listen}?
| +--rw idle-timeout? uint16
| +--rw endpoint* [name]
| +--rw name string
| +--rw (transport)
@@ -1070,98 +1174,141 @@
| | +--rw address inet:ip-address
| | +--rw port? inet:port-number
| | +--rw server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
- | | | | | +--rw algorithm
- | | | | | | ct:key-algorithm-re\
- f
- | | | | | +--rw public-key binary\
-
- | | | | | +--rw private-key union
- | | | | +--:(keystore)
- | | | | {keystore-implemented\
+ | | | | | {local-keys-supported\
}?
- | | | | +--rw reference
+ | | | | | +--rw algorithm?
+ | | | | | | ct:key-algorithm-ref
+ | | | | | +--rw public-key?
+ | | | | | | binary
+ | | | | | +--rw private-key?
+ | | | | | | union
+ | | | | | +---x generate-hidden-key
+ | | | | | | +---w input
+ | | | | | | +---w algorithm
+ | | | | | | ct:key-algori\
+ thm-ref
+ | | | | | +---x install-hidden-key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | | ct:key-algori\
+ thm-ref
+ | | | | | +---w public-key?
+ | | | | | | binary
+ | | | | | +---w private-key?
+ | | | | | binary
+ | | | | +--:(keystore)
+ | | | | {keystore-supported}?
+ | | | | +--rw reference?
| | | | ks:asymmetric-key-r\
ef
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
- | | | | +--rw algorithm
- | | | | | ct:key-algorithm-re\
- f
- | | | | +--rw public-key
+ | | | | {local-keys-supported\
+ }?
+ | | | | +--rw algorithm?
+ | | | | | ct:key-algorithm-ref
+ | | | | +--rw public-key?
| | | | | binary
- | | | | +--rw private-key
+ | | | | +--rw private-key?
| | | | | union
+ | | | | +---x generate-hidden-key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | ct:key-algori\
+ thm-ref
+ | | | | +---x install-hidden-key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | | ct:key-algori\
+ thm-ref
+ | | | | | +---w public-key?
+ | | | | | | binary
+ | | | | | +---w private-key?
+ | | | | | binary
| | | | +--rw cert
| | | | | ct:end-entity-cert-\
cms
- | | | | +---n certificate-expiratio\
- n
+ | | | | +---n certificate-expiration
| | | | +-- expiration-date?
| | | | yang:date-and-ti\
me
| | | +--:(keystore)
- | | | {keystore-implemented\
- }?
- | | | +--rw reference
+ | | | {keystore-supported}?
+ | | | +--rw reference?
| | | ks:asymmetric-key-c\
ertificate-ref
| | +--rw client-cert-auth {sshcmn:ssh-x509-certs}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
+ | | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
+ | | | {ta:x509-certificates}?
| | +--rw transport-params
| | {ssh-server-transport-params-config}?
| | +--rw host-key
| | | +--rw host-key-alg* identityref
| | +--rw key-exchange
| | | +--rw key-exchange-alg* identityref
| | +--rw encryption
| | | +--rw encryption-alg* identityref
| | +--rw mac
| | +--rw mac-alg* identityref
| +--:(tls) {tls-listen}?
| +--rw tls
| +--rw address inet:ip-address
| +--rw port? inet:port-number
| +--rw server-identity
| | +--rw (local-or-keystore)
- | | +--:(local)
- | | | +--rw algorithm
+ | | +--:(local) {local-keys-supported}?
+ | | | +--rw algorithm?
| | | | ct:key-algorithm-ref
- | | | +--rw public-key binary
- | | | +--rw private-key union
+ | | | +--rw public-key? binary
+ | | | +--rw private-key? union
+ | | | +---x generate-hidden-key
+ | | | | +---w input
+ | | | | +---w algorithm
+ | | | | ct:key-algorithm-ref
+ | | | +---x install-hidden-key
+ | | | | +---w input
+ | | | | +---w algorithm
+ | | | | | ct:key-algorithm-ref
+ | | | | +---w public-key? binary
+ | | | | +---w private-key? binary
| | | +--rw cert
| | | | ct:end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date?
| | | yang:date-and-time
- | | +--:(keystore) {keystore-implemented}?
- | | +--rw reference
+ | | +--:(keystore) {keystore-supported}?
+ | | +--rw reference?
| | ks:asymmetric-key-certificate-r\
+
ef
| +--rw client-auth
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
+ | | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
+ | | | {ta:x509-certificates}?
| | +--rw cert-maps
| | +--rw cert-to-name* [id]
| | +--rw id uint32
| | +--rw fingerprint
| | | x509c2n:tls-fingerprint
| | +--rw map-type identityref
| | +--rw name string
| +--rw hello-params
| {tls-server-hello-params-config}?
| +--rw tls-versions
@@ -1171,162 +1318,212 @@
+--rw call-home! {call-home}?
+--rw netconf-client* [name]
+--rw name string
+--rw endpoints
| +--rw endpoint* [name]
| +--rw name string
| +--rw (transport)
| +--:(ssh) {ssh-call-home}?
| | +--rw ssh
| | +--rw address inet:host
- | | +--rw port? inet:port-number\
-
+ | | +--rw port? inet:port-number
| | +--rw server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
- | | | | | +--rw algorithm
+ | | | | | {local-keys-sup\
+ ported}?
+ | | | | | +--rw algorithm?
| | | | | | ct:key-algori\
thm-ref
- | | | | | +--rw public-key
+ | | | | | +--rw public-key?
| | | | | | binary
- | | | | | +--rw private-key
- | | | | | union
+ | | | | | +--rw private-key?
+ | | | | | | union
+ | | | | | +---x generate-hidden\
+ -key
+ | | | | | | +---w input
+ | | | | | | +---w algorithm
+ | | | | | | ct:key-\
+ algorithm-ref
+ | | | | | +---x install-hidden-\
+ key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | | ct:key-\
+ algorithm-ref
+ | | | | | +---w public-ke\
+ y?
+ | | | | | | binary
+ | | | | | +---w private-k\
+ ey?
+ | | | | | binary
| | | | +--:(keystore)
- | | | | {keystore-imple\
- mented}?
- | | | | +--rw reference
+ | | | | {keystore-suppo\
+ rted}?
+ | | | | +--rw reference?
| | | | ks:asymmetric\
-key-ref
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-certs\
}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
- | | | | +--rw algorithm
+ | | | | {local-keys-sup\
+ ported}?
+ | | | | +--rw algorithm?
| | | | | ct:key-algori\
thm-ref
- | | | | +--rw public-key
+ | | | | +--rw public-key?
| | | | | binary
- | | | | +--rw private-key
+ | | | | +--rw private-key?
| | | | | union
+ | | | | +---x generate-hidden\
+ -key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | ct:key-\
+ algorithm-ref
+ | | | | +---x install-hidden-\
+ key
+ | | | | | +---w input
+ | | | | | +---w algorithm
+ | | | | | | ct:key-\
+ algorithm-ref
+ | | | | | +---w public-ke\
+ y?
+ | | | | | | binary
+ | | | | | +---w private-k\
+ ey?
+ | | | | | binary
| | | | +--rw cert
| | | | | ct:end-entity\
-cert-cms
| | | | +---n certificate-exp\
iration
| | | | +-- expiration-dat\
e?
| | | | yang:date-\
and-time
| | | +--:(keystore)
- | | | {keystore-imple\
- mented}?
- | | | +--rw reference
+ | | | {keystore-suppo\
+ rted}?
+ | | | +--rw reference?
| | | ks:asymmetric\
-key-certificate-ref
| | +--rw client-cert-auth
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
+ | | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
+ | | | {ta:x509-certificates}?
| | +--rw transport-params
| | {ssh-server-transport-params-confi\
g}?
| | +--rw host-key
| | | +--rw host-key-alg* identityref
| | +--rw key-exchange
- | | | +--rw key-exchange-alg* identityre\
- f
+ | | | +--rw key-exchange-alg* identityref
| | +--rw encryption
| | | +--rw encryption-alg* identityref
| | +--rw mac
| | +--rw mac-alg* identityref
| +--:(tls) {tls-call-home}?
| +--rw tls
| +--rw address inet:host
| +--rw port? inet:port-number
| +--rw server-identity
| | +--rw (local-or-keystore)
- | | +--:(local)
- | | | +--rw algorithm
+ | | +--:(local) {local-keys-supported}?
+ | | | +--rw algorithm?
| | | | ct:key-algorithm-ref
- | | | +--rw public-key
+ | | | +--rw public-key?
| | | | binary
- | | | +--rw private-key
+ | | | +--rw private-key?
| | | | union
+ | | | +---x generate-hidden-key
+ | | | | +---w input
+ | | | | +---w algorithm
+ | | | | ct:key-algorithm-ref
+ | | | +---x install-hidden-key
+ | | | | +---w input
+ | | | | +---w algorithm
+ | | | | | ct:key-algorithm-ref
+ | | | | +---w public-key? binary
+ | | | | +---w private-key? binary
| | | +--rw cert
| | | | ct:end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date?
| | | yang:date-and-time
- | | +--:(keystore) {keystore-implemented\
- }?
- | | +--rw reference
+ | | +--:(keystore) {keystore-supported}?
+ | | +--rw reference?
| | ks:asymmetric-key-certifi\
cate-ref
| +--rw client-auth
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
+ | | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
+ | | | {ta:x509-certificates}?
| | +--rw cert-maps
| | +--rw cert-to-name* [id]
| | +--rw id uint32
| | +--rw fingerprint
| | | x509c2n:tls-fingerprint
| | +--rw map-type identityref
| | +--rw name string
| +--rw hello-params
| {tls-server-hello-params-config}?
| +--rw tls-versions
| | +--rw tls-version* identityref
| +--rw cipher-suites
| +--rw cipher-suite* identityref
+--rw connection-type
- | +--rw (connection-type)?
+ | +--rw (connection-type)
| +--:(persistent-connection)
| | +--rw persistent!
- | | +--rw idle-timeout? uint32
| | +--rw keep-alives
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--:(periodic-connection)
| +--rw periodic!
+ | +--rw period? uint16
+ | +--rw anchor-time? yang:date-and-time
| +--rw idle-timeout? uint16
- | +--rw reconnect-timeout? uint16
+--rw reconnect-strategy
+--rw start-with? enumeration
+--rw max-attempts? uint8
4.2. Example Usage
The following example illustrates configuring a NETCONF server to
listen for NETCONF client connections using both the SSH and TLS
transport protocols, as well as configuring call-home to two NETCONF
clients, one using SSH and the other using TLS.
- This example is consistent with the examples presented in Section 2.2
+ This example is consistent with the examples presented in Section 3.2
of [I-D.ietf-netconf-keystore].
[Note: '\' line wrapping for formatting only]
+ xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name">
netconf/ssh
192.0.2.7
deployment-specific-certificate
@@ -1428,21 +1626,21 @@
inned-ca-certs>
explicitly-trusted-client-certs
300
- 60
+ 60
last-connected
3
data-collector
@@ -1506,21 +1704,20 @@
x509c2n:specified
scooby-doo
- 300
30
3
first-listed
3
@@ -1532,51 +1729,58 @@
This YANG module has normative references to [RFC6242], [RFC6991],
[RFC7407], [RFC7589], [RFC8071],
[I-D.ietf-netconf-ssh-client-server], and
[I-D.ietf-netconf-tls-client-server].
This YANG module imports YANG types from [RFC6991], and YANG
groupings from [RFC7407], [I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-ssh-client-server].
- file "ietf-netconf-server@2018-06-04.yang"
+ file "ietf-netconf-server@2018-09-20.yang"
module ietf-netconf-server {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server";
prefix "ncs";
+ import ietf-yang-types {
+ prefix yang;
+ reference
+ "RFC 6991: Common YANG Data Types";
+ }
+
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-x509-cert-to-name {
prefix x509c2n;
reference
"RFC 7407: A YANG Data Model for SNMP Configuration";
}
import ietf-ssh-server {
prefix ss;
- revision-date 2018-06-04; // stable grouping definitions
+ revision-date 2018-09-20; // stable grouping definitions
reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers";
}
import ietf-tls-server {
prefix ts;
- revision-date 2018-06-04; // stable grouping definitions
+ revision-date 2018-09-20; // stable grouping definitions
reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
+
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web:
WG List:
Author: Kent Watsen
@@ -1598,21 +1802,21 @@
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
- revision "2018-06-04" {
+ revision "2018-09-20" {
description
"Initial version";
reference
"RFC XXXX: NETCONF Client and Server Models";
}
// Features
feature listen {
description
@@ -1662,27 +1866,32 @@
}
feature tls-call-home {
description
"The 'tls-call-home' feature indicates that the NETCONF
server supports initiating a NETCONF over TLS call
home connection to NETCONF clients.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
+
+ // protocol accessible nodes
+
container netconf-server {
- uses netconf-server;
+ uses netconf-server-grouping;
description
"Top-level container for NETCONF server configuration.";
}
- grouping netconf-server {
+ // reusable groupings
+
+ grouping netconf-server-grouping {
description
"Top-level grouping for NETCONF server configuration.";
container listen {
if-feature listen;
presence "Enables server to listen for TCP connections";
description "Configures listen behavior";
leaf idle-timeout {
type uint16;
units "seconds";
default 3600; // one hour
@@ -1920,61 +2128,47 @@
}
}
} // end tls
} // end choice
} // end endpoint
}
container connection-type {
description
"Indicates the kind of connection to use.";
choice connection-type {
- default persistent-connection;
+ mandatory true;
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence
"Indicates that a persistent connection is to be
maintained.";
description
"Maintain a persistent connection to the NETCONF
client. If the connection goes down, immediately
start trying to reconnect to it, using the
reconnection strategy.
This connection type minimizes any NETCONF client
to NETCONF server data-transfer delay, albeit at
the expense of holding resources longer.";
- leaf idle-timeout {
- type uint32;
- units "seconds";
- default 86400; // one day;
- description
- "Specifies the maximum number of seconds that
- a NETCONF session may remain idle. A NETCONF
- session will be dropped if it is idle for an
- interval longer than this number of seconds.
- If set to zero, then the server will never
- drop a session because it is idle. Sessions
- that have a notification subscription active
- are never dropped.";
- }
container keep-alives {
description
"Configures the keep-alive policy, to
proactively test the aliveness of the SSH/TLS
client. An unresponsive SSH/TLS client will
be dropped after approximately max-attempts *
max-wait seconds.";
reference
- "RFC 8071: NETCONF Call Home and RESTCONF Call
- Home, Section 3.1, item S6";
+ "RFC 8071: NETCONF Call Home and RESTCONF
+ Call Home, Section 4.1, item S7";
leaf max-wait {
type uint16 {
range "1..max";
}
units seconds;
default 30;
description
"Sets the amount of time in seconds after
which if no data has been received from
the SSH/TLS client, a SSH/TLS-level message
@@ -1987,60 +2181,68 @@
description
"Sets the maximum number of sequential keep-
alive messages that can fail to obtain a
response from the SSH/TLS client before
assuming the SSH/TLS client is no longer
alive.";
}
}
}
}
+
case periodic-connection {
container periodic {
presence
"Indicates that a periodic connection is to be
maintained.";
description
- "Periodically connect to the NETCONF client, so
- that the NETCONF client may deliver messages
- pending for the NETCONF server. The NETCONF
- client must close the connection when it is
- ready to release it. Once the connection has
- been closed, the NETCONF server will restart
- its timer until the next connection.";
+ "Periodically connect to the NETCONF client. The
+ NETCONF client should close the underlying TLS
+ connection upon completing planned activities.
+
+ This connection type increases resource
+ utilization, albeit with increased delay in
+ NETCONF client to NETCONF client interactions.";
+ leaf period {
+ type uint16;
+ units "minutes";
+ default 60;
+ description
+ "Duration of time between periodic connections.";
+ }
+ leaf anchor-time {
+ type yang:date-and-time {
+ // constrained to minute-level granularity
+ pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}'
+ + '(Z|[\+\-]\d{2}:\d{2})';
+ }
+ description
+ "Designates a timestamp before or after which a
+ series of periodic connections are determined.
+ The periodic connections occur at a whole
+ multiple interval from the anchor time. For
+ example, for an anchor time is 15 minutes past
+ midnight and a period interval of 24 hours, then
+ a periodic connection will occur 15 minutes past
+ midnight everyday.";
+ }
leaf idle-timeout {
type uint16;
units "seconds";
- default 300; // five minutes
+ default 120; // two minutes
description
"Specifies the maximum number of seconds that
a NETCONF session may remain idle. A NETCONF
session will be dropped if it is idle for an
interval longer than this number of seconds.
If set to zero, then the server will never
- drop a session because it is idle. Sessions
- that have a notification subscription active
- are never dropped.";
- }
- leaf reconnect-timeout {
- type uint16 {
- range "1..max";
- }
- units minutes;
- default 60;
- description
- "Sets the maximum amount of unconnected time the
- NETCONF server will wait before re-establishing
- a connection to the NETCONF client. The
- NETCONF server may initiate a connection before
- this time if desired (e.g., to deliver an event
- notification message).";
+ drop a session because it is idle.";
}
}
}
}
}
container reconnect-strategy {
description
"The reconnection strategy directs how a NETCONF server
reconnects to a NETCONF client, after discovering its
connection to the client has dropped, even if due to a
@@ -2058,20 +2259,25 @@
}
enum last-connected {
description
"Indicates that reconnections should start with
the endpoint last connected to. If no previous
connection has ever been established, then the
first endpoint configured is used. NETCONF
servers SHOULD be able to remember the last
endpoint connected to across reboots.";
}
+ enum random-selection {
+ description
+ "Indicates that reconnections should start with
+ a random endpoint.";
+ }
}
default first-listed;
description
"Specifies which of the NETCONF client's endpoints
the NETCONF server should start with when trying
to connect to the NETCONF client.";
}
leaf max-attempts {
type uint8 {
range "1..max";
@@ -2226,21 +2432,21 @@
[I-D.ietf-netconf-tls-client-server]. Please see the Security
Considerations section in those documents for concerns related those
groupings.
The YANG module defined in this document is designed to be accessed
via YANG based management protocols, such as NETCONF [RFC6241] and
RESTCONF [RFC8040]. Both of these protocols have mandatory-to-
implement secure transport layers (e.g., SSH, TLS) with mutual
authentication.
- The NETCONF access control model (NACM) [RFC6536] provides the means
+ The NETCONF access control model (NACM) [RFC8341] provides the means
to restrict access for particular users to a pre-configured subset of
all available protocol operations and content.
There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative
effect on network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability:
@@ -2265,72 +2471,77 @@
sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the
operations and their sensitivity/vulnerability:
NONE
7. IANA Considerations
7.1. The IETF XML Registry
- This document registers two URIs in the IETF XML registry [RFC3688].
- Following the format in [RFC3688], the following registrations are
- requested:
+ This document registers two URIs in the "ns" subregistry of the IETF
+ XML Registry [RFC3688]. Following the format in [RFC3688], the
+ following registrations are requested:
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-client
Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-server
Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
7.2. The YANG Module Names Registry
This document registers two YANG modules in the YANG Module Names
- registry [RFC7950]. Following the format in [RFC7950], the the
+ registry [RFC6020]. Following the format in [RFC6020], the the
following registrations are requested:
name: ietf-netconf-client
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-client
prefix: ncc
reference: RFC XXXX
name: ietf-netconf-server
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server
prefix: ncs
reference: RFC XXXX
8. References
8.1. Normative References
[I-D.ietf-netconf-keystore]
- Watsen, K., "YANG Data Model for a "Keystore" Mechanism",
- draft-ietf-netconf-keystore-04 (work in progress), October
- 2017.
+ Watsen, K., "YANG Data Model for a Centralized Keystore
+ Mechanism", draft-ietf-netconf-keystore-06 (work in
+ progress), September 2018.
[I-D.ietf-netconf-ssh-client-server]
Watsen, K. and G. Wu, "YANG Groupings for SSH Clients and
- SSH Servers", draft-ietf-netconf-ssh-client-server-05
- (work in progress), October 2017.
+ SSH Servers", draft-ietf-netconf-ssh-client-server-06
+ (work in progress), June 2018.
[I-D.ietf-netconf-tls-client-server]
Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and
- TLS Servers", draft-ietf-netconf-tls-client-server-05
- (work in progress), October 2017.
+ TLS Servers", draft-ietf-netconf-tls-client-server-06
+ (work in progress), June 2018.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
.
+ [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
+ the Network Configuration Protocol (NETCONF)", RFC 6020,
+ DOI 10.17487/RFC6020, October 2010,
+ .
+
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
@@ -2354,37 +2565,37 @@
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, .
8.2. Informative References
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
.
- [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
- Protocol (NETCONF) Access Control Model", RFC 6536,
- DOI 10.17487/RFC6536, March 2012,
- .
-
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
.
[RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home",
RFC 8071, DOI 10.17487/RFC8071, February 2017,
.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
.
+ [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
+ Access Control Model", STD 91, RFC 8341,
+ DOI 10.17487/RFC8341, March 2018,
+ .
+
Appendix A. Change Log
A.1. 00 to 01
o Renamed "keychain" to "keystore".
A.2. 01 to 02
o Added to ietf-netconf-client ability to connected to a cluster of
endpoints, including a reconnection-strategy.
@@ -2424,29 +2635,39 @@
A.6. 05 to 06
o Fixed change log missing section issue.
o Updated examples to match latest updates to the crypto-types,
trust-anchors, and keystore drafts.
o Reduced line length of the YANG modules to fit within 69 columns.
+A.7. 06 to 07
+
+ o Removed "idle-timeout" from "persistent" connection config.
+
+ o Added "random-selection" for reconnection-strategy's "starts-with"
+ enum.
+
+ o Replaced "connection-type" choice default (persistent) with
+ "mandatory true".
+
+ o Reduced the periodic-connection's "idle-timeout" from 5 to 2
+ minutes.
+
+ o Replaced reconnect-timeout with period/anchor-time combo.
+
Acknowledgements
The authors would like to thank for following for lively discussions
on list and in the halls (ordered by last name): Andy Bierman, Martin
Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David
Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch,
Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen.
-Authors' Addresses
+Author's Address
Kent Watsen
Juniper Networks
EMail: kwatsen@juniper.net
-
- Gary Wu
- Cisco Networks
-
- EMail: garywu@cisco.com