draft-ietf-netconf-netconf-client-server-04.txt   draft-ietf-netconf-netconf-client-server-05.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Juniper Networks Internet-Draft Juniper Networks
Intended status: Standards Track G. Wu Intended status: Standards Track G. Wu
Expires: January 4, 2018 Cisco Networks Expires: May 3, 2018 Cisco Networks
J. Schoenwaelder October 30, 2017
Jacobs University Bremen
July 3, 2017
NETCONF Client and Server Models NETCONF Client and Server Models
draft-ietf-netconf-netconf-client-server-04 draft-ietf-netconf-netconf-client-server-05
Abstract Abstract
This document defines two YANG modules, one module to configure a This document defines two YANG modules, one module to configure a
NETCONF client and the other module to configure a NETCONF server. NETCONF client and the other module to configure a NETCONF server.
Both modules support both the SSH and TLS transport protocols, and Both modules support both the SSH and TLS transport protocols, and
support both standard NETCONF and NETCONF Call Home connections. support both standard NETCONF and NETCONF Call Home connections.
Editorial Note (To be removed by RFC Editor) Editorial Note (To be removed by RFC Editor)
skipping to change at page 2, line 8 skipping to change at page 2, line 5
o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-ssh-client- o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-ssh-client-
server server
o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-tls-client- o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-tls-client-
server server
Artwork in this document contains placeholder values for the date of Artwork in this document contains placeholder values for the date of
publication of this draft. Please apply the following replacement: publication of this draft. Please apply the following replacement:
o "2017-07-03" --> the publication date of this draft o "2017-10-30" --> the publication date of this draft
The following Appendix section is to be removed prior to publication: The following Appendix section is to be removed prior to publication:
o Appendix A. Change Log o Appendix A. Change Log
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://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 January 4, 2018. This Internet-Draft will expire on May 3, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
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 . . . . . . . . . . . . . . . . . . . . . . . . 4 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4 3. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4
2. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 5 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 10
2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 8 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 11
2.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 10 4. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 22
3. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 20 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 22
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 20 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 28
3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 23 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 33
3.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 26 5. Design Considerations . . . . . . . . . . . . . . . . . . . . 44
4. Design Considerations . . . . . . . . . . . . . . . . . . . . 37 5.1. Support all NETCONF transports . . . . . . . . . . . . . 44
4.1. Support all NETCONF transports . . . . . . . . . . . . . 38 5.2. Enable each transport to select which keys to use . . . . 45
4.2. Enable each transport to select which keys to use . . . . 38 5.3. Support authenticating NETCONF clients certificates . . . 45
4.3. Support authenticating NETCONF clients certificates . . . 38 5.4. Support mapping authenticated NETCONF client certificates
4.4. Support mapping authenticated NETCONF client certificates to usernames . . . . . . . . . . . . . . . . . . . . . . 45
to usernames . . . . . . . . . . . . . . . . . . . . . . 38 5.5. Support both listening for connections and call home . . 45
4.5. Support both listening for connections and call home . . 38 5.6. For Call Home connections . . . . . . . . . . . . . . . . 45
4.6. For Call Home connections . . . . . . . . . . . . . . . . 39 5.6.1. Support more than one NETCONF client . . . . . . . . 45
4.6.1. Support more than one NETCONF client . . . . . . . . 39 5.6.2. Support NETCONF clients having more than one endpoint 46
4.6.2. Support NETCONF clients having more than one endpoint 39 5.6.3. Support a reconnection strategy . . . . . . . . . . . 46
4.6.3. Support a reconnection strategy . . . . . . . . . . . 39 5.6.4. Support both persistent and periodic connections . . 46
4.6.4. Support both persistent and periodic connections . . 39 5.6.5. Reconnection strategy for periodic connections . . . 46
4.6.5. Reconnection strategy for periodic connections . . . 40 5.6.6. Keep-alives for persistent connections . . . . . . . 46
4.6.6. Keep-alives for persistent connections . . . . . . . 40 5.6.7. Customizations for periodic connections . . . . . . . 47
4.6.7. Customizations for periodic connections . . . . . . . 40 6. Security Considerations . . . . . . . . . . . . . . . . . . . 47
5. Security Considerations . . . . . . . . . . . . . . . . . . . 40 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 48
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 41 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 48
6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 41 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 48
6.2. The YANG Module Names Registry . . . . . . . . . . . . . 42 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 49
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 42 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 49
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 42 9.1. Normative References . . . . . . . . . . . . . . . . . . 49
8.1. Normative References . . . . . . . . . . . . . . . . . . 42 9.2. Informative References . . . . . . . . . . . . . . . . . 50
8.2. Informative References . . . . . . . . . . . . . . . . . 43 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 51
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 45 A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.1. server-model-09 to 00 . . . . . . . . . . . . . . . . . . 45 A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 45 A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 45 A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.4. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 45 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 51
A.5. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 45
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 46
1. Introduction 1. Introduction
This document defines two YANG [RFC7950] modules, one module to This document defines two YANG [RFC7950] modules, one module to
configure a NETCONF client and the other module to configure a configure a NETCONF [RFC6241] client and the other module to
NETCONF server. Both modules support both the SSH and TLS transport configure a NETCONF server. Both modules support both NETCONF over
protocols, and support both standard NETCONF and NETCONF Call Home SSH [RFC6242] and NETCONF over TLS [RFC7589] and NETCONF Call Home
connections. connections [RFC8071].
NETCONF is defined by [RFC6241]. SSH is defined by [RFC4252],
[RFC4253], and [RFC4254]. TLS is defined by [RFC5246]. NETCONF Call
Home is defined by [RFC8071]).
1.1. Terminology 2. Terminology
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. Tree Diagrams 3. The NETCONF Client Model
A simplified graphical representation of the data models is used in
this document. The meaning of the symbols in these diagrams is as
follows:
o Brackets "[" and "]" enclose list keys.
o Braces "{" and "}" enclose feature names, and indicate that the
named feature must be present for the subtree to be present.
o Abbreviations before data node names: "rw" means configuration
(read-write) and "ro" state data (read-only).
o Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list.
o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not
shown.
2. The NETCONF Client Model
The NETCONF client model presented in this section supports both The NETCONF client model presented in this section supports both
clients initiating connections to servers, as well as clients clients initiating connections to servers, as well as clients
listening for connections from servers calling home. listening for connections from servers calling home.
This model supports both the SSH and TLS transport protocols, using This model supports both the SSH and TLS transport protocols, using
the SSH client and TLS client groupings defined in the SSH client and TLS client groupings defined in
[I-D.ietf-netconf-ssh-client-server] and [I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-tls-client-server] respectively. [I-D.ietf-netconf-tls-client-server] respectively.
All private keys and trusted certificates are held in the keystore All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore]. model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to YANG feature statements are used to enable implementations to
advertise which parts of the model the NETCONF client supports. advertise which parts of the model the NETCONF client supports.
2.1. Tree Diagram 3.1. Tree Diagram
Just the container is displayed below, but there is also a grouping The following tree diagram [I-D.ietf-netmod-yang-tree-diagrams]
that the container is using. 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.
Note: all lines are folded at column 71 with no '\' character. [ note: '\' line wrapping for formatting only]
module: ietf-netconf-client module: ietf-netconf-client
+--rw netconf-client +--rw netconf-client
+--rw initiate {initiate}? +--rw initiate {initiate}?
| +--rw netconf-server* [name] | +--rw netconf-server* [name]
| +--rw name string | +--rw name string
| +--rw (transport) | +--rw endpoints
| | +--:(ssh) {ssh-initiate}? | | +--rw endpoint* [name]
| | | +--rw ssh | | +--rw name string
| | | +--rw endpoints | | +--rw (transport)
| | | | +--rw endpoint* [name] | | +--:(ssh) {ssh-initiate}?
| | | | +--rw name string | | | +--rw ssh
| | | | +--rw address inet:host | | | +--rw address? inet:host
| | | | +--rw port? inet:port-number | | | +--rw port? inet:port-numbe\
| | | +--rw server-auth r
| | | | +--rw trusted-ssh-host-keys? | | | +--rw client-identity
| | | | | -> /ks:keystore/trusted-host-keys/name | | | | +--rw username? string
| | | | +--rw trusted-ca-certs? leafref | | | | +--rw (auth-type)
| | | | | {sshcom:ssh-x509-certs}? | | | | +--:(certificate)
| | | | +--rw trusted-server-certs? leafref | | | | | +--rw certificate
| | | | {sshcom:ssh-x509-certs}? | | | | | {sshcom:ssh-x509-certs}?\
| | | +--rw client-auth
| | | | +--rw username? string
| | | | +--rw (auth-type)
| | | | +--:(certificate)
| | | | | +--rw certificate? leafref
| | | | | {sshcom:ssh-x509-certs}?
| | | | +--:(public-key)
| | | | | +--rw public-key?
| | | | | -> /ks:keystore/keys/key/name
| | | | +--:(password)
| | | | +--rw password? string
| | | +--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
| | | +--rw compression
| | | +--rw compression-alg* identityref
| | +--:(tls) {tls-initiate}?
| | +--rw tls
| | +--rw endpoints
| | | +--rw endpoint* [name]
| | | +--rw name string
| | | +--rw address inet:host
| | | +--rw port? inet:port-number
| | +--rw server-auth
| | | +--rw trusted-ca-certs? leafref
| | | +--rw trusted-server-certs? leafref
| | +--rw client-auth
| | | +--rw (auth-type)
| | | +--:(certificate)
| | | +--rw certificate? leafref
| | +--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)?
| | +--:(persistent-connection)
| | | +--rw persistent!
| | | +--rw idle-timeout? uint32
| | | +--rw keep-alives
| | | +--rw max-wait? uint16
| | | +--rw max-attempts? uint8
| | +--:(periodic-connection)
| | +--rw periodic!
| | +--rw idle-timeout? uint16
| | +--rw reconnect-timeout? uint16
| +--rw reconnect-strategy
| +--rw start-with? enumeration
| +--rw max-attempts? uint8
+--rw listen {listen}?
+--rw max-sessions? uint16
+--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 server-auth
| | +--rw trusted-ssh-host-keys?
| | | -> /ks:keystore/trusted-host-keys/name
| | +--rw trusted-ca-certs? leafref
| | | {sshcom:ssh-x509-certs}?
| | +--rw trusted-server-certs? leafref
| | {sshcom:ssh-x509-certs}?
| +--rw client-auth
| | +--rw username? string
| | +--rw (auth-type)
| | +--:(certificate)
| | | +--rw certificate? leafref
| | | {sshcom:ssh-x509-certs}?
| | +--:(public-key)
| | | +--rw public-key?
| | | -> /ks:keystore/keys/key/name
| | +--:(password)
| | +--rw password? string
| +--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
| +--rw compression
| +--rw compression-alg* identityref
+--:(tls) {tls-listen}?
+--rw tls
+--rw address? inet:ip-address
+--rw port? inet:port-number
+--rw server-auth
| +--rw trusted-ca-certs? leafref
| +--rw trusted-server-certs? leafref
+--rw client-auth
| +--rw (auth-type)
| +--:(certificate)
| +--rw certificate? leafref
+--rw hello-params
{tls-client-hello-params-config}?
+--rw tls-versions
| +--rw tls-version* identityref
+--rw cipher-suites
+--rw cipher-suite* identityref
2.2. Example Usage | | | | | +--rw algorithm?
| | | | | | identityref
| | | | | +--rw private-key?
| | | | | | union
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +---x generate-private-key
| | | | | | +---w input
| | | | | | +---w algorithm
| | | | | | identityref
| | | | | +--rw certificates
| | | | | | +--rw certificate* [name]
| | | | | | +--rw name string
| | | | | | +--rw value? binary
| | | | | +---x generate-certificate-si\
gning-request
| | | | | +---w input
| | | | | | +---w subject
| | | | | | | binary
| | | | | | +---w attributes?
| | | | | | binary
| | | | | +--ro output
| | | | | +--ro certificate-signi\
ng-request
| | | | | binary
| | | | +--:(public-key)
| | | | | +--rw public-key
| | | | | +--rw algorithm?
| | | | | | identityref
| | | | | +--rw private-key?
| | | | | | union
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +---x generate-private-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | identityref
| | | | +--:(password)
| | | | +--rw password? string
| | | +--rw server-auth
| | | | +--rw pinned-ssh-host-keys?
| | | | | ks:pinned-host-keys
| | | | +--rw pinned-ca-certs?
| | | | | ks:pinned-certificates
| | | | | {sshcom:ssh-x509-certs}?
| | | | +--rw pinned-server-certs?
| | | | ks:pinned-certificates
| | | | {sshcom:ssh-x509-certs}?
| | | +--rw transport-params
| | | {ssh-client-transport-params-conf\
ig}?
| | | +--rw host-key
| | | | +--rw host-key-alg* identityref
| | | +--rw key-exchange
| | | | +--rw key-exchange-alg* identityr\
ef
| | | +--rw encryption
| | | | +--rw encryption-alg* identityref\
| | | +--rw mac
| | | | +--rw mac-alg* identityref
| | | +--rw compression
| | | +--rw compression-alg* identityre\
f
| | +--:(tls) {tls-initiate}?
| | +--rw tls
| | +--rw address? inet:host
| | +--rw port? inet:port-number\
| | +--rw client-identity
| | | +--rw (auth-type)
| | | +--:(certificate)
| | | +--rw certificate
| | | +--rw algorithm?
| | | | identityref
| | | +--rw private-key?
| | | | union
| | | +--rw public-key?
| | | | binary
| | | +---x generate-private-key
| | | | +---w input
| | | | +---w algorithm
| | | | identityref
| | | +--rw certificates
| | | | +--rw certificate* [name]
| | | | +--rw name string
| | | | +--rw value? binary
| | | +---x generate-certificate-si\
gning-request
| | | +---w input
| | | | +---w subject
| | | | | binary
| | | | +---w attributes?
| | | | binary
| | | +--ro output
| | | +--ro certificate-signi\
ng-request
| | | binary
| | +--rw server-auth
| | | +--rw pinned-ca-certs?
| | | | ks:pinned-certificates
| | | +--rw pinned-server-certs?
| | | ks:pinned-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)?
| | +--:(persistent-connection)
| | | +--rw persistent!
| | | +--rw idle-timeout? uint32
| | | +--rw keep-alives
| | | +--rw max-wait? uint16
| | | +--rw max-attempts? uint8
| | +--:(periodic-connection)
| | +--rw periodic!
| | +--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)
| | +--:(certificate)
| | | +--rw certificate
| | | {sshcom:ssh-x509-certs}?
| | | +--rw algorithm?
| | | | identityref
| | | +--rw private-key?
| | | | union
| | | +--rw public-key?
| | | | binary
| | | +---x generate-private-key
| | | | +---w input
| | | | +---w algorithm identityre\
f
| | | +--rw certificates
| | | | +--rw certificate* [name]
| | | | +--rw name string
| | | | +--rw value? binary
| | | +---x generate-certificate-signing-\
request
| | | +---w input
| | | | +---w subject binary
| | | | +---w attributes? binary
| | | +--ro output
| | | +--ro certificate-signing-req\
uest
| | | binary
| | +--:(public-key)
| | | +--rw public-key
| | | +--rw algorithm?
| | | | identityref
| | | +--rw private-key? union\
| | | +--rw public-key? binar\
y
| | | +---x generate-private-key
| | | +---w input
| | | +---w algorithm identityre\
f
| | +--:(password)
| | +--rw password? string
| +--rw server-auth
| | +--rw pinned-ssh-host-keys?
| | | ks:pinned-host-keys
| | +--rw pinned-ca-certs?
| | | ks:pinned-certificates
| | | {sshcom:ssh-x509-certs}?
| | +--rw pinned-server-certs?
| | ks:pinned-certificates
| | {sshcom:ssh-x509-certs}?
| +--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
| +--rw compression
| +--rw compression-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 algorithm?
| | identityref
| +--rw private-key?
| | union
| +--rw public-key?
| | binary
| +---x generate-private-key
| | +---w input
| | +---w algorithm identityre\
f
| +--rw certificates
| | +--rw certificate* [name]
| | +--rw name string
| | +--rw value? binary
| +---x generate-certificate-signing-\
request
| +---w input
| | +---w subject binary
| | +---w attributes? binary
| +--ro output
| +--ro certificate-signing-req\
uest
| binary
+--rw server-auth
| +--rw pinned-ca-certs?
| | ks:pinned-certificates
| +--rw pinned-server-certs?
| ks:pinned-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 The following example illustrates configuring a NETCONF client to
initiate connections, using both the SSH and TLS transport protocols, initiate connections, using both the SSH and TLS transport protocols,
as well as listening for call-home connections, again using both the as well as listening for call-home connections, again using both the
SSH and TLS transport protocols. 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 2.2
of [I-D.ietf-netconf-keystore]. of [I-D.ietf-netconf-keystore].
<netconf-client [ note: '\' line wrapping for formatting only]
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-client">
<!-- NETCONF servers to initiate connections to --> <netconf-client
<initiate> xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-client">
<netconf-server>
<name>corp-fw1</name> <!-- NETCONF servers to initiate connections to -->
<ssh> <initiate>
<netconf-server>
<name>corp-fw1</name>
<endpoints> <endpoints>
<endpoint> <endpoint>
<name>corp-fw1.example.com</name> <name>corp-fw1.example.com</name>
<address>corp-fw1.example.com</address> <ssh>
<address>corp-fw1.example.com</address>
<client-identity>
<username>foobar</username>
<public-key>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ietf\
-keystore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
</public-key>
</client-identity>
<server-auth>
<pinned-server-certs>deployment-specific-ca-certs</pinn\
ed-server-certs>
</server-auth>
</ssh>
</endpoint> </endpoint>
<endpoint> <endpoint>
<name>corp-fw2.example.com</name> <name>corp-fw2.example.com</name>
<address>corp-fw2.example.com</address> <ssh>
<address>corp-fw2.example.com</address>
<client-identity>
<username>foobar</username>
<public-key>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ietf\
-keystore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
</public-key>
</client-identity>
<server-auth>
<pinned-server-certs>deployment-specific-ca-certs</pinn\
ed-server-certs>
</server-auth>
</ssh>
</endpoint> </endpoint>
</endpoints> </endpoints>
<server-auth> </netconf-server>
<trusted-server-certs>deployment-specific-ca-certs</trusted-server-certs> </initiate>
</server-auth>
<client-auth>
<username>foobar</username>
<public-key>ex-rsa-key</public-key>
</client-auth>
</ssh>
</netconf-server>
</initiate>
<!-- endpoints to listen for NETCONF Call Home connections on -->
<listen>
<endpoint>
<name>Intranet-facing listener</name>
<ssh>
<address>11.22.33.44</address>
<server-auth>
<trusted-ca-certs>deployment-specific-ca-certs</trusted-ca-certs>
<trusted-server-certs>explicitly-trusted-server-certs</trusted-server-certs>
<trusted-ssh-host-keys>explicitly-trusted-ssh-host-keys</trusted-ssh-host-keys>
</server-auth>
<client-auth>
<username>foobar</username>
<public-key>ex-rsa-key</public-key>
</client-auth>
</ssh>
</endpoint>
</listen>
</netconf-client>
2.3. YANG Model
This YANG module imports YANG types from [RFC6991] and [RFC7407].
<CODE BEGINS> file "ietf-netconf-client@2017-07-03.yang" <!-- endpoints to listen for NETCONF Call Home connections on -->
<listen>
<endpoint>
<name>Intranet-facing listener</name>
<ssh>
<address>192.0.2.7</address>
<client-identity>
<username>foobar</username>
<public-key>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ietf-key\
store">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
</public-key>
</client-identity>
<server-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-ca-ce\
rts>
<pinned-server-certs>explicitly-trusted-server-certs</pinne\
d-server-certs>
<pinned-ssh-host-keys>explicitly-trusted-ssh-host-keys</pin\
ned-ssh-host-keys>
</server-auth>
</ssh>
</endpoint>
</listen>
</netconf-client>
module ietf-netconf-client { 3.3. YANG Module
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client"; This YANG module imports YANG types from [RFC6991], and YANG
prefix "ncc"; groupings from [I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-ssh-client-server].
import ietf-inet-types { <CODE BEGINS> file "ietf-netconf-client@2017-10-30.yang"
prefix inet; module ietf-netconf-client {
reference yang-version 1.1;
"RFC 6991: Common YANG Data Types";
}
import ietf-ssh-client { namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client";
prefix ss; prefix "ncc";
revision-date 2017-06-13; // stable grouping definitions
reference
"RFC YYYY: SSH Client and Server Models";
}
import ietf-tls-client { import ietf-inet-types {
prefix ts; prefix inet;
revision-date 2017-06-13; // stable grouping definitions reference
reference "RFC 6991: Common YANG Data Types";
"RFC ZZZZ: TLS Client and Server Models"; }
}
organization import ietf-ssh-client {
"IETF NETCONF (Network Configuration) Working Group"; prefix ss;
revision-date 2017-10-30; // stable grouping definitions
reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers";
}
contact import ietf-tls-client {
"WG Web: <http://tools.ietf.org/wg/netconf/> prefix ts;
WG List: <mailto:netconf@ietf.org> revision-date 2017-10-30; // stable grouping definitions
reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
}
Author: Kent Watsen organization
<mailto:kwatsen@juniper.net> "IETF NETCONF (Network Configuration) Working Group";
Author: Gary Wu contact
<mailto:garywu@cisco.com>"; "WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
description Author: Kent Watsen
"This module contains a collection of YANG definitions for <mailto:kwatsen@juniper.net>
configuring NETCONF clients.
Copyright (c) 2014 IETF Trust and the persons identified as Author: Gary Wu
authors of the code. All rights reserved. <mailto:garywu@cisco.com>";
Redistribution and use in source and binary forms, with or description
without modification, is permitted pursuant to, and subject "This module contains a collection of YANG definitions for
to the license terms contained in, the Simplified BSD configuring NETCONF clients.
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 Copyright (c) 2017 IETF Trust and the persons identified as
the RFC itself for full legal notices."; authors of the code. All rights reserved.
revision "2017-07-03" { Redistribution and use in source and binary forms, with or
description without modification, is permitted pursuant to, and subject
"Initial version"; to the license terms contained in, the Simplified BSD
reference License set forth in Section 4.c of the IETF Trust's
"RFC XXXX: NETCONF Client and Server Models"; Legal Provisions Relating to IETF Documents
} (http://trustee.ietf.org/license-info).
// Features This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
feature initiate { revision "2017-10-30" {
description description
"The 'initiate' feature indicates that the NETCONF client "Initial version";
supports initiating NETCONF connections to NETCONF servers reference
using at least one transport (e.g., SSH, TLS, etc.)."; "RFC XXXX: NETCONF Client and Server Models";
} }
feature ssh-initiate { // Features
description
"The 'ssh-initiate' feature indicates that the NETCONF client
supports initiating SSH connections to NETCONF servers.";
reference
"RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)";
}
feature tls-initiate { feature initiate {
description description
"The 'tls-initiate' feature indicates that the NETCONF client "The 'initiate' feature indicates that the NETCONF client
supports initiating TLS connections to NETCONF servers."; supports initiating NETCONF connections to NETCONF servers
reference using at least one transport (e.g., SSH, TLS, etc.).";
"RFC 7589: Using the NETCONF Protocol over Transport }
Layer Security (TLS) with Mutual X.509
Authentication";
} feature ssh-initiate {
description
"The 'ssh-initiate' feature indicates that the NETCONF client
supports initiating SSH connections to NETCONF servers.";
reference
"RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)";
}
feature listen { feature tls-initiate {
description description
"The 'listen' feature indicates that the NETCONF client "The 'tls-initiate' feature indicates that the NETCONF client
supports opening a port to accept NETCONF server call supports initiating TLS connections to NETCONF servers.";
home connections using at least one transport (e.g., reference
SSH, TLS, etc.)."; "RFC 7589: Using the NETCONF Protocol over Transport
} Layer Security (TLS) with Mutual X.509
Authentication";
}
feature ssh-listen { feature listen {
description description
"The 'ssh-listen' feature indicates that the NETCONF client "The 'listen' feature indicates that the NETCONF client
supports opening a port to listen for incoming NETCONF supports opening a port to accept NETCONF server call
server call-home SSH connections."; home connections using at least one transport (e.g.,
reference SSH, TLS, etc.).";
"RFC 8071: NETCONF Call Home and RESTCONF Call Home"; }
}
feature tls-listen { feature ssh-listen {
description description
"The 'tls-listen' feature indicates that the NETCONF client "The 'ssh-listen' feature indicates that the NETCONF client
supports opening a port to listen for incoming NETCONF supports opening a port to listen for incoming NETCONF
server call-home TLS connections."; server call-home SSH connections.";
reference reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home"; "RFC 8071: NETCONF Call Home and RESTCONF Call Home";
} }
container netconf-client { feature tls-listen {
uses netconf-client; description
description "The 'tls-listen' feature indicates that the NETCONF client
"Top-level container for NETCONF client configuration."; supports opening a port to listen for incoming NETCONF
} server call-home TLS connections.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
grouping netconf-client { container netconf-client {
description uses netconf-client;
"Top-level grouping for NETCONF client configuration."; description
"Top-level container for NETCONF client configuration.";
}
container initiate { grouping netconf-client {
if-feature initiate;
description description
"Configures client initiating underlying TCP connections."; "Top-level grouping for NETCONF client configuration.";
list netconf-server {
key name; container initiate {
if-feature initiate;
description description
"List of NETCONF servers the NETCONF client is to initiate "Configures client initiating underlying TCP connections.";
connections to."; list netconf-server {
leaf name { key name;
type string; min-elements 1;
description
"An arbitrary name for the NETCONF server.";
}
choice transport {
mandatory true;
description description
"Selects between available transports."; "List of NETCONF servers the NETCONF client is to initiate
connections to in parallel.";
case ssh { leaf name {
if-feature ssh-initiate; type string;
container ssh { description
"An arbitrary name for the NETCONF server.";
}
container endpoints {
description
"Container for the list of endpoints.";
list endpoint {
key name;
min-elements 1;
ordered-by user;
description description
"Specifies SSH-specific transport configuration."; "A user-ordered list of endpoints that the NETCONF
uses endpoints-container { client will attempt to connect to in the specified
refine endpoints/endpoint/port { sequence. Defining more than one enables
default 830; high-availability.";
} leaf name {
type string;
description
"An arbitrary name for the endpoint.";
} }
uses ss:ssh-client-grouping; choice transport {
} mandatory true;
} // end ssh description
"Selects between available transports.";
case ssh {
if-feature ssh-initiate;
container ssh {
description
"Specifies IP and SSH specific configuration for
the connection.";
leaf address {
type inet:host;
description
"The IP address or hostname of the endpoint.
If a domain name is configured, then the DNS
resolution should happen on each usage attempt.
If the DNS resolution results in multiple IP
addresses, the IP addresses will be tried
according to local preference order until a
connection has been established or until all
IP addresses have failed.";
}
leaf port {
type inet:port-number;
default 830;
description
"The IP port for this endpoint. The NETCONF
client will use the IANA-assigned well-known
port for 'netconf-ssh' (830) if no value is
specified.";
}
uses ss:ssh-client-grouping;
case tls { }
if-feature tls-initiate; } // end ssh
container tls { case tls {
description if-feature tls-initiate;
"Specifies TLS-specific transport configuration."; container tls {
uses endpoints-container { description
refine endpoints/endpoint/port { "Specifies IP and TLS specific configuration for
default 6513; the connection.";
} leaf address {
} type inet:host;
uses ts:tls-client-grouping { description
refine "client-auth/auth-type" { "The IP address or hostname of the endpoint.
mandatory true; If a domain name is configured, then the DNS
description resolution should happen on each usage attempt.
"NETCONF/TLS clients MUST pass some authentication If the DNS resolution results in multiple IP
credentials."; addresses, the IP addresses will be tried
} according to local preference order until a
} connection has been established or until all
IP addresses have failed.";
}
leaf port {
type inet:port-number;
default 6513;
description
"The IP port for this endpoint. The NETCONF
client will use the IANA-assigned well-known
port for 'netconf-tls' (6513) if no value is
specified.";
}
uses ts:tls-client-grouping {
refine "client-identity/auth-type" {
mandatory true;
description
"NETCONF/TLS clients MUST pass some
authentication credentials.";
}
}
}
} // end tls
}
} }
} // end tls }
} // end transport
container connection-type { container connection-type {
description
"Indicates the kind of connection to use.";
choice connection-type {
description description
"Selects between available connection types."; "Indicates the kind of connection to use.";
case persistent-connection { choice connection-type {
container persistent { description
presence true; "Selects between available connection types.";
description case persistent-connection {
"Maintain a persistent connection to the NETCONF container persistent {
server. If the connection goes down, immediately presence true;
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 description
"Specifies the maximum number of seconds that a "Maintain a persistent connection to the NETCONF
a NETCONF session may remain idle. A NETCONF server. If the connection goes down, immediately
session will be dropped if it is idle for an start trying to reconnect to it, using the
interval longer than this number of seconds. reconnection strategy.
If set to zero, then the client will never drop
a session because it is idle. Sessions that This connection type minimizes any NETCONF server
have a notification subscription active are to NETCONF client data-transfer delay, albeit at
never dropped."; 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
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 be sent
to test the aliveness of the SSH/TLS server.";
}
leaf max-attempts {
type uint8;
default 3;
description
"Sets the maximum number of sequential keep-alive
messages that can fail to obtain a response from
the SSH/TLS server before assuming the SSH/TLS
server is no longer alive.";
}
}
} }
container keep-alives { }
case periodic-connection {
container periodic {
presence true;
description description
"Configures the keep-alive policy, to proactively "Periodically connect to the NETCONF server, so that
test the aliveness of the SSH/TLS server. An the NETCONF server may deliver messages pending for
unresponsive SSH/TLS server will be dropped after the NETCONF client. The NETCONF server must close
approximately max-attempts * max-wait seconds."; the connection when it is ready to release it. Once
reference the connection has been closed, the NETCONF client
"RFC 8071: NETCONF Call Home and RESTCONF Call will restart its timer until the next connection.";
Home, Section 3.1, item S6"; leaf idle-timeout {
leaf max-wait { type uint16;
units "seconds";
default 300; // five minutes
description
"Specifies the maximum number of seconds that a
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 { type uint16 {
range "1..max"; range "1..max";
} }
units seconds; units minutes;
default 30; default 60;
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 be sent
to test the aliveness of the SSH/TLS server.";
}
leaf max-attempts {
type uint8;
default 3;
description description
"Sets the maximum number of sequential keep-alive "Sets the maximum amount of unconnected time the
messages that can fail to obtain a response from NETCONF client will wait before re-establishing
the SSH/TLS server before assuming the SSH/TLS a connection to the NETCONF server. The NETCONF
server is no longer alive."; client may initiate a connection before this
time if desired (e.g., to set configuration).";
} }
} }
} }
} }
case periodic-connection { }
container periodic { container reconnect-strategy {
presence true; description
description "The reconnection strategy directs how a NETCONF client
"Periodically connect to the NETCONF server, so that reconnects to a NETCONF server, after discovering its
the NETCONF server may deliver messages pending for connection to the server has dropped, even if due to a
the NETCONF client. The NETCONF server must close reboot. The NETCONF client starts with the specified
the connection when it is ready to release it. Once endpoint and tries to connect to it max-attempts times
the connection has been closed, the NETCONF client before trying the next endpoint in the list (round
will restart its timer until the next connection."; robin).";
leaf idle-timeout { leaf start-with {
type uint16; type enumeration {
units "seconds"; enum first-listed {
default 300; // five minutes
description description
"Specifies the maximum number of seconds that a "Indicates that reconnections should start with
a NETCONF session may remain idle. A NETCONF the first endpoint listed.";
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 { enum last-connected {
type uint16 {
range "1..max";
}
units minutes;
default 60;
description description
"Sets the maximum amount of unconnected time the "Indicates that reconnections should start with
NETCONF client will wait before re-establishing the endpoint last connected to. If no previous
a connection to the NETCONF server. The NETCONF connection has ever been established, then the
client may initiate a connection before this first endpoint configured is used. NETCONF
time if desired (e.g., to set configuration)."; clients SHOULD be able to remember the last
endpoint connected to across reboots.";
} }
} }
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 {
container reconnect-strategy { range "1..max";
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
reboot. The NETCONF client starts with the specified
endpoint and tries to connect to it max-attempts times
before trying the next endpoint in the list (round
robin).";
leaf start-with {
type enumeration {
enum first-listed {
description
"Indicates that reconnections should start with
the first endpoint listed.";
}
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.";
} }
default 3;
description
"Specifies the number times the NETCONF client tries to
connect to a specific endpoint before moving on to the
next endpoint in the list (round robin).";
} }
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";
}
default 3;
description
"Specifies the number times the NETCONF client tries to
connect to a specific endpoint before moving on to the
next endpoint in the list (round robin).";
} }
}
} // end netconf-server
} // end initiate
container listen { } // end netconf-server
if-feature listen; } // end initiate
description
"Configures client accepting call-home TCP connections.";
leaf max-sessions {
type uint16;
default 0;
description
"Specifies the maximum number of concurrent sessions
that can be active at one time. The value 0 indicates
that no artificial session limit should be used.";
}
leaf idle-timeout { container listen {
type uint16; if-feature listen;
units "seconds";
default 3600; // one hour
description description
"Specifies the maximum number of seconds that a NETCONF "Configures client accepting call-home TCP connections.";
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.";
}
list endpoint { leaf idle-timeout {
key name; type uint16;
description units "seconds";
"List of endpoints to listen for NETCONF connections."; default 3600; // one hour
leaf name {
type string;
description description
"An arbitrary name for the NETCONF listen endpoint."; "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.";
} }
choice transport {
mandatory true; list endpoint {
key name;
min-elements 1;
description description
"Selects between available transports."; "List of endpoints to listen for NETCONF connections.";
case ssh { leaf name {
if-feature ssh-listen; type string;
container ssh { description
description "An arbitrary name for the NETCONF listen endpoint.";
"SSH-specific listening configuration for inbound
connections.";
leaf address {
type inet:ip-address;
description
"The IP address to listen for call-home connections.";
}
leaf port {
type inet:port-number;
default 4334;
description
"The port number to listen for call-home connections.";
}
uses ss:ssh-client-grouping;
}
} }
case tls { choice transport {
if-feature tls-listen; mandatory true;
container tls { description
description "Selects between available transports.";
"TLS-specific listening configuration for inbound case ssh {
connections."; if-feature ssh-listen;
leaf address { container ssh {
type inet:ip-address;
description description
"The IP address to listen for call-home connections."; "SSH-specific listening configuration for inbound
connections.";
leaf address {
type inet:ip-address;
description
"The IP address to listen on for incoming call-home
connections. The NETCONF client will listen on
all configured interfaces if no value is specified.
INADDR_ANY (0.0.0.0) or INADDR6_ANY (0:0:0:0:0:0:0:0
a.k.a. ::) MUST be used when the server is to listen
on all IPv4 or IPv6 addresses, respectively.";
}
leaf port {
type inet:port-number;
default 4334;
description
"The port number to listen on for call-home
connections. The NETCONF client will listen on the
IANA-assigned well-known port for 'netconf-ch-ssh'
(4334) if no value is specified.";
}
uses ss:ssh-client-grouping;
} }
leaf port { }
type inet:port-number; case tls {
default 4335; if-feature tls-listen;
container tls {
description description
"The port number to listen for call-home connections."; "TLS-specific listening configuration for inbound
} connections.";
uses ts:tls-client-grouping { leaf address {
refine "client-auth/auth-type" { type inet:ip-address;
mandatory true;
description description
"NETCONF/TLS clients MUST pass some authentication "The IP address to listen on for incoming call-home
credentials."; connections. The NETCONF client will listen on
all configured interfaces if no value is specified.
INADDR_ANY (0.0.0.0) or INADDR6_ANY (0:0:0:0:0:0:0:0
a.k.a. ::) MUST be used when the server is to listen
on all IPv4 or IPv6 addresses, respectively.";
}
leaf port {
type inet:port-number;
default 4335;
description
"The port number to listen on for call-home
connections. The NETCONF client will listen on the
IANA-assigned well-known port for 'netconf-ch-tls'
(4335) if no value is specified.";
} }
uses ts:tls-client-grouping {
refine "client-identity/auth-type" {
mandatory true;
description
"NETCONF/TLS clients MUST pass some authentication
credentials.";
}
}
} }
} }
} } // end transport
} // end transport } // end endpoint
} // end endpoint } // end listen
} // end listen
} // end netconf-client
grouping endpoints-container { } // end netconf-client
description
"This grouping is used to configure a set of NETCONF servers
a NETCONF client may initiate connections to.";
container endpoints {
description
"Container for the list of endpoints.";
list endpoint {
key name;
unique "address port";
min-elements 1;
ordered-by user;
description
"A non-empty user-ordered list of endpoints for this NETCONF
client to try to connect to. Defining more than one enables
high-availability.";
leaf name {
type string;
description
"An arbitrary name for this endpoint.";
}
leaf address {
type inet:host;
mandatory true;
description
"The IP address or hostname of the endpoint. If a
hostname is configured and the DNS resolution results
in more than one IP address, the NETCONF client
will process the IP addresses as if they had been
explicitly configured in place of the hostname.";
}
leaf port {
type inet:port-number;
description
"The IP port for this endpoint. The NETCONF client will
use the IANA-assigned well-known port (set via a refine
statement when uses) if no value is specified.";
}
}
}
} }
} <CODE ENDS>
<CODE ENDS> 4. The NETCONF Server Model
3. The NETCONF Server Model
The NETCONF server model presented in this section supports servers The NETCONF server model presented in this section supports servers
both listening for connections as well as initiating call-home both listening for connections as well as initiating call-home
connections. connections.
This model supports both the SSH and TLS transport protocols, using This model supports both the SSH and TLS transport protocols, using
the SSH server and TLS server groupings defined in the SSH server and TLS server groupings defined in
[I-D.ietf-netconf-ssh-client-server] and [I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-tls-client-server] respectively. [I-D.ietf-netconf-tls-client-server] respectively.
All private keys and trusted certificates are held in the keystore All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore]. model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to YANG feature statements are used to enable implementations to
advertise which parts of the model the NETCONF server supports. advertise which parts of the model the NETCONF server supports.
3.1. Tree Diagram 4.1. Tree Diagram
Just the container is displayed below, but there is also a grouping The following tree diagram [I-D.ietf-netmod-yang-tree-diagrams]
that the container is using. 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.
Note: all lines are folded at column 71 with no '\' character. [ note: '\' line wrapping for formatting only]
module: ietf-netconf-server module: ietf-netconf-server
+--rw netconf-server +--rw netconf-server
+--rw session-options +--rw listen {listen}?
| +--rw hello-timeout? uint16 | +--rw idle-timeout? uint16
+--rw listen {listen}? | +--rw endpoint* [name]
| +--rw max-sessions? uint16 | +--rw name string
| +--rw idle-timeout? uint16 | +--rw (transport)
| +--rw endpoint* [name] | +--:(ssh) {ssh-listen}?
| +--rw name string | | +--rw ssh
| +--rw (transport) | | +--rw address inet:ip-address
| +--:(ssh) {ssh-listen}? | | +--rw port? inet:port-number
| | +--rw ssh | | +--rw server-identity
| | +--rw address? inet:ip-address | | | +--rw host-key* [name]
| | +--rw port? inet:port-number | | | +--rw name string
| | +--rw host-keys | | | +--rw (host-key-type)
| | | +--rw host-key* [name] | | | +--:(public-key)
| | | +--rw name string | | | | +--rw public-key
| | | +--rw (host-key-type) | | | | +--rw algorithm?
| | | +--:(public-key) | | | | | identityref
| | | | +--rw public-key? | | | | +--rw private-key?
| | | | -> /ks:keystore/keys/key/name | | | | | union
| | | +--:(certificate) | | | | +--rw public-key?
| | | +--rw certificate? leafref | | | | | binary
| | | {sshcom:ssh-x509-certs}? | | | | +---x generate-private-key
| | +--rw client-cert-auth {sshcom:ssh-x509-certs}? | | | | +---w input
| | | +--rw trusted-ca-certs? leafref | | | | +---w algorithm
| | | +--rw trusted-client-certs? leafref | | | | identityref
| | +--rw transport-params | | | +--:(certificate)
| | {ssh-server-transport-params-config}? | | | +--rw certificate
| | +--rw host-key | | | {sshcom:ssh-x509-certs}?
| | | +--rw host-key-alg* identityref | | | +--rw algorithm?
| | +--rw key-exchange | | | | identityref
| | | +--rw key-exchange-alg* identityref | | | +--rw private-key?
| | +--rw encryption | | | | union
| | | +--rw encryption-alg* identityref | | | +--rw public-key?
| | +--rw mac | | | | binary
| | | +--rw mac-alg* identityref | | | +---x generate-private-key
| | +--rw compression | | | | +---w input
| | +--rw compression-alg* identityref | | | | +---w algorithm
| +--:(tls) {tls-listen}? | | | | identityref
| +--rw tls | | | +--rw certificates
| +--rw address? inet:ip-address | | | | +--rw certificate* [name]
| +--rw port? inet:port-number | | | | +--rw name string
| +--rw certificates | | | | +--rw value? binary
| | +--rw certificate* [name] | | | +---x generate-certificate-signi\
| | +--rw name leafref ng-request
| +--rw client-auth | | | +---w input
| | +--rw trusted-ca-certs? leafref | | | | +---w subject binary\
| | +--rw trusted-client-certs? leafref
| | +--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 call-home {call-home}?
+--rw netconf-client* [name]
+--rw name string
+--rw (transport)
| +--:(ssh) {ssh-call-home}?
| | +--rw ssh
| | +--rw endpoints
| | | +--rw endpoint* [name]
| | | +--rw name string
| | | +--rw address inet:host
| | | +--rw port? inet:port-number
| | +--rw host-keys
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key?
| | | | -> /ks:keystore/keys/key/name
| | | +--:(certificate)
| | | +--rw certificate? leafref
| | | {sshcom:ssh-x509-certs}?
| | +--rw client-cert-auth {sshcom:ssh-x509-certs}?
| | | +--rw trusted-ca-certs? leafref
| | | +--rw trusted-client-certs? leafref
| | +--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
| | +--rw compression
| | +--rw compression-alg* identityref
| +--:(tls) {tls-call-home}?
| +--rw tls
| +--rw endpoints
| | +--rw endpoint* [name]
| | +--rw name string
| | +--rw address inet:host
| | +--rw port? inet:port-number
| +--rw certificates
| | +--rw certificate* [name]
| | +--rw name leafref
| +--rw client-auth
| | +--rw trusted-ca-certs? leafref
| | +--rw trusted-client-certs? leafref
| | +--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)?
| +--:(persistent-connection)
| | +--rw persistent!
| | +--rw idle-timeout? uint32
| | +--rw keep-alives
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--:(periodic-connection)
| +--rw periodic!
| +--rw idle-timeout? uint16
| +--rw reconnect-timeout? uint16
+--rw reconnect-strategy
+--rw start-with? enumeration
+--rw max-attempts? uint8
3.2. Example Usage | | | | +---w attributes? binary\
| | | +--ro output
| | | +--ro certificate-signing-\
request
| | | binary
| | +--rw client-cert-auth {sshcom:ssh-x509-certs}?\
| | | +--rw pinned-ca-certs?
| | | | ks:pinned-certificates
| | | +--rw pinned-client-certs?
| | | ks:pinned-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
| | +--rw compression
| | +--rw compression-alg* identityref
| +--:(tls) {tls-listen}?
| +--rw tls
| +--rw address inet:ip-address
| +--rw port? inet:port-number
| +--rw server-identity
| | +--rw algorithm?
| | | identityref
| | +--rw private-key?
| | | union
| | +--rw public-key?
| | | binary
| | +---x generate-private-key
| | | +---w input
| | | +---w algorithm identityref
| | +--rw certificates
| | | +--rw certificate* [name]
| | | +--rw name string
| | | +--rw value? binary
| | +---x generate-certificate-signing-request
| | +---w input
| | | +---w subject binary
| | | +---w attributes? binary
| | +--ro output
| | +--ro certificate-signing-request
| | binary
| +--rw client-auth
| | +--rw pinned-ca-certs?
| | | ks:pinned-certificates
| | +--rw pinned-client-certs?
| | | ks:pinned-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 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-numbe\
r
| | +--rw server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw algorithm?
| | | | | identityref
| | | | +--rw private-key?
| | | | | union
| | | | +--rw public-key?
| | | | | binary
| | | | +---x generate-private-key\
| | | | +---w input
| | | | +---w algorithm
| | | | identityref
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcom:ssh-x509-cert\
s}?
| | | +--rw algorithm?
| | | | identityref
| | | +--rw private-key?
| | | | union
| | | +--rw public-key?
| | | | binary
| | | +---x generate-private-key\
| | | | +---w input
| | | | +---w algorithm
| | | | identityref
| | | +--rw certificates
| | | | +--rw certificate* [nam\
e]
| | | | +--rw name strin\
g
| | | | +--rw value? binar\
y
| | | +---x generate-certificate\
-signing-request
| | | +---w input
| | | | +---w subject
| | | | | binary
| | | | +---w attributes?
| | | | binary
| | | +--ro output
| | | +--ro certificate-si\
gning-request
| | | binary
| | +--rw client-cert-auth
| | | {sshcom:ssh-x509-certs}?
| | | +--rw pinned-ca-certs?
| | | | ks:pinned-certificates
| | | +--rw pinned-client-certs?
| | | ks:pinned-certificates
| | +--rw transport-params
| | {ssh-server-transport-params-conf\
ig}?
| | +--rw host-key
| | | +--rw host-key-alg* identityref
| | +--rw key-exchange
| | | +--rw key-exchange-alg* identityr\
ef
| | +--rw encryption
| | | +--rw encryption-alg* identityref\
| | +--rw mac
| | | +--rw mac-alg* identityref
| | +--rw compression
| | +--rw compression-alg* identityre\
f
| +--:(tls) {tls-call-home}?
| +--rw tls
| +--rw address inet:host
| +--rw port? inet:port-number\
| +--rw server-identity
| | +--rw algorithm?
| | | identityref
| | +--rw private-key?
| | | union
| | +--rw public-key?
| | | binary
| | +---x generate-private-key
| | | +---w input
| | | +---w algorithm identityref
| | +--rw certificates
| | | +--rw certificate* [name]
| | | +--rw name string
| | | +--rw value? binary
| | +---x generate-certificate-signing-req\
uest
| | +---w input
| | | +---w subject binary
| | | +---w attributes? binary
| | +--ro output
| | +--ro certificate-signing-reques\
t
| | binary
| +--rw client-auth
| | +--rw pinned-ca-certs?
| | | ks:pinned-certificates
| | +--rw pinned-client-certs?
| | | ks:pinned-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)?
| +--:(persistent-connection)
| | +--rw persistent!
| | +--rw idle-timeout? uint32
| | +--rw keep-alives
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--:(periodic-connection)
| +--rw periodic!
| +--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 The following example illustrates configuring a NETCONF server to
listen for NETCONF client connections using both the SSH and TLS listen for NETCONF client connections using both the SSH and TLS
transport protocols, as well as configuring call-home to two NETCONF transport protocols, as well as configuring call-home to two NETCONF
clients, one using SSH and the other using TLS. 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 2.2
of [I-D.ietf-netconf-keystore]. of [I-D.ietf-netconf-keystore].
<netconf-server [ note: '\' line wrapping for formatting only]
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server"
xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name">
<!-- listening for SSH and TLS connections --> <netconf-server
<listen> xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server"
<endpoint> <!-- listening for SSH connections --> xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name">\
<name>netconf/ssh</name>
<ssh>
<address>11.22.33.44</address>
<host-keys>
<host-key>
<name>public-key</name>
<public-key>ex-rsa-key</public-key>
</host-key>
<host-key>
<name>certificate</name>
<certificate>builtin-idevid-cert</certificate>
</host-key>
</host-keys>
<client-cert-auth>
<trusted-ca-certs>deployment-specific-ca-certs</trusted-ca-certs>
<trusted-client-certs>explicitly-trusted-client-certs</trusted-client-certs>
</client-cert-auth>
</ssh>
</endpoint>
<endpoint> <!-- listening for TLS sessions -->
<name>netconf/tls</name>
<tls>
<address>11.22.33.44</address>
<certificates>
<certificate>
<name>tls-ec-cert</name>
</certificate>
</certificates>
<client-auth>
<trusted-ca-certs>deployment-specific-ca-certs</trusted-ca-certs>
<trusted-client-certs>explicitly-trusted-client-certs</trusted-client-certs>
<cert-maps>
<cert-to-name>
<id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type>
</cert-to-name>
<cert-to-name>
<id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type>
<name>scooby-doo</name>
</cert-to-name>
</cert-maps>
</client-auth>
</tls>
</endpoint>
</listen>
<!-- calling home to an SSH and TLS based NETCONF clients --> <!-- listening for SSH and TLS connections -->
<call-home> <listen>
<netconf-client> <!-- SSH-based client --> <endpoint> <!-- listening for SSH connections -->
<name>config-mgr</name> <name>netconf/ssh</name>
<ssh> <ssh>
<address>192.0.2.7</address>
<server-identity>
<host-key>
<name>deployment-specific-certificate</name>
<public-key>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ietf-k\
eystore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
</public-key>
</host-key>
</server-identity>
<client-cert-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-ca-ce\
rts>
<pinned-client-certs>explicitly-trusted-client-certs</pinne\
d-client-certs>
</client-cert-auth>
</ssh>
</endpoint>
<endpoint> <!-- listening for TLS sessions -->
<name>netconf/tls</name>
<tls>
<address>192.0.2.7</address>
<server-identity>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ietf-keyst\
ore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
<certificates>
<certificate>
<name>domain certificate</name>
<value>base64encodedvalue==</value>
</certificate>
</certificates>
</server-identity>
<client-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-ca-ce\
rts>
<pinned-client-certs>explicitly-trusted-client-certs</pinne\
d-client-certs>
<cert-maps>
<cert-to-name>
<id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type>
</cert-to-name>
<cert-to-name>
<id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type>
<name>scooby-doo</name>
</cert-to-name>
</cert-maps>
</client-auth>
</tls>
</endpoint>
</listen>
<!-- calling home to an SSH and TLS based NETCONF clients -->
<call-home>
<netconf-client> <!-- SSH-based client -->
<name>config-mgr</name>
<endpoints> <endpoints>
<endpoint> <endpoint>
<name>east-data-center</name> <name>east-data-center</name>
<address>11.22.33.44</address> <ssh>
<address>east.config-mgr.example.com</address>
<server-identity>
<host-key>
<name>deployment-specific-certificate</name>
<public-key>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ie\
tf-keystore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
</public-key>
</host-key>
</server-identity>
<client-cert-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-c\
a-certs>
<pinned-client-certs>explicitly-trusted-client-certs</p\
inned-client-certs>
</client-cert-auth>
</ssh>
</endpoint> </endpoint>
<endpoint> <endpoint>
<name>west-data-center</name> <name>west-data-center</name>
<address>55.66.77.88</address> <ssh>
<address>west.config-mgr.example.com</address>
<server-identity>
<host-key>
<name>deployment-specific-certificate</name>
<public-key>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ie\
tf-keystore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
</public-key>
</host-key>
</server-identity>
<client-cert-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-c\
a-certs>
<pinned-client-certs>explicitly-trusted-client-certs</p\
inned-client-certs>
</client-cert-auth>
</ssh>
</endpoint> </endpoint>
</endpoints> </endpoints>
<host-keys> <connection-type>
<host-key> <periodic>
<name>certificate</name> <idle-timeout>300</idle-timeout>
<certificate>builtin-idevid-cert</certificate> <reconnect-timeout>60</reconnect-timeout>
</host-key> </periodic>
</host-keys> </connection-type>
<client-cert-auth> <reconnect-strategy>
<trusted-ca-certs>deployment-specific-ca-certs</trusted-ca-certs> <start-with>last-connected</start-with>
<trusted-client-certs>explicitly-trusted-client-certs</trusted-client-certs> <max-attempts>3</max-attempts>
</client-cert-auth> </reconnect-strategy>
</ssh> </netconf-client>
<connection-type> <netconf-client> <!-- TLS-based client -->
<periodic> <name>data-collector</name>
<idle-timeout>300</idle-timeout>
<reconnect-timeout>60</reconnect-timeout>
</periodic>
</connection-type>
<reconnect-strategy>
<start-with>last-connected</start-with>
<max-attempts>3</max-attempts>
</reconnect-strategy>
</netconf-client>
<netconf-client> <!-- TLS-based client -->
<name>event-correlator</name>
<tls>
<endpoints> <endpoints>
<endpoint> <endpoint>
<name>east-data-center</name> <name>east-data-center</name>
<address>22.33.44.55</address> <tls>
<address>east.analytics.example.com</address>
<server-identity>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ietf-k\
eystore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
<certificates>
<certificate>
<name>domain certificate</name>
<value>base64encodedvalue==</value>
</certificate>
</certificates>
</server-identity>
<client-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-c\
a-certs>
<pinned-client-certs>explicitly-trusted-client-certs</p\
inned-client-certs>
<cert-maps>
<cert-to-name>
<id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type>
</cert-to-name>
<cert-to-name>
<id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type>
<name>scooby-doo</name>
</cert-to-name>
</cert-maps>
</client-auth>
</tls>
</endpoint> </endpoint>
<endpoint> <endpoint>
<name>west-data-center</name> <name>west-data-center</name>
<address>33.44.55.66</address> <tls>
<address>west.analytics.example.com</address>
<server-identity>
<algorithm xmlns:ks="urn:ietf:params:xml:ns:yang:ietf-k\
eystore">ks:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key>
<certificates>
<certificate>
<name>domain certificate</name>
<value>base64encodedvalue==</value>
</certificate>
</certificates>
</server-identity>
<client-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-c\
a-certs>
<pinned-client-certs>explicitly-trusted-client-certs</p\
inned-client-certs>
<cert-maps>
<cert-to-name>
<id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type>
</cert-to-name>
<cert-to-name>
<id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type>
<name>scooby-doo</name>
</cert-to-name>
</cert-maps>
</client-auth>
</tls>
</endpoint> </endpoint>
</endpoints> </endpoints>
<certificates> <connection-type>
<certificate> <persistent>
<name>tls-ec-cert</name> <idle-timeout>300</idle-timeout>
</certificate> <keep-alives>
</certificates> <max-wait>30</max-wait>
<client-auth> <max-attempts>3</max-attempts>
<trusted-ca-certs>deployment-specific-ca-certs</trusted-ca-certs>
<trusted-client-certs>explicitly-trusted-client-certs</trusted-client-certs>
<cert-maps>
<cert-to-name>
<id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type>
</cert-to-name>
<cert-to-name>
<id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type>
<name>scooby-doo</name>
</cert-to-name>
</cert-maps>
</client-auth>
</tls>
<connection-type>
<persistent>
<idle-timeout>300</idle-timeout>
<keep-alives>
<max-wait>30</max-wait>
<max-attempts>3</max-attempts>
</keep-alives>
</persistent>
</connection-type>
<reconnect-strategy>
<start-with>first-listed</start-with>
<max-attempts>3</max-attempts>
</reconnect-strategy>
</netconf-client>
</call-home>
</netconf-server>
3.3. YANG Model
This YANG module imports YANG types from [RFC6991] and [RFC7407].
<CODE BEGINS> file "ietf-netconf-server@2017-07-03.yang"
module ietf-netconf-server {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server";
prefix "ncs";
import ietf-inet-types { </keep-alives>
prefix inet; </persistent>
reference </connection-type>
"RFC 6991: Common YANG Data Types"; <reconnect-strategy>
} <start-with>first-listed</start-with>
import ietf-x509-cert-to-name { <max-attempts>3</max-attempts>
prefix x509c2n; </reconnect-strategy>
reference </netconf-client>
"RFC 7407: A YANG Data Model for SNMP Configuration"; </call-home>
} </netconf-server>
import ietf-ssh-server { 4.3. YANG Module
prefix ss;
revision-date 2017-06-13; // stable grouping definitions
reference
"RFC YYYY: SSH Client and Server Models";
}
import ietf-tls-server { This YANG module imports YANG types from [RFC6991], and YANG
prefix ts; groupings from [RFC7407], [I-D.ietf-netconf-ssh-client-server] and
revision-date 2017-06-13; // stable grouping definitions [I-D.ietf-netconf-ssh-client-server].
reference
"RFC ZZZZ: TLS Client and Server Models";
}
organization <CODE BEGINS> file "ietf-netconf-server@2017-10-30.yang"
"IETF NETCONF (Network Configuration) Working Group"; module ietf-netconf-server {
yang-version 1.1;
contact namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server";
"WG Web: <http://tools.ietf.org/wg/netconf/> prefix "ncs";
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen import ietf-inet-types {
<mailto:kwatsen@juniper.net>"; prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
description import ietf-x509-cert-to-name {
"This module contains a collection of YANG definitions for prefix x509c2n;
configuring NETCONF servers. reference
"RFC 7407: A YANG Data Model for SNMP Configuration";
}
Copyright (c) 2014 IETF Trust and the persons identified as import ietf-ssh-server {
authors of the code. All rights reserved. prefix ss;
revision-date 2017-10-30; // stable grouping definitions
reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers";
}
Redistribution and use in source and binary forms, with or import ietf-tls-server {
without modification, is permitted pursuant to, and subject prefix ts;
to the license terms contained in, the Simplified BSD revision-date 2017-10-30; // stable grouping definitions
License set forth in Section 4.c of the IETF Trust's reference
Legal Provisions Relating to IETF Documents "RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
(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 "2017-07-03" { organization
description "IETF NETCONF (Network Configuration) Working Group";
"Initial version";
reference
"RFC XXXX: NETCONF Client and Server Models";
}
// Features contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
feature listen { Author: Kent Watsen
description <mailto:kwatsen@juniper.net>
"The 'listen' feature indicates that the NETCONF server
supports opening a port to accept NETCONF client connections
using at least one transport (e.g., SSH, TLS, etc.).";
}
feature ssh-listen { Author: Gary Wu
description <mailto:garywu@cisco.com>
"The 'ssh-listen' feature indicates that the NETCONF server
supports opening a port to accept NETCONF over SSH
client connections.";
reference
"RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)";
}
feature tls-listen { Author: Juergen Schoenwaelder
description <mailto:j.schoenwaelder@jacobs-university.de>";
"The 'tls-listen' feature indicates that the NETCONF server
supports opening a port to accept NETCONF over TLS
client connections.";
reference
"RFC 7589: Using the NETCONF Protocol over Transport
Layer Security (TLS) with Mutual X.509
Authentication";
}
feature call-home { description
description "This module contains a collection of YANG definitions for
"The 'call-home' feature indicates that the NETCONF server configuring NETCONF servers.
supports initiating NETCONF call home connections to NETCONF
clients using at least one transport (e.g., SSH, TLS, etc.).";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
feature ssh-call-home { Copyright (c) 2017 IETF Trust and the persons identified as
description authors of the code. All rights reserved.
"The 'ssh-call-home' feature indicates that the NETCONF
server supports initiating a NETCONF over SSH call
home connection to NETCONF clients.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
feature tls-call-home { Redistribution and use in source and binary forms, with or
description without modification, is permitted pursuant to, and subject
"The 'tls-call-home' feature indicates that the NETCONF to the license terms contained in, the Simplified BSD
server supports initiating a NETCONF over TLS call License set forth in Section 4.c of the IETF Trust's
home connection to NETCONF clients."; Legal Provisions Relating to IETF Documents
reference (http://trustee.ietf.org/license-info).
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
container netconf-server { This version of this YANG module is part of RFC XXXX; see
uses netconf-server; the RFC itself for full legal notices.";
description
"Top-level container for NETCONF server configuration.";
}
grouping netconf-server { revision "2017-10-30" {
description description
"Top-level grouping for NETCONF server configuration."; "Initial version";
reference
"RFC XXXX: NETCONF Client and Server Models";
}
container session-options { // SHOULD WE REMOVE THIS ALTOGETHER? // Features
description
"NETCONF session options, independent of transport
or connection strategy.";
leaf hello-timeout {
type uint16;
units "seconds";
default 600;
description
"Specifies the maximum number of seconds that a SSH/TLS
connection may wait for a hello message to be received.
A connection will be dropped if no hello message is
received before this number of seconds elapses. If set
to zero, then the server will wait forever for a hello
message.";
}
}
container listen { feature listen {
if-feature listen; description
description "The 'listen' feature indicates that the NETCONF server
"Configures listen behavior"; supports opening a port to accept NETCONF client connections
using at least one transport (e.g., SSH, TLS, etc.).";
}
leaf max-sessions { feature ssh-listen {
type uint16; description
default 0; "The 'ssh-listen' feature indicates that the NETCONF server
description supports opening a port to accept NETCONF over SSH
"Specifies the maximum number of concurrent sessions client connections.";
that can be active at one time. The value 0 indicates reference
that no artificial session limit should be used."; "RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)";
} }
leaf idle-timeout {
type uint16;
units "seconds";
default 3600; // one hour
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.";
}
list endpoint {
key name;
description
"List of endpoints to listen for NETCONF connections.";
leaf name {
type string;
description
"An arbitrary name for the NETCONF listen endpoint.";
}
choice transport { feature tls-listen {
mandatory true; description
description "The 'tls-listen' feature indicates that the NETCONF server
"Selects between available transports."; supports opening a port to accept NETCONF over TLS
case ssh { client connections.";
if-feature ssh-listen; reference
container ssh { "RFC 7589: Using the NETCONF Protocol over Transport
description Layer Security (TLS) with Mutual X.509
"SSH-specific listening configuration for inbound Authentication";
connections."; }
leaf address {
type inet:ip-address;
description
"The IP address of the interface to listen on. The
SSH server will listen on all interfaces if no value
is specified. Please note that some addresses have
special meanings (e.g., '0.0.0.0' and '::').";
} feature call-home {
leaf port { description
type inet:port-number; "The 'call-home' feature indicates that the NETCONF server
default 830; supports initiating NETCONF call home connections to NETCONF
description clients using at least one transport (e.g., SSH, TLS, etc.).";
"The local port number on this interface the SSH server reference
listens on."; "RFC 8071: NETCONF Call Home and RESTCONF Call Home";
} }
uses ss:ssh-server-grouping;
}
}
case tls {
if-feature tls-listen;
container tls {
description
"TLS-specific listening configuration for inbound
connections.";
leaf address {
type inet:ip-address;
description
"The IP address of the interface to listen on. The
TLS server will listen on all interfaces if no value
is specified. Please note that some addresses have
special meanings (e.g., '0.0.0.0' and '::').";
}
leaf port {
type inet:port-number;
default 6513;
description
"The local port number on this interface the TLS server
listens on.";
}
uses ts:tls-server-grouping {
refine "client-auth" {
must 'trusted-ca-certs or trusted-client-certs';
description
"NETCONF/TLS servers MUST validate client
certiticates.";
}
augment "client-auth" {
description
"Augments in the cert-to-name structure.";
uses cert-maps-grouping;
}
}
}
}
}
} feature ssh-call-home {
} description
"The 'ssh-call-home' feature indicates that the NETCONF
server supports initiating a NETCONF over SSH call
home connection to NETCONF clients.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
container call-home { feature tls-call-home {
if-feature call-home; description
description "The 'tls-call-home' feature indicates that the NETCONF
"Configures call-home behavior"; server supports initiating a NETCONF over TLS call
list netconf-client { home connection to NETCONF clients.";
key name;
description
"List of NETCONF clients the NETCONF server is to initiate
call-home connections to.";
leaf name {
type string;
description
"An arbitrary name for the remote NETCONF client.";
}
choice transport {
mandatory true;
description
"Selects between available transports.";
case ssh {
if-feature ssh-call-home;
container ssh {
description
"Specifies SSH-specific call-home transport
configuration.";
uses endpoints-container {
refine endpoints/endpoint/port {
default 4334;
}
}
uses ss:ssh-server-grouping;
}
}
case tls {
if-feature tls-call-home;
container tls {
description
"Specifies TLS-specific call-home transport
configuration.";
uses endpoints-container {
refine endpoints/endpoint/port {
default 4335;
}
}
uses ts:tls-server-grouping {
refine "client-auth" {
must 'trusted-ca-certs or trusted-client-certs';
description
"NETCONF/TLS servers MUST validate client
certiticates.";
}
augment "client-auth" {
description
"Augments in the cert-to-name structure.";
uses cert-maps-grouping;
}
}
}
}
}
container connection-type {
description
"Indicates the kind of connection to use.";
choice connection-type {
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence true;
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 reference
to NETCONF server data-transfer delay, albeit at "RFC 8071: NETCONF Call Home and RESTCONF Call Home";
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
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";
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 will be sent
to test the aliveness of the SSH/TLS client.";
}
leaf max-attempts {
type uint8;
default 3;
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 true;
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.";
leaf idle-timeout {
type uint16;
units "seconds";
default 300; // five minutes
description
"Specifies the maximum number of seconds that a
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).";
}
}
}
}
}
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
reboot. The NETCONF server starts with the specified
endpoint and tries to connect to it max-attempts times
before trying the next endpoint in the list (round
robin).";
leaf start-with {
type enumeration {
enum first-listed {
description
"Indicates that reconnections should start with
the first endpoint listed.";
}
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.";
}
}
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";
}
default 3;
description
"Specifies the number times the NETCONF server tries to
connect to a specific endpoint before moving on to the
next endpoint in the list (round robin).";
}
}
}
}
}
grouping cert-maps-grouping { container netconf-server {
description uses netconf-server;
"A grouping that defines a container around the description
cert-to-name structure defined in RFC 7407."; "Top-level container for NETCONF server configuration.";
container cert-maps { }
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by a TLS-based NETCONF
server to map the NETCONF client's presented X.509
certificate to a NETCONF username. If no matching and
valid cert-to-name list entry can be found, then the
NETCONF server MUST close the connection, and MUST NOT
accept NETCONF messages over it.";
reference
"RFC WWWW: NETCONF over TLS, Section 7";
}
}
grouping endpoints-container { grouping netconf-server {
description description
"This grouping is used to configure a set of NETCONF clients "Top-level grouping for NETCONF server configuration.";
a NETCONF server may initiate call-home connections to."; container listen {
if-feature listen;
description
"Configures listen behavior";
leaf idle-timeout {
type uint16;
units "seconds";
default 3600; // one hour
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.";
}
list endpoint {
key name;
min-elements 1;
description
"List of endpoints to listen for NETCONF connections.";
leaf name {
type string;
description
"An arbitrary name for the NETCONF listen endpoint.";
}
choice transport {
mandatory true;
description
"Selects between available transports.";
case ssh {
if-feature ssh-listen;
container ssh {
description
"SSH-specific listening configuration for inbound
connections.";
leaf address {
type inet:ip-address;
mandatory true;
description
"The IP address to listen on for incoming
connections. The NETCONF server will listen
on all configured interfaces if no value is
specified. INADDR_ANY (0.0.0.0) or INADDR6_ANY
(0:0:0:0:0:0:0:0 a.k.a. ::) MUST be used when
the server is to listen on all IPv4 or IPv6
addresses, respectively.";
}
leaf port {
type inet:port-number;
default 830;
description
"The local port number to listen on. If no value
is specified, the IANA-assigned port value for
'netconf-ssh' (830) is used.";
}
uses ss:ssh-server-grouping;
}
}
case tls {
if-feature tls-listen;
container tls {
description
"TLS-specific listening configuration for inbound
connections.";
leaf address {
type inet:ip-address;
mandatory true;
description
"The IP address to listen on for incoming
connections. The NETCONF server will listen
on all configured interfaces if no value is
specified. INADDR_ANY (0.0.0.0) or INADDR6_ANY
(0:0:0:0:0:0:0:0 a.k.a. ::) MUST be used when
the server is to listen on all IPv4 or IPv6
addresses, respectively.";
}
leaf port {
type inet:port-number;
default 6513;
description
"The local port number to listen on. If no value
is specified, the IANA-assigned port value for
'netconf-tls' (6513) is used.";
}
uses ts:tls-server-grouping {
refine "client-auth" {
must 'pinned-ca-certs or pinned-client-certs';
description
"NETCONF/TLS servers MUST validate client
certiticates.";
}
augment "client-auth" {
description
"Augments in the cert-to-name structure.";
container cert-maps {
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by a TLS-based
NETCONF server to map the NETCONF client's
presented X.509 certificate to a NETCONF
username. If no matching and valid cert-to-name
list entry can be found, then the NETCONF server
MUST close the connection, and MUST NOT accept
NETCONF messages over it.";
reference
"RFC WWWW: NETCONF over TLS, Section 7";
}
}
}
}
}
}
}
}
container endpoints { container call-home {
description if-feature call-home;
"Container for the list of endpoints."; description
list endpoint { "Configures call-home behavior";
key name; list netconf-client {
unique "address port"; key name;
min-elements 1; min-elements 1;
ordered-by user; description
description "List of NETCONF clients the NETCONF server is to initiate
"A non-empty user-ordered list of endpoints for this NETCONF call-home connections to in parallel.";
server to try to connect to. Defining more than one enables leaf name {
high-availability."; type string;
leaf name { description
type string; "An arbitrary name for the remote NETCONF client.";
description }
"An arbitrary name for this endpoint."; container endpoints {
} description
leaf address { "Container for the list of endpoints.";
type inet:host; list endpoint {
mandatory true; key name;
description min-elements 1;
"The IP address or hostname of the endpoint. If a ordered-by user;
hostname is configured and the DNS resolution results description
in more than one IP address, the NETCONF server "A non-empty user-ordered list of endpoints for this
will process the IP addresses as if they had been NETCONF server to try to connect to in sequence.
explicitly configured in place of the hostname."; Defining more than one enables high-availability.";
} leaf name {
leaf port { type string;
type inet:port-number; description
description "An arbitrary name for this endpoint.";
"The IP port for this endpoint. The NETCONF server will }
use the IANA-assigned well-known port (set via a refine choice transport {
statement when uses) if no value is specified."; mandatory true;
} description
} "Selects between available transports.";
} case ssh {
} if-feature ssh-call-home;
container ssh {
description
"Specifies SSH-specific call-home transport
configuration.";
leaf address {
type inet:host;
mandatory true;
description
"The IP address or hostname of the endpoint.
If a domain name is configured, then the DNS
resolution should happen on each usage attempt.
If the the DNS resolution results in multiple
IP addresses, the IP addresses will be tried
according to local preference order until a
connection has been established or until all
IP addresses have failed.";
}
leaf port {
type inet:port-number;
default 4334;
description
"The IP port for this endpoint. The NETCONF
server will use the IANA-assigned well-known
port for 'netconf-ch-ssh' (4334) if no value
is specified.";
}
uses ss:ssh-server-grouping;
}
}
case tls {
if-feature tls-call-home;
container tls {
description
"Specifies TLS-specific call-home transport
configuration.";
leaf address {
type inet:host;
mandatory true;
description
"The IP address or hostname of the endpoint.
If a domain name is configured, then the DNS
resolution should happen on each usage attempt.
If the the DNS resolution results in multiple
IP addresses, the IP addresses will be tried
according to local preference order until a
connection has been established or until all
IP addresses have failed.";
}
leaf port {
type inet:port-number;
default 4335;
description
"The IP port for this endpoint. The NETCONF
server will use the IANA-assigned well-known
port for 'netconf-ch-tls' (4335) if no value
is specified.";
}
uses ts:tls-server-grouping {
refine "client-auth" {
must 'pinned-ca-certs or pinned-client-certs';
description
"NETCONF/TLS servers MUST validate client
certiticates.";
}
augment "client-auth" {
description
"Augments in the cert-to-name structure.";
container cert-maps {
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by a
TLS-based NETCONF server to map the NETCONF
client's presented X.509 certificate to a
NETCONF username. If no matching and valid
cert-to-name list entry can be found, then
the NETCONF server MUST close the connection,
and MUST NOT accept NETCONF messages over
it.";
reference
"RFC WWWW: NETCONF over TLS, Section 7";
}
}
}
}
} // end tls
} // end choice
} // end endpoint
}
container connection-type {
description
"Indicates the kind of connection to use.";
choice connection-type {
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence true;
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
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";
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 will be sent
to test the aliveness of the SSH/TLS client.";
}
leaf max-attempts {
type uint8;
default 3;
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 true;
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.";
leaf idle-timeout {
type uint16;
units "seconds";
default 300; // five minutes
description
"Specifies the maximum number of seconds that a
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).";
}
}
}
}
}
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
reboot. The NETCONF server starts with the specified
endpoint and tries to connect to it max-attempts times
before trying the next endpoint in the list (round
robin).";
leaf start-with {
type enumeration {
enum first-listed {
description
"Indicates that reconnections should start with
the first endpoint listed.";
}
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.";
}
}
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";
}
default 3;
description
"Specifies the number times the NETCONF server tries to
connect to a specific endpoint before moving on to the
next endpoint in the list (round robin).";
}
}
}
}
}
}
<CODE ENDS> <CODE ENDS>
4. Design Considerations 5. Design Considerations
Editorial: this section is a hold over from before, previously called Editorial: this section is a hold over from before, previously called
"Objectives". It was only written two support the "server" (not the "Objectives". It was only written two support the "server" (not the
"client"). The question is if it's better to add the missing "client"). The question is if it's better to add the missing
"client" parts, or remove this section altogether. "client" parts, or remove this section altogether.
The primary purpose of the YANG modules defined herein is to enable The primary purpose of the YANG modules defined herein is to enable
the configuration of the NETCONF client and servers. This scope the configuration of the NETCONF client and servers. This scope
includes the following objectives: includes the following objectives:
4.1. Support all NETCONF transports 5.1. Support all NETCONF transports
The YANG module should support all current NETCONF transports, namely The YANG module should support all current NETCONF transports, namely
NETCONF over SSH [RFC6242], NETCONF over TLS [RFC7589], and to be NETCONF over SSH [RFC6242], NETCONF over TLS [RFC7589], and to be
extensible to support future transports as necessary. extensible to support future transports as necessary.
Because implementations may not support all transports, the modules Because implementations may not support all transports, the modules
should use YANG "feature" statements so that implementations can should use YANG "feature" statements so that implementations can
accurately advertise which transports are supported. accurately advertise which transports are supported.
4.2. Enable each transport to select which keys to use 5.2. Enable each transport to select which keys to use
Servers may have a multiplicity of host-keys or server-certificates Servers may have a multiplicity of host-keys or server-certificates
from which subsets may be selected for specific uses. For instance, from which subsets may be selected for specific uses. For instance,
a NETCONF server may want to use one set of SSH host-keys when a NETCONF server may want to use one set of SSH host-keys when
listening on port 830, and a different set of SSH host-keys when listening on port 830, and a different set of SSH host-keys when
calling home. The data models provided herein should enable calling home. The data models provided herein should enable
configuration of which keys to use on a per-use basis. configuration of which keys to use on a per-use basis.
4.3. Support authenticating NETCONF clients certificates 5.3. Support authenticating NETCONF clients certificates
When a certificate is used to authenticate a NETCONF client, there is When a certificate is used to authenticate a NETCONF client, there is
a need to configure the server to know how to authenticate the a need to configure the server to know how to authenticate the
certificates. The server should be able to authenticate the client's certificates. The server should be able to authenticate the client's
certificate either by using path-validation to a configured trust certificate either by using path-validation to a configured trust
anchor or by matching the client-certificate to one previously anchor or by matching the client-certificate to one previously
configured. configured.
4.4. Support mapping authenticated NETCONF client certificates to 5.4. Support mapping authenticated NETCONF client certificates to
usernames usernames
When a client certificate is used for TLS client authentication, the When a client certificate is used for TLS client authentication, the
NETCONF server must be able to derive a username from the NETCONF server must be able to derive a username from the
authenticated certificate. Thus the modules defined herein should authenticated certificate. Thus the modules defined herein should
enable this mapping to be configured. enable this mapping to be configured.
4.5. Support both listening for connections and call home 5.5. Support both listening for connections and call home
The NETCONF protocols were originally defined as having the server The NETCONF protocols were originally defined as having the server
opening a port to listen for client connections. More recently the opening a port to listen for client connections. More recently the
NETCONF working group defined support for call-home ([RFC8071]), NETCONF working group defined support for call-home ([RFC8071]),
enabling the server to initiate the connection to the client. Thus enabling the server to initiate the connection to the client. Thus
the modules defined herein should enable configuration for both the modules defined herein should enable configuration for both
listening for connections and calling home. Because implementations listening for connections and calling home. Because implementations
may not support both listening for connections and calling home, YANG may not support both listening for connections and calling home, YANG
"feature" statements should be used so that implementation can "feature" statements should be used so that implementation can
accurately advertise the connection types it supports. accurately advertise the connection types it supports.
4.6. For Call Home connections 5.6. For Call Home connections
The following objectives only pertain to call home connections. The following objectives only pertain to call home connections.
4.6.1. Support more than one NETCONF client 5.6.1. Support more than one NETCONF client
A NETCONF server may be managed by more than one NETCONF client. For A NETCONF server may be managed by more than one NETCONF client. For
instance, a deployment may have one client for provisioning and instance, a deployment may have one client for provisioning and
another for fault monitoring. Therefore, when it is desired for a another for fault monitoring. Therefore, when it is desired for a
server to initiate call home connections, it should be able to do so server to initiate call home connections, it should be able to do so
to more than one client. to more than one client.
4.6.2. Support NETCONF clients having more than one endpoint 5.6.2. Support NETCONF clients having more than one endpoint
A NETCONF client managing a NETCONF server may implement a high- A NETCONF client managing a NETCONF server may implement a high-
availability strategy employing a multiplicity of active and/or availability strategy employing a multiplicity of active and/or
passive endpoint. Therefore, when it is desired for a server to passive endpoint. Therefore, when it is desired for a server to
initiate call home connections, it should be able to connect to any initiate call home connections, it should be able to connect to any
of the client's endpoints. of the client's endpoints.
4.6.3. Support a reconnection strategy 5.6.3. Support a reconnection strategy
Assuming a NETCONF client has more than one endpoint, then it becomes Assuming a NETCONF client has more than one endpoint, then it becomes
necessary to configure how a NETCONF server should reconnect to the necessary to configure how a NETCONF server should reconnect to the
client should it lose its connection to one the client's endpoints. client should it lose its connection to one the client's endpoints.
For instance, the NETCONF server may start with first endpoint For instance, the NETCONF server may start with first endpoint
defined in a user-ordered list of endpoints or with the last defined in a user-ordered list of endpoints or with the last
endpoints it was connected to. endpoints it was connected to.
4.6.4. Support both persistent and periodic connections 5.6.4. Support both persistent and periodic connections
NETCONF clients may vary greatly on how frequently they need to NETCONF clients may vary greatly on how frequently they need to
interact with a NETCONF server, how responsive interactions need to interact with a NETCONF server, how responsive interactions need to
be, and how many simultaneous connections they can support. Some be, and how many simultaneous connections they can support. Some
clients may need a persistent connection to servers to optimize real- clients may need a persistent connection to servers to optimize real-
time interactions, while others prefer periodic interactions in order time interactions, while others prefer periodic interactions in order
to minimize resource requirements. Therefore, when it is necessary to minimize resource requirements. Therefore, when it is necessary
for server to initiate connections, it should be configurable if the for server to initiate connections, it should be configurable if the
connection is persistent or periodic. connection is persistent or periodic.
4.6.5. Reconnection strategy for periodic connections 5.6.5. Reconnection strategy for periodic connections
The reconnection strategy should apply to both persistent and The reconnection strategy should apply to both persistent and
periodic connections. How it applies to periodic connections becomes periodic connections. How it applies to periodic connections becomes
clear when considering that a periodic "connection" is a logical clear when considering that a periodic "connection" is a logical
connection to a single server. That is, the periods of connection to a single server. That is, the periods of
unconnectedness are intentional as opposed to due to external unconnectedness are intentional as opposed to due to external
reasons. A periodic "connection" should always reconnect to the same reasons. A periodic "connection" should always reconnect to the same
server until it is no longer able to, at which time the reconnection server until it is no longer able to, at which time the reconnection
strategy guides how to connect to another server. strategy guides how to connect to another server.
4.6.6. Keep-alives for persistent connections 5.6.6. Keep-alives for persistent connections
If a persistent connection is desired, it is the responsibility of If a persistent connection is desired, it is the responsibility of
the connection initiator to actively test the "aliveness" of the the connection initiator to actively test the "aliveness" of the
connection. The connection initiator must immediately work to connection. The connection initiator must immediately work to
reestablish a persistent connection as soon as the connection is reestablish a persistent connection as soon as the connection is
lost. How often the connection should be tested is driven by NETCONF lost. How often the connection should be tested is driven by NETCONF
client requirements, and therefore keep-alive settings should be client requirements, and therefore keep-alive settings should be
configurable on a per-client basis. configurable on a per-client basis.
4.6.7. Customizations for periodic connections 5.6.7. Customizations for periodic connections
If a periodic connection is desired, it is necessary for the NETCONF If a periodic connection is desired, it is necessary for the NETCONF
server to know how often it should connect. This frequency server to know how often it should connect. This frequency
determines the maximum amount of time a NETCONF client may have to determines the maximum amount of time a NETCONF client may have to
wait to send data to a server. A server may connect to a client wait to send data to a server. A server may connect to a client
before this interval expires if desired (e.g., to send data to a before this interval expires if desired (e.g., to send data to a
client). client).
5. Security Considerations 6. Security Considerations
A denial of service (DoS) attack MAY occur if the NETCONF server
limits the maximum number of NETCONF sessions it will accept (i.e.
the 'max-sessions' field in the ietf-netconf-server module is not
zero) and either the "hello-timeout" or "idle-timeout" fields in
ietf-netconf-server module have been set to indicate the NETCONF
server should wait forever (i.e. set to zero).
The YANG module defined in this document uses groupings defined in The YANG module defined in this document uses groupings defined in
[I-D.ietf-netconf-ssh-client-server] and [I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-tls-client-server]. Please see the Security [I-D.ietf-netconf-tls-client-server]. Please see the Security
Considerations section in those documents for concerns related those Considerations section in those documents for concerns related those
groupings. groupings.
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-
skipping to change at page 41, line 19 skipping to change at page 47, line 43
all available protocol operations and content. all available protocol operations and content.
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config) in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative to these data nodes without proper protection can have a negative
effect on network operations. These are the subtrees and data nodes effect on network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability: and their sensitivity/vulnerability:
NONE /: The entire data trees defined by the modules defined in this
draft are sensitive to write operations. For instance, the
addition or removal of references to keys, certificates,
trusted anchors, etc., can dramatically alter the implemented
security policy. However, no NACM annotations are applied as
the data SHOULD be editable by users other than a designated
'recovery session'.
Some of the readable data nodes in this YANG module may be considered Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability: nodes and their sensitivity/vulnerability:
NONE NONE
Some of the RPC operations in this YANG module may be considered Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the important to control access to these operations. These are the
operations and their sensitivity/vulnerability: operations and their sensitivity/vulnerability:
NONE NONE
6. IANA Considerations 7. IANA Considerations
6.1. The IETF XML Registry 7.1. The IETF XML Registry
This document registers two URIs in the IETF XML registry [RFC3688]. This document registers two URIs in the IETF XML registry [RFC3688].
Following the format in [RFC3688], the following registrations are Following the format in [RFC3688], the following registrations are
requested: requested:
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-client URI: urn:ietf:params:xml:ns:yang:ietf-netconf-client
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-server URI: urn:ietf:params:xml:ns:yang:ietf-netconf-server
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
6.2. The YANG Module Names Registry 7.2. The YANG Module Names Registry
This document registers two YANG modules in the YANG Module Names This document registers two YANG modules in the YANG Module Names
registry [RFC7950]. Following the format in [RFC7950], the the registry [RFC7950]. Following the format in [RFC7950], the the
following registrations are requested: following registrations are requested:
name: ietf-netconf-client name: ietf-netconf-client
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-client namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-client
prefix: ncc prefix: ncc
reference: RFC XXXX reference: RFC XXXX
name: ietf-netconf-server name: ietf-netconf-server
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server
prefix: ncs prefix: ncs
reference: RFC XXXX reference: RFC XXXX
7. Acknowledgements 8. Acknowledgements
The authors would like to thank for following for lively discussions The authors would like to thank for following for lively discussions
on list and in the halls (ordered by last name): Andy Bierman, Martin on list and in the halls (ordered by last name): Andy Bierman, Martin
Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David
Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch, Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch,
Phil Shafer, Sean Turner, and Bert Wijnen. Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen.
Juergen Schoenwaelder and was partly funded by Flamingo, a Network of
Excellence project (ICT-318488) supported by the European Commission
under its Seventh Framework Programme.
8. References 9. References
8.1. Normative References 9.1. Normative References
[I-D.ietf-netconf-keystore] [I-D.ietf-netconf-keystore]
Watsen, K., "Keystore Model", draft-ietf-netconf- Watsen, K., "Keystore Model", draft-ietf-netconf-
keystore-02 (work in progress), June 2017. keystore-02 (work in progress), June 2017.
[I-D.ietf-netconf-ssh-client-server] [I-D.ietf-netconf-ssh-client-server]
Watsen, K. and G. Wu, "SSH Client and Server Models", Watsen, K. and G. Wu, "SSH Client and Server Models",
draft-ietf-netconf-ssh-client-server-03 (work in draft-ietf-netconf-ssh-client-server-03 (work in
progress), June 2017. progress), June 2017.
[I-D.ietf-netconf-tls-client-server] [I-D.ietf-netconf-tls-client-server]
Watsen, K. and G. Wu, "TLS Client and Server Models", Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and
draft-ietf-netconf-tls-client-server-03 (work in TLS Servers", draft-ietf-netconf-tls-client-server-04
progress), June 2017. (work in progress), October 2017.
[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,
<http://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[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,
<http://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<http://www.rfc-editor.org/info/rfc6242>. <https://www.rfc-editor.org/info/rfc6242>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013, RFC 6991, DOI 10.17487/RFC6991, July 2013,
<http://www.rfc-editor.org/info/rfc6991>. <https://www.rfc-editor.org/info/rfc6991>.
[RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for [RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for
SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407, SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407,
December 2014, <http://www.rfc-editor.org/info/rfc7407>. December 2014, <https://www.rfc-editor.org/info/rfc7407>.
[RFC7589] Badra, M., Luchuk, A., and J. Schoenwaelder, "Using the [RFC7589] Badra, M., Luchuk, A., and J. Schoenwaelder, "Using the
NETCONF Protocol over Transport Layer Security (TLS) with NETCONF Protocol over Transport Layer Security (TLS) with
Mutual X.509 Authentication", RFC 7589, Mutual X.509 Authentication", RFC 7589,
DOI 10.17487/RFC7589, June 2015, DOI 10.17487/RFC7589, June 2015,
<http://www.rfc-editor.org/info/rfc7589>. <https://www.rfc-editor.org/info/rfc7589>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<http://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <http://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
8.2. Informative References 9.2. Informative References
[I-D.ietf-netmod-yang-tree-diagrams]
Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft-
ietf-netmod-yang-tree-diagrams-02 (work in progress),
October 2017.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<http://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC4252] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH)
Authentication Protocol", RFC 4252, DOI 10.17487/RFC4252,
January 2006, <http://www.rfc-editor.org/info/rfc4252>.
[RFC4253] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH)
Transport Layer Protocol", RFC 4253, DOI 10.17487/RFC4253,
January 2006, <http://www.rfc-editor.org/info/rfc4253>.
[RFC4254] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH)
Connection Protocol", RFC 4254, DOI 10.17487/RFC4254,
January 2006, <http://www.rfc-editor.org/info/rfc4254>.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246,
DOI 10.17487/RFC5246, August 2008,
<http://www.rfc-editor.org/info/rfc5246>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012, DOI 10.17487/RFC6536, March 2012,
<http://www.rfc-editor.org/info/rfc6536>. <https://www.rfc-editor.org/info/rfc6536>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<http://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
[RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home",
RFC 8071, DOI 10.17487/RFC8071, February 2017, RFC 8071, DOI 10.17487/RFC8071, February 2017,
<http://www.rfc-editor.org/info/rfc8071>. <https://www.rfc-editor.org/info/rfc8071>.
Appendix A. Change Log Appendix A. Change Log
A.1. server-model-09 to 00 A.1. 00 to 01
o This draft was split out from draft-ietf-netconf-server-model-09.
o Added in previously missing ietf-netconf-client module.
o Added in new features 'listen' and 'call-home' so future
transports can be augmented in.
A.2. 00 to 01
o Renamed "keychain" to "keystore". o Renamed "keychain" to "keystore".
A.3. 01 to 02 A.2. 01 to 02
o Added to ietf-netconf-client ability to connected to a cluster of o Added to ietf-netconf-client ability to connected to a cluster of
endpoints, including a reconnection-strategy. endpoints, including a reconnection-strategy.
o Added to ietf-netconf-client the ability to configure connection- o Added to ietf-netconf-client the ability to configure connection-
type and also keep-alive strategy. type and also keep-alive strategy.
o Updated both modules to accomodate new groupings in the ssh/tls o Updated both modules to accomodate new groupings in the ssh/tls
drafts. drafts.
A.4. 02 to 03 A.3. 02 to 03
o Refined use of tls-client-grouping to add a must statement o Refined use of tls-client-grouping to add a must statement
indicating that the TLS client must specify a client-certificate. indicating that the TLS client must specify a client-certificate.
o Changed 'netconf-client' to be a grouping (not a container). o Changed 'netconf-client' to be a grouping (not a container).
A.5. 03 to 04 A.4. 03 to 04
o Added RFC 8174 to Requirements Language Section. o Added RFC 8174 to Requirements Language Section.
o Replaced refine statement in ietf-netconf-client to add a o Replaced refine statement in ietf-netconf-client to add a
mandatory true. mandatory true.
o Added refine statement in ietf-netconf-server to add a must o Added refine statement in ietf-netconf-server to add a must
statement. statement.
o Now there are containers and groupings, for both the client and o Now there are containers and groupings, for both the client and
server models. server models.
o Now tree diagrams reference ietf-netmod-yang-tree-diagrams
o Updated examples to inline key and certificates (no longer a
leafref to keystore)
Authors' Addresses Authors' Addresses
Kent Watsen Kent Watsen
Juniper Networks Juniper Networks
EMail: kwatsen@juniper.net EMail: kwatsen@juniper.net
Gary Wu Gary Wu
Cisco Networks Cisco Networks
EMail: garywu@cisco.com EMail: garywu@cisco.com
Juergen Schoenwaelder
Jacobs University Bremen
EMail: j.schoenwaelder@jacobs-university.de
 End of changes. 178 change blocks. 
1523 lines changed or deleted 1869 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/