| Sean Condon | fae8e66 | 2016-12-15 10:25:13 +0000 | [diff] [blame] | 1 | module ietf-netconf-with-defaults { |
| 2 | |
| 3 | namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"; |
| 4 | |
| 5 | prefix ncwd; |
| 6 | |
| 7 | import ietf-netconf { prefix nc; } |
| 8 | |
| 9 | organization |
| 10 | "IETF NETCONF (Network Configuration Protocol) Working Group"; |
| 11 | |
| 12 | contact |
| 13 | "WG Web: <http://tools.ietf.org/wg/netconf/> |
| 14 | WG List: <mailto:netconf@ietf.org> |
| 15 | |
| 16 | WG Chair: Bert Wijnen |
| 17 | <mailto:bertietf@bwijnen.net> |
| 18 | |
| 19 | WG Chair: Mehmet Ersue |
| 20 | <mailto:mehmet.ersue@nsn.com> |
| 21 | |
| 22 | Editor: Andy Bierman |
| 23 | <mailto:andy.bierman@brocade.com> |
| 24 | |
| 25 | Editor: Balazs Lengyel |
| 26 | <mailto:balazs.lengyel@ericsson.com>"; |
| 27 | |
| 28 | description |
| 29 | "This module defines an extension to the NETCONF protocol |
| 30 | that allows the NETCONF client to control how default |
| 31 | values are handled by the server in particular NETCONF operations. |
| 32 | |
| 33 | Copyright (c) 2010 IETF Trust and the persons identified as |
| 34 | the document authors. All rights reserved. |
| 35 | |
| 36 | Redistribution and use in source and binary forms, with or |
| 37 | without modification, is permitted pursuant to, and subject |
| 38 | to the license terms contained in, the Simplified BSD License |
| 39 | set forth in Section 4.c of the IETF Trust's Legal Provisions |
| 40 | Relating to IETF Documents |
| 41 | (http://trustee.ietf.org/license-info). |
| 42 | |
| 43 | This version of this YANG module is part of RFC XXXX; see |
| 44 | the RFC itself for full legal notices."; |
| 45 | // RFC Ed.: replace XXXX with actual RFC number and remove this note |
| 46 | |
| 47 | // RFC Ed.: remove this note |
| 48 | // Note: extracted from draft-ietf-netmod-with-defaults-10.txt |
| 49 | |
| 50 | revision 2010-06-09 { |
| 51 | description |
| 52 | "Initial version."; |
| 53 | reference |
| 54 | "RFC XXXX: With-defaults capability for NETCONF"; |
| 55 | } |
| 56 | // RFC Ed.: replace XXXX with actual |
| 57 | // RFC number and remove this note |
| 58 | |
| 59 | typedef with-defaults-mode { |
| 60 | description |
| 61 | "Possible modes to report default data."; |
| 62 | reference |
| 63 | "RFC XXXX; section 3."; |
| 64 | // RFC Ed.: replace XXXX with actual |
| 65 | // RFC number and remove this note |
| 66 | |
| 67 | type enumeration { |
| 68 | enum report-all { |
| 69 | description |
| 70 | "All default data is reported."; |
| 71 | reference |
| 72 | "RFC XXXX; section 3.1"; |
| 73 | // RFC Ed.: replace XXXX with actual |
| 74 | // RFC number and remove this note |
| 75 | |
| 76 | } |
| 77 | enum report-all-tagged { |
| 78 | description |
| 79 | "All default data is reported. |
| 80 | Any nodes considered to be default data |
| 81 | will contain a 'wd:default' XML attribute, |
| 82 | set to 'true'."; |
| 83 | reference |
| 84 | "RFC XXXX; section 3.4"; |
| 85 | // RFC Ed.: replace XXXX with actual |
| 86 | // RFC number and remove this note |
| 87 | } |
| 88 | enum trim { |
| 89 | description |
| 90 | "Values are not reported if they contain the default."; |
| 91 | reference |
| 92 | "RFC XXXX; section 3.2"; |
| 93 | // RFC Ed.: replace XXXX with actual |
| 94 | // RFC number and remove this note |
| 95 | |
| 96 | } |
| 97 | enum explicit { |
| 98 | description |
| 99 | "Report values that contain the definition of |
| 100 | explicitly set data."; |
| 101 | reference |
| 102 | "RFC XXXX; section 3.3"; |
| 103 | // RFC Ed.: replace XXXX with actual |
| 104 | // RFC number and remove this note |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | |
| 109 | grouping with-defaults-parameters { |
| 110 | description |
| 111 | "Contains the <with-defaults> parameter for control |
| 112 | of defaults in NETCONF retrieval operations."; |
| 113 | |
| 114 | leaf with-defaults { |
| 115 | description |
| 116 | "The explicit defaults processing mode requested."; |
| 117 | reference |
| 118 | "RFC XXXX; section 4.6.1"; |
| 119 | // RFC Ed.: replace XXXX with actual |
| 120 | // RFC number and remove this note |
| 121 | |
| 122 | type with-defaults-mode; |
| 123 | } |
| 124 | } |
| 125 | |
| 126 | // extending the get-config operation |
| 127 | augment /nc:get-config/nc:input { |
| 128 | description |
| 129 | "Adds the <with-defaults> parameter to the |
| 130 | input of the NETCONF <get-config> operation."; |
| 131 | reference |
| 132 | "RFC XXXX; section 4.6.1"; |
| 133 | // RFC Ed.: replace XXXX with actual |
| 134 | // RFC number and remove this note |
| 135 | |
| 136 | uses with-defaults-parameters; |
| 137 | } |
| 138 | |
| 139 | // extending the get operation |
| 140 | augment /nc:get/nc:input { |
| 141 | description |
| 142 | "Adds the <with-defaults> parameter to |
| 143 | the input of the NETCONF <get> operation."; |
| 144 | reference |
| 145 | "RFC XXXX; section 4.6.1"; |
| 146 | // RFC Ed.: replace XXXX with actual |
| 147 | // RFC number and remove this note |
| 148 | |
| 149 | uses with-defaults-parameters; |
| 150 | } |
| 151 | |
| 152 | // extending the copy-config operation |
| 153 | augment /nc:copy-config/nc:input { |
| 154 | description |
| 155 | "Adds the <with-defaults> parameter to |
| 156 | the input of the NETCONF <copy-config> operation."; |
| 157 | reference |
| 158 | "RFC XXXX; section 4.6.1"; |
| 159 | // RFC Ed.: replace XXXX with actual |
| 160 | // RFC number and remove this note |
| 161 | |
| 162 | uses with-defaults-parameters; |
| 163 | } |
| 164 | |
| 165 | } |