draft-ietf-netconf-netconf-client-server-10.txt   draft-ietf-netconf-netconf-client-server-11.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Watsen Networks Internet-Draft Watsen Networks
Intended status: Standards Track March 9, 2019 Intended status: Standards Track April 7, 2019
Expires: September 10, 2019 Expires: October 9, 2019
NETCONF Client and Server Models NETCONF Client and Server Models
draft-ietf-netconf-netconf-client-server-10 draft-ietf-netconf-netconf-client-server-11
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 1, line 32 skipping to change at page 1, line 32
summarizes all of the substitutions that are needed. No other RFC summarizes all of the substitutions that are needed. No other RFC
Editor instructions are specified elsewhere in this document. Editor instructions are specified elsewhere in this document.
This document contains references to other drafts in progress, both This document contains references to other drafts in progress, both
in the Normative References section, as well as in body text in the Normative References section, as well as in body text
throughout. Please update the following references to reflect their throughout. Please update the following references to reflect their
final RFC assignments: final RFC assignments:
o I-D.ietf-netconf-keystore o I-D.ietf-netconf-keystore
o I-D.ietf-netconf-tcp-client-server
o I-D.ietf-netconf-ssh-client-server o I-D.ietf-netconf-ssh-client-server
o I-D.ietf-netconf-tls-client-server o I-D.ietf-netconf-tls-client-server
Artwork in this document contains shorthand references to drafts in Artwork in this document contains shorthand references to drafts in
progress. Please apply the following replacements: progress. Please apply the following replacements:
o "XXXX" --> the assigned RFC value for this draft o "XXXX" --> the assigned RFC value for this draft
o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-ssh-client- o "AAAA" --> the assigned RFC value for I-D.ietf-netconf-tcp-client-
server server
o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-tls-client- o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-ssh-client-
server server
o "AAAA" --> the assigned RFC value for I-D.ietf-netconf-tcp-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 "2019-03-09" --> the publication date of this draft o "2019-04-07" --> 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 B. 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 https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 10, 2019. This Internet-Draft will expire on October 9, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 3, line 11 skipping to change at page 3, line 11
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 . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4 3. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 13 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 5
3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 16 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 8
4. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 25 4. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 18
4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 25 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 18
4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 34 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 19
4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 39 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 25
5. Design Considerations . . . . . . . . . . . . . . . . . . . . 49 5. Design Considerations . . . . . . . . . . . . . . . . . . . . 36
5.1. Support all NETCONF transports . . . . . . . . . . . . . 50 5.1. Support all NETCONF transports . . . . . . . . . . . . . 36
5.2. Enable each transport to select which keys to use . . . . 50 5.2. Enable each transport to select which keys to use . . . . 36
5.3. Support authenticating NETCONF clients certificates . . . 50 5.3. Support authenticating NETCONF clients certificates . . . 36
5.4. Support mapping authenticated NETCONF client certificates 5.4. Support mapping authenticated NETCONF client certificates
to usernames . . . . . . . . . . . . . . . . . . . . . . 50 to usernames . . . . . . . . . . . . . . . . . . . . . . 36
5.5. Support both listening for connections and call home . . 50 5.5. Support both listening for connections and call home . . 37
5.6. For Call Home connections . . . . . . . . . . . . . . . . 51 5.6. For Call Home connections . . . . . . . . . . . . . . . . 37
5.6.1. Support more than one NETCONF client . . . . . . . . 51 5.6.1. Support more than one NETCONF client . . . . . . . . 37
5.6.2. Support NETCONF clients having more than one endpoint 51 5.6.2. Support NETCONF clients having more than one endpoint 37
5.6.3. Support a reconnection strategy . . . . . . . . . . . 51 5.6.3. Support a reconnection strategy . . . . . . . . . . . 37
5.6.4. Support both persistent and periodic connections . . 51 5.6.4. Support both persistent and periodic connections . . 38
5.6.5. Reconnection strategy for periodic connections . . . 51 5.6.5. Reconnection strategy for periodic connections . . . 38
5.6.6. Keep-alives for persistent connections . . . . . . . 52 5.6.6. Keep-alives for persistent connections . . . . . . . 38
5.6.7. Customizations for periodic connections . . . . . . . 52 5.6.7. Customizations for periodic connections . . . . . . . 38
6. Security Considerations . . . . . . . . . . . . . . . . . . . 52 6. Security Considerations . . . . . . . . . . . . . . . . . . . 38
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 53 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 39
7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 53 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 39
7.2. The YANG Module Names Registry . . . . . . . . . . . . . 53 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 40
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 54 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 40
8.1. Normative References . . . . . . . . . . . . . . . . . . 54 8.1. Normative References . . . . . . . . . . . . . . . . . . 40
8.2. Informative References . . . . . . . . . . . . . . . . . 55 8.2. Informative References . . . . . . . . . . . . . . . . . 41
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 56 Appendix A. Expanded Tree Diagrams . . . . . . . . . . . . . . . 43
A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 56 A.1. Expanded Tree Diagram for 'ietf-netconf-client' . . . . . 43
A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 56 A.2. Expanded Tree Diagram for 'ietf-netconf-server' . . . . . 52
A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 56 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 61
A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 56 B.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 61
A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 56 B.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 61
A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 57 B.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 62
A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 57 B.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 62
A.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 57 B.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 62
Appendix B. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . 57 B.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 62
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 57 B.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 62
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 58 B.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 63
B.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 63
B.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 63
B.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 63
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 63
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 64
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 [RFC6241] client and the other module to configure a NETCONF [RFC6241] client and the other module to
configure a NETCONF server. Both modules support both NETCONF over configure a NETCONF server. Both modules support both NETCONF over
SSH [RFC6242] and NETCONF over TLS [RFC7589] and NETCONF Call Home SSH [RFC6242] and NETCONF over TLS [RFC7589] and NETCONF Call Home
connections [RFC8071]. connections [RFC8071].
2. Terminology 2. Terminology
skipping to change at page 4, line 25 skipping to change at page 4, line 28
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.
3. The NETCONF Client Model 3. 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, using either the
SSH and TLS transport protocols.
This model supports both the SSH and TLS transport protocols, using
the SSH client and TLS client groupings defined in
[I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-tls-client-server] respectively.
All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to YANG feature statements are used to enable implementations to
advertise which parts of the model the NETCONF client supports. advertise which potentially uncommon parts of the model the NETCONF
client supports.
3.1. Tree Diagram 3.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-netconf-client" module. Just the container is model for the "ietf-netconf-client" module.
displayed below, but there is also a reusable grouping called
"netconf-client-grouping" that the container is using.
========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) =========== This tree diagram only shows the nodes defined in this module; it
does show the nodes defined by "grouping" statements used by this
module.
Please see Appendix A.1 for a tree diagram that illustrates what the
module looks like with all the "grouping" statements expanded.
module: ietf-netconf-client module: ietf-netconf-client
+--rw netconf-client +--rw netconf-client
+--rw initiate! {initiate}? +---u netconf-client-grouping
| +--rw netconf-server* [name]
| +--rw name string
| +--rw endpoints
| | +--rw endpoint* [name]
| | +--rw name string
| | +--rw (transport)
| | +--:(ssh) {ssh-initiate}?
| | | +--rw ssh
| | | +--rw remote-address inet:host
| | | +--rw remote-port?
| | | | inet:port-number
| | | +--rw local-address? inet:ip-addr\
\ess
| | | +--rw local-port?
| | | | inet:port-number
| | | +--rw tcp-keepalives {tcp-client-keepalive\
\s}?
| | | | +--rw idle-time? uint16
| | | | +--rw max-probes? uint16
| | | | +--rw probe-interval? uint16
| | | +--rw ssh-client-identity
| | | | +--rw username? string
| | | | +--rw (auth-type)
| | | | +--:(password)
| | | | | +--rw password? string
| | | | +--:(public-key)
| | | | | +--rw public-key
| | | | | +--rw (local-or-keystore)
| | | | | +--:(local)
| | | | | | {local-keys-suppor\
\ted}?
| | | | | | +--rw local-definition
| | | | | | +--rw algorithm?
| | | | | | | asymmetric-ke\
\y-algorithm-ref
| | | | | | +--rw public-key?
| | | | | | | binary
| | | | | | +--rw private-key?
| | | | | | | union
| | | | | | +---x generate-hidden\
\-key
| | | | | | | +---w input
| | | | | | | +---w algorithm
| | | | | | | asymmet\
\ric-key-algorithm-ref
| | | | | | +---x install-hidden-\
\key
| | | | | | +---w input
| | | | | | +---w algorithm
| | | | | | | asymmet\
\ric-key-algorithm-ref
| | | | | | +---w public-ke\
\y?
| | | | | | | binary
| | | | | | +---w private-k\
\ey?
| | | | | | binary
| | | | | +--:(keystore)
| | | | | {keystore-supporte\
\d}?
| | | | | +--rw keystore-reference?
| | | | | ks:asymmetric-ke\
\y-ref
| | | | +--:(certificate)
| | | | +--rw certificate
| | | | {sshcmn:ssh-x509-certs}?
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-suppor\
\ted}?
| | | | | +--rw local-definition
| | | | | +--rw algorithm?
| | | | | | asymmetric-ke\
\y-algorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
| | | | | +---x generate-hidden\
\-key
| | | | | | +---w input
| | | | | | +---w algorithm
| | | | | | asymmet\
\ric-key-algorithm-ref
| | | | | +---x install-hidden-\
\key
| | | | | | +---w input
| | | | | | +---w algorithm
| | | | | | | asymmet\
\ric-key-algorithm-ref
| | | | | | +---w public-ke\
\y?
| | | | | | | binary
| | | | | | +---w private-k\
\ey?
| | | | | | binary
| | | | | +--rw cert?
| | | | | | end-entity-ce\
\rt-cms
| | | | | +---n certificate-exp\
\iration
| | | | | +-- expiration-date
| | | | | yang:date-\
\and-time
| | | | +--:(keystore)
| | | | {keystore-supporte\
\d}?
| | | | +--rw keystore-reference?
| | | | ks:asymmetric-ke\
\y-certificate-ref
| | | +--rw ssh-server-auth
| | | | +--rw pinned-ssh-host-keys?
| | | | | ta:pinned-host-keys-ref
| | | | | {ta:ssh-host-keys}?
| | | | +--rw pinned-ca-certs?
| | | | | ta:pinned-certificates-ref
| | | | | {sshcmn:ssh-x509-certs,ta:x509-\
\certificates}?
| | | | +--rw pinned-server-certs?
| | | | ta:pinned-certificates-ref
| | | | {sshcmn:ssh-x509-certs,ta:x509-\
\certificates}?
| | | +--rw ssh-transport-params
| | | | {ssh-client-transport-params-confi\
\g}?
| | | | +--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 ssh-keepalives {ssh-client-keepalive\
\s}?
| | | +--rw max-wait? uint16
| | | +--rw max-attempts? uint8
| | +--:(tls) {tls-initiate}?
| | +--rw tls
| | +--rw remote-address inet:host
| | +--rw remote-port? inet:port-num\
\ber
| | +--rw local-address? inet:ip-addre\
\ss
| | +--rw local-port? inet:port-num\
\ber
| | +--rw tcp-keepalives {tcp-client-keepalive\
\s}?
| | | +--rw idle-time? uint16
| | | +--rw max-probes? uint16
| | | +--rw probe-interval? uint16
| | +--rw tls-client-identity
| | | +--rw (auth-type)
| | | +--:(certificate)
| | | +--rw certificate
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-suppor\
\ted}?
| | | | +--rw local-definition
| | | | +--rw algorithm?
| | | | | asymmetric-ke\
\y-algorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hidden\
\-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | asymmet\
\ric-key-algorithm-ref
| | | | +---x install-hidden-\
\key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | asymmet\
\ric-key-algorithm-ref
| | | | | +---w public-ke\
\y?
| | | | | | binary
| | | | | +---w private-k\
\ey?
| | | | | binary
| | | | +--rw cert?
| | | | | end-entity-ce\
\rt-cms
| | | | +---n certificate-exp\
\iration
| | | | +-- expiration-date
| | | | yang:date-\
\and-time
| | | +--:(keystore)
| | | {keystore-supporte\
\d}? grouping netconf-client-grouping
| | | +--rw keystore-reference? +-- initiate! {initiate}?
| | | ks:asymmetric-ke\ | +-- netconf-server* [name]
\y-certificate-ref | +-- name? string
| | +--rw tls-server-auth | +-- endpoints
| | | +--rw pinned-ca-certs? | | +-- endpoint* [name]
| | | | ta:pinned-certificates-ref | | +-- name? string
| | | | {ta:x509-certificates}? | | +-- (transport)
| | | +--rw pinned-server-certs? | | +--:(ssh) {ssh-initiate}?
| | | ta:pinned-certificates-ref | | | +-- ssh
| | | {ta:x509-certificates}? | | | +---u netconf-client-grouping
| | +--rw tls-hello-params | | +--:(tls) {tls-initiate}?
| | | {tls-client-hello-params-config}? | | +-- tls
| | | +--rw tls-versions | | +---u netconf-client-grouping
| | | | +--rw tls-version* identityref | +-- connection-type
| | | +--rw cipher-suites | | +-- (connection-type)
| | | +--rw cipher-suite* identityref | | +--:(persistent-connection)
| | +--rw tls-keepalives {tls-client-keepalive\ | | | +-- persistent!
\s}? | | +--:(periodic-connection)
| | +--rw max-wait? uint16 | | +-- periodic!
| | +--rw max-attempts? uint8 | | +-- period? uint16
| +--rw connection-type | | +-- anchor-time? yang:date-and-time
| | +--rw (connection-type) | | +-- idle-timeout? uint16
| | +--:(persistent-connection) | +-- reconnect-strategy
| | | +--rw persistent! | +-- start-with? enumeration
| | +--:(periodic-connection) | +-- max-attempts? uint8
| | +--rw periodic! +-- listen! {listen}?
| | +--rw period? uint16 +-- idle-timeout? uint16
| | +--rw anchor-time? yang:date-and-time +-- endpoint* [name]
| | +--rw idle-timeout? uint16 +-- name? string
| +--rw reconnect-strategy +-- (transport)
| +--rw start-with? enumeration +--:(ssh) {ssh-listen}?
| +--rw max-attempts? uint8 | +-- ssh
+--rw listen! {listen}? | +---u netconf-client-grouping
+--rw idle-timeout? uint16 +--:(tls) {tls-listen}?
+--rw endpoint* [name] +-- tls
+--rw name string +---u netconf-client-grouping
+--rw (transport)
+--:(ssh) {ssh-listen}?
| +--rw ssh
| +--rw local-address inet:ip-address
| +--rw local-port? inet:port-number
| +--rw tcp-keepalives {tcp-server-keepalives}?
| | +--rw idle-time? uint16
| | +--rw max-probes? uint16
| | +--rw probe-interval? uint16
| +--rw ssh-client-identity
| | +--rw username? string
| | +--rw (auth-type)
| | +--:(password)
| | | +--rw password? string
| | +--:(public-key)
| | | +--rw public-key
| | | +--rw (local-or-keystore)
| | | +--:(local) {local-keys-supported\
\}?
| | | | +--rw local-definition
| | | | +--rw algorithm?
| | | | | asymmetric-key-algo\
\rithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | asymmetric-ke\
\y-algorithm-ref
| | | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric-ke\
\y-algorithm-ref
| | | | +---w public-key?
| | | | | binary
| | | | +---w private-key?
| | | | binary
| | | +--:(keystore) {keystore-supporte\
\d}?
| | | +--rw keystore-reference?
| | | ks:asymmetric-key-ref
| | +--:(certificate)
| | +--rw certificate {sshcmn:ssh-x509-cert\
\s}?
| | +--rw (local-or-keystore)
| | +--:(local) {local-keys-supported\
\}?
| | | +--rw local-definition
| | | +--rw algorithm?
| | | | asymmetric-key-algo\
\rithm-ref
| | | +--rw public-key?
| | | | binary
| | | +--rw private-key?
| | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | asymmetric-ke\
\y-algorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric-ke\
\y-algorithm-ref
| | | | +---w public-key?
| | | | | binary
| | | | +---w private-key?
| | | | binary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
| | | yang:date-and-ti\
\me
| | +--:(keystore) {keystore-supporte\
\d}?
| | +--rw keystore-reference?
| | ks:asymmetric-key-cert\
\ificate-ref
| +--rw ssh-server-auth
| | +--rw pinned-ssh-host-keys?
| | | ta:pinned-host-keys-ref
| | | {ta:ssh-host-keys}?
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {sshcmn:ssh-x509-certs,ta:x509-certif\
\icates}?
| | +--rw pinned-server-certs?
| | ta:pinned-certificates-ref
| | {sshcmn:ssh-x509-certs,ta:x509-certif\
\icates}?
| +--rw ssh-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 ssh-keepalives {ssh-client-keepalives}?
| +--rw max-wait? uint16
| +--rw max-attempts? uint8
+--:(tls) {tls-listen}?
+--rw tls
+--rw local-address inet:ip-address
+--rw local-port? inet:port-number
+--rw tcp-keepalives {tcp-server-keepalives}?
| +--rw idle-time? uint16
| +--rw max-probes? uint16
| +--rw probe-interval? uint16
+--rw tls-client-identity
| +--rw (auth-type)
| +--:(certificate)
| +--rw certificate
| +--rw (local-or-keystore)
| +--:(local) {local-keys-supported\
\}?
| | +--rw local-definition
| | +--rw algorithm?
| | | asymmetric-key-algo\
\rithm-ref
| | +--rw public-key?
| | | binary
| | +--rw private-key?
| | | union
| | +---x generate-hidden-key
| | | +---w input
| | | +---w algorithm
| | | asymmetric-ke\
\y-algorithm-ref
| | +---x install-hidden-key
| | | +---w input
| | | +---w algorithm
| | | | asymmetric-ke\
\y-algorithm-ref
| | | +---w public-key?
| | | | binary
| | | +---w private-key?
| | | binary
| | +--rw cert?
| | | end-entity-cert-cms
| | +---n certificate-expiration
| | +-- expiration-date
| | yang:date-and-ti\
\me
| +--:(keystore) {keystore-supporte\
\d}?
| +--rw keystore-reference?
| ks:asymmetric-key-cert\
\ificate-ref
+--rw tls-server-auth
| +--rw pinned-ca-certs?
| | ta:pinned-certificates-ref
| | {ta:x509-certificates}?
| +--rw pinned-server-certs?
| ta:pinned-certificates-ref
| {ta:x509-certificates}?
+--rw tls-hello-params
| {tls-client-hello-params-config}?
| +--rw tls-versions
| | +--rw tls-version* identityref
| +--rw cipher-suites
| +--rw cipher-suite* identityref
+--rw tls-keepalives {tls-client-keepalives}?
+--rw max-wait? uint16
+--rw max-attempts? uint8
3.2. Example Usage 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 3.2 This example is consistent with the examples presented in Section 3.2
of [I-D.ietf-netconf-keystore]. of [I-D.ietf-netconf-keystore].
========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) =========== =========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) ===========
<netconf-client <netconf-client
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-client"> xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-client">
<!-- NETCONF servers to initiate connections to --> <!-- NETCONF servers to initiate connections to -->
<initiate> <initiate>
<netconf-server> <netconf-server>
<name>corp-fw1</name> <name>corp-fw1</name>
<endpoints> <endpoints>
<endpoint> <endpoint>
<name>corp-fw1.example.com</name> <name>corp-fw1.example.com</name>
<ssh> <ssh>
<remote-address>corp-fw1.example.com</remote-address> <tcp-client-parameters>
<tcp-keepalives> <remote-address>corp-fw1.example.com</remote-address>
<idle-time>15</idle-time> <keepalives>
<max-probes>3</max-probes> <idle-time>15</idle-time>
<probe-interval>30</probe-interval> <max-probes>3</max-probes>
</tcp-keepalives> <probe-interval>30</probe-interval>
<ssh-client-identity> </keepalives>
<username>foobar</username> </tcp-client-parameters>
<public-key> <ssh-client-parameters>
<local-definition> <client-identity>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\ <username>foobar</username>
\etf-crypto-types">ct:rsa2048</algorithm> <public-key>
<private-key>base64encodedvalue==</private-key> <local-definition>
<public-key>base64encodedvalue==</public-key> <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\
</local-definition> :ietf-crypto-types">ct:rsa2048</algorithm>
</public-key> <private-key>base64encodedvalue==</private-key>
</ssh-client-identity> <public-key>base64encodedvalue==</public-key>
<ssh-server-auth> </local-definition>
<pinned-ca-certs>explicitly-trusted-server-ca-certs</p\ </public-key>
\inned-ca-certs> </client-identity>
<pinned-server-certs>explicitly-trusted-server-certs</\ <server-authentication>
\pinned-server-certs> <pinned-ca-certs>explicitly-trusted-server-ca-certs<\
</ssh-server-auth> /pinned-ca-certs>
<ssh-keepalives> <pinned-server-certs>explicitly-trusted-server-certs\
<max-wait>30</max-wait> </pinned-server-certs>
<max-attempts>3</max-attempts> </server-authentication>
</ssh-keepalives> <keepalives>
<max-wait>30</max-wait>
<max-attempts>3</max-attempts>
</keepalives>
</ssh-client-parameters>
</ssh> </ssh>
</endpoint> </endpoint>
<endpoint> <endpoint>
<name>corp-fw2.example.com</name> <name>corp-fw2.example.com</name>
<ssh> <ssh>
<remote-address>corp-fw2.example.com</remote-address> <tcp-client-parameters>
<tcp-keepalives> <remote-address>corp-fw2.example.com</remote-address>
<idle-time>15</idle-time> <keepalives>
<max-probes>3</max-probes> <idle-time>15</idle-time>
<probe-interval>30</probe-interval> <max-probes>3</max-probes>
</tcp-keepalives> <probe-interval>30</probe-interval>
<ssh-client-identity> </keepalives>
<username>foobar</username> </tcp-client-parameters>
<public-key> <ssh-client-parameters>
<local-definition> <client-identity>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\ <username>foobar</username>
\etf-crypto-types">ct:rsa2048</algorithm> <public-key>
<private-key>base64encodedvalue==</private-key> <local-definition>
<public-key>base64encodedvalue==</public-key> <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\
</local-definition> :ietf-crypto-types">ct:rsa2048</algorithm>
</public-key> <private-key>base64encodedvalue==</private-key>
</ssh-client-identity> <public-key>base64encodedvalue==</public-key>
<ssh-server-auth> </local-definition>
<pinned-ca-certs>explicitly-trusted-server-ca-certs</p\ </public-key>
\inned-ca-certs> </client-identity>
<pinned-server-certs>explicitly-trusted-server-certs</\ <server-authentication>
\pinned-server-certs> <pinned-ca-certs>explicitly-trusted-server-ca-certs<\
</ssh-server-auth> /pinned-ca-certs>
<ssh-keepalives> <pinned-server-certs>explicitly-trusted-server-certs\
<max-wait>30</max-wait> </pinned-server-certs>
<max-attempts>3</max-attempts> </server-authentication>
</ssh-keepalives> <keepalives>
<max-wait>30</max-wait>
<max-attempts>3</max-attempts>
</keepalives>
</ssh-client-parameters>
</ssh> </ssh>
</endpoint> </endpoint>
</endpoints> </endpoints>
<connection-type> <connection-type>
<persistent/> <persistent/>
</connection-type> </connection-type>
<reconnect-strategy> <reconnect-strategy>
<start-with>last-connected</start-with> <start-with>last-connected</start-with>
</reconnect-strategy> </reconnect-strategy>
</netconf-server> </netconf-server>
</initiate> </initiate>
<!-- endpoints to listen for NETCONF Call Home connections on --> <!-- endpoints to listen for NETCONF Call Home connections on -->
<listen> <listen>
<endpoint> <endpoint>
<name>Intranet-facing listener</name> <name>Intranet-facing listener</name>
<ssh> <ssh>
<local-address>192.0.2.7</local-address> <tcp-server-parameters>
<ssh-client-identity> <local-address>192.0.2.7</local-address>
<username>foobar</username> </tcp-server-parameters>
<public-key> <ssh-client-parameters>
<local-definition> <client-identity>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-\ <username>foobar</username>
\crypto-types">ct:rsa2048</algorithm> <public-key>
<private-key>base64encodedvalue==</private-key> <local-definition>
<public-key>base64encodedvalue==</public-key> <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\
</local-definition> f-crypto-types">ct:rsa2048</algorithm>
</public-key> <private-key>base64encodedvalue==</private-key>
</ssh-client-identity> <public-key>base64encodedvalue==</public-key>
<ssh-server-auth> </local-definition>
<pinned-ca-certs>explicitly-trusted-server-ca-certs</pinne\ </public-key>
\d-ca-certs> </client-identity>
<pinned-server-certs>explicitly-trusted-server-certs</pinn\ <server-authentication>
\ed-server-certs> <pinned-ca-certs>explicitly-trusted-server-ca-certs</pin\
<pinned-ssh-host-keys>explicitly-trusted-ssh-host-keys</pi\ ned-ca-certs>
\nned-ssh-host-keys> <pinned-server-certs>explicitly-trusted-server-certs</pi\
</ssh-server-auth> nned-server-certs>
<pinned-ssh-host-keys>explicitly-trusted-ssh-host-keys</\
pinned-ssh-host-keys>
</server-authentication>
</ssh-client-parameters>
</ssh> </ssh>
</endpoint> </endpoint>
</listen> </listen>
</netconf-client> </netconf-client>
3.3. YANG Module 3.3. YANG Module
This YANG module has normative references to [RFC6242], [RFC6991], This YANG module has normative references to [RFC6242], [RFC6991],
[RFC7589], [RFC8071], [I-D.kwatsen-netconf-tcp-client-server], [RFC7589], [RFC8071], [I-D.kwatsen-netconf-tcp-client-server],
[I-D.ietf-netconf-ssh-client-server], and [I-D.ietf-netconf-ssh-client-server], and
[I-D.ietf-netconf-tls-client-server]. [I-D.ietf-netconf-tls-client-server].
<CODE BEGINS> file "ietf-netconf-client@2019-03-09.yang" <CODE BEGINS> file "ietf-netconf-client@2019-04-07.yang"
module ietf-netconf-client { module ietf-netconf-client {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client"; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client";
prefix ncc; prefix ncc;
import ietf-yang-types { import ietf-yang-types {
prefix yang; prefix yang;
reference reference
"RFC 6991: Common YANG Data Types"; "RFC 6991: Common YANG Data Types";
} }
skipping to change at page 16, line 37 skipping to change at page 9, line 21
"RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers";
} }
import ietf-tcp-server { import ietf-tcp-server {
prefix tcps; prefix tcps;
reference reference
"RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers";
} }
import ietf-ssh-client { import ietf-ssh-client {
prefix sshc; prefix sshc;
revision-date 2019-03-09; // stable grouping definitions revision-date 2019-04-07; // stable grouping definitions
reference reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers"; "RFC BBBB: YANG Groupings for SSH Clients and SSH Servers";
} }
import ietf-tls-client { import ietf-tls-client {
prefix tlsc; prefix tlsc;
revision-date 2019-03-09; // stable grouping definitions revision-date 2019-04-07; // stable grouping definitions
reference reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers"; "RFC CCCC: YANG Groupings for TLS Clients and TLS Servers";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/> "WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net> Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Gary Wu <mailto:garywu@cisco.com>"; Author: Gary Wu <mailto:garywu@cisco.com>";
description description
"This module contains a collection of YANG definitions for "This module contains a collection of YANG definitions
configuring NETCONF clients. for configuring NETCONF clients.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 [RFC2119]
[RFC8174] when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2019 IETF Trust and the persons identified as Copyright (c) 2019 IETF Trust and the persons identified
authors of the code. All rights reserved. as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with
without modification, is permitted pursuant to, and subject or without modification, is permitted pursuant to, and
to the license terms contained in, the Simplified BSD subject to the license terms contained in, the Simplified
License set forth in Section 4.c of the IETF Trust's BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX
the RFC itself for full legal notices."; (https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.;
revision 2019-03-09 { The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-04-07 {
description description
"Initial version"; "Initial version";
reference reference
"RFC XXXX: NETCONF Client and Server Models"; "RFC XXXX: NETCONF Client and Server Models";
} }
// Features // Features
feature initiate { feature initiate {
description description
skipping to change at page 19, line 46 skipping to change at page 12, line 31
mandatory true; mandatory true;
description description
"Selects between available transports."; "Selects between available transports.";
case ssh { case ssh {
if-feature "ssh-initiate"; if-feature "ssh-initiate";
container ssh { container ssh {
description description
"Specifies IP and SSH specific configuration "Specifies IP and SSH specific configuration
for the connection."; for the connection.";
uses tcpc:tcp-client-grouping { uses tcpc:tcp-client-grouping {
refine "remote-port" { refine "tcp-client-parameters/remote-port" {
default "830"; default "830";
description description
"The NETCONF client will attempt to connect "The NETCONF client will attempt to connect
to the IANA-assigned well-known port value to the IANA-assigned well-known port value
for 'netconf-ssh' (443) if no value is for 'netconf-ssh' (443) if no value is
specified."; specified.";
} }
} }
uses sshc:ssh-client-grouping; uses sshc:ssh-client-grouping;
} }
} }
case tls { case tls {
if-feature "tls-initiate"; if-feature "tls-initiate";
container tls { container tls {
description description
"Specifies IP and TLS specific configuration "Specifies IP and TLS specific configuration
for the connection."; for the connection.";
uses tcpc:tcp-client-grouping { uses tcpc:tcp-client-grouping {
refine "remote-port" { refine "tcp-client-parameters/remote-port" {
default "6513"; default "6513";
description description
"The NETCONF client will attempt to connect "The NETCONF client will attempt to connect
to the IANA-assigned well-known port value to the IANA-assigned well-known port value
for 'netconf-tls' (6513) if no value is for 'netconf-tls' (6513) if no value is
specified."; specified.";
} }
} }
uses tlsc:tls-client-grouping { uses tlsc:tls-client-grouping {
refine "tls-client-identity/auth-type" { refine "tls-client-parameters/client-identity"
+ "/auth-type" {
mandatory true; mandatory true;
description description
"NETCONF/TLS clients MUST pass some "NETCONF/TLS clients MUST pass some
authentication credentials."; authentication credentials.";
} }
} }
} }
} }
} // choice transport } // choice transport
} // list endpoint } // list endpoint
skipping to change at page 21, line 18 skipping to change at page 13, line 51
start trying to reconnect to it, using the start trying to reconnect to it, using the
reconnection strategy. reconnection strategy.
This connection type minimizes any NETCONF server This connection type minimizes any NETCONF server
to NETCONF client data-transfer delay, albeit at to NETCONF client data-transfer delay, albeit at
the expense of holding resources longer."; the expense of holding resources longer.";
} }
} }
case periodic-connection { case periodic-connection {
container periodic { container periodic {
must 'not (../../endpoints/endpoint/ssh/'
+ 'tcp-client-parameters/keepalives '
+ 'or ../../endpoints/endpoint/ssh/'
+ 'ssh-client-parameters/keepalives '
+ 'or ../../endpoints/endpoint/tls/'
+ 'tcp-client-parameters/keepalives '
+ 'or ../../endpoints/endpoint/tls/'
+ 'tls-client-parameters/keepalives)';
presence "Indicates that a periodic connection is presence "Indicates that a periodic connection is
to be maintained."; to be maintained.";
description description
"Periodically connect to the NETCONF server. The "Periodically connect to the NETCONF server. The
NETCONF server should close the connection upon NETCONF server should close the connection upon
completing planned activities. completing planned activities.
This connection type increases resource This connection type increases resource
utilization, albeit with increased delay in utilization, albeit with increased delay in
NETCONF server to NETCONF client interactions."; NETCONF server to NETCONF client interactions.";
skipping to change at page 24, line 12 skipping to change at page 17, line 6
mandatory true; mandatory true;
description description
"Selects between available transports."; "Selects between available transports.";
case ssh { case ssh {
if-feature "ssh-listen"; if-feature "ssh-listen";
container ssh { container ssh {
description description
"SSH-specific listening configuration for inbound "SSH-specific listening configuration for inbound
connections."; connections.";
uses tcps:tcp-server-grouping { uses tcps:tcp-server-grouping {
refine "local-port" { refine "tcp-server-parameters/local-port" {
default "4334"; default "4334";
description description
"The NETCONF client will listen on the IANA- "The NETCONF client will listen on the IANA-
assigned well-known port for 'netconf-ch-ssh' assigned well-known port for 'netconf-ch-ssh'
(4334) if no value is specified."; (4334) if no value is specified.";
} }
} }
uses sshc:ssh-client-grouping; uses sshc:ssh-client-grouping;
} }
} }
case tls { case tls {
if-feature "tls-listen"; if-feature "tls-listen";
container tls { container tls {
description description
"TLS-specific listening configuration for inbound "TLS-specific listening configuration for inbound
connections."; connections.";
uses tcps:tcp-server-grouping { uses tcps:tcp-server-grouping {
refine "local-port" { refine "tcp-server-parameters/local-port" {
default "4334"; default "4334";
description description
"The NETCONF client will listen on the IANA- "The NETCONF client will listen on the IANA-
assigned well-known port for 'netconf-ch-ssh' assigned well-known port for 'netconf-ch-ssh'
(4334) if no value is specified."; (4334) if no value is specified.";
} }
} }
uses tlsc:tls-client-grouping { uses tlsc:tls-client-grouping {
refine "tls-client-identity/auth-type" { refine
"tls-client-parameters/client-identity/auth-type" {
mandatory true; mandatory true;
description description
"NETCONF/TLS clients MUST pass some "NETCONF/TLS clients MUST pass some
authentication credentials."; authentication credentials.";
} }
} }
} }
} }
} // transport } // transport
} // endpoint } // endpoint
skipping to change at page 25, line 17 skipping to change at page 18, line 13
container netconf-client { container netconf-client {
uses netconf-client-grouping; uses netconf-client-grouping;
description description
"Top-level container for NETCONF client configuration."; "Top-level container for NETCONF client configuration.";
} }
} }
<CODE ENDS> <CODE ENDS>
4. The NETCONF Server Model 4. The NETCONF Server Model
The NETCONF server model presented in this section supports servers The NETCONF server model presented in this section supports both
both listening for connections as well as initiating call-home listening for connections as well as initiating call-home
connections. connections, using either the SSH and TLS transport protocols.
This model supports both the SSH and TLS transport protocols, using
the SSH server and TLS server groupings defined in
[I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-tls-client-server] respectively.
All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to YANG feature statements are used to enable implementations to
advertise which parts of the model the NETCONF server supports. advertise which potentially uncommon parts of the model the NETCONF
server supports.
4.1. Tree Diagram 4.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-netconf-server" module. Just the container is model for the "ietf-netconf-server" module.
displayed below, but there is also a reusable grouping called
"netconf-server-grouping" that the container is using.
========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) =========== This tree diagram only shows the nodes defined in this module; it
does show the nodes defined by "grouping" statements used by this
module.
Please see Appendix A.2 for a tree diagram that illustrates what the
module looks like with all the "grouping" statements expanded.
module: ietf-netconf-server module: ietf-netconf-server
+--rw netconf-server +--rw netconf-server
+--rw listen! {listen}? +---u netconf-server-grouping
| +--rw idle-timeout? uint16
| +--rw endpoint* [name]
| +--rw name string
| +--rw (transport)
| +--:(ssh) {ssh-listen}?
| | +--rw ssh
| | +--rw local-address inet:ip-address
| | +--rw local-port? inet:port-number
| | +--rw tcp-keepalives {tcp-server-keepalives}?
| | | +--rw idle-time? uint16
| | | +--rw max-probes? uint16
| | | +--rw probe-interval? uint16
| | +--rw ssh-server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-supported\
\}?
| | | | | +--rw local-definition
| | | | | +--rw algorithm?
| | | | | | asymmetric-key-a\
\lgorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
| | | | | +---x generate-hidden-key
| | | | | | +---w input
| | | | | | +---w algorithm
| | | | | | asymmetric\
\-key-algorithm-ref
| | | | | +---x install-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | asymmetric\
\-key-algorithm-ref
| | | | | +---w public-key?
| | | | | | binary
| | | | | +---w private-key?
| | | | | binary
| | | | +--:(keystore)
| | | | {keystore-supported}?
| | | | +--rw keystore-reference?
| | | | ks:asymmetric-key-r\
\ef
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-supported\
\}?
| | | | +--rw local-definition
| | | | +--rw algorithm?
| | | | | asymmetric-key-a\
\lgorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | asymmetric\
\-key-algorithm-ref
| | | | +---x install-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | asymmetric\
\-key-algorithm-ref
| | | | | +---w public-key?
| | | | | | binary
| | | | | +---w private-key?
| | | | | binary
| | | | +--rw cert?
| | | | | end-entity-cert-\
\cms
| | | | +---n certificate-expira\
\tion
| | | | +-- expiration-date
| | | | yang:date-and\
\-time
| | | +--:(keystore)
| | | {keystore-supported}?
| | | +--rw keystore-reference?
| | | ks:asymmetric-key-c\
\ertificate-ref
| | +--rw ssh-client-cert-auth {sshcmn:ssh-x509-cert\
\s}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw ssh-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 ssh-keepalives {ssh-server-keepalives}?
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--:(tls) {tls-listen}?
| +--rw tls
| +--rw local-address inet:ip-address
| +--rw local-port? inet:port-number
| +--rw tcp-keepalives {tcp-server-keepalives}?
| | +--rw idle-time? uint16
| | +--rw max-probes? uint16
| | +--rw probe-interval? uint16
| +--rw tls-server-identity
| | +--rw (local-or-keystore)
| | +--:(local) {local-keys-supported}?
| | | +--rw local-definition
| | | +--rw algorithm?
| | | | asymmetric-key-algorithm-ref
| | | +--rw public-key? bina\
\ry
| | | +--rw private-key? union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | asymmetric-key-algorit\
\hm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric-key-algorit\
\hm-ref
| | | | +---w public-key? binary
| | | | +---w private-key? binary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
| | | yang:date-and-time
| | +--:(keystore) {keystore-supported}?
| | +--rw keystore-reference?
| | ks:asymmetric-key-certificate-r\
\ef
| +--rw tls-client-auth
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw cert-maps
| | +--rw cert-to-name* [id]
| | +--rw id uint32
| | +--rw fingerprint
| | | x509c2n:tls-fingerprint
| | +--rw map-type identityref
| | +--rw name string
| +--rw tls-hello-params
| | {tls-server-hello-params-config}?
| | +--rw tls-versions
| | | +--rw tls-version* identityref
| | +--rw cipher-suites
| | +--rw cipher-suite* identityref
| +--rw tls-keepalives {tls-server-keepalives}?
| +--rw max-wait? uint16
| +--rw max-attempts? uint8
+--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 remote-address inet:host
| | +--rw remote-port?
| | | inet:port-number
| | +--rw local-address? inet:ip-addr\
\ess
| | +--rw local-port?
| | | inet:port-number
| | +--rw tcp-keepalives {tcp-client-keepalive\
\s}?
| | | +--rw idle-time? uint16
| | | +--rw max-probes? uint16
| | | +--rw probe-interval? uint16
| | +--rw ssh-server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-sup\
\ported}?
| | | | | +--rw local-definition
| | | | | +--rw algorithm?
| | | | | | asymmetric\
\-key-algorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
| | | | | +---x generate-hid\
\den-key
| | | | | | +---w input
| | | | | | +---w algori\
\thm
| | | | | | asym\
\metric-key-algorithm-ref
| | | | | +---x install-hidd\
\en-key
| | | | | +---w input
| | | | | +---w algori\
\thm
| | | | | | asym\
\metric-key-algorithm-ref
| | | | | +---w public\
\-key?
| | | | | | bina\
\ry
| | | | | +---w privat\
\e-key?
| | | | | bina\
\ry
| | | | +--:(keystore)
| | | | {keystore-suppo\
\rted}?
| | | | +--rw keystore-refere\
\nce?
| | | | ks:asymmetric\
\-key-ref
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-certs\
\}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-sup\
\ported}? grouping netconf-server-grouping
| | | | +--rw local-definition +-- listen! {listen}?
| | | | +--rw algorithm? | +-- idle-timeout? uint16
| | | | | asymmetric\ | +-- endpoint* [name]
\-key-algorithm-ref | +-- name? string
| | | | +--rw public-key? | +-- (transport)
| | | | | binary | +--:(ssh) {ssh-listen}?
| | | | +--rw private-key? | | +-- ssh
| | | | | union | | +---u netconf-server-grouping
| | | | +---x generate-hid\ | +--:(tls) {tls-listen}?
\den-key | +-- tls
| | | | | +---w input | +---u netconf-server-grouping
| | | | | +---w algori\ +-- call-home! {call-home}?
\thm +-- netconf-client* [name]
| | | | | asym\ +-- name? string
\metric-key-algorithm-ref +-- endpoints
| | | | +---x install-hidd\ | +-- endpoint* [name]
\en-key | +-- name? string
| | | | | +---w input | +-- (transport)
| | | | | +---w algori\ | +--:(ssh) {ssh-call-home}?
\thm | | +-- ssh
| | | | | | asym\ | | +---u netconf-server-grouping
\metric-key-algorithm-ref | +--:(tls) {tls-call-home}?
| | | | | +---w public\ | +-- tls
\-key? | +---u netconf-server-grouping
| | | | | | bina\ +-- connection-type
\ry | +-- (connection-type)
| | | | | +---w privat\ | +--:(persistent-connection)
\e-key? | | +-- persistent!
| | | | | bina\ | +--:(periodic-connection)
\ry | +-- periodic!
| | | | +--rw cert? | +-- period? uint16
| | | | | end-entity\ | +-- anchor-time? yang:date-and-time
\-cert-cms | +-- idle-timeout? uint16
| | | | +---n certificate-\ +-- reconnect-strategy
\expiration +-- start-with? enumeration
| | | | +-- expiration-\ +-- max-attempts? uint8
\date
| | | | yang:da\
\te-and-time
| | | +--:(keystore)
| | | {keystore-suppo\
\rted}?
| | | +--rw keystore-refere\
\nce?
| | | ks:asymmetric\
\-key-certificate-ref
| | +--rw ssh-client-cert-auth
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw ssh-transport-params
| | | {ssh-server-transport-params-confi\
\g}?
| | | +--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 ssh-keepalives {ssh-server-keepalive\
\s}?
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--:(tls) {tls-call-home}?
| +--rw tls
| +--rw remote-address inet:host
| +--rw remote-port? inet:port-num\
\ber
| +--rw local-address? inet:ip-addre\
\ss
| +--rw local-port? inet:port-num\
\ber
| +--rw tcp-keepalives {tcp-client-keepalive\
\s}?
| | +--rw idle-time? uint16
| | +--rw max-probes? uint16
| | +--rw probe-interval? uint16
| +--rw tls-server-identity
| | +--rw (local-or-keystore)
| | +--:(local) {local-keys-supported}?
| | | +--rw local-definition
| | | +--rw algorithm?
| | | | asymmetric-key-algorit\
\hm-ref
| | | +--rw public-key?
| | | | binary
| | | +--rw private-key?
| | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | asymmetric-key-a\
\lgorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric-key-a\
\lgorithm-ref
| | | | +---w public-key? bin\
\ary
| | | | +---w private-key? bin\
\ary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
| | | yang:date-and-time
| | +--:(keystore) {keystore-supported}?
| | +--rw keystore-reference?
| | ks:asymmetric-key-certifi\
\cate-ref
| +--rw tls-client-auth
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw cert-maps
| | +--rw cert-to-name* [id]
| | +--rw id uint32
| | +--rw fingerprint
| | | x509c2n:tls-fingerprint
| | +--rw map-type identityref
| | +--rw name string
| +--rw tls-hello-params
| | {tls-server-hello-params-config}?
| | +--rw tls-versions
| | | +--rw tls-version* identityref
| | +--rw cipher-suites
| | +--rw cipher-suite* identityref
| +--rw tls-keepalives {tls-server-keepalive\
\s}?
| +--rw max-wait? uint16
| +--rw max-attempts? uint8
+--rw connection-type
| +--rw (connection-type)
| +--:(persistent-connection)
| | +--rw persistent!
| +--:(periodic-connection)
| +--rw periodic!
| +--rw period? uint16
| +--rw anchor-time? yang:date-and-time
| +--rw idle-timeout? uint16
+--rw reconnect-strategy
+--rw start-with? enumeration
+--rw max-attempts? uint8
4.2. Example Usage 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 3.2 This example is consistent with the examples presented in Section 3.2
of [I-D.ietf-netconf-keystore]. of [I-D.ietf-netconf-keystore].
========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) =========== =========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) ===========
<netconf-server <netconf-server
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server" xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server"
xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name"> xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name">
<!-- endpoints to listen for NETCONF connections on --> <!-- endpoints to listen for NETCONF connections on -->
<listen> <listen>
<endpoint> <!-- listening for SSH connections --> <endpoint> <!-- listening for SSH connections -->
<name>netconf/ssh</name> <name>netconf/ssh</name>
<ssh> <ssh>
<local-address>192.0.2.7</local-address> <tcp-server-parameters>
<ssh-server-identity> <local-address>192.0.2.7</local-address>
<host-key> </tcp-server-parameters>
<name>deployment-specific-certificate</name> <ssh-server-parameters>
<public-key> <server-identity>
<local-definition> <host-key>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\ <name>deployment-specific-certificate</name>
\f-crypto-types">ct:rsa2048</algorithm> <public-key>
<private-key>base64encodedvalue==</private-key> <local-definition>
<public-key>base64encodedvalue==</public-key> <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\
</local-definition> etf-crypto-types">ct:rsa2048</algorithm>
</public-key> <private-key>base64encodedvalue==</private-key>
</host-key> <public-key>base64encodedvalue==</public-key>
</ssh-server-identity> </local-definition>
<ssh-client-cert-auth> </public-key>
<pinned-ca-certs>explicitly-trusted-client-ca-certs</pinne\ </host-key>
</server-identity>
\d-ca-certs> <client-cert-auth>
<pinned-client-certs>explicitly-trusted-client-certs</pinn\ <pinned-ca-certs>explicitly-trusted-client-ca-certs</pin\
\ed-client-certs> ned-ca-certs>
</ssh-client-cert-auth> <pinned-client-certs>explicitly-trusted-client-certs</pi\
nned-client-certs>
</client-cert-auth>
</ssh-server-parameters>
</ssh> </ssh>
</endpoint> </endpoint>
<endpoint> <!-- listening for TLS sessions --> <endpoint> <!-- listening for TLS sessions -->
<name>netconf/tls</name> <name>netconf/tls</name>
<tls> <tls>
<local-address>192.0.2.7</local-address> <tcp-server-parameters>
<tls-server-identity> <local-address>192.0.2.7</local-address>
<local-definition> </tcp-server-parameters>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-cr\ <tls-server-parameters>
\ypto-types">ct:rsa2048</algorithm> <server-identity>
<private-key>base64encodedvalue==</private-key> <local-definition>
<public-key>base64encodedvalue==</public-key> <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-\
<cert>base64encodedvalue==</cert> crypto-types">ct:rsa2048</algorithm>
</local-definition> <private-key>base64encodedvalue==</private-key>
</tls-server-identity> <public-key>base64encodedvalue==</public-key>
<tls-client-auth> <cert>base64encodedvalue==</cert>
<pinned-ca-certs>explicitly-trusted-client-ca-certs</pinne\ </local-definition>
\d-ca-certs> </server-identity>
<pinned-client-certs>explicitly-trusted-client-certs</pinn\ <client-authentication>
\ed-client-certs> <pinned-ca-certs>explicitly-trusted-client-ca-certs</pin\
<cert-maps> ned-ca-certs>
<cert-to-name> <pinned-client-certs>explicitly-trusted-client-certs</pi\
<id>1</id> nned-client-certs>
<fingerprint>11:0A:05:11:00</fingerprint> <cert-maps>
<map-type>x509c2n:san-any</map-type> <cert-to-name>
</cert-to-name> <id>1</id>
<cert-to-name> <fingerprint>11:0A:05:11:00</fingerprint>
<id>2</id> <map-type>x509c2n:san-any</map-type>
<fingerprint>B3:4F:A1:8C:54</fingerprint> </cert-to-name>
<map-type>x509c2n:specified</map-type> <cert-to-name>
<name>scooby-doo</name> <id>2</id>
</cert-to-name> <fingerprint>B3:4F:A1:8C:54</fingerprint>
</cert-maps> <map-type>x509c2n:specified</map-type>
</tls-client-auth> <name>scooby-doo</name>
</cert-to-name>
</cert-maps>
</client-authentication>
</tls-server-parameters>
</tls> </tls>
</endpoint> </endpoint>
</listen> </listen>
<!-- calling home to SSH and TLS based NETCONF clients --> <!-- calling home to SSH and TLS based NETCONF clients -->
<call-home> <call-home>
<netconf-client> <!-- SSH-based client --> <netconf-client> <!-- SSH-based client -->
<name>config-mgr</name> <name>config-mgr</name>
<endpoints> <endpoints>
<endpoint> <endpoint>
<name>east-data-center</name> <name>east-data-center</name>
<ssh> <ssh>
<remote-address>east.config-mgr.example.com</remote-addr\ <tcp-client-parameters>
\ess> <remote-address>east.config-mgr.example.com</remote-ad\
<ssh-server-identity> dress>
<host-key> </tcp-client-parameters>
<name>deployment-specific-certificate</name> <ssh-server-parameters>
<public-key> <server-identity>
<local-definition> <host-key>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\ <name>deployment-specific-certificate</name>
\:ietf-crypto-types">ct:rsa2048</algorithm> <public-key>
<private-key>base64encodedvalue==</private-key> <local-definition>
<public-key>base64encodedvalue==</public-key> <algorithm xmlns:ct="urn:ietf:params:xml:ns:ya\
</local-definition> ng:ietf-crypto-types">ct:rsa2048</algorithm>
</public-key> <private-key>base64encodedvalue==</private-key>
</host-key> <public-key>base64encodedvalue==</public-key>
</ssh-server-identity> </local-definition>
<ssh-client-cert-auth> </public-key>
<pinned-ca-certs>explicitly-trusted-client-ca-certs</p\ </host-key>
\inned-ca-certs> </server-identity>
<pinned-client-certs>explicitly-trusted-client-certs</\ <client-cert-auth>
\pinned-client-certs> <pinned-ca-certs>explicitly-trusted-client-ca-certs<\
</ssh-client-cert-auth> /pinned-ca-certs>
<pinned-client-certs>explicitly-trusted-client-certs\
</pinned-client-certs>
</client-cert-auth>
</ssh-server-parameters>
</ssh> </ssh>
</endpoint> </endpoint>
<endpoint> <endpoint>
<name>west-data-center</name> <name>west-data-center</name>
<ssh> <ssh>
<remote-address>west.config-mgr.example.com</remote-addr\ <tcp-client-parameters>
\ess> <remote-address>west.config-mgr.example.com</remote-ad\
<ssh-server-identity> dress>
<host-key> </tcp-client-parameters>
<name>deployment-specific-certificate</name> <ssh-server-parameters>
<public-key> <server-identity>
<local-definition> <host-key>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\ <name>deployment-specific-certificate</name>
\:ietf-crypto-types">ct:rsa2048</algorithm> <public-key>
<private-key>base64encodedvalue==</private-key> <local-definition>
<public-key>base64encodedvalue==</public-key> <algorithm xmlns:ct="urn:ietf:params:xml:ns:ya\
</local-definition> ng:ietf-crypto-types">ct:rsa2048</algorithm>
</public-key> <private-key>base64encodedvalue==</private-key>
</host-key> <public-key>base64encodedvalue==</public-key>
</ssh-server-identity> </local-definition>
<ssh-client-cert-auth> </public-key>
<pinned-ca-certs>explicitly-trusted-client-ca-certs</p\ </host-key>
\inned-ca-certs> </server-identity>
<pinned-client-certs>explicitly-trusted-client-certs</\ <client-cert-auth>
\pinned-client-certs> <pinned-ca-certs>explicitly-trusted-client-ca-certs<\
</ssh-client-cert-auth> /pinned-ca-certs>
<pinned-client-certs>explicitly-trusted-client-certs\
</pinned-client-certs>
</client-cert-auth>
</ssh-server-parameters>
</ssh> </ssh>
</endpoint> </endpoint>
</endpoints> </endpoints>
<connection-type> <connection-type>
<periodic> <periodic>
<idle-timeout>300</idle-timeout> <idle-timeout>300</idle-timeout>
<period>60</period> <period>60</period>
</periodic> </periodic>
</connection-type> </connection-type>
<reconnect-strategy> <reconnect-strategy>
<start-with>last-connected</start-with> <start-with>last-connected</start-with>
skipping to change at page 37, line 25 skipping to change at page 23, line 24
<start-with>last-connected</start-with> <start-with>last-connected</start-with>
<max-attempts>3</max-attempts> <max-attempts>3</max-attempts>
</reconnect-strategy> </reconnect-strategy>
</netconf-client> </netconf-client>
<netconf-client> <!-- TLS-based client --> <netconf-client> <!-- TLS-based client -->
<name>data-collector</name> <name>data-collector</name>
<endpoints> <endpoints>
<endpoint> <endpoint>
<name>east-data-center</name> <name>east-data-center</name>
<tls> <tls>
<remote-address>east.analytics.example.com</remote-addre\ <tcp-client-parameters>
\ss> <remote-address>east.analytics.example.com</remote-add\
<tls-server-identity> ress>
<local-definition> <keepalives>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\ <idle-time>15</idle-time>
\f-crypto-types">ct:rsa2048</algorithm> <max-probes>3</max-probes>
<private-key>base64encodedvalue==</private-key> <probe-interval>30</probe-interval>
<public-key>base64encodedvalue==</public-key> </keepalives>
<cert>base64encodedvalue==</cert> </tcp-client-parameters>
</local-definition> <tls-server-parameters>
</tls-server-identity> <server-identity>
<tls-client-auth> <local-definition>
<pinned-ca-certs>explicitly-trusted-client-ca-certs</p\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\
\inned-ca-certs> etf-crypto-types">ct:rsa2048</algorithm>
<pinned-client-certs>explicitly-trusted-client-certs</\ <private-key>base64encodedvalue==</private-key>
\pinned-client-certs> <public-key>base64encodedvalue==</public-key>
<cert-maps> <cert>base64encodedvalue==</cert>
<cert-to-name> </local-definition>
<id>1</id> </server-identity>
<fingerprint>11:0A:05:11:00</fingerprint> <client-authentication>
<map-type>x509c2n:san-any</map-type> <pinned-ca-certs>explicitly-trusted-client-ca-certs<\
</cert-to-name> /pinned-ca-certs>
<cert-to-name> <pinned-client-certs>explicitly-trusted-client-certs\
<id>2</id> </pinned-client-certs>
<fingerprint>B3:4F:A1:8C:54</fingerprint> <cert-maps>
<map-type>x509c2n:specified</map-type> <cert-to-name>
<name>scooby-doo</name> <id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type>
</cert-to-name> </cert-to-name>
</cert-maps> <cert-to-name>
</tls-client-auth> <id>2</id>
<tcp-keepalives> <fingerprint>B3:4F:A1:8C:54</fingerprint>
<idle-time>15</idle-time> <map-type>x509c2n:specified</map-type>
<max-probes>3</max-probes> <name>scooby-doo</name>
<probe-interval>30</probe-interval> </cert-to-name>
</tcp-keepalives> </cert-maps>
<tls-keepalives> </client-authentication>
<max-wait>30</max-wait> <keepalives>
<max-attempts>3</max-attempts> <max-wait>30</max-wait>
</tls-keepalives> <max-attempts>3</max-attempts>
</keepalives>
</tls-server-parameters>
</tls> </tls>
</endpoint> </endpoint>
<endpoint> <endpoint>
<name>west-data-center</name> <name>west-data-center</name>
<tls> <tls>
<remote-address>west.analytics.example.com</remote-addre\ <tcp-client-parameters>
\ss> <remote-address>west.analytics.example.com</remote-add\
<tls-server-identity> ress>
<local-definition> <keepalives>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\ <idle-time>15</idle-time>
\f-crypto-types">ct:rsa2048</algorithm> <max-probes>3</max-probes>
<private-key>base64encodedvalue==</private-key> <probe-interval>30</probe-interval>
<public-key>base64encodedvalue==</public-key> </keepalives>
<cert>base64encodedvalue==</cert> </tcp-client-parameters>
</local-definition> <tls-server-parameters>
</tls-server-identity> <server-identity>
<tls-client-auth> <local-definition>
<pinned-ca-certs>explicitly-trusted-client-ca-certs</p\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\
\inned-ca-certs> etf-crypto-types">ct:rsa2048</algorithm>
<pinned-client-certs>explicitly-trusted-client-certs</\ <private-key>base64encodedvalue==</private-key>
\pinned-client-certs> <public-key>base64encodedvalue==</public-key>
<cert-maps> <cert>base64encodedvalue==</cert>
<cert-to-name> </local-definition>
<id>1</id> </server-identity>
<fingerprint>11:0A:05:11:00</fingerprint> <client-authentication>
<map-type>x509c2n:san-any</map-type> <pinned-ca-certs>explicitly-trusted-client-ca-certs<\
</cert-to-name> /pinned-ca-certs>
<cert-to-name> <pinned-client-certs>explicitly-trusted-client-certs\
<id>2</id> </pinned-client-certs>
<fingerprint>B3:4F:A1:8C:54</fingerprint> <cert-maps>
<map-type>x509c2n:specified</map-type> <cert-to-name>
<name>scooby-doo</name> <id>1</id>
</cert-to-name> <fingerprint>11:0A:05:11:00</fingerprint>
</cert-maps> <map-type>x509c2n:san-any</map-type>
</tls-client-auth>
<tcp-keepalives> </cert-to-name>
<idle-time>15</idle-time> <cert-to-name>
<max-probes>3</max-probes> <id>2</id>
<probe-interval>30</probe-interval> <fingerprint>B3:4F:A1:8C:54</fingerprint>
</tcp-keepalives> <map-type>x509c2n:specified</map-type>
<tls-keepalives> <name>scooby-doo</name>
<max-wait>30</max-wait> </cert-to-name>
<max-attempts>3</max-attempts> </cert-maps>
</tls-keepalives> </client-authentication>
<keepalives>
<max-wait>30</max-wait>
<max-attempts>3</max-attempts>
</keepalives>
</tls-server-parameters>
</tls> </tls>
</endpoint> </endpoint>
</endpoints> </endpoints>
<connection-type> <connection-type>
<persistent/> <persistent/>
</connection-type> </connection-type>
<reconnect-strategy> <reconnect-strategy>
<start-with>first-listed</start-with> <start-with>first-listed</start-with>
<max-attempts>3</max-attempts> <max-attempts>3</max-attempts>
</reconnect-strategy> </reconnect-strategy>
skipping to change at page 39, line 34 skipping to change at page 25, line 41
</netconf-server> </netconf-server>
4.3. YANG Module 4.3. YANG Module
This YANG module has normative references to [RFC6242], [RFC6991], This YANG module has normative references to [RFC6242], [RFC6991],
[RFC7407], [RFC7589], [RFC8071], [RFC7407], [RFC7589], [RFC8071],
[I-D.kwatsen-netconf-tcp-client-server], [I-D.kwatsen-netconf-tcp-client-server],
[I-D.ietf-netconf-ssh-client-server], and [I-D.ietf-netconf-ssh-client-server], and
[I-D.ietf-netconf-tls-client-server]. [I-D.ietf-netconf-tls-client-server].
This YANG module imports YANG types from [RFC6991], and YANG <CODE BEGINS> file "ietf-netconf-server@2019-04-07.yang"
groupings from [RFC7407], [I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-ssh-client-server].
<CODE BEGINS> file "ietf-netconf-server@2019-03-09.yang"
module ietf-netconf-server { module ietf-netconf-server {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server"; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server";
prefix ncs; prefix ncs;
import ietf-yang-types { import ietf-yang-types {
prefix yang; prefix yang;
reference reference
"RFC 6991: Common YANG Data Types"; "RFC 6991: Common YANG Data Types";
} }
skipping to change at page 40, line 22 skipping to change at page 26, line 24
} }
import ietf-tcp-server { import ietf-tcp-server {
prefix tcps; prefix tcps;
reference reference
"RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers";
} }
import ietf-ssh-server { import ietf-ssh-server {
prefix sshs; prefix sshs;
revision-date 2019-03-09; // stable grouping definitions revision-date 2019-04-07; // stable grouping definitions
reference reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers"; "RFC BBBB: YANG Groupings for SSH Clients and SSH Servers";
} }
import ietf-tls-server { import ietf-tls-server {
prefix tlss; prefix tlss;
revision-date 2019-03-09; // stable grouping definitions revision-date 2019-04-07; // stable grouping definitions
reference reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers"; "RFC CCCC: YANG Groupings for TLS Clients and TLS Servers";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/> "WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net> Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Gary Wu <mailto:garywu@cisco.com> Author: Gary Wu <mailto:garywu@cisco.com>
Author: Juergen Schoenwaelder Author: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de>"; <mailto:j.schoenwaelder@jacobs-university.de>";
description description
"This module contains a collection of YANG definitions for "This module contains a collection of YANG definitions
configuring NETCONF servers. for configuring NETCONF servers.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 [RFC2119]
[RFC8174] when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2019 IETF Trust and the persons identified as Copyright (c) 2019 IETF Trust and the persons identified
authors of the code. All rights reserved. as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with
without modification, is permitted pursuant to, and subject or without modification, is permitted pursuant to, and
to the license terms contained in, the Simplified BSD subject to the license terms contained in, the Simplified
License set forth in Section 4.c of the IETF Trust's BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX
the RFC itself for full legal notices."; (https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.;
revision 2019-03-09 { The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-04-07 {
description description
"Initial version"; "Initial version";
reference reference
"RFC XXXX: NETCONF Client and Server Models"; "RFC XXXX: NETCONF Client and Server Models";
} }
// Features // Features
feature listen { feature listen {
description description
skipping to change at page 43, line 32 skipping to change at page 29, line 35
mandatory true; mandatory true;
description description
"Selects between available transports."; "Selects between available transports.";
case ssh { case ssh {
if-feature "ssh-listen"; if-feature "ssh-listen";
container ssh { container ssh {
description description
"SSH-specific listening configuration for inbound "SSH-specific listening configuration for inbound
connections."; connections.";
uses tcps:tcp-server-grouping { uses tcps:tcp-server-grouping {
refine "local-port" { refine "tcp-server-parameters/local-port" {
default "830"; default "830";
description description
"The NETCONF server will listen on the IANA- "The NETCONF server will listen on the IANA-
assigned well-known port value for 'netconf-ssh' assigned well-known port value for 'netconf-ssh'
(830) if no value is specified."; (830) if no value is specified.";
} }
} }
uses sshs:ssh-server-grouping; uses sshs:ssh-server-grouping;
} }
} }
skipping to change at page 43, line 49 skipping to change at page 30, line 4
} }
uses sshs:ssh-server-grouping; uses sshs:ssh-server-grouping;
} }
} }
case tls { case tls {
if-feature "tls-listen"; if-feature "tls-listen";
container tls { container tls {
description description
"TLS-specific listening configuration for inbound "TLS-specific listening configuration for inbound
connections."; connections.";
uses tcps:tcp-server-grouping { uses tcps:tcp-server-grouping {
refine "local-port" { refine "tcp-server-parameters/local-port" {
default "6513"; default "6513";
description description
"The NETCONF server will listen on the IANA- "The NETCONF server will listen on the IANA-
assigned well-known port value for 'netconf-tls' assigned well-known port value for 'netconf-tls'
(6513) if no value is specified."; (6513) if no value is specified.";
} }
} }
uses tlss:tls-server-grouping { uses tlss:tls-server-grouping {
refine "tls-client-auth" { refine
"tls-server-parameters/client-authentication" {
must 'pinned-ca-certs or pinned-client-certs'; must 'pinned-ca-certs or pinned-client-certs';
description description
"NETCONF/TLS servers MUST validate client "NETCONF/TLS servers MUST validate client
certiticates."; certiticates.";
} }
augment "tls-client-auth" { augment
"tls-server-parameters/client-authentication" {
description description
"Augments in the cert-to-name structure."; "Augments in the cert-to-name structure.";
container cert-maps { container cert-maps {
uses x509c2n:cert-to-name; uses x509c2n:cert-to-name;
description description
"The cert-maps container is used by a TLS- "The cert-maps container is used by a TLS-
based NETCONF server to map the NETCONF based NETCONF server to map the NETCONF
client's presented X.509 certificate to a client's presented X.509 certificate to a
NETCONF username. If no matching and valid NETCONF username. If no matching and valid
cert-to-name list entry can be found, then cert-to-name list entry can be found, then
skipping to change at page 45, line 35 skipping to change at page 31, line 40
mandatory true; mandatory true;
description description
"Selects between available transports."; "Selects between available transports.";
case ssh { case ssh {
if-feature "ssh-call-home"; if-feature "ssh-call-home";
container ssh { container ssh {
description description
"Specifies SSH-specific call-home transport "Specifies SSH-specific call-home transport
configuration."; configuration.";
uses tcpc:tcp-client-grouping { uses tcpc:tcp-client-grouping {
refine "remote-port" { refine "tcp-client-parameters/remote-port" {
default "4334"; default "4334";
description description
"The NETCONF server will attempt to connect "The NETCONF server will attempt to connect
to the IANA-assigned well-known port for to the IANA-assigned well-known port for
'netconf-ch-tls' (4334) if no value is 'netconf-ch-tls' (4334) if no value is
specified."; specified.";
} }
} }
uses sshs:ssh-server-grouping; uses sshs:ssh-server-grouping;
} }
} }
case tls { case tls {
if-feature "tls-call-home"; if-feature "tls-call-home";
container tls { container tls {
description description
"Specifies TLS-specific call-home transport "Specifies TLS-specific call-home transport
configuration."; configuration.";
uses tcpc:tcp-client-grouping { uses tcpc:tcp-client-grouping {
refine "remote-port" { refine "tcp-client-parameters/remote-port" {
default "4335"; default "4335";
description description
"The NETCONF server will attempt to connect "The NETCONF server will attempt to connect
to the IANA-assigned well-known port for to the IANA-assigned well-known port for
'netconf-ch-tls' (4335) if no value is 'netconf-ch-tls' (4335) if no value is
specified."; specified.";
} }
} }
uses tlss:tls-server-grouping { uses tlss:tls-server-grouping {
refine "tls-client-auth" { refine
"tls-server-parameters/client-authentication" {
must 'pinned-ca-certs or pinned-client-certs'; must 'pinned-ca-certs or pinned-client-certs';
description description
"NETCONF/TLS servers MUST validate client "NETCONF/TLS servers MUST validate client
certiticates."; certiticates.";
} }
augment "tls-client-auth" { augment
"tls-server-parameters/client-authentication" {
description description
"Augments in the cert-to-name structure."; "Augments in the cert-to-name structure.";
container cert-maps { container cert-maps {
uses x509c2n:cert-to-name; uses x509c2n:cert-to-name;
description description
"The cert-maps container is used by a "The cert-maps container is used by a
TLS-based NETCONF server to map the TLS-based NETCONF server to map the
NETCONF client's presented X.509 NETCONF client's presented X.509
certificate to a NETCONF username. If certificate to a NETCONF username. If
no matching and valid cert-to-name list no matching and valid cert-to-name list
skipping to change at page 47, line 24 skipping to change at page 33, line 32
start trying to reconnect to it, using the start trying to reconnect to it, using the
reconnection strategy. reconnection strategy.
This connection type minimizes any NETCONF client This connection type minimizes any NETCONF client
to NETCONF server data-transfer delay, albeit at to NETCONF server data-transfer delay, albeit at
the expense of holding resources longer."; the expense of holding resources longer.";
} // container persistent } // container persistent
} // case persistent-connection } // case persistent-connection
case periodic-connection { case periodic-connection {
container periodic { container periodic {
must 'not (../../endpoints/endpoint/ssh/'
+ 'tcp-client-parameters/keepalives '
+ 'or ../../endpoints/endpoint/ssh/'
+ 'ssh-server-parameters/keepalives '
+ 'or ../../endpoints/endpoint/tls/'
+ 'tcp-client-parameters/keepalives '
+ 'or ../../endpoints/endpoint/tls/'
+ 'tls-server-parameters/keepalives)';
presence "Indicates that a periodic connection is presence "Indicates that a periodic connection is
to be maintained."; to be maintained.";
description description
"Periodically connect to the NETCONF client. The "Periodically connect to the NETCONF client. The
NETCONF client should close the underlying TLS NETCONF client should close the underlying TLS
connection upon completing planned activities. connection upon completing planned activities.
This connection type increases resource This connection type increases resource
utilization, albeit with increased delay in utilization, albeit with increased delay in
NETCONF client to NETCONF client interactions."; NETCONF client to NETCONF client interactions.";
skipping to change at page 52, line 29 skipping to change at page 38, line 49
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).
6. Security Considerations 6. Security Considerations
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.kwatsen-netconf-tcp-client-server],
[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 modules defined in this document are designed to be accessed
via YANG based management protocols, such as NETCONF [RFC6241] and via YANG based management protocols, such as NETCONF [RFC6241] and
RESTCONF [RFC8040]. Both of these protocols have mandatory-to- RESTCONF [RFC8040]. Both of these protocols have mandatory-to-
implement secure transport layers (e.g., SSH, TLS) with mutual implement secure transport layers (e.g., SSH, TLS) with mutual
authentication. authentication.
The NETCONF access control model (NACM) [RFC8341] provides the means The NETCONF access control model (NACM) [RFC8341] provides the means
to restrict access for particular users to a pre-configured subset of to restrict access for particular users to a pre-configured subset of
all available protocol operations and content. all available protocol operations and content.
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in the YANG modules 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). Some of these data nodes may be considered sensitive or
in some network environments. Write operations (e.g., edit-config) vulnerable in some network environments. Write operations (e.g.,
to these data nodes without proper protection can have a negative edit-config) to these data nodes without proper protection can have a
effect on network operations. These are the subtrees and data nodes negative effect on network operations. These are the subtrees and
and their sensitivity/vulnerability: data nodes and their sensitivity/vulnerability:
/: The entire data trees defined by the modules defined in this None of the subtrees or data nodes in the modules defined in this
draft are sensitive to write operations. For instance, the document need to be protected from write operations.
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 the YANG modules 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 of the subtrees or data nodes in the modules defined in this
document need to be protected from read operations.
Some of the RPC operations in this YANG module may be considered Some of the RPC operations in the YANG modules 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 The modules defined in this document do not define any 'RPC' or
'action' statements.
7. IANA Considerations 7. IANA Considerations
7.1. The IETF XML Registry 7.1. The IETF XML Registry
This document registers two URIs in the "ns" subregistry of the IETF This document registers two URIs in the "ns" subregistry of the IETF
XML Registry [RFC3688]. Following the format in [RFC3688], the XML Registry [RFC3688]. Following the format in [RFC3688], the
following registrations are requested: following registrations are requested:
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-client URI: urn:ietf:params:xml:ns:yang:ietf-netconf-client
skipping to change at page 54, line 27 skipping to change at page 40, line 41
8.1. Normative References 8.1. Normative References
[I-D.ietf-netconf-keystore] [I-D.ietf-netconf-keystore]
Watsen, K., "YANG Data Model for a Centralized Keystore Watsen, K., "YANG Data Model for a Centralized Keystore
Mechanism", draft-ietf-netconf-keystore-08 (work in Mechanism", draft-ietf-netconf-keystore-08 (work in
progress), March 2019. progress), March 2019.
[I-D.ietf-netconf-ssh-client-server] [I-D.ietf-netconf-ssh-client-server]
Watsen, K., Wu, G., and L. Xia, "YANG Groupings for SSH Watsen, K., Wu, G., and L. Xia, "YANG Groupings for SSH
Clients and SSH Servers", draft-ietf-netconf-ssh-client- Clients and SSH Servers", draft-ietf-netconf-ssh-client-
server-08 (work in progress), October 2018. server-11 (work in progress), March 2019.
[I-D.ietf-netconf-tls-client-server] [I-D.ietf-netconf-tls-client-server]
Watsen, K., Wu, G., and L. Xia, "YANG Groupings for TLS Watsen, K., Wu, G., and L. Xia, "YANG Groupings for TLS
Clients and TLS Servers", draft-ietf-netconf-tls-client- Clients and TLS Servers", draft-ietf-netconf-tls-client-
server-08 (work in progress), October 2018. server-10 (work in progress), March 2019.
[I-D.kwatsen-netconf-tcp-client-server] [I-D.kwatsen-netconf-tcp-client-server]
Watsen, K., "YANG Groupings for TCP Clients and TCP Watsen, K., "YANG Groupings for TCP Clients and TCP
Servers", draft-kwatsen-netconf-tcp-client-server-00 (work Servers", draft-kwatsen-netconf-tcp-client-server-00 (work
in progress), March 2019. in progress), March 2019.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
skipping to change at page 56, line 5 skipping to change at page 43, line 5
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>. <https://www.rfc-editor.org/info/rfc8340>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018, DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
Appendix A. Change Log Appendix A. Expanded Tree Diagrams
A.1. 00 to 01 A.1. Expanded Tree Diagram for 'ietf-netconf-client'
The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-netconf-client" module.
This tree diagram shows all the nodes defined in this module,
including those defined by "grouping" statements used by this module.
Please see Section 3.1 for a tree diagram that illustrates what the
module looks like without all the "grouping" statements expanded.
=========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) ===========
module: ietf-netconf-client
+--rw netconf-client
+--rw initiate! {initiate}?
| +--rw netconf-server* [name]
| +--rw name string
| +--rw endpoints
| | +--rw endpoint* [name]
| | +--rw name string
| | +--rw (transport)
| | +--:(ssh) {ssh-initiate}?
| | | +--rw ssh
| | | +--rw tcp-client-parameters
| | | | +--rw remote-address inet:host
| | | | +--rw remote-port? inet:port-number
| | | | +--rw local-address? inet:ip-address
| | | | +--rw local-port? inet:port-number
| | | | +--rw keepalives!
| | | | {tcp-client-keepalives}?
| | | | +--rw idle-time uint16
| | | | +--rw max-probes? uint16
| | | | +--rw probe-interval? uint16
| | | +--rw ssh-client-parameters
| | | +--rw client-identity
| | | | +--rw username? string
| | | | +--rw (auth-type)
| | | | +--:(password)
| | | | | +--rw password? string
| | | | +--:(public-key)
| | | | | +--rw public-key
| | | | | +--rw (local-or-keystore)
| | | | | +--:(local)
| | | | | | {local-keys-sup\
ported}?
| | | | | | +--rw local-definition
| | | | | | +--rw algorithm?
| | | | | | | asymmetric\
-key-algorithm-ref
| | | | | | +--rw public-key?
| | | | | | | binary
| | | | | | +--rw private-key?
| | | | | | | union
| | | | | | +---x generate-hid\
den-key
| | | | | | | +---w input
| | | | | | | +---w algori\
thm
| | | | | | | asym\
metric-key-algorithm-ref
| | | | | | +---x install-hidd\
en-key
| | | | | | +---w input
| | | | | | +---w algori\
thm
| | | | | | | asym\
metric-key-algorithm-ref
| | | | | | +---w public\
-key?
| | | | | | | bina\
ry
| | | | | | +---w privat\
e-key?
| | | | | | bina\
ry
| | | | | +--:(keystore)
| | | | | {keystore-suppo\
rted}?
| | | | | +--rw keystore-refere\
nce?
| | | | | ks:asymmetric\
-key-ref
| | | | +--:(certificate)
| | | | +--rw certificate
| | | | {sshcmn:ssh-x509-certs\
}?
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-sup\
ported}?
| | | | | +--rw local-definition
| | | | | +--rw algorithm?
| | | | | | asymmetric\
-key-algorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
| | | | | +---x generate-hid\
den-key
| | | | | | +---w input
| | | | | | +---w algori\
thm
| | | | | | asym\
metric-key-algorithm-ref
| | | | | +---x install-hidd\
en-key
| | | | | | +---w input
| | | | | | +---w algori\
thm
| | | | | | | asym\
metric-key-algorithm-ref
| | | | | | +---w public\
-key?
| | | | | | | bina\
ry
| | | | | | +---w privat\
e-key?
| | | | | | bina\
ry
| | | | | +--rw cert?
| | | | | | end-entity\
-cert-cms
| | | | | +---n certificate-\
expiration
| | | | | +-- expiration-\
date
| | | | | yang:da\
te-and-time
| | | | +--:(keystore)
| | | | {keystore-suppo\
rted}?
| | | | +--rw keystore-refere\
nce?
| | | | ks:asymmetric\
-key-certificate-ref
| | | +--rw server-authentication
| | | | +--rw pinned-ssh-host-keys?
| | | | | ta:pinned-host-keys-ref
| | | | | {ta:ssh-host-keys}?
| | | | +--rw pinned-ca-certs?
| | | | | ta:pinned-certificates-ref
| | | | | {sshcmn:ssh-x509-certs,ta:x5\
09-certificates}?
| | | | +--rw pinned-server-certs?
| | | | ta:pinned-certificates-ref
| | | | {sshcmn:ssh-x509-certs,ta:x5\
09-certificates}?
| | | +--rw transport-params
| | | | {ssh-client-transport-params-co\
nfig}?
| | | | +--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 keepalives!
| | | {ssh-client-keepalives}?
| | | +--rw max-wait? uint16
| | | +--rw max-attempts? uint8
| | +--:(tls) {tls-initiate}?
| | +--rw tls
| | +--rw tcp-client-parameters
| | | +--rw remote-address inet:host
| | | +--rw remote-port? inet:port-number
| | | +--rw local-address? inet:ip-address
| | | +--rw local-port? inet:port-number
| | | +--rw keepalives!
| | | {tcp-client-keepalives}?
| | | +--rw idle-time uint16
| | | +--rw max-probes? uint16
| | | +--rw probe-interval? uint16
| | +--rw tls-client-parameters
| | +--rw client-identity
| | | +--rw (auth-type)
| | | +--:(certificate)
| | | +--rw certificate
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-sup\
ported}?
| | | | +--rw local-definition
| | | | +--rw algorithm?
| | | | | asymmetric\
-key-algorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hid\
den-key
| | | | | +---w input
| | | | | +---w algori\
thm
| | | | | asym\
metric-key-algorithm-ref
| | | | +---x install-hidd\
en-key
| | | | | +---w input
| | | | | +---w algori\
thm
| | | | | | asym\
metric-key-algorithm-ref
| | | | | +---w public\
-key?
| | | | | | bina\
ry
| | | | | +---w privat\
e-key?
| | | | | bina\
ry
| | | | +--rw cert?
| | | | | end-entity\
-cert-cms
| | | | +---n certificate-\
expiration
| | | | +-- expiration-\
date
| | | | yang:da\
te-and-time
| | | +--:(keystore)
| | | {keystore-suppo\
rted}?
| | | +--rw keystore-refere\
nce?
| | | ks:asymmetric\
-key-certificate-ref
| | +--rw server-authentication
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-server-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw hello-params
| | | {tls-client-hello-params-config\
}?
| | | +--rw tls-versions
| | | | +--rw tls-version* identityref
| | | +--rw cipher-suites
| | | +--rw cipher-suite* identityref
| | +--rw keepalives!
| | {tls-client-keepalives}?
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--rw connection-type
| | +--rw (connection-type)
| | +--:(persistent-connection)
| | | +--rw persistent!
| | +--:(periodic-connection)
| | +--rw periodic!
| | +--rw period? uint16
| | +--rw anchor-time? yang:date-and-time
| | +--rw idle-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 tcp-server-parameters
| | +--rw local-address inet:ip-address
| | +--rw local-port? inet:port-number
| | +--rw keepalives! {tcp-server-keepalives}?
| | +--rw idle-time uint16
| | +--rw max-probes? uint16
| | +--rw probe-interval? uint16
| +--rw ssh-client-parameters
| +--rw client-identity
| | +--rw username? string
| | +--rw (auth-type)
| | +--:(password)
| | | +--rw password? string
| | +--:(public-key)
| | | +--rw public-key
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-supported\
}?
| | | | +--rw local-definition
| | | | +--rw algorithm?
| | | | | asymmetric-key-a\
lgorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | asymmetric\
-key-algorithm-ref
| | | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric\
-key-algorithm-ref
| | | | +---w public-key?
| | | | | binary
| | | | +---w private-key?
| | | | binary
| | | +--:(keystore)
| | | {keystore-supported}?
| | | +--rw keystore-reference?
| | | ks:asymmetric-key-r\
ef
| | +--:(certificate)
| | +--rw certificate
| | {sshcmn:ssh-x509-certs}?
| | +--rw (local-or-keystore)
| | +--:(local)
| | | {local-keys-supported\
}?
| | | +--rw local-definition
| | | +--rw algorithm?
| | | | asymmetric-key-a\
lgorithm-ref
| | | +--rw public-key?
| | | | binary
| | | +--rw private-key?
| | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | asymmetric\
-key-algorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric\
-key-algorithm-ref
| | | | +---w public-key?
| | | | | binary
| | | | +---w private-key?
| | | | binary
| | | +--rw cert?
| | | | end-entity-cert-\
cms
| | | +---n certificate-expira\
tion
| | | +-- expiration-date
| | | yang:date-and\
-time
| | +--:(keystore)
| | {keystore-supported}?
| | +--rw keystore-reference?
| | ks:asymmetric-key-c\
ertificate-ref
| +--rw server-authentication
| | +--rw pinned-ssh-host-keys?
| | | ta:pinned-host-keys-ref
| | | {ta:ssh-host-keys}?
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {sshcmn:ssh-x509-certs,ta:x509-cer\
tificates}?
| | +--rw pinned-server-certs?
| | ta:pinned-certificates-ref
| | {sshcmn:ssh-x509-certs,ta:x509-cer\
tificates}?
| +--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 keepalives! {ssh-client-keepalives}?
| +--rw max-wait? uint16
| +--rw max-attempts? uint8
+--:(tls) {tls-listen}?
+--rw tls
+--rw tcp-server-parameters
| +--rw local-address inet:ip-address
| +--rw local-port? inet:port-number
| +--rw keepalives! {tcp-server-keepalives}?
| +--rw idle-time uint16
| +--rw max-probes? uint16
| +--rw probe-interval? uint16
+--rw tls-client-parameters
+--rw client-identity
| +--rw (auth-type)
| +--:(certificate)
| +--rw certificate
| +--rw (local-or-keystore)
| +--:(local)
| | {local-keys-supported\
}?
| | +--rw local-definition
| | +--rw algorithm?
| | | asymmetric-key-a\
lgorithm-ref
| | +--rw public-key?
| | | binary
| | +--rw private-key?
| | | union
| | +---x generate-hidden-key
| | | +---w input
| | | +---w algorithm
| | | asymmetric\
-key-algorithm-ref
| | +---x install-hidden-key
| | | +---w input
| | | +---w algorithm
| | | | asymmetric\
-key-algorithm-ref
| | | +---w public-key?
| | | | binary
| | | +---w private-key?
| | | binary
| | +--rw cert?
| | | end-entity-cert-\
cms
| | +---n certificate-expira\
tion
| | +-- expiration-date
| | yang:date-and\
-time
| +--:(keystore)
| {keystore-supported}?
| +--rw keystore-reference?
| ks:asymmetric-key-c\
ertificate-ref
+--rw server-authentication
| +--rw pinned-ca-certs?
| | ta:pinned-certificates-ref
| | {ta:x509-certificates}?
| +--rw pinned-server-certs?
| ta:pinned-certificates-ref
| {ta:x509-certificates}?
+--rw hello-params
| {tls-client-hello-params-config}?
| +--rw tls-versions
| | +--rw tls-version* identityref
| +--rw cipher-suites
| +--rw cipher-suite* identityref
+--rw keepalives! {tls-client-keepalives}?
+--rw max-wait? uint16
+--rw max-attempts? uint8
A.2. Expanded Tree Diagram for 'ietf-netconf-server'
The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-netconf-server" module.
This tree diagram shows all the nodes defined in this module,
including those defined by "grouping" statements used by this module.
Please see Section 4.1 for a tree diagram that illustrates what the
module looks like without all the "grouping" statements expanded.
=========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) ===========
module: ietf-netconf-server
+--rw netconf-server
+--rw listen! {listen}?
| +--rw idle-timeout? uint16
| +--rw endpoint* [name]
| +--rw name string
| +--rw (transport)
| +--:(ssh) {ssh-listen}?
| | +--rw ssh
| | +--rw tcp-server-parameters
| | | +--rw local-address inet:ip-address
| | | +--rw local-port? inet:port-number
| | | +--rw keepalives! {tcp-server-keepalives}?
| | | +--rw idle-time uint16
| | | +--rw max-probes? uint16
| | | +--rw probe-interval? uint16
| | +--rw ssh-server-parameters
| | +--rw server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-suppor\
ted}?
| | | | | +--rw local-definition
| | | | | +--rw algorithm?
| | | | | | asymmetric-ke\
y-algorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
| | | | | +---x generate-hidden\
-key
| | | | | | +---w input
| | | | | | +---w algorithm
| | | | | | asymmet\
ric-key-algorithm-ref
| | | | | +---x install-hidden-\
key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | asymmet\
ric-key-algorithm-ref
| | | | | +---w public-ke\
y?
| | | | | | binary
| | | | | +---w private-k\
ey?
| | | | | binary
| | | | +--:(keystore)
| | | | {keystore-supporte\
d}?
| | | | +--rw keystore-reference?
| | | | ks:asymmetric-ke\
y-ref
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-suppor\
ted}?
| | | | +--rw local-definition
| | | | +--rw algorithm?
| | | | | asymmetric-ke\
y-algorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hidden\
-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | asymmet\
ric-key-algorithm-ref
| | | | +---x install-hidden-\
key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | asymmet\
ric-key-algorithm-ref
| | | | | +---w public-ke\
y?
| | | | | | binary
| | | | | +---w private-k\
ey?
| | | | | binary
| | | | +--rw cert?
| | | | | end-entity-ce\
rt-cms
| | | | +---n certificate-exp\
iration
| | | | +-- expiration-date
| | | | yang:date-\
and-time
| | | +--:(keystore)
| | | {keystore-supporte\
d}?
| | | +--rw keystore-reference?
| | | ks:asymmetric-ke\
y-certificate-ref
| | +--rw client-cert-auth
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw transport-params
| | | {ssh-server-transport-params-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 keepalives! {ssh-server-keepalives}?
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--:(tls) {tls-listen}?
| +--rw tls
| +--rw tcp-server-parameters
| | +--rw local-address inet:ip-address
| | +--rw local-port? inet:port-number
| | +--rw keepalives! {tcp-server-keepalives}?
| | +--rw idle-time uint16
| | +--rw max-probes? uint16
| | +--rw probe-interval? uint16
| +--rw tls-server-parameters
| +--rw server-identity
| | +--rw (local-or-keystore)
| | +--:(local) {local-keys-supported}?
| | | +--rw local-definition
| | | +--rw algorithm?
| | | | asymmetric-key-algorithm-\
ref
| | | +--rw public-key?
| | | | binary
| | | +--rw private-key?
| | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | asymmetric-key-algo\
rithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric-key-algo\
rithm-ref
| | | | +---w public-key? binary
| | | | +---w private-key? binary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
| | | yang:date-and-time
| | +--:(keystore) {keystore-supported}?
| | +--rw keystore-reference?
| | ks:asymmetric-key-certificat\
e-ref
| +--rw client-authentication
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw cert-maps
| | +--rw cert-to-name* [id]
| | +--rw id uint32
| | +--rw fingerprint
| | | x509c2n:tls-fingerprint
| | +--rw map-type identityref
| | +--rw name string
| +--rw hello-params
| | {tls-server-hello-params-config}?
| | +--rw tls-versions
| | | +--rw tls-version* identityref
| | +--rw cipher-suites
| | +--rw cipher-suite* identityref
| +--rw keepalives! {tls-server-keepalives}?
| +--rw max-wait? uint16
| +--rw max-attempts? uint8
+--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 tcp-client-parameters
| | | +--rw remote-address inet:host
| | | +--rw remote-port? inet:port-number
| | | +--rw local-address? inet:ip-address
| | | +--rw local-port? inet:port-number
| | | +--rw keepalives!
| | | {tcp-client-keepalives}?
| | | +--rw idle-time uint16
| | | +--rw max-probes? uint16
| | | +--rw probe-interval? uint16
| | +--rw ssh-server-parameters
| | +--rw server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-\
supported}?
| | | | | +--rw local-defini\
tion
| | | | | +--rw algorithm?
| | | | | | asymmet\
ric-key-algorithm-ref
| | | | | +--rw public-ke\
y?
| | | | | | binary
| | | | | +--rw private-k\
ey?
| | | | | | union
| | | | | +---x generate-\
hidden-key
| | | | | | +---w input
| | | | | | +---w alg\
orithm
| | | | | | a\
symmetric-key-algorithm-ref
| | | | | +---x install-h\
idden-key
| | | | | +---w input
| | | | | +---w alg\
orithm
| | | | | | a\
symmetric-key-algorithm-ref
| | | | | +---w pub\
lic-key?
| | | | | | b\
inary
| | | | | +---w pri\
vate-key?
| | | | | b\
inary
| | | | +--:(keystore)
| | | | {keystore-su\
pported}?
| | | | +--rw keystore-ref\
erence?
| | | | ks:asymmet\
ric-key-ref
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-ce\
rts}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-\
supported}?
| | | | +--rw local-defini\
tion
| | | | +--rw algorithm?
| | | | | asymmet\
ric-key-algorithm-ref
| | | | +--rw public-ke\
y?
| | | | | binary
| | | | +--rw private-k\
ey?
| | | | | union
| | | | +---x generate-\
hidden-key
| | | | | +---w input
| | | | | +---w alg\
orithm
| | | | | a\
symmetric-key-algorithm-ref
| | | | +---x install-h\
idden-key
| | | | | +---w input
| | | | | +---w alg\
orithm
| | | | | | a\
symmetric-key-algorithm-ref
| | | | | +---w pub\
lic-key?
| | | | | | b\
inary
| | | | | +---w pri\
vate-key?
| | | | | b\
inary
| | | | +--rw cert?
| | | | | end-ent\
ity-cert-cms
| | | | +---n certifica\
te-expiration
| | | | +-- expirati\
on-date
| | | | yang\
:date-and-time
| | | +--:(keystore)
| | | {keystore-su\
pported}?
| | | +--rw keystore-ref\
erence?
| | | ks:asymmet\
ric-key-certificate-ref
| | +--rw client-cert-auth
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw transport-params
| | | {ssh-server-transport-params-co\
nfig}?
| | | +--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 keepalives!
| | {ssh-server-keepalives}?
| | +--rw max-wait? uint16
| | +--rw max-attempts? uint8
| +--:(tls) {tls-call-home}?
| +--rw tls
| +--rw tcp-client-parameters
| | +--rw remote-address inet:host
| | +--rw remote-port? inet:port-number
| | +--rw local-address? inet:ip-address
| | +--rw local-port? inet:port-number
| | +--rw keepalives!
| | {tcp-client-keepalives}?
| | +--rw idle-time uint16
| | +--rw max-probes? uint16
| | +--rw probe-interval? uint16
| +--rw tls-server-parameters
| +--rw server-identity
| | +--rw (local-or-keystore)
| | +--:(local)
| | | {local-keys-supported}?
| | | +--rw local-definition
| | | +--rw algorithm?
| | | | asymmetric-key-algo\
rithm-ref
| | | +--rw public-key?
| | | | binary
| | | +--rw private-key?
| | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | asymmetric-ke\
y-algorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric-ke\
y-algorithm-ref
| | | | +---w public-key?
| | | | | binary
| | | | +---w private-key?
| | | | binary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
| | | yang:date-and-ti\
me
| | +--:(keystore)
| | {keystore-supported}?
| | +--rw keystore-reference?
| | ks:asymmetric-key-cert\
ificate-ref
| +--rw client-authentication
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw cert-maps
| | +--rw cert-to-name* [id]
| | +--rw id uint32
| | +--rw fingerprint
| | | x509c2n:tls-fingerprint
| | +--rw map-type
| | | identityref
| | +--rw name string
| +--rw hello-params
| | {tls-server-hello-params-config\
}?
| | +--rw tls-versions
| | | +--rw tls-version* identityref
| | +--rw cipher-suites
| | +--rw cipher-suite* identityref
| +--rw keepalives!
| {tls-server-keepalives}?
| +--rw max-wait? uint16
| +--rw max-attempts? uint8
+--rw connection-type
| +--rw (connection-type)
| +--:(persistent-connection)
| | +--rw persistent!
| +--:(periodic-connection)
| +--rw periodic!
| +--rw period? uint16
| +--rw anchor-time? yang:date-and-time
| +--rw idle-timeout? uint16
+--rw reconnect-strategy
+--rw start-with? enumeration
+--rw max-attempts? uint8
Appendix B. Change Log
B.1. 00 to 01
o Renamed "keychain" to "keystore". o Renamed "keychain" to "keystore".
A.2. 01 to 02 B.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 accommodate new groupings in the ssh/tls o Updated both modules to accommodate new groupings in the ssh/tls
drafts. drafts.
A.3. 02 to 03 B.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.4. 03 to 04 B.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.
A.5. 04 to 05 B.5. 04 to 05
o Now tree diagrams reference ietf-netmod-yang-tree-diagrams o Now tree diagrams reference ietf-netmod-yang-tree-diagrams
o Updated examples to inline key and certificates (no longer a o Updated examples to inline key and certificates (no longer a
leafref to keystore) leafref to keystore)
A.6. 05 to 06 B.6. 05 to 06
o Fixed change log missing section issue. o Fixed change log missing section issue.
o Updated examples to match latest updates to the crypto-types, o Updated examples to match latest updates to the crypto-types,
trust-anchors, and keystore drafts. trust-anchors, and keystore drafts.
o Reduced line length of the YANG modules to fit within 69 columns. o Reduced line length of the YANG modules to fit within 69 columns.
A.7. 06 to 07 B.7. 06 to 07
o Removed "idle-timeout" from "persistent" connection config. o Removed "idle-timeout" from "persistent" connection config.
o Added "random-selection" for reconnection-strategy's "starts-with" o Added "random-selection" for reconnection-strategy's "starts-with"
enum. enum.
o Replaced "connection-type" choice default (persistent) with o Replaced "connection-type" choice default (persistent) with
"mandatory true". "mandatory true".
o Reduced the periodic-connection's "idle-timeout" from 5 to 2 o Reduced the periodic-connection's "idle-timeout" from 5 to 2
minutes. minutes.
o Replaced reconnect-timeout with period/anchor-time combo. o Replaced reconnect-timeout with period/anchor-time combo.
A.8. 07 to 08 B.8. 07 to 08
o Modified examples to be compatible with new crypto-types algs o Modified examples to be compatible with new crypto-types algs
Appendix B. 08 to 09 B.9. 08 to 09
o Corrected use of "mandatory true" for "address" leafs. o Corrected use of "mandatory true" for "address" leafs.
o Updated examples to reflect update to groupings defined in the o Updated examples to reflect update to groupings defined in the
keystore draft. keystore draft.
o Updated to use groupings defined in new TCP and HTTP drafts. o Updated to use groupings defined in new TCP and HTTP drafts.
o Updated copyright date, boilerplate template, affiliation, and o Updated copyright date, boilerplate template, affiliation, and
folding algorithm. folding algorithm.
B.10. 09 to 10
o Reformatted YANG modules.
B.11. 10 to 11
o Adjusted for the top-level "demux container" added to groupings
imported from other modules.
o Added "must" expressions to ensure that keepalives are not
configured for "periodic" connections.
o Updated the boilerplate text in module-level "description"
statement to match copyeditor convention.
o Moved "expanded" tree diagrams to the Appendix.
Acknowledgements 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, Ramkumar Dhanapal, Mehmet Ersue, Balazs Bjorklund, Benoit Claise, Ramkumar Dhanapal, Mehmet Ersue, Balazs
Kovacs, David Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Kovacs, David Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci,
Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert
Wijnen. Wijnen.
Author's Address Author's Address
 End of changes. 99 change blocks. 
1231 lines changed or deleted 1478 lines changed or added

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