netconf rfc

Internet Engineering Task Force (IETF) R. Enns, Ed.

Request for Comments: 6241 Juniper Networks

Obsoletes:

4741 M. Bjorklund, Ed.

Category: Standards Track Tail-f Systems

ISSN: 2070-1721 J. Schoenwaelder, Ed.

Jacobs University

A. Bierman, Ed.

Brocade

Language (XML)-based data encoding for the configuration data as well

as the protocol messages. The NETCONF protocol operations are

realized as remote procedure calls (RPCs). This document obsoletes

RFC 4741.

Status of This Memo

This is an Internet Standards Track document.

This document is a product of the Internet Engineering Task Force

(IETF). It represents the consensus of the IETF community. It has

received public review and has been approved for publication by the

Enns, et al. Standards Track [Page 1]

RFC 6241

NETCONF Protocol June 2011

Copyright Notice

Copyright (c) 2011 IETF Trust and the persons identified as the

document authors. All rights reserved.

This document is subject to

BCP 78 and the IETF Trust’s Legal

Provisions Relating to IETF Documents

(

http://trustee.ietf.org/license-info) in effect on the date of

This document may contain material from IETF Documents or IETF

Contributions published or made publicly available before November

10, 2008. The person(s) controlling the copyright in some of this

material may not have granted the IETF Trust the right to allow

modifications of such material outside the IETF Standards Process.

Without obtaining an adequate license from the person(s) controlling

the copyright in such materials, this document may not be modified

outside the IETF Standards Process, and derivative works of it may

not be created outside the IETF Standards Process, except to format

it for publication as an RFC or to translate it into languages other

RFC 6241

NETCONF Protocol June 2011

Table of Contents

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 6

1.3. Capabilities . . . . . . . . . . . . . . . . . . . . . . 10

2. Transport Protocol Requirements . . . . . . . . . . . . . . . 11

2.2. Authentication, Integrity, and Confidentiality . . . . . 12

2.3. Mandatory Transport Protocol . . . . . . . . . . . . . . 12

3. XML Considerations . . . . . . . . . . . . . . . . . . . . . 13

3.1. Namespace . . . . . . . . . . . . . . . . . . . . . . . . 13

4. RPC Model . . . . . . . . . . . . . . . . . . . . . . . . . . 13

4.1. <rpc> Element . . . . . . . . . . . . . . . . . . . . . . 13

4.2. <rpc-reply> Element . . . . . . . . . . . . . . . . . . . 15

4.3. <rpc-error> Element . . . . . . . . . . . . . . . . . . . 16

4.4. <ok> Element . . . . . . . . . . . . . . . . . . . . . . 19

4.5. Pipelining . . . . . . . . . . . . . . . . . . . . . . . 19

5. Configuration Model . . . . . . . . . . . . . . . . . . . . . 19

6.2.3. Containment Nodes . . . . . . . . . . . . . . . . . . 23

6.2.4. Selection Nodes . . . . . . . . . . . . . . . . . . . 23

6.2.5. Content Match Nodes . . . . . . . . . . . . . . . . . 24

6.4. Subtree Filtering Examples . . . . . . . . . . . . . . . 26

6.4.1. No Filter . . . . . . . . . . . . . . . . . . . . . . 26

6.4.2. Empty Filter . . . . . . . . . . . . . . . . . . . . 26

6.4.3. Select the Entire <users> Subtree . . . . . . . . . . 27

6.4.4. Select All <name> Elements within the <users>

Subtree . . . . . . . . . . . . . . . . . . . . . . .

29

7.2. <edit-config> . . . . . . . . . . . . . . . . . . . . . . 37

7.3. <copy-config> . . . . . . . . . . . . . . . . . . . . . . 43

7.4. <delete-config> . . . . . . . . . . . . . . . . . . . . . 44

7.5. <lock> . . . . . . . . . . . . . . . . . . . . . . . . . 44

Enns, et al. Standards Track [Page 3]

RFC 6241

NETCONF Protocol June 2011

7.6. <unlock> . . . . . . . . . . . . . . . . . . . . . . . . 47

7.7. <get> . . . . . . . . . . . . . . . . . . . . . . . . . . 48

7.8. <close-session> . . . . . . . . . . . . . . . . . . . . . 49

8.1. Capabilities Exchange . . . . . . . . . . . . . . . . . . 51

8.2.1. Description . . . . . . . . . . . . . . . . . . . . . 53

8.2.3. Capability Identifier . . . . . . . . . . . . . . . . 53

8.2.4. New Operations . . . . . . . . . . . . . . . . . . . 53

8.2.5. Modifications to Existing Operations . . . . . . . . 53

8.3. Candidate Configuration Capability . . . . . . . . . . . 53

8.3.2. Dependencies . . . . . . . . . . . . . . . . . . . . 54

8.3.3. Capability Identifier . . . . . . . . . . . . . . . . 54

8.3.4. New Operations . . . . . . . . . . . . . . . . . . . 54

8.3.5. Modifications to Existing Operations . . . . . . . . 56

8.4. Confirmed Commit Capability . . . . . . . . . . . . . . . 57

8.4.1. Description . . . . . . . . . . . . . . . . . . . . . 57

8.4.2. Dependencies . . . . . . . . . . . . . . . . . . . . 58

8.5.4. New Operations . . . . . . . . . . . . . . . . . . . 62

8.5.5. Modifications to Existing Operations . . . . . . . . 62

8.6. Validate Capability . . . . . . . . . . . . . . . . . . . 63

8.6.2. Dependencies . . . . . . . . . . . . . . . . . . . . 63

8.6.3. Capability Identifier . . . . . . . . . . . . . . . . 63

8.6.4. New Operations . . . . . . . . . . . . . . . . . . . 63

8.6.5. Modifications to Existing Operations . . . . . . . . 64

8.7. Distinct Startup Capability . . . . . . . . . . . . . . . 64

8.7.1. Description . . . . . . . . . . . . . . . . . . . . . 64

8.8.2. Dependencies . . . . . . . . . . . . . . . . . . . . 66

8.8.3. Capability Identifier . . . . . . . . . . . . . . . . 66

8.8.4. New Operations . . . . . . . . . . . . . . . . . . . 66

8.8.5. Modifications to Existing Operations . . . . . . . . 66

Enns, et al. Standards Track [Page 4]

RFC 6241

NETCONF Protocol June 2011

8.9. XPath Capability . . . . . . . . . . . . . . . . . . . . 67

8.9.1. Description . . . . . . . . . . . . . . . . . . . . . 67

8.9.2. Dependencies . . . . . . . . . . . . . . . . . . . . 68

8.9.5. Modifications to Existing Operations . . . . . . . . 68

10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 71

10.2. NETCONF XML Schema . . . . . . . . . . . . . . . . . . . 71

10.3. NETCONF YANG Module . . . . . . . . . . . . . . . . . . . 72

10.4. NETCONF Capability URNs . . . . . . . . . . . . . . . . . 72

11. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 73

13. References . . . . . . . . . . . . . . . . . . . . . . . . . 74

13.1. Normative References . . . . . . . . . . . . . . . . . . 74

13.2. Informative References . . . . . . . . . . . . . . . . . 75

Appendix A. NETCONF Error List . . . . . . . . . . . . . . . . . 76

Appendix B. XML Schema for NETCONF Messages Layer . . . . . . . 80

Appendix C. YANG Module for NETCONF Protocol Operations . . . . 85

Appendix D. Capability Template . . . . . . . . . . . . . . . . 105

Appendix E. Configuring Multiple Devices with NETCONF . . . . . 106

E.1. Operations on Individual Devices . . . . . . . . . . . . 106

E.1.1. Acquiring the Configuration Lock . . . . . . . . . . 106

E.1.3. Loading and Validating the Incoming Configuration . . 108

E.1.4. Changing the Running Configuration . . . . . . . . . 108

E.1.5. Testing the New Configuration . . . . . . . . . . . . 109

E.1.6. Making the Change Permanent . . . . . . . . . . . . . 109

E.1.7. Releasing the Configuration Lock . . . . . . . . . . 110

E.2. Operations on Multiple Devices . . . . . . . . . . . . . 111

Enns, et al. Standards Track [Page 5]