Radek Krejci | ce24ab8 | 2015-10-08 15:37:02 +0200 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <module name="ietf-netconf" |
| 3 | xmlns="urn:ietf:params:xml:ns:yang:yin:1" |
| 4 | xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" |
| 5 | xmlns:inet="urn:ietf:params:xml:ns:yang:ietf-inet-types" |
| 6 | xmlns:nacm="urn:ietf:params:xml:ns:yang:ietf-netconf-acm"> |
| 7 | <namespace uri="urn:ietf:params:xml:ns:netconf:base:1.0"/> |
| 8 | <prefix value="nc"/> |
| 9 | <import module="ietf-inet-types"> |
| 10 | <prefix value="inet"/> |
| 11 | </import> |
| 12 | <import module="ietf-netconf-acm"> |
| 13 | <prefix value="nacm"/> |
| 14 | </import> |
| 15 | <organization> |
| 16 | <text>IETF NETCONF (Network Configuration) Working Group</text> |
| 17 | </organization> |
| 18 | <contact> |
| 19 | <text>WG Web: <http://tools.ietf.org/wg/netconf/> |
| 20 | WG List: <netconf@ietf.org> |
| 21 | |
| 22 | WG Chair: Bert Wijnen |
| 23 | <bertietf@bwijnen.net> |
| 24 | |
| 25 | WG Chair: Mehmet Ersue |
| 26 | <mehmet.ersue@nsn.com> |
| 27 | |
| 28 | Editor: Martin Bjorklund |
| 29 | <mbj@tail-f.com> |
| 30 | |
| 31 | Editor: Juergen Schoenwaelder |
| 32 | <j.schoenwaelder@jacobs-university.de> |
| 33 | |
| 34 | Editor: Andy Bierman |
| 35 | <andy.bierman@brocade.com></text> |
| 36 | </contact> |
| 37 | <description> |
| 38 | <text>NETCONF Protocol Data Types and Protocol Operations. |
| 39 | |
| 40 | Copyright (c) 2011 IETF Trust and the persons identified as |
| 41 | the document authors. All rights reserved. |
| 42 | |
| 43 | Redistribution and use in source and binary forms, with or |
| 44 | without modification, is permitted pursuant to, and subject |
| 45 | to the license terms contained in, the Simplified BSD License |
| 46 | set forth in Section 4.c of the IETF Trust's Legal Provisions |
| 47 | Relating to IETF Documents |
| 48 | (http://trustee.ietf.org/license-info). |
| 49 | |
| 50 | This version of this YANG module is part of RFC 6241; see |
| 51 | the RFC itself for full legal notices.</text> |
| 52 | </description> |
| 53 | <revision date="2011-06-01"> |
| 54 | <description> |
| 55 | <text>Initial revision; |
| 56 | 2013-09-29: Updated to include NACM attributes, |
| 57 | as specified in RFC 6536: sec 3.2.5 and 3.2.8</text> |
| 58 | </description> |
| 59 | <reference> |
| 60 | <text>RFC 6241: Network Configuration Protocol</text> |
| 61 | </reference> |
| 62 | </revision> |
| 63 | <extension name="get-filter-element-attributes"> |
| 64 | <description> |
| 65 | <text>If this extension is present within an 'anyxml' |
| 66 | statement named 'filter', which must be conceptually |
| 67 | defined within the RPC input section for the <get> |
| 68 | and <get-config> protocol operations, then the |
| 69 | following unqualified XML attribute is supported |
| 70 | within the <filter> element, within a <get> or |
| 71 | <get-config> protocol operation: |
| 72 | |
| 73 | type : optional attribute with allowed |
| 74 | value strings 'subtree' and 'xpath'. |
| 75 | If missing, the default value is 'subtree'. |
| 76 | |
| 77 | If the 'xpath' feature is supported, then the |
| 78 | following unqualified XML attribute is |
| 79 | also supported: |
| 80 | |
| 81 | select: optional attribute containing a |
| 82 | string representing an XPath expression. |
| 83 | The 'type' attribute must be equal to 'xpath' |
| 84 | if this attribute is present.</text> |
| 85 | </description> |
| 86 | </extension> |
| 87 | <feature name="writable-running"> |
| 88 | <description> |
| 89 | <text>NETCONF :writable-running capability; |
| 90 | If the server advertises the :writable-running |
| 91 | capability for a session, then this feature must |
| 92 | also be enabled for that session. Otherwise, |
| 93 | this feature must not be enabled.</text> |
| 94 | </description> |
| 95 | <reference> |
| 96 | <text>RFC 6241, Section 8.2</text> |
| 97 | </reference> |
| 98 | </feature> |
| 99 | <feature name="candidate"> |
| 100 | <description> |
| 101 | <text>NETCONF :candidate capability; |
| 102 | If the server advertises the :candidate |
| 103 | capability for a session, then this feature must |
| 104 | also be enabled for that session. Otherwise, |
| 105 | this feature must not be enabled.</text> |
| 106 | </description> |
| 107 | <reference> |
| 108 | <text>RFC 6241, Section 8.3</text> |
| 109 | </reference> |
| 110 | </feature> |
| 111 | <feature name="confirmed-commit"> |
| 112 | <if-feature name="candidate"/> |
| 113 | <description> |
| 114 | <text>NETCONF :confirmed-commit:1.1 capability; |
| 115 | If the server advertises the :confirmed-commit:1.1 |
| 116 | capability for a session, then this feature must |
| 117 | also be enabled for that session. Otherwise, |
| 118 | this feature must not be enabled.</text> |
| 119 | </description> |
| 120 | <reference> |
| 121 | <text>RFC 6241, Section 8.4</text> |
| 122 | </reference> |
| 123 | </feature> |
| 124 | <feature name="rollback-on-error"> |
| 125 | <description> |
| 126 | <text>NETCONF :rollback-on-error capability; |
| 127 | If the server advertises the :rollback-on-error |
| 128 | capability for a session, then this feature must |
| 129 | also be enabled for that session. Otherwise, |
| 130 | this feature must not be enabled.</text> |
| 131 | </description> |
| 132 | <reference> |
| 133 | <text>RFC 6241, Section 8.5</text> |
| 134 | </reference> |
| 135 | </feature> |
| 136 | <feature name="validate"> |
| 137 | <description> |
| 138 | <text>NETCONF :validate:1.1 capability; |
| 139 | If the server advertises the :validate:1.1 |
| 140 | capability for a session, then this feature must |
| 141 | also be enabled for that session. Otherwise, |
| 142 | this feature must not be enabled.</text> |
| 143 | </description> |
| 144 | <reference> |
| 145 | <text>RFC 6241, Section 8.6</text> |
| 146 | </reference> |
| 147 | </feature> |
| 148 | <feature name="startup"> |
| 149 | <description> |
| 150 | <text>NETCONF :startup capability; |
| 151 | If the server advertises the :startup |
| 152 | capability for a session, then this feature must |
| 153 | also be enabled for that session. Otherwise, |
| 154 | this feature must not be enabled.</text> |
| 155 | </description> |
| 156 | <reference> |
| 157 | <text>RFC 6241, Section 8.7</text> |
| 158 | </reference> |
| 159 | </feature> |
| 160 | <feature name="url"> |
| 161 | <description> |
| 162 | <text>NETCONF :url capability; |
| 163 | If the server advertises the :url |
| 164 | capability for a session, then this feature must |
| 165 | also be enabled for that session. Otherwise, |
| 166 | this feature must not be enabled.</text> |
| 167 | </description> |
| 168 | <reference> |
| 169 | <text>RFC 6241, Section 8.8</text> |
| 170 | </reference> |
| 171 | </feature> |
| 172 | <feature name="xpath"> |
| 173 | <description> |
| 174 | <text>NETCONF :xpath capability; |
| 175 | If the server advertises the :xpath |
| 176 | capability for a session, then this feature must |
| 177 | also be enabled for that session. Otherwise, |
| 178 | this feature must not be enabled.</text> |
| 179 | </description> |
| 180 | <reference> |
| 181 | <text>RFC 6241, Section 8.9</text> |
| 182 | </reference> |
| 183 | </feature> |
| 184 | <typedef name="session-id-type"> |
| 185 | <type name="uint32"> |
| 186 | <range value="1..max"/> |
| 187 | </type> |
| 188 | <description> |
| 189 | <text>NETCONF Session Id</text> |
| 190 | </description> |
| 191 | </typedef> |
| 192 | <typedef name="session-id-or-zero-type"> |
| 193 | <type name="uint32"/> |
| 194 | <description> |
| 195 | <text>NETCONF Session Id or Zero to indicate none</text> |
| 196 | </description> |
| 197 | </typedef> |
| 198 | <typedef name="error-tag-type"> |
| 199 | <type name="enumeration"> |
| 200 | <enum name="in-use"> |
| 201 | <description> |
| 202 | <text>The request requires a resource that |
| 203 | already is in use.</text> |
| 204 | </description> |
| 205 | </enum> |
| 206 | <enum name="invalid-value"> |
| 207 | <description> |
| 208 | <text>The request specifies an unacceptable value for one |
| 209 | or more parameters.</text> |
| 210 | </description> |
| 211 | </enum> |
| 212 | <enum name="too-big"> |
| 213 | <description> |
| 214 | <text>The request or response (that would be generated) is |
| 215 | too large for the implementation to handle.</text> |
| 216 | </description> |
| 217 | </enum> |
| 218 | <enum name="missing-attribute"> |
| 219 | <description> |
| 220 | <text>An expected attribute is missing.</text> |
| 221 | </description> |
| 222 | </enum> |
| 223 | <enum name="bad-attribute"> |
| 224 | <description> |
| 225 | <text>An attribute value is not correct; e.g., wrong type, |
| 226 | out of range, pattern mismatch.</text> |
| 227 | </description> |
| 228 | </enum> |
| 229 | <enum name="unknown-attribute"> |
| 230 | <description> |
| 231 | <text>An unexpected attribute is present.</text> |
| 232 | </description> |
| 233 | </enum> |
| 234 | <enum name="missing-element"> |
| 235 | <description> |
| 236 | <text>An expected element is missing.</text> |
| 237 | </description> |
| 238 | </enum> |
| 239 | <enum name="bad-element"> |
| 240 | <description> |
| 241 | <text>An element value is not correct; e.g., wrong type, |
| 242 | out of range, pattern mismatch.</text> |
| 243 | </description> |
| 244 | </enum> |
| 245 | <enum name="unknown-element"> |
| 246 | <description> |
| 247 | <text>An unexpected element is present.</text> |
| 248 | </description> |
| 249 | </enum> |
| 250 | <enum name="unknown-namespace"> |
| 251 | <description> |
| 252 | <text>An unexpected namespace is present.</text> |
| 253 | </description> |
| 254 | </enum> |
| 255 | <enum name="access-denied"> |
| 256 | <description> |
| 257 | <text>Access to the requested protocol operation or |
| 258 | data model is denied because authorization failed.</text> |
| 259 | </description> |
| 260 | </enum> |
| 261 | <enum name="lock-denied"> |
| 262 | <description> |
| 263 | <text>Access to the requested lock is denied because the |
| 264 | lock is currently held by another entity.</text> |
| 265 | </description> |
| 266 | </enum> |
| 267 | <enum name="resource-denied"> |
| 268 | <description> |
| 269 | <text>Request could not be completed because of |
| 270 | insufficient resources.</text> |
| 271 | </description> |
| 272 | </enum> |
| 273 | <enum name="rollback-failed"> |
| 274 | <description> |
| 275 | <text>Request to roll back some configuration change (via |
| 276 | rollback-on-error or <discard-changes> operations) |
| 277 | was not completed for some reason.</text> |
| 278 | </description> |
| 279 | </enum> |
| 280 | <enum name="data-exists"> |
| 281 | <description> |
| 282 | <text>Request could not be completed because the relevant |
| 283 | data model content already exists. For example, |
| 284 | a 'create' operation was attempted on data that |
| 285 | already exists.</text> |
| 286 | </description> |
| 287 | </enum> |
| 288 | <enum name="data-missing"> |
| 289 | <description> |
| 290 | <text>Request could not be completed because the relevant |
| 291 | data model content does not exist. For example, |
| 292 | a 'delete' operation was attempted on |
| 293 | data that does not exist.</text> |
| 294 | </description> |
| 295 | </enum> |
| 296 | <enum name="operation-not-supported"> |
| 297 | <description> |
| 298 | <text>Request could not be completed because the requested |
| 299 | operation is not supported by this implementation.</text> |
| 300 | </description> |
| 301 | </enum> |
| 302 | <enum name="operation-failed"> |
| 303 | <description> |
| 304 | <text>Request could not be completed because the requested |
| 305 | operation failed for some reason not covered by |
| 306 | any other error condition.</text> |
| 307 | </description> |
| 308 | </enum> |
| 309 | <enum name="partial-operation"> |
| 310 | <description> |
| 311 | <text>This error-tag is obsolete, and SHOULD NOT be sent |
| 312 | by servers conforming to this document.</text> |
| 313 | </description> |
| 314 | </enum> |
| 315 | <enum name="malformed-message"> |
| 316 | <description> |
| 317 | <text>A message could not be handled because it failed to |
| 318 | be parsed correctly. For example, the message is not |
| 319 | well-formed XML or it uses an invalid character set.</text> |
| 320 | </description> |
| 321 | </enum> |
| 322 | </type> |
| 323 | <description> |
| 324 | <text>NETCONF Error Tag</text> |
| 325 | </description> |
| 326 | <reference> |
| 327 | <text>RFC 6241, Appendix A</text> |
| 328 | </reference> |
| 329 | </typedef> |
| 330 | <typedef name="error-severity-type"> |
| 331 | <type name="enumeration"> |
| 332 | <enum name="error"> |
| 333 | <description> |
| 334 | <text>Error severity</text> |
| 335 | </description> |
| 336 | </enum> |
| 337 | <enum name="warning"> |
| 338 | <description> |
| 339 | <text>Warning severity</text> |
| 340 | </description> |
| 341 | </enum> |
| 342 | </type> |
| 343 | <description> |
| 344 | <text>NETCONF Error Severity</text> |
| 345 | </description> |
| 346 | <reference> |
| 347 | <text>RFC 6241, Section 4.3</text> |
| 348 | </reference> |
| 349 | </typedef> |
| 350 | <typedef name="edit-operation-type"> |
| 351 | <type name="enumeration"> |
| 352 | <enum name="merge"> |
| 353 | <description> |
| 354 | <text>The configuration data identified by the |
| 355 | element containing this attribute is merged |
| 356 | with the configuration at the corresponding |
| 357 | level in the configuration datastore identified |
| 358 | by the target parameter.</text> |
| 359 | </description> |
| 360 | </enum> |
| 361 | <enum name="replace"> |
| 362 | <description> |
| 363 | <text>The configuration data identified by the element |
| 364 | containing this attribute replaces any related |
| 365 | configuration in the configuration datastore |
| 366 | identified by the target parameter. If no such |
| 367 | configuration data exists in the configuration |
| 368 | datastore, it is created. Unlike a |
| 369 | <copy-config> operation, which replaces the |
| 370 | entire target configuration, only the configuration |
| 371 | actually present in the config parameter is affected.</text> |
| 372 | </description> |
| 373 | </enum> |
| 374 | <enum name="create"> |
| 375 | <description> |
| 376 | <text>The configuration data identified by the element |
| 377 | containing this attribute is added to the |
| 378 | configuration if and only if the configuration |
| 379 | data does not already exist in the configuration |
| 380 | datastore. If the configuration data exists, an |
| 381 | <rpc-error> element is returned with an |
| 382 | <error-tag> value of 'data-exists'.</text> |
| 383 | </description> |
| 384 | </enum> |
| 385 | <enum name="delete"> |
| 386 | <description> |
| 387 | <text>The configuration data identified by the element |
| 388 | containing this attribute is deleted from the |
| 389 | configuration if and only if the configuration |
| 390 | data currently exists in the configuration |
| 391 | datastore. If the configuration data does not |
| 392 | exist, an <rpc-error> element is returned with |
| 393 | an <error-tag> value of 'data-missing'.</text> |
| 394 | </description> |
| 395 | </enum> |
| 396 | <enum name="remove"> |
| 397 | <description> |
| 398 | <text>The configuration data identified by the element |
| 399 | containing this attribute is deleted from the |
| 400 | configuration if the configuration |
| 401 | data currently exists in the configuration |
| 402 | datastore. If the configuration data does not |
| 403 | exist, the 'remove' operation is silently ignored |
| 404 | by the server.</text> |
| 405 | </description> |
| 406 | </enum> |
| 407 | </type> |
| 408 | <default value="merge"/> |
| 409 | <description> |
| 410 | <text>NETCONF 'operation' attribute values</text> |
| 411 | </description> |
| 412 | <reference> |
| 413 | <text>RFC 6241, Section 7.2</text> |
| 414 | </reference> |
| 415 | </typedef> |
| 416 | <rpc name="get-config"> |
| 417 | <description> |
| 418 | <text>Retrieve all or part of a specified configuration.</text> |
| 419 | </description> |
| 420 | <reference> |
| 421 | <text>RFC 6241, Section 7.1</text> |
| 422 | </reference> |
| 423 | <input> |
| 424 | <container name="source"> |
| 425 | <description> |
| 426 | <text>Particular configuration to retrieve.</text> |
| 427 | </description> |
| 428 | <choice name="config-source"> |
| 429 | <mandatory value="true"/> |
| 430 | <description> |
| 431 | <text>The configuration to retrieve.</text> |
| 432 | </description> |
| 433 | <leaf name="candidate"> |
| 434 | <if-feature name="candidate"/> |
| 435 | <type name="empty"/> |
| 436 | <description> |
| 437 | <text>The candidate configuration is the config source.</text> |
| 438 | </description> |
| 439 | </leaf> |
| 440 | <leaf name="running"> |
| 441 | <type name="empty"/> |
| 442 | <description> |
| 443 | <text>The running configuration is the config source.</text> |
| 444 | </description> |
| 445 | </leaf> |
| 446 | <leaf name="startup"> |
| 447 | <if-feature name="startup"/> |
| 448 | <type name="empty"/> |
| 449 | <description> |
| 450 | <text>The startup configuration is the config source. |
| 451 | This is optional-to-implement on the server because |
| 452 | not all servers will support filtering for this |
| 453 | datastore.</text> |
| 454 | </description> |
| 455 | </leaf> |
| 456 | </choice> |
| 457 | </container> |
| 458 | <anyxml name="filter"> |
| 459 | <description> |
| 460 | <text>Subtree or XPath filter to use.</text> |
| 461 | </description> |
| 462 | <nc:get-filter-element-attributes/> |
| 463 | </anyxml> |
| 464 | </input> |
| 465 | <output> |
| 466 | <anyxml name="data"> |
| 467 | <description> |
| 468 | <text>Copy of the source datastore subset that matched |
| 469 | the filter criteria (if any). An empty data container |
| 470 | indicates that the request did not produce any results.</text> |
| 471 | </description> |
| 472 | </anyxml> |
| 473 | </output> |
| 474 | </rpc> |
| 475 | <rpc name="edit-config"> |
| 476 | <description> |
| 477 | <text>The <edit-config> operation loads all or part of a specified |
| 478 | configuration to the specified target configuration.</text> |
| 479 | </description> |
| 480 | <reference> |
| 481 | <text>RFC 6241, Section 7.2</text> |
| 482 | </reference> |
| 483 | <input> |
| 484 | <container name="target"> |
| 485 | <description> |
| 486 | <text>Particular configuration to edit.</text> |
| 487 | </description> |
| 488 | <choice name="config-target"> |
| 489 | <mandatory value="true"/> |
| 490 | <description> |
| 491 | <text>The configuration target.</text> |
| 492 | </description> |
| 493 | <leaf name="candidate"> |
| 494 | <if-feature name="candidate"/> |
| 495 | <type name="empty"/> |
| 496 | <description> |
| 497 | <text>The candidate configuration is the config target.</text> |
| 498 | </description> |
| 499 | </leaf> |
| 500 | <leaf name="running"> |
| 501 | <if-feature name="writable-running"/> |
| 502 | <type name="empty"/> |
| 503 | <description> |
| 504 | <text>The running configuration is the config source.</text> |
| 505 | </description> |
| 506 | </leaf> |
| 507 | </choice> |
| 508 | </container> |
| 509 | <leaf name="default-operation"> |
| 510 | <type name="enumeration"> |
| 511 | <enum name="merge"> |
| 512 | <description> |
| 513 | <text>The default operation is merge.</text> |
| 514 | </description> |
| 515 | </enum> |
| 516 | <enum name="replace"> |
| 517 | <description> |
| 518 | <text>The default operation is replace.</text> |
| 519 | </description> |
| 520 | </enum> |
| 521 | <enum name="none"> |
| 522 | <description> |
| 523 | <text>There is no default operation.</text> |
| 524 | </description> |
| 525 | </enum> |
| 526 | </type> |
| 527 | <default value="merge"/> |
| 528 | <description> |
| 529 | <text>The default operation to use.</text> |
| 530 | </description> |
| 531 | </leaf> |
| 532 | <leaf name="test-option"> |
| 533 | <if-feature name="validate"/> |
| 534 | <type name="enumeration"> |
| 535 | <enum name="test-then-set"> |
| 536 | <description> |
| 537 | <text>The server will test and then set if no errors.</text> |
| 538 | </description> |
| 539 | </enum> |
| 540 | <enum name="set"> |
| 541 | <description> |
| 542 | <text>The server will set without a test first.</text> |
| 543 | </description> |
| 544 | </enum> |
| 545 | <enum name="test-only"> |
| 546 | <description> |
| 547 | <text>The server will only test and not set, even |
| 548 | if there are no errors.</text> |
| 549 | </description> |
| 550 | </enum> |
| 551 | </type> |
| 552 | <default value="test-then-set"/> |
| 553 | <description> |
| 554 | <text>The test option to use.</text> |
| 555 | </description> |
| 556 | </leaf> |
| 557 | <leaf name="error-option"> |
| 558 | <type name="enumeration"> |
| 559 | <enum name="stop-on-error"> |
| 560 | <description> |
| 561 | <text>The server will stop on errors.</text> |
| 562 | </description> |
| 563 | </enum> |
| 564 | <enum name="continue-on-error"> |
| 565 | <description> |
| 566 | <text>The server may continue on errors.</text> |
| 567 | </description> |
| 568 | </enum> |
| 569 | <enum name="rollback-on-error"> |
| 570 | <description> |
| 571 | <text>The server will roll back on errors. |
| 572 | This value can only be used if the 'rollback-on-error' |
| 573 | feature is supported.</text> |
| 574 | </description> |
| 575 | </enum> |
| 576 | </type> |
| 577 | <default value="stop-on-error"/> |
| 578 | <description> |
| 579 | <text>The error option to use.</text> |
| 580 | </description> |
| 581 | </leaf> |
| 582 | <choice name="edit-content"> |
| 583 | <mandatory value="true"/> |
| 584 | <description> |
| 585 | <text>The content for the edit operation.</text> |
| 586 | </description> |
| 587 | <anyxml name="config"> |
| 588 | <description> |
| 589 | <text>Inline Config content.</text> |
| 590 | </description> |
| 591 | </anyxml> |
| 592 | <leaf name="url"> |
| 593 | <if-feature name="url"/> |
| 594 | <type name="inet:uri"/> |
| 595 | <description> |
| 596 | <text>URL-based config content.</text> |
| 597 | </description> |
| 598 | </leaf> |
| 599 | </choice> |
| 600 | </input> |
| 601 | </rpc> |
| 602 | <rpc name="copy-config"> |
| 603 | <description> |
| 604 | <text>Create or replace an entire configuration datastore with the |
| 605 | contents of another complete configuration datastore.</text> |
| 606 | </description> |
| 607 | <reference> |
| 608 | <text>RFC 6241, Section 7.3</text> |
| 609 | </reference> |
| 610 | <input> |
| 611 | <container name="target"> |
| 612 | <description> |
| 613 | <text>Particular configuration to copy to.</text> |
| 614 | </description> |
| 615 | <choice name="config-target"> |
| 616 | <mandatory value="true"/> |
| 617 | <description> |
| 618 | <text>The configuration target of the copy operation.</text> |
| 619 | </description> |
| 620 | <leaf name="candidate"> |
| 621 | <if-feature name="candidate"/> |
| 622 | <type name="empty"/> |
| 623 | <description> |
| 624 | <text>The candidate configuration is the config target.</text> |
| 625 | </description> |
| 626 | </leaf> |
| 627 | <leaf name="running"> |
| 628 | <if-feature name="writable-running"/> |
| 629 | <type name="empty"/> |
| 630 | <description> |
| 631 | <text>The running configuration is the config target. |
| 632 | This is optional-to-implement on the server.</text> |
| 633 | </description> |
| 634 | </leaf> |
| 635 | <leaf name="startup"> |
| 636 | <if-feature name="startup"/> |
| 637 | <type name="empty"/> |
| 638 | <description> |
| 639 | <text>The startup configuration is the config target.</text> |
| 640 | </description> |
| 641 | </leaf> |
| 642 | <leaf name="url"> |
| 643 | <if-feature name="url"/> |
| 644 | <type name="inet:uri"/> |
| 645 | <description> |
| 646 | <text>The URL-based configuration is the config target.</text> |
| 647 | </description> |
| 648 | </leaf> |
| 649 | </choice> |
| 650 | </container> |
| 651 | <container name="source"> |
| 652 | <description> |
| 653 | <text>Particular configuration to copy from.</text> |
| 654 | </description> |
| 655 | <choice name="config-source"> |
| 656 | <mandatory value="true"/> |
| 657 | <description> |
| 658 | <text>The configuration source for the copy operation.</text> |
| 659 | </description> |
| 660 | <leaf name="candidate"> |
| 661 | <if-feature name="candidate"/> |
| 662 | <type name="empty"/> |
| 663 | <description> |
| 664 | <text>The candidate configuration is the config source.</text> |
| 665 | </description> |
| 666 | </leaf> |
| 667 | <leaf name="running"> |
| 668 | <type name="empty"/> |
| 669 | <description> |
| 670 | <text>The running configuration is the config source.</text> |
| 671 | </description> |
| 672 | </leaf> |
| 673 | <leaf name="startup"> |
| 674 | <if-feature name="startup"/> |
| 675 | <type name="empty"/> |
| 676 | <description> |
| 677 | <text>The startup configuration is the config source.</text> |
| 678 | </description> |
| 679 | </leaf> |
| 680 | <leaf name="url"> |
| 681 | <if-feature name="url"/> |
| 682 | <type name="inet:uri"/> |
| 683 | <description> |
| 684 | <text>The URL-based configuration is the config source.</text> |
| 685 | </description> |
| 686 | </leaf> |
| 687 | <anyxml name="config"> |
| 688 | <description> |
| 689 | <text>Inline Config content: <config> element. Represents |
| 690 | an entire configuration datastore, not |
| 691 | a subset of the running datastore.</text> |
| 692 | </description> |
| 693 | </anyxml> |
| 694 | </choice> |
| 695 | </container> |
| 696 | </input> |
| 697 | </rpc> |
| 698 | <rpc name="delete-config"> |
| 699 | <nacm:default-deny-all/> |
| 700 | <description> |
| 701 | <text>Delete a configuration datastore.</text> |
| 702 | </description> |
| 703 | <reference> |
| 704 | <text>RFC 6241, Section 7.4</text> |
| 705 | </reference> |
| 706 | <input> |
| 707 | <container name="target"> |
| 708 | <description> |
| 709 | <text>Particular configuration to delete.</text> |
| 710 | </description> |
| 711 | <choice name="config-target"> |
| 712 | <mandatory value="true"/> |
| 713 | <description> |
| 714 | <text>The configuration target to delete.</text> |
| 715 | </description> |
| 716 | <leaf name="startup"> |
| 717 | <if-feature name="startup"/> |
| 718 | <type name="empty"/> |
| 719 | <description> |
| 720 | <text>The startup configuration is the config target.</text> |
| 721 | </description> |
| 722 | </leaf> |
| 723 | <leaf name="url"> |
| 724 | <if-feature name="url"/> |
| 725 | <type name="inet:uri"/> |
| 726 | <description> |
| 727 | <text>The URL-based configuration is the config target.</text> |
| 728 | </description> |
| 729 | </leaf> |
| 730 | </choice> |
| 731 | </container> |
| 732 | </input> |
| 733 | </rpc> |
| 734 | <rpc name="lock"> |
| 735 | <description> |
| 736 | <text>The lock operation allows the client to lock the configuration |
| 737 | system of a device.</text> |
| 738 | </description> |
| 739 | <reference> |
| 740 | <text>RFC 6241, Section 7.5</text> |
| 741 | </reference> |
| 742 | <input> |
| 743 | <container name="target"> |
| 744 | <description> |
| 745 | <text>Particular configuration to lock.</text> |
| 746 | </description> |
| 747 | <choice name="config-target"> |
| 748 | <mandatory value="true"/> |
| 749 | <description> |
| 750 | <text>The configuration target to lock.</text> |
| 751 | </description> |
| 752 | <leaf name="candidate"> |
| 753 | <if-feature name="candidate"/> |
| 754 | <type name="empty"/> |
| 755 | <description> |
| 756 | <text>The candidate configuration is the config target.</text> |
| 757 | </description> |
| 758 | </leaf> |
| 759 | <leaf name="running"> |
| 760 | <type name="empty"/> |
| 761 | <description> |
| 762 | <text>The running configuration is the config target.</text> |
| 763 | </description> |
| 764 | </leaf> |
| 765 | <leaf name="startup"> |
| 766 | <if-feature name="startup"/> |
| 767 | <type name="empty"/> |
| 768 | <description> |
| 769 | <text>The startup configuration is the config target.</text> |
| 770 | </description> |
| 771 | </leaf> |
| 772 | </choice> |
| 773 | </container> |
| 774 | </input> |
| 775 | </rpc> |
| 776 | <rpc name="unlock"> |
| 777 | <description> |
| 778 | <text>The unlock operation is used to release a configuration lock, |
| 779 | previously obtained with the 'lock' operation.</text> |
| 780 | </description> |
| 781 | <reference> |
| 782 | <text>RFC 6241, Section 7.6</text> |
| 783 | </reference> |
| 784 | <input> |
| 785 | <container name="target"> |
| 786 | <description> |
| 787 | <text>Particular configuration to unlock.</text> |
| 788 | </description> |
| 789 | <choice name="config-target"> |
| 790 | <mandatory value="true"/> |
| 791 | <description> |
| 792 | <text>The configuration target to unlock.</text> |
| 793 | </description> |
| 794 | <leaf name="candidate"> |
| 795 | <if-feature name="candidate"/> |
| 796 | <type name="empty"/> |
| 797 | <description> |
| 798 | <text>The candidate configuration is the config target.</text> |
| 799 | </description> |
| 800 | </leaf> |
| 801 | <leaf name="running"> |
| 802 | <type name="empty"/> |
| 803 | <description> |
| 804 | <text>The running configuration is the config target.</text> |
| 805 | </description> |
| 806 | </leaf> |
| 807 | <leaf name="startup"> |
| 808 | <if-feature name="startup"/> |
| 809 | <type name="empty"/> |
| 810 | <description> |
| 811 | <text>The startup configuration is the config target.</text> |
| 812 | </description> |
| 813 | </leaf> |
| 814 | </choice> |
| 815 | </container> |
| 816 | </input> |
| 817 | </rpc> |
| 818 | <rpc name="get"> |
| 819 | <description> |
| 820 | <text>Retrieve running configuration and device state information.</text> |
| 821 | </description> |
| 822 | <reference> |
| 823 | <text>RFC 6241, Section 7.7</text> |
| 824 | </reference> |
| 825 | <input> |
| 826 | <anyxml name="filter"> |
| 827 | <description> |
| 828 | <text>This parameter specifies the portion of the system |
| 829 | configuration and state data to retrieve.</text> |
| 830 | </description> |
| 831 | <nc:get-filter-element-attributes/> |
| 832 | </anyxml> |
| 833 | </input> |
| 834 | <output> |
| 835 | <anyxml name="data"> |
| 836 | <description> |
| 837 | <text>Copy of the running datastore subset and/or state |
| 838 | data that matched the filter criteria (if any). |
| 839 | An empty data container indicates that the request did not |
| 840 | produce any results.</text> |
| 841 | </description> |
| 842 | </anyxml> |
| 843 | </output> |
| 844 | </rpc> |
| 845 | <rpc name="close-session"> |
| 846 | <description> |
| 847 | <text>Request graceful termination of a NETCONF session.</text> |
| 848 | </description> |
| 849 | <reference> |
| 850 | <text>RFC 6241, Section 7.8</text> |
| 851 | </reference> |
| 852 | </rpc> |
| 853 | <rpc name="kill-session"> |
| 854 | <nacm:default-deny-all/> |
| 855 | <description> |
| 856 | <text>Force the termination of a NETCONF session.</text> |
| 857 | </description> |
| 858 | <reference> |
| 859 | <text>RFC 6241, Section 7.9</text> |
| 860 | </reference> |
| 861 | <input> |
| 862 | <leaf name="session-id"> |
| 863 | <type name="session-id-type"/> |
| 864 | <mandatory value="true"/> |
| 865 | <description> |
| 866 | <text>Particular session to kill.</text> |
| 867 | </description> |
| 868 | </leaf> |
| 869 | </input> |
| 870 | </rpc> |
| 871 | <rpc name="commit"> |
| 872 | <if-feature name="candidate"/> |
| 873 | <description> |
| 874 | <text>Commit the candidate configuration as the device's new |
| 875 | current configuration.</text> |
| 876 | </description> |
| 877 | <reference> |
| 878 | <text>RFC 6241, Section 8.3.4.1</text> |
| 879 | </reference> |
| 880 | <input> |
| 881 | <leaf name="confirmed"> |
| 882 | <if-feature name="confirmed-commit"/> |
| 883 | <type name="empty"/> |
| 884 | <description> |
| 885 | <text>Requests a confirmed commit.</text> |
| 886 | </description> |
| 887 | <reference> |
| 888 | <text>RFC 6241, Section 8.3.4.1</text> |
| 889 | </reference> |
| 890 | </leaf> |
| 891 | <leaf name="confirm-timeout"> |
| 892 | <if-feature name="confirmed-commit"/> |
| 893 | <type name="uint32"> |
| 894 | <range value="1..max"/> |
| 895 | </type> |
| 896 | <units name="seconds"/> |
| 897 | <default value="600"/> |
| 898 | <description> |
| 899 | <text>The timeout interval for a confirmed commit.</text> |
| 900 | </description> |
| 901 | <reference> |
| 902 | <text>RFC 6241, Section 8.3.4.1</text> |
| 903 | </reference> |
| 904 | </leaf> |
| 905 | <leaf name="persist"> |
| 906 | <if-feature name="confirmed-commit"/> |
| 907 | <type name="string"/> |
| 908 | <description> |
| 909 | <text>This parameter is used to make a confirmed commit |
| 910 | persistent. A persistent confirmed commit is not aborted |
| 911 | if the NETCONF session terminates. The only way to abort |
| 912 | a persistent confirmed commit is to let the timer expire, |
| 913 | or to use the <cancel-commit> operation. |
| 914 | |
| 915 | The value of this parameter is a token that must be given |
| 916 | in the 'persist-id' parameter of <commit> or |
| 917 | <cancel-commit> operations in order to confirm or cancel |
| 918 | the persistent confirmed commit. |
| 919 | |
| 920 | The token should be a random string.</text> |
| 921 | </description> |
| 922 | <reference> |
| 923 | <text>RFC 6241, Section 8.3.4.1</text> |
| 924 | </reference> |
| 925 | </leaf> |
| 926 | <leaf name="persist-id"> |
| 927 | <if-feature name="confirmed-commit"/> |
| 928 | <type name="string"/> |
| 929 | <description> |
| 930 | <text>This parameter is given in order to commit a persistent |
| 931 | confirmed commit. The value must be equal to the value |
| 932 | given in the 'persist' parameter to the <commit> operation. |
| 933 | If it does not match, the operation fails with an |
| 934 | 'invalid-value' error.</text> |
| 935 | </description> |
| 936 | <reference> |
| 937 | <text>RFC 6241, Section 8.3.4.1</text> |
| 938 | </reference> |
| 939 | </leaf> |
| 940 | </input> |
| 941 | </rpc> |
| 942 | <rpc name="discard-changes"> |
| 943 | <if-feature name="candidate"/> |
| 944 | <description> |
| 945 | <text>Revert the candidate configuration to the current |
| 946 | running configuration.</text> |
| 947 | </description> |
| 948 | <reference> |
| 949 | <text>RFC 6241, Section 8.3.4.2</text> |
| 950 | </reference> |
| 951 | </rpc> |
| 952 | <rpc name="cancel-commit"> |
| 953 | <if-feature name="confirmed-commit"/> |
| 954 | <description> |
| 955 | <text>This operation is used to cancel an ongoing confirmed commit. |
| 956 | If the confirmed commit is persistent, the parameter |
| 957 | 'persist-id' must be given, and it must match the value of the |
| 958 | 'persist' parameter.</text> |
| 959 | </description> |
| 960 | <reference> |
| 961 | <text>RFC 6241, Section 8.4.4.1</text> |
| 962 | </reference> |
| 963 | <input> |
| 964 | <leaf name="persist-id"> |
| 965 | <type name="string"/> |
| 966 | <description> |
| 967 | <text>This parameter is given in order to cancel a persistent |
| 968 | confirmed commit. The value must be equal to the value |
| 969 | given in the 'persist' parameter to the <commit> operation. |
| 970 | If it does not match, the operation fails with an |
| 971 | 'invalid-value' error.</text> |
| 972 | </description> |
| 973 | </leaf> |
| 974 | </input> |
| 975 | </rpc> |
| 976 | <rpc name="validate"> |
| 977 | <if-feature name="validate"/> |
| 978 | <description> |
| 979 | <text>Validates the contents of the specified configuration.</text> |
| 980 | </description> |
| 981 | <reference> |
| 982 | <text>RFC 6241, Section 8.6.4.1</text> |
| 983 | </reference> |
| 984 | <input> |
| 985 | <container name="source"> |
| 986 | <description> |
| 987 | <text>Particular configuration to validate.</text> |
| 988 | </description> |
| 989 | <choice name="config-source"> |
| 990 | <mandatory value="true"/> |
| 991 | <description> |
| 992 | <text>The configuration source to validate.</text> |
| 993 | </description> |
| 994 | <leaf name="candidate"> |
| 995 | <if-feature name="candidate"/> |
| 996 | <type name="empty"/> |
| 997 | <description> |
| 998 | <text>The candidate configuration is the config source.</text> |
| 999 | </description> |
| 1000 | </leaf> |
| 1001 | <leaf name="running"> |
| 1002 | <type name="empty"/> |
| 1003 | <description> |
| 1004 | <text>The running configuration is the config source.</text> |
| 1005 | </description> |
| 1006 | </leaf> |
| 1007 | <leaf name="startup"> |
| 1008 | <if-feature name="startup"/> |
| 1009 | <type name="empty"/> |
| 1010 | <description> |
| 1011 | <text>The startup configuration is the config source.</text> |
| 1012 | </description> |
| 1013 | </leaf> |
| 1014 | <leaf name="url"> |
| 1015 | <if-feature name="url"/> |
| 1016 | <type name="inet:uri"/> |
| 1017 | <description> |
| 1018 | <text>The URL-based configuration is the config source.</text> |
| 1019 | </description> |
| 1020 | </leaf> |
| 1021 | <anyxml name="config"> |
| 1022 | <description> |
| 1023 | <text>Inline Config content: <config> element. Represents |
| 1024 | an entire configuration datastore, not |
| 1025 | a subset of the running datastore.</text> |
| 1026 | </description> |
| 1027 | </anyxml> |
| 1028 | </choice> |
| 1029 | </container> |
| 1030 | </input> |
| 1031 | </rpc> |
| 1032 | </module> |