Internet Engineering Task Force (IETF) M. Bjorklund, Ed. Request for Comments: 6020 Tail-f Systems Category: Standards Track October 2010 ISSN: 2070-1721
Internet Engineering Task Force (IETF) M. Bjorklund, Ed. Request for Comments: 6020 Tail-f Systems Category: Standards Track October 2010 ISSN: 2070-1721
YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)
YANG—网络配置协议(NETCONF)的数据建模语言
Abstract
摘要
YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications.
YANG是一种数据建模语言,用于对网络配置协议(NETCONF)、NETCONF远程过程调用和NETCONF通知操作的配置和状态数据进行建模。
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 Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 5741.
本文件是互联网工程任务组(IETF)的产品。它代表了IETF社区的共识。它已经接受了公众审查,并已被互联网工程指导小组(IESG)批准出版。有关互联网标准的更多信息,请参见RFC 5741第2节。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc6020.
有关本文件当前状态、任何勘误表以及如何提供反馈的信息,请访问http://www.rfc-editor.org/info/rfc6020.
Copyright Notice
版权公告
Copyright (c) 2010 IETF Trust and the persons identified as the document authors. All rights reserved.
版权所有(c)2010 IETF信托基金和确定为文件作者的人员。版权所有。
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 publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
本文件受BCP 78和IETF信托有关IETF文件的法律规定的约束(http://trustee.ietf.org/license-info)自本文件出版之日起生效。请仔细阅读这些文件,因为它们描述了您对本文件的权利和限制。从本文件中提取的代码组件必须包括信托法律条款第4.e节中所述的简化BSD许可证文本,并提供简化BSD许可证中所述的无担保。
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 than English.
本文件可能包含2008年11月10日之前发布或公开的IETF文件或IETF贡献中的材料。控制某些材料版权的人员可能未授予IETF信托允许在IETF标准流程之外修改此类材料的权利。在未从控制此类材料版权的人员处获得充分许可的情况下,不得在IETF标准流程之外修改本文件,也不得在IETF标准流程之外创建其衍生作品,除了将其格式化以RFC形式发布或将其翻译成英语以外的其他语言。
Table of Contents
目录
1. Introduction ....................................................8 2. Keywords ........................................................8 3. Terminology .....................................................8 3.1. Mandatory Nodes ...........................................10 4. YANG Overview ..................................................11 4.1. Functional Overview .......................................11 4.2. Language Overview .........................................13 4.2.1. Modules and Submodules .............................13 4.2.2. Data Modeling Basics ...............................13 4.2.3. State Data .........................................18 4.2.4. Built-In Types .....................................18 4.2.5. Derived Types (typedef) ............................19 4.2.6. Reusable Node Groups (grouping) ....................20 4.2.7. Choices ............................................21 4.2.8. Extending Data Models (augment) ....................22 4.2.9. RPC Definitions ....................................23 4.2.10. Notification Definitions ..........................24 5. Language Concepts ..............................................25 5.1. Modules and Submodules ....................................25 5.1.1. Import and Include by Revision .....................26 5.1.2. Module Hierarchies .................................27 5.2. File Layout ...............................................28 5.3. XML Namespaces ............................................29 5.3.1. YANG XML Namespace .................................29 5.4. Resolving Grouping, Type, and Identity Names ..............29 5.5. Nested Typedefs and Groupings .............................29 5.6. Conformance ...............................................30 5.6.1. Basic Behavior .....................................31 5.6.2. Optional Features ..................................31 5.6.3. Deviations .........................................31 5.6.4. Announcing Conformance Information in the <hello> Message ....................................32 5.7. Data Store Modification ...................................34 6. YANG Syntax ....................................................34
1. Introduction ....................................................8 2. Keywords ........................................................8 3. Terminology .....................................................8 3.1. Mandatory Nodes ...........................................10 4. YANG Overview ..................................................11 4.1. Functional Overview .......................................11 4.2. Language Overview .........................................13 4.2.1. Modules and Submodules .............................13 4.2.2. Data Modeling Basics ...............................13 4.2.3. State Data .........................................18 4.2.4. Built-In Types .....................................18 4.2.5. Derived Types (typedef) ............................19 4.2.6. Reusable Node Groups (grouping) ....................20 4.2.7. Choices ............................................21 4.2.8. Extending Data Models (augment) ....................22 4.2.9. RPC Definitions ....................................23 4.2.10. Notification Definitions ..........................24 5. Language Concepts ..............................................25 5.1. Modules and Submodules ....................................25 5.1.1. Import and Include by Revision .....................26 5.1.2. Module Hierarchies .................................27 5.2. File Layout ...............................................28 5.3. XML Namespaces ............................................29 5.3.1. YANG XML Namespace .................................29 5.4. Resolving Grouping, Type, and Identity Names ..............29 5.5. Nested Typedefs and Groupings .............................29 5.6. Conformance ...............................................30 5.6.1. Basic Behavior .....................................31 5.6.2. Optional Features ..................................31 5.6.3. Deviations .........................................31 5.6.4. Announcing Conformance Information in the <hello> Message ....................................32 5.7. Data Store Modification ...................................34 6. YANG Syntax ....................................................34
6.1. Lexical Tokenization ......................................34 6.1.1. Comments ...........................................34 6.1.2. Tokens .............................................34 6.1.3. Quoting ............................................35 6.2. Identifiers ...............................................36 6.2.1. Identifiers and Their Namespaces ...................36 6.3. Statements ................................................37 6.3.1. Language Extensions ................................37 6.4. XPath Evaluations .........................................38 6.4.1. XPath Context ......................................38 6.5. Schema Node Identifier ....................................39 7. YANG Statements ................................................39 7.1. The module Statement ......................................39 7.1.1. The module's Substatements .........................41 7.1.2. The yang-version Statement .........................41 7.1.3. The namespace Statement ............................42 7.1.4. The prefix Statement ...............................42 7.1.5. The import Statement ...............................42 7.1.6. The include Statement ..............................43 7.1.7. The organization Statement .........................44 7.1.8. The contact Statement ..............................44 7.1.9. The revision Statement .............................44 7.1.10. Usage Example .....................................45 7.2. The submodule Statement ...................................46 7.2.1. The submodule's Substatements ......................48 7.2.2. The belongs-to Statement ...........................48 7.2.3. Usage Example ......................................49 7.3. The typedef Statement .....................................49 7.3.1. The typedef's Substatements ........................50 7.3.2. The typedef's type Statement .......................50 7.3.3. The units Statement ................................50 7.3.4. The typedef's default Statement ....................50 7.3.5. Usage Example ......................................51 7.4. The type Statement ........................................51 7.4.1. The type's Substatements ...........................51 7.5. The container Statement ...................................51 7.5.1. Containers with Presence ...........................52 7.5.2. The container's Substatements ......................53 7.5.3. The must Statement .................................53 7.5.4. The must's Substatements ...........................55 7.5.5. The presence Statement .............................56 7.5.6. The container's Child Node Statements ..............56 7.5.7. XML Mapping Rules ..................................56 7.5.8. NETCONF <edit-config> Operations ...................56 7.5.9. Usage Example ......................................57 7.6. The leaf Statement ........................................58 7.6.1. The leaf's default value ...........................58 7.6.2. The leaf's Substatements ...........................59
6.1. Lexical Tokenization ......................................34 6.1.1. Comments ...........................................34 6.1.2. Tokens .............................................34 6.1.3. Quoting ............................................35 6.2. Identifiers ...............................................36 6.2.1. Identifiers and Their Namespaces ...................36 6.3. Statements ................................................37 6.3.1. Language Extensions ................................37 6.4. XPath Evaluations .........................................38 6.4.1. XPath Context ......................................38 6.5. Schema Node Identifier ....................................39 7. YANG Statements ................................................39 7.1. The module Statement ......................................39 7.1.1. The module's Substatements .........................41 7.1.2. The yang-version Statement .........................41 7.1.3. The namespace Statement ............................42 7.1.4. The prefix Statement ...............................42 7.1.5. The import Statement ...............................42 7.1.6. The include Statement ..............................43 7.1.7. The organization Statement .........................44 7.1.8. The contact Statement ..............................44 7.1.9. The revision Statement .............................44 7.1.10. Usage Example .....................................45 7.2. The submodule Statement ...................................46 7.2.1. The submodule's Substatements ......................48 7.2.2. The belongs-to Statement ...........................48 7.2.3. Usage Example ......................................49 7.3. The typedef Statement .....................................49 7.3.1. The typedef's Substatements ........................50 7.3.2. The typedef's type Statement .......................50 7.3.3. The units Statement ................................50 7.3.4. The typedef's default Statement ....................50 7.3.5. Usage Example ......................................51 7.4. The type Statement ........................................51 7.4.1. The type's Substatements ...........................51 7.5. The container Statement ...................................51 7.5.1. Containers with Presence ...........................52 7.5.2. The container's Substatements ......................53 7.5.3. The must Statement .................................53 7.5.4. The must's Substatements ...........................55 7.5.5. The presence Statement .............................56 7.5.6. The container's Child Node Statements ..............56 7.5.7. XML Mapping Rules ..................................56 7.5.8. NETCONF <edit-config> Operations ...................56 7.5.9. Usage Example ......................................57 7.6. The leaf Statement ........................................58 7.6.1. The leaf's default value ...........................58 7.6.2. The leaf's Substatements ...........................59
7.6.3. The leaf's type Statement ..........................59 7.6.4. The leaf's default Statement .......................59 7.6.5. The leaf's mandatory Statement .....................60 7.6.6. XML Mapping Rules ..................................60 7.6.7. NETCONF <edit-config> Operations ...................60 7.6.8. Usage Example ......................................61 7.7. The leaf-list Statement ...................................62 7.7.1. Ordering ...........................................62 7.7.2. The leaf-list's Substatements ......................63 7.7.3. The min-elements Statement .........................63 7.7.4. The max-elements Statement .........................63 7.7.5. The ordered-by Statement ...........................64 7.7.6. XML Mapping Rules ..................................64 7.7.7. NETCONF <edit-config> Operations ...................65 7.7.8. Usage Example ......................................66 7.8. The list Statement ........................................67 7.8.1. The list's Substatements ...........................68 7.8.2. The list's key Statement ...........................68 7.8.3. The list's unique Statement ........................69 7.8.4. The list's Child Node Statements ...................70 7.8.5. XML Mapping Rules ..................................70 7.8.6. NETCONF <edit-config> Operations ...................71 7.8.7. Usage Example ......................................72 7.9. The choice Statement ......................................75 7.9.1. The choice's Substatements .........................76 7.9.2. The choice's case Statement ........................76 7.9.3. The choice's default Statement .....................77 7.9.4. The choice's mandatory Statement ...................79 7.9.5. XML Mapping Rules ..................................79 7.9.6. NETCONF <edit-config> Operations ...................79 7.9.7. Usage Example ......................................79 7.10. The anyxml Statement .....................................80 7.10.1. The anyxml's Substatements ........................81 7.10.2. XML Mapping Rules .................................81 7.10.3. NETCONF <edit-config> Operations ..................81 7.10.4. Usage Example .....................................82 7.11. The grouping Statement ...................................82 7.11.1. The grouping's Substatements ......................83 7.11.2. Usage Example .....................................84 7.12. The uses Statement .......................................84 7.12.1. The uses's Substatements ..........................85 7.12.2. The refine Statement ..............................85 7.12.3. XML Mapping Rules .................................86 7.12.4. Usage Example .....................................86 7.13. The rpc Statement ........................................87 7.13.1. The rpc's Substatements ...........................88 7.13.2. The input Statement ...............................88 7.13.3. The output Statement ..............................89
7.6.3. The leaf's type Statement ..........................59 7.6.4. The leaf's default Statement .......................59 7.6.5. The leaf's mandatory Statement .....................60 7.6.6. XML Mapping Rules ..................................60 7.6.7. NETCONF <edit-config> Operations ...................60 7.6.8. Usage Example ......................................61 7.7. The leaf-list Statement ...................................62 7.7.1. Ordering ...........................................62 7.7.2. The leaf-list's Substatements ......................63 7.7.3. The min-elements Statement .........................63 7.7.4. The max-elements Statement .........................63 7.7.5. The ordered-by Statement ...........................64 7.7.6. XML Mapping Rules ..................................64 7.7.7. NETCONF <edit-config> Operations ...................65 7.7.8. Usage Example ......................................66 7.8. The list Statement ........................................67 7.8.1. The list's Substatements ...........................68 7.8.2. The list's key Statement ...........................68 7.8.3. The list's unique Statement ........................69 7.8.4. The list's Child Node Statements ...................70 7.8.5. XML Mapping Rules ..................................70 7.8.6. NETCONF <edit-config> Operations ...................71 7.8.7. Usage Example ......................................72 7.9. The choice Statement ......................................75 7.9.1. The choice's Substatements .........................76 7.9.2. The choice's case Statement ........................76 7.9.3. The choice's default Statement .....................77 7.9.4. The choice's mandatory Statement ...................79 7.9.5. XML Mapping Rules ..................................79 7.9.6. NETCONF <edit-config> Operations ...................79 7.9.7. Usage Example ......................................79 7.10. The anyxml Statement .....................................80 7.10.1. The anyxml's Substatements ........................81 7.10.2. XML Mapping Rules .................................81 7.10.3. NETCONF <edit-config> Operations ..................81 7.10.4. Usage Example .....................................82 7.11. The grouping Statement ...................................82 7.11.1. The grouping's Substatements ......................83 7.11.2. Usage Example .....................................84 7.12. The uses Statement .......................................84 7.12.1. The uses's Substatements ..........................85 7.12.2. The refine Statement ..............................85 7.12.3. XML Mapping Rules .................................86 7.12.4. Usage Example .....................................86 7.13. The rpc Statement ........................................87 7.13.1. The rpc's Substatements ...........................88 7.13.2. The input Statement ...............................88 7.13.3. The output Statement ..............................89
7.13.4. XML Mapping Rules .................................90 7.13.5. Usage Example .....................................91 7.14. The notification Statement ...............................91 7.14.1. The notification's Substatements ..................92 7.14.2. XML Mapping Rules .................................92 7.14.3. Usage Example .....................................93 7.15. The augment Statement ....................................93 7.15.1. The augment's Substatements .......................94 7.15.2. XML Mapping Rules .................................94 7.15.3. Usage Example .....................................95 7.16. The identity Statement ...................................97 7.16.1. The identity's Substatements ......................97 7.16.2. The base Statement ................................97 7.16.3. Usage Example .....................................98 7.17. The extension Statement ..................................98 7.17.1. The extension's Substatements .....................99 7.17.2. The argument Statement ............................99 7.17.3. Usage Example ....................................100 7.18. Conformance-Related Statements ..........................100 7.18.1. The feature Statement ............................100 7.18.2. The if-feature Statement .........................102 7.18.3. The deviation Statement ..........................102 7.19. Common Statements .......................................105 7.19.1. The config Statement .............................105 7.19.2. The status Statement .............................105 7.19.3. The description Statement ........................106 7.19.4. The reference Statement ..........................106 7.19.5. The when Statement ...............................107 8. Constraints ...................................................108 8.1. Constraints on Data ......................................108 8.2. Hierarchy of Constraints .................................109 8.3. Constraint Enforcement Model .............................109 8.3.1. Payload Parsing ...................................109 8.3.2. NETCONF <edit-config> Processing ..................110 8.3.3. Validation ........................................111 9. Built-In Types ................................................111 9.1. Canonical Representation .................................112 9.2. The Integer Built-In Types ...............................112 9.2.1. Lexical Representation ............................113 9.2.2. Canonical Form ....................................114 9.2.3. Restrictions ......................................114 9.2.4. The range Statement ...............................114 9.2.5. Usage Example .....................................115 9.3. The decimal64 Built-In Type ..............................115 9.3.1. Lexical Representation ............................115 9.3.2. Canonical Form ....................................115 9.3.3. Restrictions ......................................116 9.3.4. The fraction-digits Statement .....................116
7.13.4. XML Mapping Rules .................................90 7.13.5. Usage Example .....................................91 7.14. The notification Statement ...............................91 7.14.1. The notification's Substatements ..................92 7.14.2. XML Mapping Rules .................................92 7.14.3. Usage Example .....................................93 7.15. The augment Statement ....................................93 7.15.1. The augment's Substatements .......................94 7.15.2. XML Mapping Rules .................................94 7.15.3. Usage Example .....................................95 7.16. The identity Statement ...................................97 7.16.1. The identity's Substatements ......................97 7.16.2. The base Statement ................................97 7.16.3. Usage Example .....................................98 7.17. The extension Statement ..................................98 7.17.1. The extension's Substatements .....................99 7.17.2. The argument Statement ............................99 7.17.3. Usage Example ....................................100 7.18. Conformance-Related Statements ..........................100 7.18.1. The feature Statement ............................100 7.18.2. The if-feature Statement .........................102 7.18.3. The deviation Statement ..........................102 7.19. Common Statements .......................................105 7.19.1. The config Statement .............................105 7.19.2. The status Statement .............................105 7.19.3. The description Statement ........................106 7.19.4. The reference Statement ..........................106 7.19.5. The when Statement ...............................107 8. Constraints ...................................................108 8.1. Constraints on Data ......................................108 8.2. Hierarchy of Constraints .................................109 8.3. Constraint Enforcement Model .............................109 8.3.1. Payload Parsing ...................................109 8.3.2. NETCONF <edit-config> Processing ..................110 8.3.3. Validation ........................................111 9. Built-In Types ................................................111 9.1. Canonical Representation .................................112 9.2. The Integer Built-In Types ...............................112 9.2.1. Lexical Representation ............................113 9.2.2. Canonical Form ....................................114 9.2.3. Restrictions ......................................114 9.2.4. The range Statement ...............................114 9.2.5. Usage Example .....................................115 9.3. The decimal64 Built-In Type ..............................115 9.3.1. Lexical Representation ............................115 9.3.2. Canonical Form ....................................115 9.3.3. Restrictions ......................................116 9.3.4. The fraction-digits Statement .....................116
9.3.5. Usage Example .....................................117 9.4. The string Built-In Type .................................117 9.4.1. Lexical Representation ............................117 9.4.2. Canonical Form ....................................117 9.4.3. Restrictions ......................................117 9.4.4. The length Statement ..............................117 9.4.5. Usage Example .....................................118 9.4.6. The pattern Statement .............................119 9.4.7. Usage Example .....................................119 9.5. The boolean Built-In Type ................................120 9.5.1. Lexical Representation ............................120 9.5.2. Canonical Form ....................................120 9.5.3. Restrictions ......................................120 9.6. The enumeration Built-In Type ............................120 9.6.1. Lexical Representation ............................120 9.6.2. Canonical Form ....................................120 9.6.3. Restrictions ......................................120 9.6.4. The enum Statement ................................120 9.6.5. Usage Example .....................................121 9.7. The bits Built-In Type ...................................122 9.7.1. Restrictions ......................................122 9.7.2. Lexical Representation ............................122 9.7.3. Canonical Form ....................................122 9.7.4. The bit Statement .................................122 9.7.5. Usage Example .....................................123 9.8. The binary Built-In Type .................................123 9.8.1. Restrictions ......................................124 9.8.2. Lexical Representation ............................124 9.8.3. Canonical Form ....................................124 9.9. The leafref Built-In Type ................................124 9.9.1. Restrictions ......................................124 9.9.2. The path Statement ................................124 9.9.3. Lexical Representation ............................125 9.9.4. Canonical Form ....................................125 9.9.5. Usage Example .....................................126 9.10. The identityref Built-In Type ...........................129 9.10.1. Restrictions .....................................129 9.10.2. The identityref's base Statement .................129 9.10.3. Lexical Representation ...........................130 9.10.4. Canonical Form ...................................130 9.10.5. Usage Example ....................................130 9.11. The empty Built-In Type .................................131 9.11.1. Restrictions .....................................131 9.11.2. Lexical Representation ...........................131 9.11.3. Canonical Form ...................................131 9.11.4. Usage Example ....................................131 9.12. The union Built-In Type .................................132 9.12.1. Restrictions .....................................132
9.3.5. Usage Example .....................................117 9.4. The string Built-In Type .................................117 9.4.1. Lexical Representation ............................117 9.4.2. Canonical Form ....................................117 9.4.3. Restrictions ......................................117 9.4.4. The length Statement ..............................117 9.4.5. Usage Example .....................................118 9.4.6. The pattern Statement .............................119 9.4.7. Usage Example .....................................119 9.5. The boolean Built-In Type ................................120 9.5.1. Lexical Representation ............................120 9.5.2. Canonical Form ....................................120 9.5.3. Restrictions ......................................120 9.6. The enumeration Built-In Type ............................120 9.6.1. Lexical Representation ............................120 9.6.2. Canonical Form ....................................120 9.6.3. Restrictions ......................................120 9.6.4. The enum Statement ................................120 9.6.5. Usage Example .....................................121 9.7. The bits Built-In Type ...................................122 9.7.1. Restrictions ......................................122 9.7.2. Lexical Representation ............................122 9.7.3. Canonical Form ....................................122 9.7.4. The bit Statement .................................122 9.7.5. Usage Example .....................................123 9.8. The binary Built-In Type .................................123 9.8.1. Restrictions ......................................124 9.8.2. Lexical Representation ............................124 9.8.3. Canonical Form ....................................124 9.9. The leafref Built-In Type ................................124 9.9.1. Restrictions ......................................124 9.9.2. The path Statement ................................124 9.9.3. Lexical Representation ............................125 9.9.4. Canonical Form ....................................125 9.9.5. Usage Example .....................................126 9.10. The identityref Built-In Type ...........................129 9.10.1. Restrictions .....................................129 9.10.2. The identityref's base Statement .................129 9.10.3. Lexical Representation ...........................130 9.10.4. Canonical Form ...................................130 9.10.5. Usage Example ....................................130 9.11. The empty Built-In Type .................................131 9.11.1. Restrictions .....................................131 9.11.2. Lexical Representation ...........................131 9.11.3. Canonical Form ...................................131 9.11.4. Usage Example ....................................131 9.12. The union Built-In Type .................................132 9.12.1. Restrictions .....................................132
9.12.2. Lexical Representation ...........................132 9.12.3. Canonical Form ...................................133 9.13. The instance-identifier Built-In Type ...................133 9.13.1. Restrictions .....................................134 9.13.2. The require-instance Statement ...................134 9.13.3. Lexical Representation ...........................134 9.13.4. Canonical Form ...................................134 9.13.5. Usage Example ....................................134 10. Updating a Module ............................................135 11. YIN ..........................................................137 11.1. Formal YIN Definition ...................................137 11.1.1. Usage Example ....................................141 12. YANG ABNF Grammar ............................................143 13. Error Responses for YANG Related Errors ......................165 13.1. Error Message for Data That Violates a unique Statement ...............................................165 13.2. Error Message for Data That Violates a max-elements Statement ..................................165 13.3. Error Message for Data That Violates a min-elements Statement ..................................165 13.4. Error Message for Data That Violates a must Statement ...166 13.5. Error Message for Data That Violates a require-instance Statement ..............................166 13.6. Error Message for Data That Does Not Match a leafref Type ............................................166 13.7. Error Message for Data That Violates a mandatory choice Statement ........................................166 13.8. Error Message for the "insert" Operation ................167 14. IANA Considerations ..........................................167 14.1. Media type application/yang .............................168 14.2. Media type application/yin+xml ..........................169 15. Security Considerations ......................................170 16. Contributors .................................................171 17. Acknowledgements .............................................171 18. References ...................................................171 18.1. Normative References ....................................171 18.2. Informative References ..................................172
9.12.2. Lexical Representation ...........................132 9.12.3. Canonical Form ...................................133 9.13. The instance-identifier Built-In Type ...................133 9.13.1. Restrictions .....................................134 9.13.2. The require-instance Statement ...................134 9.13.3. Lexical Representation ...........................134 9.13.4. Canonical Form ...................................134 9.13.5. Usage Example ....................................134 10. Updating a Module ............................................135 11. YIN ..........................................................137 11.1. Formal YIN Definition ...................................137 11.1.1. Usage Example ....................................141 12. YANG ABNF Grammar ............................................143 13. Error Responses for YANG Related Errors ......................165 13.1. Error Message for Data That Violates a unique Statement ...............................................165 13.2. Error Message for Data That Violates a max-elements Statement ..................................165 13.3. Error Message for Data That Violates a min-elements Statement ..................................165 13.4. Error Message for Data That Violates a must Statement ...166 13.5. Error Message for Data That Violates a require-instance Statement ..............................166 13.6. Error Message for Data That Does Not Match a leafref Type ............................................166 13.7. Error Message for Data That Violates a mandatory choice Statement ........................................166 13.8. Error Message for the "insert" Operation ................167 14. IANA Considerations ..........................................167 14.1. Media type application/yang .............................168 14.2. Media type application/yin+xml ..........................169 15. Security Considerations ......................................170 16. Contributors .................................................171 17. Acknowledgements .............................................171 18. References ...................................................171 18.1. Normative References ....................................171 18.2. Informative References ..................................172
YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. YANG is used to model the operations and content layers of NETCONF (see the NETCONF Configuration Protocol [RFC4741], Section 1.1).
YANG是一种数据建模语言,用于对网络配置协议(NETCONF)、NETCONF远程过程调用和NETCONF通知操作的配置和状态数据进行建模。YANG用于建模NETCONF的操作和内容层(请参阅NETCONF配置协议[RFC4741],第1.1节)。
This document describes the syntax and semantics of the YANG language, how the data model defined in a YANG module is represented in the Extensible Markup Language (XML), and how NETCONF operations are used to manipulate the data.
本文档描述YANG语言的语法和语义,YANG模块中定义的数据模型如何用可扩展标记语言(XML)表示,以及如何使用NETCONF操作来操作数据。
The keywords "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].
本文件中的关键词“必须”、“不得”、“必需”、“应”、“不应”、“建议”、“不建议”、“可”和“可选”应按照BCP 14、[RFC2119]中所述进行解释。
o anyxml: A data node that can contain an unknown chunk of XML data.
o anyxml:可以包含未知XML数据块的数据节点。
o augment: Adds new schema nodes to a previously defined schema node.
o 扩充:将新架构节点添加到先前定义的架构节点。
o base type: The type from which a derived type was derived, which may be either a built-in type or another derived type.
o 基类型:派生类型的派生类型,可以是内置类型或其他派生类型。
o built-in type: A YANG data type defined in the YANG language, such as uint32 or string.
o 内置类型:用YANG语言定义的YANG数据类型,如uint32或字符串。
o choice: A schema node where only one of a number of identified alternatives is valid.
o 选择:一个模式节点,其中许多已识别的备选方案中只有一个是有效的。
o configuration data: The set of writable data that is required to transform a system from its initial default state into its current state [RFC4741].
o 配置数据:将系统从初始默认状态转换为当前状态所需的一组可写数据[RFC4741]。
o conformance: A measure of how accurately a device follows a data model.
o 一致性:衡量设备遵循数据模型的准确程度。
o container: An interior data node that exists in at most one instance in the data tree. A container has no value, but rather a set of child nodes.
o 容器:数据树中最多存在一个实例的内部数据节点。容器没有值,而是一组子节点。
o data definition statement: A statement that defines new data nodes. One of container, leaf, leaf-list, list, choice, case, augment, uses, and anyxml.
o 数据定义语句:定义新数据节点的语句。容器、叶、叶列表、列表、选项、大小写、扩充、使用和anyxml之一。
o data model: A data model describes how data is represented and accessed.
o 数据模型:数据模型描述如何表示和访问数据。
o data node: A node in the schema tree that can be instantiated in a data tree. One of container, leaf, leaf-list, list, and anyxml.
o 数据节点:架构树中可以在数据树中实例化的节点。容器、叶、叶列表、列表和anyxml之一。
o data tree: The instantiated tree of configuration and state data on a device.
o 数据树:设备上配置和状态数据的实例化树。
o derived type: A type that is derived from a built-in type (such as uint32), or another derived type.
o 派生类型:从内置类型(如uint32)或其他派生类型派生的类型。
o device deviation: A failure of the device to implement the module faithfully.
o 设备偏差:设备未能忠实执行模块。
o extension: An extension attaches non-YANG semantics to statements. The extension statement defines new statements to express these semantics.
o 扩展:扩展将非YANG语义附加到语句。extension语句定义新语句来表达这些语义。
o feature: A mechanism for marking a portion of the model as optional. Definitions can be tagged with a feature name and are only valid on devices that support that feature.
o 特性:将模型的一部分标记为可选的机制。定义可以使用功能名称进行标记,并且仅在支持该功能的设备上有效。
o grouping: A reusable set of schema nodes, which may be used locally in the module, in modules that include it, and by other modules that import from it. The grouping statement is not a data definition statement and, as such, does not define any nodes in the schema tree.
o 分组:一组可重用的模式节点,可以在模块中本地使用,也可以在包含它的模块中使用,还可以由从中导入的其他模块使用。grouping语句不是数据定义语句,因此不定义架构树中的任何节点。
o identifier: Used to identify different kinds of YANG items by name.
o 标识符:用于按名称标识不同种类的项目。
o instance identifier: A mechanism for identifying a particular node in a data tree.
o 实例标识符:用于标识数据树中特定节点的机制。
o interior node: Nodes within a hierarchy that are not leaf nodes.
o 内部节点:层次中不是叶节点的节点。
o leaf: A data node that exists in at most one instance in the data tree. A leaf has a value but no child nodes.
o 叶:数据树中最多存在一个实例的数据节点。叶有一个值,但没有子节点。
o leaf-list: Like the leaf node but defines a set of uniquely identifiable nodes rather than a single node. Each node has a value but no child nodes.
o 叶列表:与叶节点类似,但定义了一组唯一可识别的节点,而不是单个节点。每个节点都有一个值,但没有子节点。
o list: An interior data node that may exist in multiple instances in the data tree. A list has no value, but rather a set of child nodes.
o 列表:可能存在于数据树中多个实例中的内部数据节点。列表没有值,而是一组子节点。
o module: A YANG module defines a hierarchy of nodes that can be used for NETCONF-based operations. With its definitions and the definitions it imports or includes from elsewhere, a module is self-contained and "compilable".
o 模块:模块定义了可用于基于NETCONF的操作的节点层次结构。通过定义以及从其他地方导入或包含的定义,模块是自包含的且“可编译的”。
o RPC: A Remote Procedure Call, as used within the NETCONF protocol.
o RPC:在NETCONF协议中使用的远程过程调用。
o RPC operation: A specific Remote Procedure Call, as used within the NETCONF protocol. It is also called a protocol operation.
o RPC操作:在NETCONF协议中使用的特定远程过程调用。它也被称为协议操作。
o schema node: A node in the schema tree. One of container, leaf, leaf-list, list, choice, case, rpc, input, output, notification, and anyxml.
o 架构节点:架构树中的节点。容器、叶、叶列表、列表、选项、大小写、rpc、输入、输出、通知和anyxml之一。
o schema node identifier: A mechanism for identifying a particular node in the schema tree.
o 模式节点标识符:用于标识模式树中特定节点的机制。
o schema tree: The definition hierarchy specified within a module.
o 架构树:模块中指定的定义层次结构。
o state data: The additional data on a system that is not configuration data such as read-only status information and collected statistics [RFC4741].
o 状态数据:系统上非配置数据的附加数据,如只读状态信息和收集的统计信息[RFC4741]。
o submodule: A partial module definition that contributes derived types, groupings, data nodes, RPCs, and notifications to a module. A YANG module can be constructed from a number of submodules.
o 子模块:向模块提供派生类型、分组、数据节点、RPC和通知的部分模块定义。杨模可以由许多子模构成。
o top-level data node: A data node where there is no other data node between it and a module or submodule statement.
o 顶级数据节点:与模块或子模块语句之间没有其他数据节点的数据节点。
o uses: The "uses" statement is used to instantiate the set of schema nodes defined in a grouping statement. The instantiated nodes may be refined and augmented to tailor them to any specific needs.
o uses:“uses”语句用于实例化在分组语句中定义的模式节点集。可以对实例化的节点进行细化和扩充,以使其适应任何特定需求。
A mandatory node is one of:
强制节点是以下节点之一:
o A leaf, choice, or anyxml node with a "mandatory" statement with the value "true".
o 具有值为“true”的“强制”语句的叶节点、选项节点或任意XML节点。
o A list or leaf-list node with a "min-elements" statement with a value greater than zero.
o 具有值大于零的“min elements”语句的列表或叶列表节点。
o A container node without a "presence" statement, which has at least one mandatory node as a child.
o 没有“presence”语句的容器节点,至少有一个强制节点作为子节点。
YANG is a language used to model data for the NETCONF protocol. A YANG module defines a hierarchy of data that can be used for NETCONF-based operations, including configuration, state data, Remote Procedure Calls (RPCs), and notifications. This allows a complete description of all data sent between a NETCONF client and server.
YANG是一种用于为NETCONF协议建模数据的语言。模块定义了可用于基于NETCONF的操作的数据层次结构,包括配置、状态数据、远程过程调用(RPC)和通知。这允许完整描述NETCONF客户端和服务器之间发送的所有数据。
YANG models the hierarchical organization of data as a tree in which each node has a name, and either a value or a set of child nodes. YANG provides clear and concise descriptions of the nodes, as well as the interaction between those nodes.
YANG将数据的分层组织建模为一棵树,其中每个节点都有一个名称、一个值或一组子节点。YANG对节点以及这些节点之间的交互进行了清晰简洁的描述。
YANG structures data models into modules and submodules. A module can import data from other external modules, and include data from submodules. The hierarchy can be augmented, allowing one module to add data nodes to the hierarchy defined in another module. This augmentation can be conditional, with new nodes appearing only if certain conditions are met.
YANG将数据模型分为模块和子模块。模块可以从其他外部模块导入数据,并包括子模块的数据。层次结构可以扩充,允许一个模块向另一个模块中定义的层次结构添加数据节点。这种扩展可以是有条件的,只有在满足某些条件时才会出现新节点。
YANG models can describe constraints to be enforced on the data, restricting the appearance or value of nodes based on the presence or value of other nodes in the hierarchy. These constraints are enforceable by either the client or the server, and valid content MUST abide by them.
YANG模型可以描述对数据实施的约束,根据层次结构中其他节点的存在或值限制节点的外观或值。客户机或服务器都可以强制执行这些约束,有效内容必须遵守这些约束。
YANG defines a set of built-in types, and has a type mechanism through which additional types may be defined. Derived types can restrict their base type's set of valid values using mechanisms like range or pattern restrictions that can be enforced by clients or servers. They can also define usage conventions for use of the derived type, such as a string-based type that contains a host name.
YANG定义了一组内置类型,并具有一种类型机制,通过该机制可以定义其他类型。派生类型可以使用诸如范围或模式限制之类的机制来限制其基类型的有效值集,这些机制可以由客户端或服务器强制实施。它们还可以定义使用派生类型的使用约定,例如包含主机名的基于字符串的类型。
YANG permits the definition of reusable groupings of nodes. The instantiation of these groupings can refine or augment the nodes, allowing it to tailor the nodes to its particular needs. Derived types and groupings can be defined in one module or submodule and used in either that location or in another module or submodule that imports or includes it.
YANG允许定义可重用的节点分组。这些分组的实例化可以细化或扩充节点,使其能够根据特定需求定制节点。派生类型和分组可以在一个模块或子模块中定义,并在该位置或导入或包含它的另一个模块或子模块中使用。
YANG data hierarchy constructs include defining lists where list entries are identified by keys that distinguish them from each other. Such lists may be defined as either sorted by user or automatically sorted by the system. For user-sorted lists, operations are defined for manipulating the order of the list entries.
数据层次结构包括定义列表,其中列表项由键标识,键将它们彼此区分开来。此类列表可定义为按用户排序或由系统自动排序。对于用户排序的列表,定义了用于操纵列表项顺序的操作。
YANG modules can be translated into an equivalent XML syntax called YANG Independent Notation (YIN) (Section 11), allowing applications using XML parsers and Extensible Stylesheet Language Transformations (XSLT) scripts to operate on the models. The conversion from YANG to YIN is lossless, so content in YIN can be round-tripped back into YANG.
YANG模块可以转换为一种等价的XML语法,称为YANG独立表示法(YIN)(第11节),允许使用XML解析器和可扩展样式表语言转换(XSLT)脚本的应用程序在模型上操作。从阳到阴的转换是无损的,因此阴中的内容可以循环回到阳中。
YANG strikes a balance between high-level data modeling and low-level bits-on-the-wire encoding. The reader of a YANG module can see the high-level view of the data model while understanding how the data will be encoded in NETCONF operations.
杨在高级数据建模和线编码的低级位之间取得了平衡。YANG模块的读者可以看到数据模型的高级视图,同时了解数据在NETCONF操作中的编码方式。
YANG is an extensible language, allowing extension statements to be defined by standards bodies, vendors, and individuals. The statement syntax allows these extensions to coexist with standard YANG statements in a natural way, while extensions in a YANG module stand out sufficiently for the reader to notice them.
YANG是一种可扩展语言,允许标准机构、供应商和个人定义扩展语句。语句语法允许这些扩展以一种自然的方式与标准的YANG语句共存,而YANG模块中的扩展足以让读者注意到它们。
YANG resists the tendency to solve all possible problems, limiting the problem space to allow expression of NETCONF data models, not arbitrary XML documents or arbitrary data models. The data models described by YANG are designed to be easily operated upon by NETCONF operations.
YANG抵制解决所有可能问题的倾向,将问题空间限制为允许表达NETCONF数据模型,而不是任意XML文档或任意数据模型。YANG所描述的数据模型设计为便于NETCONF操作。
To the extent possible, YANG maintains compatibility with Simple Network Management Protocol's (SNMP's) SMIv2 (Structure of Management Information version 2 [RFC2578], [RFC2579]). SMIv2-based MIB modules can be automatically translated into YANG modules for read-only access. However, YANG is not concerned with reverse translation from YANG to SMIv2.
YANG尽可能保持与简单网络管理协议(SNMP)SMIv2(管理信息结构版本2[RFC2578],[RFC2579])的兼容性。基于SMIv2的MIB模块可以自动转换为只读访问的模块。然而,杨并不关心从杨到SMIv2的反向翻译。
Like NETCONF, YANG targets smooth integration with the device's native management infrastructure. This allows implementations to leverage their existing access control mechanisms to protect or expose elements of the data model.
与NETCONF一样,YANG的目标是与设备的本机管理基础设施平滑集成。这允许实现利用其现有的访问控制机制来保护或公开数据模型的元素。
This section introduces some important constructs used in YANG that will aid in the understanding of the language specifics in later sections. This progressive approach handles the inter-related nature of YANG concepts and statements. A detailed description of YANG statements and syntax begins in Section 7.
本节介绍YANG中使用的一些重要结构,这些结构将有助于理解后面章节中的语言细节。这种渐进的方法处理杨概念和陈述的相互关联性质。YANG语句和语法的详细描述从第7节开始。
A module contains three types of statements: module-header statements, revision statements, and definition statements. The module header statements describe the module and give information about the module itself, the revision statements give information about the history of the module, and the definition statements are the body of the module where the data model is defined.
模块包含三种类型的语句:模块标题语句、修订语句和定义语句。模块标题语句描述模块并提供关于模块本身的信息,修订语句提供关于模块历史的信息,定义语句是定义数据模型的模块主体。
A NETCONF server may implement a number of modules, allowing multiple views of the same data, or multiple views of disjoint subsections of the device's data. Alternatively, the server may implement only one module that defines all available data.
NETCONF服务器可以实现多个模块,允许相同数据的多个视图,或设备数据不相交部分的多个视图。或者,服务器可以仅实现一个定义所有可用数据的模块。
A module may be divided into submodules, based on the needs of the module owner. The external view remains that of a single module, regardless of the presence or size of its submodules.
根据模块所有者的需要,可以将模块划分为子模块。外部视图保持单个模块的视图,无论其子模块的存在或大小。
The "include" statement allows a module or submodule to reference material in submodules, and the "import" statement allows references to material defined in other modules.
“include”语句允许模块或子模块引用子模块中的材料,“import”语句允许引用其他模块中定义的材料。
YANG defines four types of nodes for data modeling. In each of the following subsections, the example shows the YANG syntax as well as a corresponding NETCONF XML representation.
YANG为数据建模定义了四种类型的节点。在下面的每个小节中,示例都显示了YANG语法以及相应的NETCONF XML表示。
A leaf node contains simple data like an integer or a string. It has exactly one value of a particular type and no child nodes.
叶节点包含简单的数据,如整数或字符串。它只有一个特定类型的值,并且没有子节点。
YANG Example:
杨举例:
leaf host-name { type string; description "Hostname for this system"; }
leaf host-name { type string; description "Hostname for this system"; }
NETCONF XML Example:
NETCONF XML示例:
<host-name>my.example.com</host-name>
<host-name>my.example.com</host-name>
The "leaf" statement is covered in Section 7.6.
第7.6节介绍了“叶”声明。
A leaf-list is a sequence of leaf nodes with exactly one value of a particular type per leaf.
叶列表是一系列叶节点,每个叶只有一个特定类型的值。
YANG Example:
杨举例:
leaf-list domain-search { type string; description "List of domain names to search"; }
leaf-list domain-search { type string; description "List of domain names to search"; }
NETCONF XML Example:
NETCONF XML示例:
<domain-search>high.example.com</domain-search> <domain-search>low.example.com</domain-search> <domain-search>everywhere.example.com</domain-search>
<domain-search>high.example.com</domain-search> <domain-search>low.example.com</domain-search> <domain-search>everywhere.example.com</domain-search>
The "leaf-list" statement is covered in Section 7.7.
第7.7节介绍了“叶列表”声明。
A container node is used to group related nodes in a subtree. A container has only child nodes and no value. A container may contain any number of child nodes of any type (including leafs, lists, containers, and leaf-lists).
容器节点用于将子树中的相关节点分组。容器只有子节点,没有值。容器可以包含任意数量的任意类型的子节点(包括叶、列表、容器和叶列表)。
YANG Example:
杨举例:
container system { container login { leaf message { type string; description "Message given at start of login session"; } } }
container system { container login { leaf message { type string; description "Message given at start of login session"; } } }
NETCONF XML Example:
NETCONF XML示例:
<system> <login> <message>Good morning</message> </login> </system>
<system> <login> <message>Good morning</message> </login> </system>
The "container" statement is covered in Section 7.5.
第7.5节介绍了“容器”声明。
A list defines a sequence of list entries. Each entry is like a structure or a record instance, and is uniquely identified by the values of its key leafs. A list can define multiple key leafs and may contain any number of child nodes of any type (including leafs, lists, containers etc.).
列表定义了一系列列表条目。每个条目就像一个结构或一个记录实例,并由其键叶的值唯一标识。列表可以定义多个键叶,并且可以包含任意数量的任何类型的子节点(包括叶、列表、容器等)。
YANG Example:
杨举例:
list user { key "name"; leaf name { type string; } leaf full-name { type string; } leaf class { type string; } }
list user { key "name"; leaf name { type string; } leaf full-name { type string; } leaf class { type string; } }
NETCONF XML Example:
NETCONF XML示例:
<user> <name>glocks</name> <full-name>Goldie Locks</full-name> <class>intruder</class> </user> <user> <name>snowey</name> <full-name>Snow White</full-name> <class>free-loader</class> </user> <user> <name>rzell</name> <full-name>Rapun Zell</full-name> <class>tower</class> </user>
<user> <name>glocks</name> <full-name>Goldie Locks</full-name> <class>intruder</class> </user> <user> <name>snowey</name> <full-name>Snow White</full-name> <class>free-loader</class> </user> <user> <name>rzell</name> <full-name>Rapun Zell</full-name> <class>tower</class> </user>
The "list" statement is covered in Section 7.8.
第7.8节介绍了“列表”说明。
These statements are combined to define the module:
这些语句组合起来定义模块:
// Contents of "acme-system.yang" module acme-system { namespace "http://acme.example.com/system"; prefix "acme";
// Contents of "acme-system.yang" module acme-system { namespace "http://acme.example.com/system"; prefix "acme";
organization "ACME Inc."; contact "joe@acme.example.com"; description "The module for entities implementing the ACME system.";
organization "ACME Inc."; contact "joe@acme.example.com"; description "The module for entities implementing the ACME system.";
revision 2007-06-09 { description "Initial revision."; }
revision 2007-06-09 { description "Initial revision."; }
container system { leaf host-name { type string; description "Hostname for this system"; }
container system { leaf host-name { type string; description "Hostname for this system"; }
leaf-list domain-search { type string; description "List of domain names to search"; }
leaf-list domain-search { type string; description "List of domain names to search"; }
container login { leaf message { type string; description "Message given at start of login session"; }
container login { leaf message { type string; description "Message given at start of login session"; }
list user { key "name"; leaf name { type string; } leaf full-name { type string; } leaf class { type string; } } } } }
list user { key "name"; leaf name { type string; } leaf full-name { type string; } leaf class { type string; } } } } }
YANG can model state data, as well as configuration data, based on the "config" statement. When a node is tagged with "config false", its subhierarchy is flagged as state data, to be reported using NETCONF's <get> operation, not the <get-config> operation. Parent containers, lists, and key leafs are reported also, giving the context for the state data.
YANG可以根据“config”语句对状态数据和配置数据进行建模。当一个节点被标记为“config false”时,它的子层次结构被标记为状态数据,将使用NETCONF的<get>操作而不是<get config>操作来报告。还报告父容器、列表和键叶,为状态数据提供上下文。
In this example, two leafs are defined for each interface, a configured speed and an observed speed. The observed speed is not configuration, so it can be returned with NETCONF <get> operations, but not with <get-config> operations. The observed speed is not configuration data, and it cannot be manipulated using <edit-config>.
在本例中,为每个接口定义了两个LEAF,一个配置速度和一个观察速度。观察到的速度不是配置,因此可以通过NETCONF<get>操作返回,但不能通过<get config>操作返回。观察到的速度不是配置数据,不能使用<edit config>进行操作。
list interface { key "name";
list interface { key "name";
leaf name { type string; } leaf speed { type enumeration { enum 10m; enum 100m; enum auto; } } leaf observed-speed { type uint32; config false; } }
leaf name { type string; } leaf speed { type enumeration { enum 10m; enum 100m; enum auto; } } leaf observed-speed { type uint32; config false; } }
YANG has a set of built-in types, similar to those of many programming languages, but with some differences due to special requirements from the management domain. The following table summarizes the built-in types discussed in Section 9:
YANG有一组内置类型,类似于许多编程语言的类型,但由于管理领域的特殊要求而有所不同。下表总结了第9节中讨论的内置类型:
+---------------------+-------------------------------------+ | Name | Description | +---------------------+-------------------------------------+ | binary | Any binary data | | bits | A set of bits or flags | | boolean | "true" or "false" | | decimal64 | 64-bit signed decimal number | | empty | A leaf that does not have any value | | enumeration | Enumerated strings | | identityref | A reference to an abstract identity | | instance-identifier | References a data tree node | | int8 | 8-bit signed integer | | int16 | 16-bit signed integer | | int32 | 32-bit signed integer | | int64 | 64-bit signed integer | | leafref | A reference to a leaf instance | | string | Human-readable string | | uint8 | 8-bit unsigned integer | | uint16 | 16-bit unsigned integer | | uint32 | 32-bit unsigned integer | | uint64 | 64-bit unsigned integer | | union | Choice of member types | +---------------------+-------------------------------------+
+---------------------+-------------------------------------+ | Name | Description | +---------------------+-------------------------------------+ | binary | Any binary data | | bits | A set of bits or flags | | boolean | "true" or "false" | | decimal64 | 64-bit signed decimal number | | empty | A leaf that does not have any value | | enumeration | Enumerated strings | | identityref | A reference to an abstract identity | | instance-identifier | References a data tree node | | int8 | 8-bit signed integer | | int16 | 16-bit signed integer | | int32 | 32-bit signed integer | | int64 | 64-bit signed integer | | leafref | A reference to a leaf instance | | string | Human-readable string | | uint8 | 8-bit unsigned integer | | uint16 | 16-bit unsigned integer | | uint32 | 32-bit unsigned integer | | uint64 | 64-bit unsigned integer | | union | Choice of member types | +---------------------+-------------------------------------+
The "type" statement is covered in Section 7.4.
“类型”说明见第7.4节。
YANG can define derived types from base types using the "typedef" statement. A base type can be either a built-in type or a derived type, allowing a hierarchy of derived types.
YANG可以使用“typedef”语句从基类型定义派生类型。基类型可以是内置类型或派生类型,允许派生类型的层次结构。
A derived type can be used as the argument for the "type" statement.
派生类型可用作“type”语句的参数。
YANG Example:
杨举例:
typedef percent { type uint8 { range "0 .. 100"; } description "Percentage"; }
typedef percent { type uint8 { range "0 .. 100"; } description "Percentage"; }
leaf completed { type percent; }
leaf completed { type percent; }
NETCONF XML Example:
NETCONF XML示例:
<completed>20</completed>
<completed>20</completed>
The "typedef" statement is covered in Section 7.3.
第7.3节介绍了“typedef”语句。
Groups of nodes can be assembled into reusable collections using the "grouping" statement. A grouping defines a set of nodes that are instantiated with the "uses" statement:
可以使用“grouping”语句将节点组组装成可重用的集合。分组定义了一组用“uses”语句实例化的节点:
grouping target { leaf address { type inet:ip-address; description "Target IP address"; } leaf port { type inet:port-number; description "Target port number"; } }
grouping target { leaf address { type inet:ip-address; description "Target IP address"; } leaf port { type inet:port-number; description "Target port number"; } }
container peer { container destination { uses target; } }
container peer { container destination { uses target; } }
NETCONF XML Example:
NETCONF XML示例:
<peer> <destination> <address>192.0.2.1</address> <port>830</port> </destination> </peer>
<peer> <destination> <address>192.0.2.1</address> <port>830</port> </destination> </peer>
The grouping can be refined as it is used, allowing certain statements to be overridden. In this example, the description is refined:
分组可以在使用时进行细化,允许覆盖某些语句。在本例中,对描述进行了细化:
container connection { container source { uses target { refine "address" { description "Source IP address"; } refine "port" { description "Source port number"; } } } container destination { uses target { refine "address" { description "Destination IP address"; } refine "port" { description "Destination port number"; } } } }
container connection { container source { uses target { refine "address" { description "Source IP address"; } refine "port" { description "Source port number"; } } } container destination { uses target { refine "address" { description "Destination IP address"; } refine "port" { description "Destination port number"; } } } }
The "grouping" statement is covered in Section 7.11.
第7.11节介绍了“分组”声明。
YANG allows the data model to segregate incompatible nodes into distinct choices using the "choice" and "case" statements. The "choice" statement contains a set of "case" statements that define sets of schema nodes that cannot appear together. Each "case" may contain multiple nodes, but each node may appear in only one "case" under a "choice".
YANG允许数据模型使用“choice”和“case”语句将不兼容的节点分隔为不同的选项。“choice”语句包含一组“case”语句,用于定义不能同时出现的模式节点集。每个“案例”可能包含多个节点,但每个节点可能仅出现在“选项”下的一个“案例”中。
When an element from one case is created, all elements from all other cases are implicitly deleted. The device handles the enforcement of the constraint, preventing incompatibilities from existing in the configuration.
创建一个案例中的元素时,隐式删除所有其他案例中的所有元素。设备处理约束的实施,防止配置中存在不兼容。
The choice and case nodes appear only in the schema tree, not in the data tree or NETCONF messages. The additional levels of hierarchy are not needed beyond the conceptual schema.
choice和case节点仅出现在模式树中,而不出现在数据树或NETCONF消息中。除了概念模式之外,不需要额外的层次结构。
YANG Example:
杨举例:
container food { choice snack { case sports-arena { leaf pretzel { type empty; } leaf beer { type empty; } } case late-night { leaf chocolate { type enumeration { enum dark; enum milk; enum first-available; } } } } }
container food { choice snack { case sports-arena { leaf pretzel { type empty; } leaf beer { type empty; } } case late-night { leaf chocolate { type enumeration { enum dark; enum milk; enum first-available; } } } } }
NETCONF XML Example:
NETCONF XML示例:
<food> <pretzel/> <beer/> </food>
<food> <pretzel/> <beer/> </food>
The "choice" statement is covered in Section 7.9.
“选择”声明见第7.9节。
YANG allows a module to insert additional nodes into data models, including both the current module (and its submodules) or an external module. This is useful for example for vendors to add vendor-specific parameters to standard data models in an interoperable way.
YANG允许模块将其他节点插入数据模型,包括当前模块(及其子模块)或外部模块。例如,这对于供应商以可互操作的方式向标准数据模型添加供应商特定的参数非常有用。
The "augment" statement defines the location in the data model hierarchy where new nodes are inserted, and the "when" statement defines the conditions when the new nodes are valid.
“augment”语句定义了数据模型层次结构中插入新节点的位置,“when”语句定义了新节点有效的条件。
YANG Example:
杨举例:
augment /system/login/user { when "class != 'wheel'"; leaf uid { type uint16 { range "1000 .. 30000"; } } }
augment /system/login/user { when "class != 'wheel'"; leaf uid { type uint16 { range "1000 .. 30000"; } } }
This example defines a "uid" node that only is valid when the user's "class" is not "wheel".
此示例定义了一个“uid”节点,该节点仅在用户的“类”不是“轮子”时有效。
If a module augments another module, the XML representation of the data will reflect the prefix of the augmenting module. For example, if the above augmentation were in a module with prefix "other", the XML would look like:
如果一个模块扩充了另一个模块,则数据的XML表示形式将反映扩充模块的前缀。例如,如果上述扩展位于前缀为“other”的模块中,则XML将如下所示:
NETCONF XML Example:
NETCONF XML示例:
<user> <name>alicew</name> <full-name>Alice N. Wonderland</full-name> <class>drop-out</class> <other:uid>1024</other:uid> </user>
<user> <name>alicew</name> <full-name>Alice N. Wonderland</full-name> <class>drop-out</class> <other:uid>1024</other:uid> </user>
The "augment" statement is covered in Section 7.15.
第7.15节介绍了“增强”声明。
YANG allows the definition of NETCONF RPCs. The operations' names, input parameters, and output parameters are modeled using YANG data definition statements.
YANG允许定义NETCONF RPC。使用数据定义语句对操作的名称、输入参数和输出参数进行建模。
YANG Example:
杨举例:
rpc activate-software-image { input { leaf image-name { type string; } } output { leaf status { type string; } } }
rpc activate-software-image { input { leaf image-name { type string; } } output { leaf status { type string; } } }
NETCONF XML Example:
NETCONF XML示例:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <activate-software-image xmlns="http://acme.example.com/system"> <image-name>acmefw-2.3</image-name> </activate-software-image> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <activate-software-image xmlns="http://acme.example.com/system"> <image-name>acmefw-2.3</image-name> </activate-software-image> </rpc>
<rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <status xmlns="http://acme.example.com/system"> The image acmefw-2.3 is being installed. </status> </rpc-reply>
<rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <status xmlns="http://acme.example.com/system"> The image acmefw-2.3 is being installed. </status> </rpc-reply>
The "rpc" statement is covered in Section 7.13.
第7.13节介绍了“rpc”语句。
YANG allows the definition of notifications suitable for NETCONF. YANG data definition statements are used to model the content of the notification.
YANG允许定义适用于NETCONF的通知。数据定义语句用于对通知的内容建模。
YANG Example:
杨举例:
notification link-failure { description "A link failure has been detected"; leaf if-name { type leafref { path "/interface/name"; } } leaf if-admin-status { type admin-status; } leaf if-oper-status { type oper-status; } }
notification link-failure { description "A link failure has been detected"; leaf if-name { type leafref { path "/interface/name"; } } leaf if-admin-status { type admin-status; } leaf if-oper-status { type oper-status; } }
NETCONF XML Example:
NETCONF XML示例:
<notification xmlns="urn:ietf:params:netconf:capability:notification:1.0"> <eventTime>2007-09-01T10:00:00Z</eventTime> <link-failure xmlns="http://acme.example.com/system"> <if-name>so-1/2/3.0</if-name> <if-admin-status>up</if-admin-status> <if-oper-status>down</if-oper-status> </link-failure> </notification>
<notification xmlns="urn:ietf:params:netconf:capability:notification:1.0"> <eventTime>2007-09-01T10:00:00Z</eventTime> <link-failure xmlns="http://acme.example.com/system"> <if-name>so-1/2/3.0</if-name> <if-admin-status>up</if-admin-status> <if-oper-status>down</if-oper-status> </link-failure> </notification>
The "notification" statement is covered in Section 7.14.
“通知”声明见第7.14节。
The module is the base unit of definition in YANG. A module defines a single data model. A module can define a complete, cohesive model, or augment an existing data model with additional nodes.
模块是杨定义的基本单位。模块定义单个数据模型。一个模块可以定义一个完整的、内聚的模型,或者用额外的节点扩充现有的数据模型。
Submodules are partial modules that contribute definitions to a module. A module may include any number of submodules, but each submodule may belong to only one module.
子模块是为模块提供定义的部分模块。一个模块可以包括任意数量的子模块,但每个子模块只能属于一个模块。
The names of all standard modules and submodules MUST be unique. Developers of enterprise modules are RECOMMENDED to choose names for their modules that will have a low probability of colliding with standard or other enterprise modules, e.g., by using the enterprise or organization name as a prefix for the module name.
所有标准模块和子模块的名称必须唯一。建议企业模块的开发人员为其模块选择与标准模块或其他企业模块发生冲突的可能性较低的名称,例如,使用企业或组织名称作为模块名称的前缀。
A module uses the "include" statement to include its submodules, and the "import" statement to reference external modules. Similarly, a submodule uses the "import" statement to reference other modules, and uses the "include" statement to reference other submodules within its module. A module or submodule MUST NOT include submodules from other modules, and a submodule MUST NOT import its own module.
模块使用“include”语句包含其子模块,“import”语句引用外部模块。类似地,子模块使用“import”语句引用其他模块,并使用“include”语句引用其模块内的其他子模块。模块或子模块不得包含来自其他模块的子模块,并且子模块不得导入自己的模块。
The import and include statements are used to make definitions available to other modules and submodules:
import和include语句用于将定义提供给其他模块和子模块:
o For a module or submodule to reference definitions in an external module, the external module MUST be imported.
o 要使模块或子模块引用外部模块中的定义,必须导入外部模块。
o For a module to reference definitions in one of its submodules, the module MUST include the submodule.
o 要使模块引用其子模块之一中的定义,该模块必须包含该子模块。
o For a submodule to reference definitions in a second submodule of the same module, the first submodule MUST include the second submodule.
o 要使子模块引用同一模块的第二个子模块中的定义,第一个子模块必须包含第二个子模块。
There MUST NOT be any circular chains of imports or includes. For example, if submodule "a" includes submodule "b", "b" cannot include "a".
不得有任何进口或包含的环形链。例如,如果子模块“a”包括子模块“b”,则“b”不能包括“a”。
When a definition in an external module is referenced, a locally defined prefix MUST be used, followed by ":", and then the external identifier. References to definitions in the local module MAY use the prefix notation. Since built-in data types do not belong to any module and have no prefix, references to built-in data types (e.g., int32) cannot use the prefix notation.
引用外部模块中的定义时,必须使用本地定义的前缀,后跟“:”,然后是外部标识符。对本地模块中定义的引用可以使用前缀表示法。由于内置数据类型不属于任何模块且没有前缀,因此对内置数据类型(例如int32)的引用不能使用前缀表示法。
Published modules evolve independently over time. In order to allow for this evolution, modules need to be imported using specific revisions. When a module is written, it uses the current revisions of other modules, based on what is available at the time. As future revisions of the imported modules are published, the importing module is unaffected and its contents are unchanged. When the author of the module is prepared to move to the most recently published revision of an imported module, the module is republished with an updated "import" statement. By republishing with the new revision, the authors explicitly indicate their acceptance of any changes in the imported module.
已发布的模块会随着时间的推移独立演化。为了允许这种演变,需要使用特定的版本导入模块。编写模块时,它会根据当时可用的内容使用其他模块的当前版本。随着导入模块的未来版本的发布,导入模块不受影响,其内容不变。当模块的作者准备移动到导入模块的最新发布版本时,将使用更新的“导入”语句重新发布该模块。通过使用新版本重新发布,作者明确表示接受导入模块中的任何更改。
For submodules, the issue is related but simpler. A module or submodule that includes submodules needs to specify the revision of the included submodules. If a submodule changes, any module or submodule that includes it needs to be updated.
对于子模块,问题是相关的,但更简单。包含子模块的模块或子模块需要指定包含子模块的版本。如果子模块发生更改,则需要更新包含它的任何模块或子模块。
For example, module "b" imports module "a".
例如,模块“b”导入模块“a”。
module a { revision 2008-01-01 { ... } grouping a { leaf eh { .... } } }
module a { revision 2008-01-01 { ... } grouping a { leaf eh { .... } } }
module b { import a { prefix p; revision-date 2008-01-01; }
module b { import a { prefix p; revision-date 2008-01-01; }
container bee { uses p:a; } }
container bee { uses p:a; } }
When the author of "a" publishes a new revision, the changes may not be acceptable to the author of "b". If the new revision is acceptable, the author of "b" can republish with an updated revision in the "import" statement.
当“a”的作者发布新版本时,“b”的作者可能不接受这些更改。如果新版本可以接受,“b”的作者可以在“导入”语句中使用更新版本重新发布。
YANG allows modeling of data in multiple hierarchies, where data may have more than one top-level node. Models that have multiple top-level nodes are sometimes convenient, and are supported by YANG.
YANG允许在多个层次结构中对数据进行建模,其中数据可能有多个顶级节点。具有多个顶级节点的模型有时很方便,并且受到YANG的支持。
NETCONF is capable of carrying any XML content as the payload in the <config> and <data> elements. The top-level nodes of YANG modules are encoded as child elements, in any order, within these elements. This encapsulation guarantees that the corresponding NETCONF messages are always well-formed XML documents.
NETCONF能够在<config>和<data>元素中承载任何XML内容作为有效负载。YANG模块的顶级节点在这些元素中以任意顺序编码为子元素。这种封装保证了相应的NETCONF消息始终是格式良好的XML文档。
For example:
例如:
module my-config { namespace "http://example.com/schema/config"; prefix "co";
module my-config { namespace "http://example.com/schema/config"; prefix "co";
container system { ... } container routing { ... } }
container system { ... } container routing { ... } }
could be encoded in NETCONF as:
可以在NETCONF中编码为:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <!-- system data here --> </system> <routing xmlns="http://example.com/schema/config"> <!-- routing data here --> </routing> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <!-- system data here --> </system> <routing xmlns="http://example.com/schema/config"> <!-- routing data here --> </routing> </config> </edit-config> </rpc>
YANG modules and submodules are typically stored in files, one module or submodule per file. The name of the file SHOULD be of the form:
模块和子模块通常存储在文件中,每个文件一个模块或子模块。文件名的格式应为:
module-or-submodule-name ['@' revision-date] ( '.yang' / '.yin' )
模块或子模块名称['@'修订日期]('.yang'/'.yin')
YANG compilers can find imported modules and included submodules via this convention. While the YANG language defines modules, tools may compile submodules independently for performance and manageability reasons. Errors and warnings that cannot be detected during submodule compilation may be delayed until the submodules are linked into a cohesive module.
YANG编译器可以通过此约定查找导入的模块和包含的子模块。虽然YANG语言定义模块,但出于性能和可管理性的原因,工具可以独立编译子模块。在子模块编译期间无法检测到的错误和警告可能会延迟,直到子模块链接到内聚模块中。
All YANG definitions are specified within a module that is bound to a particular XML namespace [XML-NAMES], which is a globally unique URI [RFC3986]. A NETCONF client or server uses the namespace during XML encoding of data.
所有定义都在绑定到特定XML名称空间[XML-NAMES]的模块中指定,该名称空间是全局唯一的URI[RFC3986]。NETCONF客户端或服务器在数据的XML编码期间使用名称空间。
Namespaces for modules published in RFC streams [RFC4844] MUST be assigned by IANA, see Section 14.
RFC streams[RFC4844]中发布的模块名称空间必须由IANA分配,请参见第14节。
Namespaces for private modules are assigned by the organization owning the module without a central registry. Namespace URIs MUST be chosen so they cannot collide with standard or other enterprise namespaces, for example by using the enterprise or organization name in the namespace.
私有模块的名称空间由拥有该模块的组织分配,而没有中央注册表。必须选择名称空间URI,以便它们不会与标准或其他企业名称空间冲突,例如,通过在名称空间中使用企业或组织名称。
The "namespace" statement is covered in Section 7.1.3.
第7.1.3节介绍了“名称空间”语句。
YANG defines an XML namespace for NETCONF <edit-config> operations and <error-info> content. The name of this namespace is "urn:ietf:params:xml:ns:yang:1".
YANG为NETCONF<edit config>操作和<error info>内容定义了一个XML名称空间。此命名空间的名称为“urn:ietf:params:xml:ns:yang:1”。
Grouping, type, and identity names are resolved in the context in which they are defined, rather than the context in which they are used. Users of groupings, typedefs, and identities are not required to import modules or include submodules to satisfy all references made by the original definition. This behaves like static scoping in a conventional programming language.
分组、类型和标识名在定义它们的上下文中解析,而不是在使用它们的上下文中解析。分组、typedef和标识的用户无需导入模块或包含子模块以满足原始定义所做的所有引用。这与传统编程语言中的静态作用域类似。
For example, if a module defines a grouping in which a type is referenced, when the grouping is used in a second module, the type is resolved in the context of the original module, not the second module. There is no worry over conflicts if both modules define the type, since there is no ambiguity.
例如,如果一个模块定义了一个引用类型的分组,则当该分组在第二个模块中使用时,该类型将在原始模块的上下文中解析,而不是在第二个模块中解析。如果两个模块都定义了类型,则不必担心冲突,因为不存在歧义。
Typedefs and groupings may appear nested under many YANG statements, allowing these to be lexically scoped by the hierarchy under which they appear. This allows types and groupings to be defined near where they are used, rather than placing them at the top level of the hierarchy. The close proximity increases readability.
typedef和groupings可能嵌套在许多YANG语句下,允许这些语句根据它们出现的层次结构在词汇上确定范围。这允许在使用类型和分组的位置附近定义它们,而不是将它们放在层次结构的顶层。近距离增加了可读性。
Scoping also allows types to be defined without concern for naming conflicts between types in different submodules. Type names can be specified without adding leading strings designed to prevent name collisions within large modules.
作用域还允许定义类型,而不必担心不同子模块中类型之间的命名冲突。可以在不添加前导字符串的情况下指定类型名,前导字符串旨在防止大型模块中的名称冲突。
Finally, scoping allows the module author to keep types and groupings private to their module or submodule, preventing their reuse. Since only top-level types and groupings (i.e., those appearing as substatements to a module or submodule statement) can be used outside the module or submodule, the developer has more control over what pieces of their module are presented to the outside world, supporting the need to hide internal information and maintaining a boundary between what is shared with the outside world and what is kept private.
最后,作用域允许模块作者将类型和分组保持为其模块或子模块的私有,从而防止其重用。由于只有顶级类型和分组(即,那些作为模块或子模块语句的子状态出现的类型和分组)可以在模块或子模块外部使用,因此开发人员可以更好地控制向外部世界显示其模块的哪些部分,支持隐藏内部信息的需要,并在与外部世界共享的信息和保密的信息之间保持界限。
Scoped definitions MUST NOT shadow definitions at a higher scope. A type or grouping cannot be defined if a higher level in the schema hierarchy has a definition with a matching identifier.
作用域定义不能在更高的作用域中隐藏定义。如果架构层次结构中的更高级别具有具有匹配标识符的定义,则无法定义类型或分组。
A reference to an unprefixed type or grouping, or one which uses the prefix of the current module, is resolved by locating the closest matching "typedef" or "grouping" statement among the immediate substatements of each ancestor statement.
通过在每个祖先语句的直接子语句中查找最匹配的“typedef”或“grouping”语句,可以解析对未固定类型或分组或使用当前模块前缀的类型或分组的引用。
Conformance is a measure of how accurately a device follows the model. Generally speaking, devices are responsible for implementing the model faithfully, allowing applications to treat devices which implement the model identically. Deviations from the model can reduce the utility of the model and increase fragility of applications that use it.
一致性是衡量设备遵循模型的准确程度。一般来说,设备负责忠实地实现模型,允许应用程序以相同的方式处理实现模型的设备。偏离模型会降低模型的实用性,并增加使用它的应用程序的脆弱性。
YANG modelers have three mechanisms for conformance:
YANG建模者有三种一致性机制:
o the basic behavior of the model
o 模型的基本行为
o optional features that are part of the model
o 作为模型一部分的可选功能
o deviations from the model
o 与模型的偏差
We will consider each of these in sequence.
我们将依次考虑每一个问题。
The model defines a contract between the NETCONF client and server, which allows both parties to have faith the other knows the syntax and semantics behind the modeled data. The strength of YANG lies in the strength of this contract.
该模型在NETCONF客户机和服务器之间定义了一个契约,它允许双方相信对方知道建模数据背后的语法和语义。杨的力量在于这份合同的力量。
In many models, the modeler will allow sections of the model to be conditional. The device controls whether these conditional portions of the model are supported or valid for that particular device.
在许多模型中,建模者将允许模型的部分是有条件的。该设备控制模型的这些条件部分对于该特定设备是否受支持或有效。
For example, a syslog data model may choose to include the ability to save logs locally, but the modeler will realize that this is only possible if the device has local storage. If there is no local storage, an application should not tell the device to save logs.
例如,syslog数据模型可能会选择包含本地保存日志的功能,但建模者会意识到,只有当设备具有本地存储时,这才是可能的。如果没有本地存储,应用程序不应告诉设备保存日志。
YANG supports this conditional mechanism using a construct called "feature". Features give the modeler a mechanism for making portions of the module conditional in a manner that is controlled by the device. The model can express constructs that are not universally present in all devices. These features are included in the model definition, allowing a consistent view and allowing applications to learn which features are supported and tailor their behavior to the device.
YANG使用一种称为“特征”的结构来支持这种条件机制。特性为建模者提供了一种机制,使模块的某些部分以设备控制的方式有条件。该模型可以表示并非所有设备中都普遍存在的结构。这些功能包含在模型定义中,允许一致的视图,允许应用程序了解支持哪些功能,并根据设备调整其行为。
A module may declare any number of features, identified by simple strings, and may make portions of the module optional based on those features. If the device supports a feature, then the corresponding portions of the module are valid for that device. If the device doesn't support the feature, those parts of the module are not valid, and applications should behave accordingly.
一个模块可以声明任意数量的特性,由简单字符串标识,并且可以基于这些特性使模块的部分成为可选的。如果设备支持功能,则模块的相应部分对该设备有效。如果设备不支持该功能,则模块的这些部分无效,应用程序应相应运行。
Features are defined using the "feature" statement. Definitions in the module that are conditional to the feature are noted by the "if-feature" statement with the name of the feature as its argument.
使用“功能”语句定义功能。模块中与功能相关的定义由“if feature”语句注释,该语句以功能的名称作为参数。
Further details are available in Section 7.18.1.
更多详情见第7.18.1节。
In an ideal world, all devices would be required to implement the model exactly as defined, and deviations from the model would not be allowed. But in the real world, devices are often not able or designed to implement the model as written. For YANG-based
在理想情况下,所有设备都需要完全按照定义实现模型,并且不允许偏离模型。但在现实世界中,设备往往无法或设计为实现所编写的模型。以杨为基础
automation to deal with these device deviations, a mechanism must exist for devices to inform applications of the specifics of such deviations.
自动化为了处理这些设备偏差,必须为设备提供一种机制,以告知应用程序此类偏差的具体情况。
For example, a BGP module may allow any number of BGP peers, but a particular device may only support 16 BGP peers. Any application configuring the 17th peer will receive an error. While an error may suffice to let the application know it cannot add another peer, it would be far better if the application had prior knowledge of this limitation and could prevent the user from starting down the path that could not succeed.
例如,BGP模块可允许任意数量的BGP对等点,但特定设备可仅支持16个BGP对等点。任何配置第17个对等点的应用程序都将收到错误。虽然一个错误可能足以让应用程序知道它无法添加另一个对等点,但如果应用程序事先知道这一限制,并且可以阻止用户沿着无法成功的路径启动,那就更好了。
Device deviations are declared using the "deviation" statement, which takes as its argument a string that identifies a node in the schema tree. The contents of the statement details the manner in which the device implementation deviates from the contract as defined in the module.
设备偏差是使用“偏差”语句声明的,该语句以标识模式树中节点的字符串作为参数。声明的内容详细说明了设备实现偏离模块中定义的契约的方式。
Further details are available in Section 7.18.3.
更多详情见第7.18.3节。
The namespace URI MUST be advertised as a capability in the NETCONF <hello> message to indicate support for the YANG module by a NETCONF server. The capability URI advertised MUST be of the form:
名称空间URI必须在NETCONF<hello>消息中作为一种功能发布,以指示NETCONF服务器对模块的支持。播发的功能URI的格式必须为:
capability-string = namespace-uri [ parameter-list ] parameter-list = "?" parameter *( "&" parameter ) parameter = revision-parameter / module-parameter / feature-parameter / deviation-parameter revision-parameter = "revision=" revision-date module-parameter = "module=" module-name feature-parameter = "features=" feature *( "," feature ) deviation-parameter = "deviations=" deviation *( "," deviation )
capability-string = namespace-uri [ parameter-list ] parameter-list = "?" parameter *( "&" parameter ) parameter = revision-parameter / module-parameter / feature-parameter / deviation-parameter revision-parameter = "revision=" revision-date module-parameter = "module=" module-name feature-parameter = "features=" feature *( "," feature ) deviation-parameter = "deviations=" deviation *( "," deviation )
Where "revision-date" is the revision of the module (see Section 7.1.9) that the NETCONF server implements, "module-name" is the name of module as it appears in the "module" statement (see Section 7.1), "namespace-uri" is the namespace URI for the module as it appears in the "namespace" statement (see Section 7.1.3), "feature" is the name of an optional feature implemented by the device (see Section 7.18.1), and "deviation" is the name of a module defining device deviations (see Section 7.18.3).
其中,“修订日期”是NETCONF服务器实现的模块修订版(见第7.1.9节),“模块名称”是“模块”语句中出现的模块名称(见第7.1节),“名称空间uri”是“名称空间”语句中出现的模块名称空间uri(见第7.1.3节),“功能”是设备实现的可选功能的名称(见第7.18.1节),“偏差”是定义设备偏差的模块名称(见第7.18.3节)。
In the parameter list, each named parameter MUST occur at most once.
在参数列表中,每个命名参数最多只能出现一次。
Servers indicate the names of supported modules via the <hello> message. Module namespaces are encoded as the base URI in the capability string, and the module name is encoded as the "module" parameter to the base URI.
服务器通过<hello>消息指示受支持模块的名称。模块名称空间编码为功能字符串中的基本URI,模块名称编码为基本URI的“模块”参数。
A server MUST advertise all revisions of all modules it implements.
服务器必须公布其实现的所有模块的所有版本。
For example, this <hello> message advertises one module "syslog".
例如,此<hello>消息播发一个模块“syslog”。
<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <capability> http://example.com/syslog?module=syslog&revision=2008-04-01 </capability> </hello>
<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <capability> http://example.com/syslog?module=syslog&revision=2008-04-01 </capability> </hello>
Servers indicate the names of supported features via the <hello> message. In <hello> messages, the features are encoded in the "features" parameter within the URI. The value of this parameter is a comma-separated list of feature names that the device supports for the specific module.
服务器通过<hello>消息指示受支持功能的名称。在<hello>消息中,功能在URI中的“features”参数中编码。此参数的值是设备支持特定模块的功能名称的逗号分隔列表。
For example, this <hello> message advertises one module, informing the client that it supports the "local-storage" feature of module "syslog". <hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <capability> http://example.com/syslog?module=syslog&features=local-storage </capability> </hello>
For example, this <hello> message advertises one module, informing the client that it supports the "local-storage" feature of module "syslog". <hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <capability> http://example.com/syslog?module=syslog&features=local-storage </capability> </hello>
Device deviations are announced via the "deviations" parameter. The value of the "deviations" parameter is a comma-separated list of modules containing deviations from the capability's module.
通过“偏差”参数宣布设备偏差。“偏差”参数的值是以逗号分隔的模块列表,其中包含与能力模块的偏差。
For example, this <hello> message advertises two modules, informing the client that it deviates from module "syslog" according to the deviations listed in the module "my-devs".
例如,此<hello>消息播发两个模块,通知客户机它根据模块“my devs”中列出的偏差偏离了模块“syslog”。
<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <capability> http://example.com/syslog?module=syslog&deviations=my-devs </capability> <capability> http://example.com/my-deviations?module=my-devs </capability> </hello>
<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <capability> http://example.com/syslog?module=syslog&deviations=my-devs </capability> <capability> http://example.com/my-deviations?module=my-devs </capability> </hello>
Data models may allow the server to alter the configuration data store in ways not explicitly directed via NETCONF protocol messages. For example, a data model may define leafs that are assigned system-generated values when the client does not provide one. A formal mechanism for specifying the circumstances where these changes are allowed is out of scope for this specification.
数据模型可能允许服务器以NETCONF协议消息未明确指示的方式更改配置数据存储。例如,数据模型可以定义在客户端不提供时分配给系统生成值的LEAF。用于指定允许这些更改的情况的正式机制超出了本规范的范围。
The YANG syntax is similar to that of SMIng [RFC3780] and programming languages like C and C++. This C-like syntax was chosen specifically for its readability, since YANG values the time and effort of the readers of models above those of modules writers and YANG tool-chain developers. This section introduces the YANG syntax.
杨语法类似于SMI[RCF380]和C语言和C++语言。这种类似C的语法是专门为其可读性而选择的,因为YANG重视模型读者的时间和精力,而不是模块作者和YANG工具链开发人员的时间和精力。本节介绍YANG语法。
YANG modules use the UTF-8 [RFC3629] character encoding.
模块使用UTF-8[RFC3629]字符编码。
YANG modules are parsed as a series of tokens. This section details the rules for recognizing tokens from an input stream. YANG tokenization rules are both simple and powerful. The simplicity is driven by a need to keep the parsers easy to implement, while the power is driven by the fact that modelers need to express their models in readable formats.
YANG模块被解析为一系列标记。本节详细介绍了从输入流识别令牌的规则。YANG标记化规则既简单又强大。简单性是由保持解析器易于实现的需要驱动的,而强大的驱动力是由建模者需要以可读的格式表达他们的模型这一事实驱动的。
Comments are C++ style. A single line comment starts with "//" and ends at the end of the line. A block comment is enclosed within "/*" and "*/".
注释是C++风格。单行注释以“/”开头,并在行尾结束。块注释包含在“/*”和“*/”中。
A token in YANG is either a keyword, a string, a semicolon (";"), or braces ("{" or "}"). A string can be quoted or unquoted. A keyword is either one of the YANG keywords defined in this document, or a
YANG中的标记可以是关键字、字符串、分号(“;”)或大括号(“{”或“}”)。字符串可以是带引号的或不带引号的。关键字可以是本文档中定义的关键字之一,也可以是
prefix identifier, followed by ":", followed by a language extension keyword. Keywords are case sensitive. See Section 6.2 for a formal definition of identifiers.
前缀标识符,后跟“:”,后跟语言扩展关键字。关键字区分大小写。标识符的正式定义见第6.2节。
If a string contains any space or tab characters, a semicolon (";"), braces ("{" or "}"), or comment sequences ("//", "/*", or "*/"), then it MUST be enclosed within double or single quotes.
如果字符串包含任何空格或制表符、分号(“;”)、大括号(“{”或“}”)或注释序列(“//”、“/*”)或“*/”),则必须将其括在双引号或单引号内。
If the double-quoted string contains a line break followed by space or tab characters that are used to indent the text according to the layout in the YANG file, this leading whitespace is stripped from the string, up to and including the column of the double quote character, or to the first non-whitespace character, whichever occurs first. In this process, a tab character is treated as 8 space characters.
如果双引号字符串包含一个换行符,后跟空格或制表符,用于根据YANG文件中的布局缩进文本,则该前导空格将从字符串中删除,直至并包括双引号字符的列,或第一个非空格字符,以先出现的为准。在此过程中,制表符被视为8个空格字符。
If the double-quoted string contains space or tab characters before a line break, this trailing whitespace is stripped from the string.
如果双引号字符串在换行符之前包含空格或制表符,则会从字符串中删除该尾随空格。
A single-quoted string (enclosed within ' ') preserves each character within the quotes. A single quote character cannot occur in a single-quoted string, even when preceded by a backslash.
单引号字符串(括在“”中)保留引号中的每个字符。单引号字符不能出现在单引号字符串中,即使前面有反斜杠。
Within a double-quoted string (enclosed within " "), a backslash character introduces a special character, which depends on the character that immediately follows the backslash:
在双引号字符串(括在“”中)中,反斜杠字符引入一个特殊字符,该字符取决于紧跟在反斜杠后面的字符:
\n new line \t a tab character \" a double quote \\ a single backslash
\n新行\t制表符\“双引号\\单反斜杠”
If a quoted string is followed by a plus character ("+"), followed by another quoted string, the two strings are concatenated into one string, allowing multiple concatenations to build one string. Whitespace trimming and substitution of backslash-escaped characters in double-quoted strings is done before concatenation.
如果一个带引号的字符串后跟一个加号(“+”),后跟另一个带引号的字符串,则这两个字符串将连接成一个字符串,从而允许多个连接生成一个字符串。双引号字符串中的空格修剪和反斜杠转义字符替换在连接之前完成。
The following strings are equivalent:
以下字符串是等效的:
hello "hello" 'hello' "hel" + "lo" 'hel' + "lo"
喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂喂
The following examples show some special strings:
以下示例显示了一些特殊字符串:
"\"" - string containing a double quote '"' - string containing a double quote "\n" - string containing a new line character '\n' - string containing a backslash followed by the character n
“\”“-包含双引号的字符串”-包含双引号的字符串“\n”-包含新行字符“\n”-包含反斜杠后跟字符n的字符串
The following examples show some illegal strings:
以下示例显示了一些非法字符串:
'''' - a single-quoted string cannot contain single quotes """ - a double quote must be escaped in a double-quoted string
“”“”-单引号字符串不能包含单引号“”-双引号字符串中必须转义双引号
The following strings are equivalent:
以下字符串是等效的:
"first line second line"
“第一行第二行”
"first line\n" + " second line"
“第一行\n”+“第二行”
Identifiers are used to identify different kinds of YANG items by name. Each identifier starts with an uppercase or lowercase ASCII letter or an underscore character, followed by zero or more ASCII letters, digits, underscore characters, hyphens, and dots. Implementations MUST support identifiers up to 64 characters in length. Identifiers are case sensitive. The identifier syntax is formally defined by the rule "identifier" in Section 12. Identifiers can be specified as quoted or unquoted strings.
标识符用于按名称标识不同种类的项目。每个标识符以大写或小写ASCII字母或下划线字符开头,后跟零个或多个ASCII字母、数字、下划线字符、连字符和点。实现必须支持长度不超过64个字符的标识符。标识符区分大小写。标识符语法由第12节中的“标识符”规则正式定义。标识符可以指定为带引号或不带引号的字符串。
Each identifier is valid in a namespace that depends on the type of the YANG item being defined. All identifiers defined in a namespace MUST be unique.
每个标识符在命名空间中都是有效的,该命名空间取决于所定义项的类型。命名空间中定义的所有标识符都必须是唯一的。
o All module and submodule names share the same global module identifier namespace.
o 所有模块和子模块名称共享相同的全局模块标识符命名空间。
o All extension names defined in a module and its submodules share the same extension identifier namespace.
o 模块及其子模块中定义的所有扩展名共享相同的扩展标识符命名空间。
o All feature names defined in a module and its submodules share the same feature identifier namespace.
o 模块及其子模块中定义的所有功能名称共享相同的功能标识符命名空间。
o All identity names defined in a module and its submodules share the same identity identifier namespace.
o 模块及其子模块中定义的所有标识名共享相同的标识标识符命名空间。
o All derived type names defined within a parent node or at the top level of the module or its submodules share the same type identifier namespace. This namespace is scoped to all descendant nodes of the parent node or module. This means that any descendent node may use that typedef, and it MUST NOT define a typedef with the same name.
o 在父节点内或在模块或其子模块的顶层定义的所有派生类型名称共享相同的类型标识符命名空间。此命名空间的作用域为父节点或模块的所有子节点。这意味着任何子节点都可以使用该typedef,并且它不能定义具有相同名称的typedef。
o All grouping names defined within a parent node or at the top level of the module or its submodules share the same grouping identifier namespace. This namespace is scoped to all descendant nodes of the parent node or module. This means that any descendent node may use that grouping, and it MUST NOT define a grouping with the same name.
o 在父节点内或在模块或其子模块的顶层定义的所有分组名称共享相同的分组标识符命名空间。此命名空间的作用域为父节点或模块的所有子节点。这意味着任何子节点都可以使用该分组,并且不能使用相同的名称定义分组。
o All leafs, leaf-lists, lists, containers, choices, rpcs, notifications, and anyxmls defined (directly or through a uses statement) within a parent node or at the top level of the module or its submodules share the same identifier namespace. This namespace is scoped to the parent node or module, unless the parent node is a case node. In that case, the namespace is scoped to the closest ancestor node that is not a case or choice node.
o 父节点内或模块或其子模块顶层定义的所有叶、叶列表、列表、容器、选项、RPC、通知和任何XML(直接或通过uses语句)共享相同的标识符命名空间。除非父节点是案例节点,否则此命名空间的作用域为父节点或模块。在这种情况下,名称空间的作用域是最接近的祖先节点,该节点不是case或choice节点。
o All cases within a choice share the same case identifier namespace. This namespace is scoped to the parent choice node.
o 选项中的所有案例共享相同的案例标识符命名空间。此命名空间的作用域为父选择节点。
Forward references are allowed in YANG.
在YANG中允许向前引用。
A YANG module contains a sequence of statements. Each statement starts with a keyword, followed by zero or one argument, followed either by a semicolon (";") or a block of substatements enclosed within braces ("{ }"):
模块包含一系列语句。每个语句都以关键字开头,后跟零或一个参数,后跟分号(;)或大括号({})中包含的子语句块:
statement = keyword [argument] (";" / "{" *statement "}")
statement = keyword [argument] (";" / "{" *statement "}")
The argument is a string, as defined in Section 6.1.2.
参数是一个字符串,如第6.1.2节所定义。
A module can introduce YANG extensions by using the "extension" keyword (see Section 7.17). The extensions can be imported by other modules with the "import" statement (see Section 7.1.5). When an imported extension is used, the extension's keyword MUST be qualified using the prefix with which the extension's module was imported. If an extension is used in the module where it is defined, the extension's keyword MUST be qualified with the module's prefix.
模块可以使用“extension”关键字引入YANG扩展(参见第7.17节)。其他模块可以使用“导入”语句导入扩展(参见第7.1.5节)。使用导入的扩展时,必须使用导入扩展模块时使用的前缀限定扩展的关键字。如果在定义扩展的模块中使用扩展,则扩展的关键字必须使用模块的前缀限定。
Since submodules cannot include the parent module, any extensions in the module that need to be exposed to submodules MUST be defined in a submodule. Submodules can then include this submodule to find the definition of the extension.
由于子模块不能包含父模块,因此必须在子模块中定义模块中需要向子模块公开的任何扩展。然后子模块可以包含此子模块以查找扩展的定义。
If a YANG compiler does not support a particular extension, which appears in a YANG module as an unknown-statement (see Section 12), the entire unknown-statement MAY be ignored by the compiler.
如果YANG编译器不支持特定的扩展,该扩展在YANG模块中作为未知语句出现(参见第12节),编译器可能会忽略整个未知语句。
YANG relies on XML Path Language (XPath) 1.0 [XPATH] as a notation for specifying many inter-node references and dependencies. NETCONF clients and servers are not required to implement an XPath interpreter, but MUST ensure that the requirements encoded in the data model are enforced. The manner of enforcement is an implementation decision. The XPath expressions MUST be syntactically correct, and all prefixes used MUST be present in the XPath context (see Section 6.4.1). An implementation may choose to implement them by hand, rather than using the XPath expression directly.
YANG依赖XML路径语言(XPath)1.0[XPath]作为指定许多节点间引用和依赖关系的表示法。NETCONF客户端和服务器不需要实现XPath解释器,但必须确保数据模型中编码的要求得到实施。执行方式是一项执行决定。XPath表达式必须语法正确,并且使用的所有前缀必须出现在XPath上下文中(请参见第6.4.1节)。实现可以选择手工实现,而不是直接使用XPath表达式。
The data model used in the XPath expressions is the same as that used in XPath 1.0 [XPATH], with the same extension for root node children as used by XSLT 1.0 [XSLT] (Section 3.1). Specifically, it means that the root node may have any number of element nodes as its children.
XPath表达式中使用的数据模型与XPath 1.0[XPath]中使用的数据模型相同,根节点子节点的扩展与XSLT 1.0[XSLT]使用的扩展相同(第3.1节)。具体来说,这意味着根节点可以有任意数量的元素节点作为其子节点。
All YANG XPath expressions share the following XPath context definition:
所有XPath表达式共享以下XPath上下文定义:
o The set of namespace declarations is the set of all "import" statements' prefix and namespace pairs in the module where the XPath expression is specified, and the "prefix" statement's prefix for the "namespace" statement's URI.
o 名称空间声明集是指定XPath表达式的模块中所有“导入”语句的前缀和名称空间对的集合,以及“名称空间”语句URI的“前缀”语句的前缀。
o Names without a namespace prefix belong to the same namespace as the identifier of the current node. Inside a grouping, that namespace is affected by where the grouping is used (see Section 7.12).
o 没有名称空间前缀的名称与当前节点的标识符属于同一名称空间。在分组中,名称空间受分组使用位置的影响(参见第7.12节)。
o The function library is the core function library defined in [XPATH], and a function "current()" that returns a node set with the initial context node.
o 函数库是[XPATH]中定义的核心函数库,是一个函数“current()”,返回带有初始上下文节点的节点集。
o The set of variable bindings is empty.
o 变量绑定集为空。
The mechanism for handling unprefixed names is adopted from XPath 2.0 [XPATH2.0], and helps simplify XPath expressions in YANG. No ambiguity may ever arise because YANG node identifiers are always qualified names with a non-null namespace URI.
处理不固定名称的机制采用XPATH2.0[XPATH2.0],有助于简化XML中的XPath表达式。不会出现歧义,因为节点标识符始终是具有非空命名空间URI的限定名称。
The context node varies with the YANG XPath expression, and is specified where the YANG statement with the XPath expression is defined.
上下文节点随YANG XPath表达式的不同而变化,并在定义带有XPath表达式的YANG语句的位置指定。
A schema node identifier is a string that identifies a node in the schema tree. It has two forms, "absolute" and "descendant", defined by the rules "absolute-schema-nodeid" and "descendant-schema-nodeid" in Section 12, respectively. A schema node identifier consists of a path of identifiers, separated by slashes ("/"). In an absolute schema node identifier, the first identifier after the leading slash is any top-level schema node in the local module or in all imported modules.
架构节点标识符是标识架构树中节点的字符串。它有两种形式,“绝对”和“后代”,分别由第12节中的规则“绝对模式节点ID”和“后代模式节点ID”定义。架构节点标识符由标识符路径组成,由斜杠(“/”)分隔。在绝对模式节点标识符中,前导斜杠后的第一个标识符是本地模块或所有导入模块中的任何顶级模式节点。
References to identifiers defined in external modules MUST be qualified with appropriate prefixes, and references to identifiers defined in the current module and its submodules MAY use a prefix.
对外部模块中定义的标识符的引用必须使用适当的前缀进行限定,对当前模块及其子模块中定义的标识符的引用可以使用前缀。
For example, to identify the child node "b" of top-level node "a", the string "/a/b" can be used.
例如,要标识顶级节点“a”的子节点“b”,可以使用字符串“/a/b”。
The following sections describe all of the YANG statements.
以下各节描述了所有杨陈述。
Note that even a statement that does not have any substatements defined in YANG can have vendor-specific extensions as substatements. For example, the "description" statement does not have any substatements defined in YANG, but the following is legal:
请注意,即使没有在YANG中定义任何子状态的语句也可以将特定于供应商的扩展作为子状态。例如,“description”语句在YANG中没有定义任何子语句,但以下语句是合法的:
description "some text" { acme:documentation-flag 5; }
description "some text" { acme:documentation-flag 5; }
The "module" statement defines the module's name, and groups all statements that belong to the module together. The "module" statement's argument is the name of the module, followed by a block of substatements that hold detailed module information. The module name follows the rules for identifiers in Section 6.2.
“module”语句定义模块的名称,并将属于该模块的所有语句分组在一起。“module”语句的参数是模块的名称,后跟一块包含详细模块信息的子语句。模块名称遵循第6.2节中的标识符规则。
Names of modules published in RFC streams [RFC4844] MUST be assigned by IANA, see Section 14.
在RFC流[RFC4844]中发布的模块名称必须由IANA分配,见第14节。
Private module names are assigned by the organization owning the module without a central registry. It is RECOMMENDED to choose module names that will have a low probability of colliding with standard or other enterprise modules and submodules, e.g., by using the enterprise or organization name as a prefix for the module name.
私有模块名称由拥有该模块的组织分配,而无需中央注册表。建议选择与标准或其他企业模块和子模块冲突的可能性较低的模块名称,例如,使用企业或组织名称作为模块名称的前缀。
A module typically has the following layout:
模块通常具有以下布局:
module <module-name> {
module <module-name> {
// header information <yang-version statement> <namespace statement> <prefix statement>
// header information <yang-version statement> <namespace statement> <prefix statement>
// linkage statements <import statements> <include statements>
// linkage statements <import statements> <include statements>
// meta information <organization statement> <contact statement> <description statement> <reference statement>
// meta information <organization statement> <contact statement> <description statement> <reference statement>
// revision history <revision statements>
// revision history <revision statements>
// module definitions <other statements> }
// module definitions <other statements> }
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | augment | 7.15 | 0..n | | choice | 7.9 | 0..n | | contact | 7.1.8 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | deviation | 7.18.3 | 0..n | | extension | 7.17 | 0..n | | feature | 7.18.1 | 0..n | | grouping | 7.11 | 0..n | | identity | 7.16 | 0..n | | import | 7.1.5 | 0..n | | include | 7.1.6 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | namespace | 7.1.3 | 1 | | notification | 7.14 | 0..n | | organization | 7.1.7 | 0..1 | | prefix | 7.1.4 | 1 | | reference | 7.19.4 | 0..1 | | revision | 7.1.9 | 0..n | | rpc | 7.13 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | | yang-version | 7.1.2 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | augment | 7.15 | 0..n | | choice | 7.9 | 0..n | | contact | 7.1.8 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | deviation | 7.18.3 | 0..n | | extension | 7.17 | 0..n | | feature | 7.18.1 | 0..n | | grouping | 7.11 | 0..n | | identity | 7.16 | 0..n | | import | 7.1.5 | 0..n | | include | 7.1.6 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | namespace | 7.1.3 | 1 | | notification | 7.14 | 0..n | | organization | 7.1.7 | 0..1 | | prefix | 7.1.4 | 1 | | reference | 7.19.4 | 0..1 | | revision | 7.1.9 | 0..n | | rpc | 7.13 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | | yang-version | 7.1.2 | 0..1 | +--------------+---------+-------------+
The optional "yang-version" statement specifies which version of the YANG language was used in developing the module. The statement's argument is a string. If present, it MUST contain the value "1", which is the current YANG version and the default value.
可选的“yang version”语句指定在开发模块时使用的yang语言版本。语句的参数是字符串。如果存在,它必须包含值“1”,这是当前版本和默认值。
Handling of the "yang-version" statement for versions other than "1" (the version defined here) is out of scope for this specification. Any document that defines a higher version will need to define the backward compatibility of such a higher version.
对于“1”以外的版本(此处定义的版本)处理“yang version”语句超出了本规范的范围。任何定义更高版本的文档都需要定义这样一个更高版本的向后兼容性。
The "namespace" statement defines the XML namespace that all identifiers defined by the module are qualified by, with the exception of data node identifiers defined inside a grouping (see Section 7.12 for details). The argument to the "namespace" statement is the URI of the namespace.
“namespace”语句定义了由模块定义的所有标识符所限定的XML名称空间,分组中定义的数据节点标识符除外(有关详细信息,请参见第7.12节)。“namespace”语句的参数是名称空间的URI。
See also Section 5.3.
另见第5.3节。
The "prefix" statement is used to define the prefix associated with the module and its namespace. The "prefix" statement's argument is the prefix string that is used as a prefix to access a module. The prefix string MAY be used to refer to definitions contained in the module, e.g., "if:ifName". A prefix follows the same rules as an identifier (see Section 6.2).
“prefix”语句用于定义与模块及其命名空间关联的前缀。“prefix”语句的参数是用作访问模块前缀的前缀字符串。前缀字符串可用于引用模块中包含的定义,例如,“if:ifName”。前缀遵循与标识符相同的规则(见第6.2节)。
When used inside the "module" statement, the "prefix" statement defines the prefix to be used when this module is imported. To improve readability of the NETCONF XML, a NETCONF client or server that generates XML or XPath that use prefixes SHOULD use the prefix defined by the module, unless there is a conflict.
在“module”语句中使用时,“prefix”语句定义导入此模块时要使用的前缀。为了提高NETCONF XML的可读性,生成使用前缀的XML或XPath的NETCONF客户端或服务器应使用模块定义的前缀,除非存在冲突。
When used inside the "import" statement, the "prefix" statement defines the prefix to be used when accessing definitions inside the imported module. When a reference to an identifier from the imported module is used, the prefix string for the imported module is used in combination with a colon (":") and the identifier, e.g., "if: ifIndex". To improve readability of YANG modules, the prefix defined by a module SHOULD be used when the module is imported, unless there is a conflict. If there is a conflict, i.e., two different modules that both have defined the same prefix are imported, at least one of them MUST be imported with a different prefix.
在“import”语句中使用时,“prefix”语句定义访问导入模块中的定义时要使用的前缀。使用对导入模块标识符的引用时,导入模块的前缀字符串将与冒号(“:”)和标识符结合使用,例如“if:ifIndex”。为提高模块的可读性,导入模块时应使用模块定义的前缀,除非存在冲突。如果存在冲突,即导入两个定义了相同前缀的不同模块,则必须使用不同前缀导入其中至少一个模块。
All prefixes, including the prefix for the module itself MUST be unique within the module or submodule.
所有前缀(包括模块本身的前缀)在模块或子模块中必须是唯一的。
The "import" statement makes definitions from one module available inside another module or submodule. The argument is the name of the module to import, and the statement is followed by a block of substatements that holds detailed import information. When a module is imported, the importing module may:
“import”语句使一个模块中的定义在另一个模块或子模块中可用。参数是要导入的模块的名称,语句后面是一个包含详细导入信息的子语句块。导入模块时,导入模块可以:
o use any grouping and typedef defined at the top level in the imported module or its submodules.
o 使用在导入的模块或其子模块的顶层定义的任何分组和typedef。
o use any extension, feature, and identity defined in the imported module or its submodules.
o 使用导入的模块或其子模块中定义的任何扩展、功能和标识。
o use any node in the imported module's schema tree in "must", "path", and "when" statements, or as the target node in "augment" and "deviation" statements.
o 在“must”、“path”和“when”语句中使用导入模块模式树中的任何节点,或者在“augment”和“develope”语句中作为目标节点。
The mandatory "prefix" substatement assigns a prefix for the imported module that is scoped to the importing module or submodule. Multiple "import" statements may be specified to import from different modules.
必填的“prefix”子语句为导入的模块分配一个前缀,其作用域为导入模块或子模块。可以指定多个“导入”语句从不同的模块导入。
When the optional "revision-date" substatement is present, any typedef, grouping, extension, feature, and identity referenced by definitions in the local module are taken from the specified revision of the imported module. It is an error if the specified revision of the imported module does not exist. If no "revision-date" substatement is present, it is undefined from which revision of the module they are taken.
当存在可选的“修订日期”子状态时,本地模块中定义引用的任何类型定义、分组、扩展、特征和标识都将取自导入模块的指定版本。如果导入模块的指定版本不存在,则为错误。如果不存在“修订日期”子语句,则未定义从哪个版本获取这些子语句的模块。
Multiple revisions of the same module MUST NOT be imported.
不得导入同一模块的多个修订版。
The import's Substatements
导入的子语句
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | prefix | 7.1.4 | 1 | | revision-date | 7.1.5.1 | 0..1 | +---------------+---------+-------------+
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | prefix | 7.1.4 | 1 | | revision-date | 7.1.5.1 | 0..1 | +---------------+---------+-------------+
The import's "revision-date" statement is used to specify the exact version of the module to import. The "revision-date" statement MUST match the most recent "revision" statement in the imported module.
导入的“修订日期”语句用于指定要导入的模块的确切版本。“修订日期”语句必须与导入模块中最近的“修订”语句匹配。
The "include" statement is used to make content from a submodule available to that submodule's parent module, or to another submodule of that parent module. The argument is an identifier that is the name of the submodule to include. Modules are only allowed to
“include”语句用于将子模块中的内容提供给该子模块的父模块或该父模块的另一个子模块。参数是一个标识符,它是要包含的子模块的名称。模块只允许
include submodules that belong to that module, as defined by the "belongs-to" statement (see Section 7.2.2). Submodules are only allowed to include other submodules belonging to the same module.
包括属于该模块的子模块,如“属于”语句所定义(见第7.2.2节)。子模块仅允许包含属于同一模块的其他子模块。
When a module includes a submodule, it incorporates the contents of the submodule into the node hierarchy of the module. When a submodule includes another submodule, the target submodule's definitions are made available to the current submodule.
当模块包含子模块时,它会将子模块的内容合并到模块的节点层次结构中。当一个子模块包含另一个子模块时,目标子模块的定义可供当前子模块使用。
When the optional "revision-date" substatement is present, the specified revision of the submodule is included in the module. It is an error if the specified revision of the submodule does not exist. If no "revision-date" substatement is present, it is undefined which revision of the submodule is included.
当存在可选的“修订日期”子状态时,子模块的指定修订将包含在模块中。如果子模块的指定版本不存在,则为错误。如果不存在“修订日期”子语句,则未定义包含子模块的哪个修订。
Multiple revisions of the same submodule MUST NOT be included.
不得包含同一子模块的多个修订版。
The includes's Substatements
包含的子语句
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | revision-date | 7.1.5.1 | 0..1 | +---------------+---------+-------------+
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | revision-date | 7.1.5.1 | 0..1 | +---------------+---------+-------------+
The "organization" statement defines the party responsible for this module. The argument is a string that is used to specify a textual description of the organization(s) under whose auspices this module was developed.
“组织”声明定义了负责此模块的一方。参数是一个字符串,用于指定在其主持下开发此模块的组织的文本描述。
The "contact" statement provides contact information for the module. The argument is a string that is used to specify contact information for the person or persons to whom technical queries concerning this module should be sent, such as their name, postal address, telephone number, and electronic mail address.
“contact”语句提供模块的联系信息。参数是一个字符串,用于指定应向其发送有关此模块的技术查询的人员的联系信息,如姓名、邮政地址、电话号码和电子邮件地址。
The "revision" statement specifies the editorial revision history of the module, including the initial revision. A series of revision statements detail the changes in the module's definition. The argument is a date string in the format "YYYY-MM-DD", followed by a block of substatements that holds detailed revision information. A module SHOULD have at least one initial "revision" statement. For
“修订”语句指定模块的编辑修订历史记录,包括初始修订。一系列修订声明详细说明了模块定义中的更改。参数是格式为“YYYY-MM-DD”的日期字符串,后跟一块保存详细修订信息的子状态。模块应至少有一个初始“修订”语句。对于
every published editorial change, a new one SHOULD be added in front of the revisions sequence, so that all revisions are in reverse chronological order.
每次发布的编辑变更,都应在修订顺序前添加一个新的修订,以便所有修订都按相反的时间顺序进行。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | +--------------+---------+-------------+
module acme-system { namespace "http://acme.example.com/system"; prefix "acme";
module acme-system { namespace "http://acme.example.com/system"; prefix "acme";
import ietf-yang-types { prefix "yang"; }
import ietf-yang-types { prefix "yang"; }
include acme-types;
包括顶点类型;
organization "ACME Inc."; contact "Joe L. User
组织“ACME公司”;联系“Joe L.用户”
ACME, Inc. 42 Anywhere Drive Nowhere, CA 95134 USA
ACME,Inc.42 Anywhere Drive Nowhere,加利福尼亚州95134美国
Phone: +1 800 555 0100 EMail: joe@acme.example.com";
Phone: +1 800 555 0100 EMail: joe@acme.example.com";
description "The module for entities implementing the ACME protocol.";
描述“用于实现ACME协议的实体的模块。”;
revision "2007-06-09" { description "Initial revision."; }
revision "2007-06-09" { description "Initial revision."; }
// definitions follow... }
//定义如下…}
While the primary unit in YANG is a module, a YANG module can itself be constructed out of several submodules. Submodules allow a module designer to split a complex model into several pieces where all the submodules contribute to a single namespace, which is defined by the module that includes the submodules.
虽然YANG中的主要单元是一个模块,但YANG模块本身可以由几个子模块构成。子模块允许模块设计器将复杂模型拆分为多个部分,其中所有子模块都贡献给单个名称空间,该名称空间由包含子模块的模块定义。
The "submodule" statement defines the submodule's name, and groups all statements that belong to the submodule together. The "submodule" statement's argument is the name of the submodule, followed by a block of substatements that hold detailed submodule information. The submodule name follows the rules for identifiers in Section 6.2.
“submodule”语句定义子模块的名称,并将属于该子模块的所有语句分组在一起。“submodule”语句的参数是子模块的名称,后跟包含详细子模块信息的子语句块。子模块名称遵循第6.2节中的标识符规则。
Names of submodules published in RFC streams [RFC4844] MUST be assigned by IANA, see Section 14.
在RFC streams[RFC4844]中发布的子模块名称必须由IANA分配,见第14节。
Private submodule names are assigned by the organization owning the submodule without a central registry. It is RECOMMENDED to choose submodule names that will have a low probability of colliding with standard or other enterprise modules and submodules, e.g., by using the enterprise or organization name as a prefix for the submodule name.
私有子模块名称由拥有该子模块的组织分配,而无需中央注册表。建议选择与标准或其他企业模块和子模块冲突概率较低的子模块名称,例如,使用企业或组织名称作为子模块名称的前缀。
A submodule typically has the following layout:
子模块通常具有以下布局:
submodule <module-name> {
submodule <module-name> {
<yang-version statement>
<yang版本声明>
// module identification <belongs-to statement>
// module identification <belongs-to statement>
// linkage statements <import statements> <include statements>
// linkage statements <import statements> <include statements>
// meta information <organization statement> <contact statement> <description statement> <reference statement>
// meta information <organization statement> <contact statement> <description statement> <reference statement>
// revision history <revision statements>
// revision history <revision statements>
// module definitions <other statements> }
// module definitions <other statements> }
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | augment | 7.15 | 0..n | | belongs-to | 7.2.2 | 1 | | choice | 7.9 | 0..n | | contact | 7.1.8 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | deviation | 7.18.3 | 0..n | | extension | 7.17 | 0..n | | feature | 7.18.1 | 0..n | | grouping | 7.11 | 0..n | | identity | 7.16 | 0..n | | import | 7.1.5 | 0..n | | include | 7.1.6 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | notification | 7.14 | 0..n | | organization | 7.1.7 | 0..1 | | reference | 7.19.4 | 0..1 | | revision | 7.1.9 | 0..n | | rpc | 7.13 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | | yang-version | 7.1.2 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | augment | 7.15 | 0..n | | belongs-to | 7.2.2 | 1 | | choice | 7.9 | 0..n | | contact | 7.1.8 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | deviation | 7.18.3 | 0..n | | extension | 7.17 | 0..n | | feature | 7.18.1 | 0..n | | grouping | 7.11 | 0..n | | identity | 7.16 | 0..n | | import | 7.1.5 | 0..n | | include | 7.1.6 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | notification | 7.14 | 0..n | | organization | 7.1.7 | 0..1 | | reference | 7.19.4 | 0..1 | | revision | 7.1.9 | 0..n | | rpc | 7.13 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | | yang-version | 7.1.2 | 0..1 | +--------------+---------+-------------+
The "belongs-to" statement specifies the module to which the submodule belongs. The argument is an identifier that is the name of the module.
“属于”语句指定子模块所属的模块。参数是一个标识符,它是模块的名称。
A submodule MUST only be included by the module to which it belongs, or by another submodule that belongs to that module.
子模块只能由其所属的模块或属于该模块的另一个子模块包含。
The mandatory "prefix" substatement assigns a prefix for the module to which the submodule belongs. All definitions in the local submodule and any included submodules can be accessed by using the prefix.
强制性的“prefix”子语句为子模块所属的模块指定前缀。可以使用前缀访问本地子模块和任何包含的子模块中的所有定义。
The belongs-to's Substatements
属于的子状态
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | prefix | 7.1.4 | 1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | prefix | 7.1.4 | 1 | +--------------+---------+-------------+
submodule acme-types {
子模块顶点类型{
belongs-to "acme-system" { prefix "acme"; }
belongs-to "acme-system" { prefix "acme"; }
import ietf-yang-types { prefix "yang"; }
import ietf-yang-types { prefix "yang"; }
organization "ACME Inc."; contact "Joe L. User
组织“ACME公司”;联系“Joe L.用户”
ACME, Inc. 42 Anywhere Drive Nowhere, CA 95134 USA
ACME,Inc.42 Anywhere Drive Nowhere,加利福尼亚州95134美国
Phone: +1 800 555 0100 EMail: joe@acme.example.com";
Phone: +1 800 555 0100 EMail: joe@acme.example.com";
description "This submodule defines common ACME types.";
description“此子模块定义常见的ACME类型。”;
revision "2007-06-09" { description "Initial revision."; }
revision "2007-06-09" { description "Initial revision."; }
// definitions follows... }
//定义如下…}
The "typedef" statement defines a new type that may be used locally in the module, in modules or submodules which include it, and by other modules that import from it, according to the rules in
“typedef”语句定义了一个新类型,该类型可以根据中的规则在模块、包含它的模块或子模块中本地使用,也可以由从中导入的其他模块使用
Section 5.5. The new type is called the "derived type", and the type from which it was derived is called the "base type". All derived types can be traced back to a YANG built-in type.
第5.5节。新类型称为“派生类型”,派生它的类型称为“基类型”。所有派生类型都可以追溯到内置类型。
The "typedef" statement's argument is an identifier that is the name of the type to be defined, and MUST be followed by a block of substatements that holds detailed typedef information.
“typedef”语句的参数是一个标识符,它是要定义的类型的名称,后面必须跟一个包含详细typedef信息的子语句块。
The name of the type MUST NOT be one of the YANG built-in types. If the typedef is defined at the top level of a YANG module or submodule, the name of the type to be defined MUST be unique within the module.
类型的名称不能是内置类型之一。如果typedef是在模块或子模块的顶层定义的,则要定义的类型名称在模块中必须是唯一的。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | default | 7.3.4 | 0..1 | | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | type | 7.3.2 | 1 | | units | 7.3.3 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | default | 7.3.4 | 0..1 | | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | type | 7.3.2 | 1 | | units | 7.3.3 | 0..1 | +--------------+---------+-------------+
The "type" statement, which MUST be present, defines the base type from which this type is derived. See Section 7.4 for details.
必须存在的“type”语句定义了派生此类型的基类型。详见第7.4节。
The "units" statement, which is optional, takes as an argument a string that contains a textual definition of the units associated with the type.
“units”语句是可选的,它将包含与类型关联的单元的文本定义的字符串作为参数。
The "default" statement takes as an argument a string that contains a default value for the new type.
“default”语句将包含新类型的默认值的字符串作为参数。
The value of the "default" statement MUST be valid according to the type specified in the "type" statement.
根据“type”语句中指定的类型,“default”语句的值必须有效。
If the base type has a default value, and the new derived type does not specify a new default value, the base type's default value is also the default value of the new derived type.
如果基类型具有默认值,而新派生类型未指定新的默认值,则基类型的默认值也是新派生类型的默认值。
If the type's default value is not valid according to the new restrictions specified in a derived type or leaf definition, the derived type or leaf definition MUST specify a new default value compatible with the restrictions.
如果根据派生类型或叶定义中指定的新限制,类型的默认值无效,则派生类型或叶定义必须指定与这些限制兼容的新默认值。
typedef listen-ipv4-address { type inet:ipv4-address; default "0.0.0.0"; }
typedef listen-ipv4-address { type inet:ipv4-address; default "0.0.0.0"; }
The "type" statement takes as an argument a string that is the name of a YANG built-in type (see Section 9) or a derived type (see Section 7.3), followed by an optional block of substatements that are used to put further restrictions on the type.
“type”语句将一个字符串作为参数,该字符串是内置类型(参见第9节)或派生类型(参见第7.3节)的名称,后跟一个可选的子语句块,用于对该类型施加进一步的限制。
The restrictions that can be applied depend on the type being restricted. The restriction statements for all built-in types are described in the subsections of Section 9.
可以应用的限制取决于被限制的类型。所有内置类型的限制说明见第9节的小节。
+------------------+---------+-------------+ | substatement | section | cardinality | +------------------+---------+-------------+ | bit | 9.7.4 | 0..n | | enum | 9.6.4 | 0..n | | length | 9.4.4 | 0..1 | | path | 9.9.2 | 0..1 | | pattern | 9.4.6 | 0..n | | range | 9.2.4 | 0..1 | | require-instance | 9.13.2 | 0..1 | | type | 7.4 | 0..n | +------------------+---------+-------------+
+------------------+---------+-------------+ | substatement | section | cardinality | +------------------+---------+-------------+ | bit | 9.7.4 | 0..n | | enum | 9.6.4 | 0..n | | length | 9.4.4 | 0..1 | | path | 9.9.2 | 0..1 | | pattern | 9.4.6 | 0..n | | range | 9.2.4 | 0..1 | | require-instance | 9.13.2 | 0..1 | | type | 7.4 | 0..n | +------------------+---------+-------------+
The "container" statement is used to define an interior data node in the schema tree. It takes one argument, which is an identifier, followed by a block of substatements that holds detailed container information.
“container”语句用于定义模式树中的内部数据节点。它有一个参数,它是一个标识符,后跟一个包含详细容器信息的子语句块。
A container node does not have a value, but it has a list of child nodes in the data tree. The child nodes are defined in the container's substatements.
容器节点没有值,但在数据树中有子节点列表。子节点在容器的子状态中定义。
YANG supports two styles of containers, those that exist only for organizing the hierarchy of data nodes, and those whose presence in the configuration has an explicit meaning.
YANG支持两种类型的容器,一种是仅用于组织数据节点层次结构的容器,另一种是在配置中具有明确含义的容器。
In the first style, the container has no meaning of its own, existing only to contain child nodes. This is the default style.
在第一种样式中,容器本身没有意义,只存在于包含子节点的地方。这是默认样式。
For example, the set of scrambling options for Synchronous Optical Network (SONET) interfaces may be placed inside a "scrambling" container to enhance the organization of the configuration hierarchy, and to keep these nodes together. The "scrambling" node itself has no meaning, so removing the node when it becomes empty relieves the user from performing this task.
例如,用于同步光网络(SONET)接口的一组加扰选项可放置在“加扰”容器内,以增强配置层次结构的组织,并将这些节点保持在一起。“加扰”节点本身没有任何意义,因此在节点变空时移除节点可以免除用户执行此任务。
In the second style, the presence of the container itself is configuration data, representing a single bit of configuration data. The container acts as both a configuration knob and a means of organizing related configuration. These containers are explicitly created and deleted.
在第二种样式中,容器本身的存在是配置数据,表示单个位的配置数据。容器充当配置旋钮和组织相关配置的手段。这些容器是显式创建和删除的。
YANG calls this style a "presence container" and it is indicated using the "presence" statement, which takes as its argument a text string indicating what the presence of the node means.
YANG将这种样式称为“状态容器”,并使用“状态”语句表示,该语句将一个文本字符串作为其参数,指示节点的存在意味着什么。
For example, an "ssh" container may turn on the ability to log into the device using ssh, but can also contain any ssh-related configuration knobs, such as connection rates or retry limits.
例如,“ssh”容器可以启用使用ssh登录设备的功能,但也可以包含任何与ssh相关的配置旋钮,例如连接速率或重试限制。
The "presence" statement (see Section 7.5.5) is used to give semantics to the existence of the container in the data tree.
“presence”语句(见第7.5.5节)用于为数据树中容器的存在提供语义。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | config | 7.19.1 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | must | 7.5.3 | 0..n | | presence | 7.5.5 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | config | 7.19.1 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | must | 7.5.3 | 0..n | | presence | 7.5.5 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
The "must" statement, which is optional, takes as an argument a string that contains an XPath expression (see Section 6.4). It is used to formally declare a constraint on valid data. The constraint is enforced according to the rules in Section 8.
“must”语句是可选的,它将包含XPath表达式的字符串作为参数(参见第6.4节)。它用于正式声明对有效数据的约束。根据第8节中的规则强制执行约束。
When a datastore is validated, all "must" constraints are conceptually evaluated once for each data node in the data tree, and for all leafs with default values in use (see Section 7.6.1). If a data node does not exist in the data tree, and it does not have a default value, its "must" statements are not evaluated.
验证数据存储时,对数据树中的每个数据节点以及使用默认值的所有LEAF,在概念上对所有“必须”约束进行一次评估(见第7.6.1节)。如果数据树中不存在数据节点,并且该节点没有默认值,则不会计算其“必须”语句。
All such constraints MUST evaluate to true for the data to be valid.
所有这些约束的计算结果必须为true,数据才能有效。
The XPath expression is conceptually evaluated in the following context, in addition to the definition in Section 6.4.1:
除了第6.4.1节中的定义外,XPath表达式在以下上下文中进行概念性评估:
o The context node is the node in the data tree for which the "must" statement is defined.
o 上下文节点是数据树中定义了“必须”语句的节点。
o The accessible tree is made up of all nodes in the data tree, and all leafs with default values in use (see Section 7.6.1).
o 可访问树由数据树中的所有节点和使用默认值的所有叶组成(见第7.6.1节)。
The accessible tree depends on the context node:
可访问树取决于上下文节点:
o If the context node represents configuration, the tree is the data in the NETCONF datastore where the context node exists. The XPath root node has all top-level configuration data nodes in all modules as children.
o 如果上下文节点表示配置,则树是存在上下文节点的NETCONF数据存储中的数据。XPath根节点将所有模块中的所有顶级配置数据节点作为子节点。
o If the context node represents state data, the tree is all state data on the device, and the <running/> datastore. The XPath root node has all top-level data nodes in all modules as children.
o 如果上下文节点表示状态数据,则树是设备上的所有状态数据,以及<running/>数据存储。XPath根节点将所有模块中的所有顶级数据节点作为子节点。
o If the context node represents notification content, the tree is the notification XML instance document. The XPath root node has the element representing the notification being defined as the only child.
o 如果上下文节点表示通知内容,则树就是通知XML实例文档。XPath根节点具有表示被定义为唯一子节点的通知的元素。
o If the context node represents RPC input parameters, the tree is the RPC XML instance document. The XPath root node has the element representing the RPC operation being defined as the only child.
o 如果上下文节点表示RPC输入参数,则树就是RPC XML实例文档。XPath根节点将表示RPC操作的元素定义为唯一的子节点。
o If the context node represents RPC output parameters, the tree is the RPC reply instance document. The XPath root node has the elements representing the RPC output parameters as children.
o 如果上下文节点表示RPC输出参数,则树就是RPC应答实例文档。XPath根节点具有表示RPC输出参数的子元素。
The result of the XPath expression is converted to a boolean value using the standard XPath rules.
XPath表达式的结果使用标准XPath规则转换为布尔值。
Note that since all leaf values in the data tree are conceptually stored in their canonical form (see Sections 7.6 and 7.7), any XPath comparisons are done on the canonical value.
请注意,由于数据树中的所有叶值在概念上都以其规范形式存储(请参见第7.6和7.7节),因此任何XPath比较都是在规范值上进行的。
Also note that the XPath expression is conceptually evaluated. This means that an implementation does not have to use an XPath evaluator on the device. How the evaluation is done in practice is an implementation decision.
还要注意,XPath表达式是在概念上计算的。这意味着实现不必在设备上使用XPath计算器。如何在实践中进行评估是一项实施决策。
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
The "error-message" statement, which is optional, takes a string as an argument. If the constraint evaluates to false, the string is passed as <error-message> in the <rpc-error>.
“error message”语句是可选的,它将字符串作为参数。如果约束的计算结果为false,则字符串将作为<rpc error>中的<error message>传递。
The "error-app-tag" statement, which is optional, takes a string as an argument. If the constraint evaluates to false, the string is passed as <error-app-tag> in the <rpc-error>.
“error-app-tag”语句是可选的,它将字符串作为参数。如果约束的计算结果为false,则字符串将作为<rpc error>中的<error app tag>传递。
container interface { leaf ifType { type enumeration { enum ethernet; enum atm; } } leaf ifMTU { type uint32; } must "ifType != 'ethernet' or " + "(ifType = 'ethernet' and ifMTU = 1500)" { error-message "An ethernet MTU must be 1500"; } must "ifType != 'atm' or " + "(ifType = 'atm' and ifMTU <= 17966 and ifMTU >= 64)" { error-message "An atm MTU must be 64 .. 17966"; } }
container interface { leaf ifType { type enumeration { enum ethernet; enum atm; } } leaf ifMTU { type uint32; } must "ifType != 'ethernet' or " + "(ifType = 'ethernet' and ifMTU = 1500)" { error-message "An ethernet MTU must be 1500"; } must "ifType != 'atm' or " + "(ifType = 'atm' and ifMTU <= 17966 and ifMTU >= 64)" { error-message "An atm MTU must be 64 .. 17966"; } }
The "presence" statement assigns a meaning to the presence of a container in the data tree. It takes as an argument a string that contains a textual description of what the node's presence means.
“presence”语句为数据树中容器的存在赋予了意义。它接受一个字符串作为参数,该字符串包含节点存在的含义的文本描述。
If a container has the "presence" statement, the container's existence in the data tree carries some meaning. Otherwise, the container is used to give some structure to the data, and it carries no meaning by itself.
如果一个容器有“presence”语句,那么该容器在数据树中的存在就具有某种意义。否则,容器被用来为数据提供某种结构,它本身没有任何意义。
See Section 7.5.1 for additional information.
更多信息见第7.5.1节。
Within a container, the "container", "leaf", "list", "leaf-list", "uses", "choice", and "anyxml" statements can be used to define child nodes to the container.
在容器中,“container”、“leaf”、“list”、“leaf list”、“uses”、“choice”和“anyxml”语句可用于定义容器的子节点。
A container node is encoded as an XML element. The element's local name is the container's identifier, and its namespace is the module's XML namespace (see Section 7.1.3).
容器节点编码为XML元素。元素的本地名称是容器的标识符,其名称空间是模块的XML名称空间(参见第7.1.3节)。
The container's child nodes are encoded as subelements to the container element. If the container defines RPC input or output parameters, these subelements are encoded in the same order as they are defined within the "container" statement. Otherwise, the subelements are encoded in any order.
容器的子节点被编码为容器元素的子元素。如果容器定义了RPC输入或输出参数,则这些子元素的编码顺序与“container”语句中定义的顺序相同。否则,子元素按任意顺序编码。
A NETCONF server that replies to a <get> or <get-config> request MAY choose not to send a container element if the container node does not have the "presence" statement and no child nodes exist. Thus, a client that receives an <rpc-reply> for a <get> or <get-config> request, must be prepared to handle the case that a container node without a "presence" statement is not present in the XML.
如果容器节点没有“presence”语句且不存在子节点,则响应<get>或<get config>请求的NETCONF服务器可以选择不发送容器元素。因此,接收<get>或<get config>请求的<rpc reply>的客户机必须准备好处理没有“presence”语句的容器节点在XML中不存在的情况。
Containers can be created, deleted, replaced, and modified through <edit-config>, by using the "operation" attribute (see [RFC4741], Section 7.2) in the container's XML element.
通过使用容器XML元素中的“操作”属性(参见[RFC4741],第7.2节),可以通过<edit config>创建、删除、替换和修改容器。
If a container does not have a "presence" statement and the last child node is deleted, the NETCONF server MAY delete the container.
如果容器没有“presence”语句,并且删除了最后一个子节点,NETCONF服务器可能会删除该容器。
When a NETCONF server processes an <edit-config> request, the elements of procedure for the container node are:
当NETCONF服务器处理<edit config>请求时,容器节点的过程元素包括:
If the operation is "merge" or "replace", the node is created if it does not exist.
如果操作为“合并”或“替换”,则会在节点不存在时创建该节点。
If the operation is "create", the node is created if it does not exist. If the node already exists, a "data-exists" error is returned.
如果操作为“创建”,则在节点不存在时创建该节点。如果节点已经存在,则返回“数据存在”错误。
If the operation is "delete", the node is deleted if it exists. If the node does not exist, a "data-missing" error is returned.
如果操作为“删除”,则删除节点(如果存在)。如果节点不存在,则返回“数据丢失”错误。
Given the following container definition:
给定以下容器定义:
container system { description "Contains various system parameters"; container services { description "Configure externally available services"; container "ssh" { presence "Enables SSH"; description "SSH service specific configuration"; // more leafs, containers and stuff here... } } }
container system { description "Contains various system parameters"; container services { description "Configure externally available services"; container "ssh" { presence "Enables SSH"; description "SSH service specific configuration"; // more leafs, containers and stuff here... } } }
A corresponding XML instance example:
对应的XML实例示例:
<system> <services> <ssh/> </services> </system>
<system> <services> <ssh/> </services> </system>
Since the <ssh> element is present, ssh is enabled.
由于存在<ssh>元素,因此启用了ssh。
To delete a container with an <edit-config>:
要删除带有<edit config>的容器,请执行以下操作:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh nc:operation="delete"/> </services> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh nc:operation="delete"/> </services> </system> </config> </edit-config> </rpc>
The "leaf" statement is used to define a leaf node in the schema tree. It takes one argument, which is an identifier, followed by a block of substatements that holds detailed leaf information.
“leaf”语句用于在模式树中定义叶节点。它有一个参数,它是一个标识符,后跟一个包含详细叶信息的子语句块。
A leaf node has a value, but no child nodes in the data tree. Conceptually, the value in the data tree is always in the canonical form (see Section 9.1).
叶节点有一个值,但在数据树中没有子节点。从概念上讲,数据树中的值始终采用规范形式(参见第9.1节)。
A leaf node exists in zero or one instances in the data tree.
叶节点存在于数据树中的零个或一个实例中。
The "leaf" statement is used to define a scalar variable of a particular built-in or derived type.
“leaf”语句用于定义特定内置或派生类型的标量变量。
The default value of a leaf is the value that the server uses if the leaf does not exist in the data tree. The usage of the default value depends on the leaf's closest ancestor node in the schema tree that is not a non-presence container:
如果叶在数据树中不存在,则叶的默认值是服务器使用的值。默认值的使用取决于叶在架构树中最近的祖先节点,该节点不是非存在容器:
o If no such ancestor exists in the schema tree, the default value MUST be used.
o 如果模式树中不存在这样的祖先,则必须使用默认值。
o Otherwise, if this ancestor is a case node, the default value MUST be used if any node from the case exists in the data tree, or if the case node is the choice's default case, and no nodes from any other case exist in the data tree.
o 否则,如果此祖先是案例节点,则如果数据树中存在案例中的任何节点,或者如果案例节点是选项的默认案例,并且数据树中不存在任何其他案例中的节点,则必须使用默认值。
o Otherwise, the default value MUST be used if the ancestor node exists in the data tree.
o 否则,如果数据树中存在祖先节点,则必须使用默认值。
In these cases, the default value is said to be in use.
在这些情况下,默认值被称为正在使用。
When the default value is in use, the server MUST operationally behave as if the leaf was present in the data tree with the default value as its value.
当使用默认值时,服务器在操作上的行为必须与叶在数据树中以默认值作为其值一样。
If a leaf has a "default" statement, the leaf's default value is the value of the "default" statement. Otherwise, if the leaf's type has a default value, and the leaf is not mandatory, then the leaf's default value is the type's default value. In all other cases, the leaf does not have a default value.
如果一个叶子有一个“default”语句,那么叶子的默认值就是“default”语句的值。否则,如果叶的类型具有默认值,并且叶不是必需的,则叶的默认值是该类型的默认值。在所有其他情况下,叶没有默认值。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | default | 7.6.4 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | mandatory | 7.6.5 | 0..1 | | must | 7.5.3 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | type | 7.6.3 | 1 | | units | 7.3.3 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | default | 7.6.4 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | mandatory | 7.6.5 | 0..1 | | must | 7.5.3 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | type | 7.6.3 | 1 | | units | 7.3.3 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
The "type" statement, which MUST be present, takes as an argument the name of an existing built-in or derived type. The optional substatements specify restrictions on this type. See Section 7.4 for details.
必须存在的“type”语句将现有内置类型或派生类型的名称作为参数。可选子语句指定此类型的限制。详见第7.4节。
The "default" statement, which is optional, takes as an argument a string that contains a default value for the leaf.
“default”语句是可选的,它将包含叶的默认值的字符串作为参数。
The value of the "default" statement MUST be valid according to the type specified in the leaf's "type" statement.
根据叶的“type”语句中指定的类型,“default”语句的值必须有效。
The "default" statement MUST NOT be present on nodes where "mandatory" is true.
“default”语句不能出现在“mandatory”为true的节点上。
The "mandatory" statement, which is optional, takes as an argument the string "true" or "false", and puts a constraint on valid data. If not specified, the default is "false".
“mandatory”语句是可选的,它将字符串“true”或“false”作为参数,并对有效数据进行约束。如果未指定,则默认值为“false”。
If "mandatory" is "true", the behavior of the constraint depends on the type of the leaf's closest ancestor node in the schema tree that is not a non-presence container (see Section 7.5.1):
如果“mandatory”为“true”,则约束的行为取决于模式树中叶的最近祖先节点的类型,该节点不是非存在容器(请参见第7.5.1节):
o If no such ancestor exists in the schema tree, the leaf MUST exist.
o 如果模式树中不存在这样的祖先,那么叶必须存在。
o Otherwise, if this ancestor is a case node, the leaf MUST exist if any node from the case exists in the data tree.
o 否则,如果此祖先是案例节点,则如果案例中的任何节点存在于数据树中,则该叶必须存在。
o Otherwise, the leaf MUST exist if the ancestor node exists in the data tree.
o 否则,如果数据树中存在祖先节点,则叶必须存在。
This constraint is enforced according to the rules in Section 8.
此约束根据第8节中的规则强制执行。
A leaf node is encoded as an XML element. The element's local name is the leaf's identifier, and its namespace is the module's XML namespace (see Section 7.1.3).
叶节点编码为XML元素。元素的本地名称是叶的标识符,其名称空间是模块的XML名称空间(参见第7.1.3节)。
The value of the leaf node is encoded to XML according to the type, and sent as character data in the element.
叶节点的值根据类型编码为XML,并作为元素中的字符数据发送。
A NETCONF server that replies to a <get> or <get-config> request MAY choose not to send the leaf element if its value is the default value. Thus, a client that receives an <rpc-reply> for a <get> or <get-config> request, MUST be prepared to handle the case that a leaf node with a default value is not present in the XML. In this case, the value used by the server is known to be the default value.
A NETCONF server that replies to a <get> or <get-config> request MAY choose not to send the leaf element if its value is the default value. Thus, a client that receives an <rpc-reply> for a <get> or <get-config> request, MUST be prepared to handle the case that a leaf node with a default value is not present in the XML. In this case, the value used by the server is known to be the default value.translate error, please retry
See Section 7.6.8 for an example.
示例见第7.6.8节。
When a NETCONF server processes an <edit-config> request, the elements of procedure for the leaf node are:
当NETCONF服务器处理<edit config>请求时,叶节点的过程元素包括:
If the operation is "merge" or "replace", the node is created if it does not exist, and its value is set to the value found in the XML RPC data.
如果操作为“merge”或“replace”,则将在节点不存在时创建该节点,并将其值设置为在XML RPC数据中找到的值。
If the operation is "create", the node is created if it does not exist. If the node already exists, a "data-exists" error is returned.
如果操作为“创建”,则在节点不存在时创建该节点。如果节点已经存在,则返回“数据存在”错误。
If the operation is "delete", the node is deleted if it exists. If the node does not exist, a "data-missing" error is returned.
如果操作为“删除”,则删除节点(如果存在)。如果节点不存在,则返回“数据丢失”错误。
Given the following "leaf" statement, placed in the previously defined "ssh" container (see Section 7.5.9):
给出以下“leaf”语句,放在前面定义的“ssh”容器中(参见第7.5.9节):
leaf port { type inet:port-number; default 22; description "The port to which the SSH server listens" }
leaf port { type inet:port-number; default 22; description "The port to which the SSH server listens" }
A corresponding XML instance example:
对应的XML实例示例:
<port>2022</port>
<port>2022</port>
To set the value of a leaf with an <edit-config>:
要使用<edit config>设置叶的值,请执行以下操作:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh> <port>2022</port> </ssh> </services> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh> <port>2022</port> </ssh> </services> </system> </config> </edit-config> </rpc>
Where the "leaf" statement is used to define a simple scalar variable of a particular type, the "leaf-list" statement is used to define an array of a particular type. The "leaf-list" statement takes one argument, which is an identifier, followed by a block of substatements that holds detailed leaf-list information.
如果“leaf”语句用于定义特定类型的简单标量变量,“leaf list”语句用于定义特定类型的数组。“叶列表”语句接受一个参数,该参数是一个标识符,后跟一个包含详细叶列表信息的子语句块。
The values in a leaf-list MUST be unique.
叶列表中的值必须是唯一的。
Conceptually, the values in the data tree are always in the canonical form (see Section 9.1).
从概念上讲,数据树中的值始终采用规范形式(参见第9.1节)。
If the type referenced by the leaf-list has a default value, it has no effect in the leaf-list.
如果叶列表引用的类型具有默认值,则该类型在叶列表中无效。
YANG supports two styles for ordering the entries within lists and leaf-lists. In many lists, the order of list entries does not impact the implementation of the list's configuration, and the device is free to sort the list entries in any reasonable order. The "description" string for the list may suggest an order to the device implementor. YANG calls this style of list "system ordered" and they are indicated with the statement "ordered-by system".
YANG支持两种样式对列表和叶列表中的条目进行排序。在许多列表中,列表项的顺序不会影响列表配置的实现,并且设备可以按照任何合理的顺序对列表项进行排序。列表的“描述”字符串可能会向设备实现者建议一个顺序。杨称这种类型的列表为“系统有序”,并用“按系统有序”的语句表示。
For example, a list of valid users would typically be sorted alphabetically, since the order in which the users appeared in the configuration would not impact the creation of those users' accounts.
例如,有效用户列表通常按字母顺序排序,因为用户在配置中出现的顺序不会影响这些用户帐户的创建。
In the other style of lists, the order of list entries matters for the implementation of the list's configuration and the user is responsible for ordering the entries, while the device maintains that order. YANG calls this style of list "user ordered" and they are indicated with the statement "ordered-by user".
在另一种类型的列表中,列表条目的顺序对列表配置的实现很重要,用户负责对条目进行排序,而设备保持该顺序。YANG将这种类型的列表称为“用户订购”,并用语句“按用户订购”表示。
For example, the order in which firewall filters entries are applied to incoming traffic may affect how that traffic is filtered. The user would need to decide if the filter entry that discards all TCP traffic should be applied before or after the filter entry that allows all traffic from trusted interfaces. The choice of order would be crucial.
例如,防火墙过滤器条目应用于传入流量的顺序可能会影响该流量的过滤方式。用户需要决定是否应在允许来自受信任接口的所有流量的筛选器条目之前或之后应用丢弃所有TCP流量的筛选器条目。秩序的选择至关重要。
YANG provides a rich set of facilities within NETCONF's <edit-config> operation that allows the order of list entries in user-ordered lists to be controlled. List entries may be inserted or rearranged, positioned as the first or last entry in the list, or positioned before or after another specific entry.
YANG在NETCONF的<edit config>操作中提供了一组丰富的工具,允许控制用户排序列表中列表项的顺序。列表条目可以插入或重新排列,定位为列表中的第一个或最后一个条目,或者定位在另一个特定条目之前或之后。
The "ordered-by" statement is covered in Section 7.7.5.
第7.7.5节介绍了“订购人”声明。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | max-elements | 7.7.4 | 0..1 | | min-elements | 7.7.3 | 0..1 | | must | 7.5.3 | 0..n | | ordered-by | 7.7.5 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | type | 7.4 | 1 | | units | 7.3.3 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | max-elements | 7.7.4 | 0..1 | | min-elements | 7.7.3 | 0..1 | | must | 7.5.3 | 0..n | | ordered-by | 7.7.5 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | type | 7.4 | 1 | | units | 7.3.3 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
The "min-elements" statement, which is optional, takes as an argument a non-negative integer that puts a constraint on valid list entries. A valid leaf-list or list MUST have at least min-elements entries.
“min elements”语句是可选的,它将一个非负整数作为参数,该非负整数对有效的列表项进行约束。有效的叶列表或列表必须至少包含min元素条目。
If no "min-elements" statement is present, it defaults to zero.
如果不存在“min elements”语句,则默认为零。
The behavior of the constraint depends on the type of the leaf-list's or list's closest ancestor node in the schema tree that is not a non-presence container (see Section 7.5.1):
约束的行为取决于模式树中不是非存在容器的叶列表或列表最近祖先节点的类型(参见第7.5.1节):
o If this ancestor is a case node, the constraint is enforced if any other node from the case exists.
o 如果此祖先是案例节点,则如果案例中存在任何其他节点,则强制执行约束。
o Otherwise, it is enforced if the ancestor node exists.
o 否则,如果祖先节点存在,则强制执行。
The constraint is further enforced according to the rules in Section 8.
根据第8节中的规则,进一步实施约束。
The "max-elements" statement, which is optional, takes as an argument a positive integer or the string "unbounded", which puts a constraint on valid list entries. A valid leaf-list or list always has at most max-elements entries.
“max elements”语句是可选的,它将一个正整数或字符串“unbounded”作为参数,该字符串对有效列表项施加约束。有效的叶列表或列表始终最多包含max elements条目。
If no "max-elements" statement is present, it defaults to "unbounded".
如果不存在“max elements”语句,则默认为“unbounded”。
The "max-elements" constraint is enforced according to the rules in Section 8.
“最大元素”约束根据第8节中的规则强制执行。
The "ordered-by" statement defines whether the order of entries within a list are determined by the user or the system. The argument is one of the strings "system" or "user". If not present, order defaults to "system".
“ordered by”语句定义列表中条目的顺序是由用户还是由系统确定的。参数是字符串“system”或“user”之一。如果不存在,订单默认为“系统”。
This statement is ignored if the list represents state data, RPC output parameters, or notification content.
如果列表表示状态数据、RPC输出参数或通知内容,则忽略此语句。
See Section 7.7.1 for additional information.
更多信息见第7.7.1节。
The entries in the list are sorted according to an unspecified order. Thus, an implementation is free to sort the entries in the most appropriate order. An implementation SHOULD use the same order for the same data, regardless of how the data were created. Using a deterministic order will make comparisons possible using simple tools like "diff".
列表中的条目按照未指定的顺序进行排序。因此,实现可以按照最合适的顺序对条目进行自由排序。无论数据是如何创建的,实现都应该对相同的数据使用相同的顺序。使用确定性顺序可以使用“diff”等简单工具进行比较。
This is the default order.
这是默认顺序。
The entries in the list are sorted according to an order defined by the user. This order is controlled by using special XML attributes in the <edit-config> request. See Section 7.7.7 for details.
列表中的条目根据用户定义的顺序进行排序。此顺序通过在<edit config>请求中使用特殊的XML属性来控制。详见第7.7.7节。
A leaf-list node is encoded as a series of XML elements. Each element's local name is the leaf-list's identifier, and its namespace is the module's XML namespace (see Section 7.1.3).
叶列表节点编码为一系列XML元素。每个元素的本地名称是叶列表的标识符,其名称空间是模块的XML名称空间(参见第7.1.3节)。
The value of each leaf-list entry is encoded to XML according to the type, and sent as character data in the element.
每个叶列表条目的值根据类型编码为XML,并作为元素中的字符数据发送。
The XML elements representing leaf-list entries MUST appear in the order specified by the user if the leaf-list is "ordered-by user"; otherwise, the order is implementation-dependent. The XML elements
如果叶列表是“按用户排序”的,则表示叶列表条目的XML元素必须按照用户指定的顺序出现;否则,顺序取决于实现。XML元素
representing leaf-list entries MAY be interleaved with other sibling elements, unless the leaf-list defines RPC input or output parameters.
除非叶列表定义了RPC输入或输出参数,否则表示叶列表的条目可以与其他同级元素交错。
See Section 7.7.8 for an example.
示例见第7.7.8节。
Leaf-list entries can be created and deleted, but not modified, through <edit-config>, by using the "operation" attribute in the leaf-list entry's XML element.
通过使用叶列表条目的XML元素中的“operation”属性,可以创建和删除叶列表条目,但不能修改。
In an "ordered-by user" leaf-list, the attributes "insert" and "value" in the YANG XML namespace (Section 5.3.1) can be used to control where in the leaf-list the entry is inserted. These can be used during "create" operations to insert a new leaf-list entry, or during "merge" or "replace" operations to insert a new leaf-list entry or move an existing one.
在“按用户排序”叶列表中,XML命名空间(第5.3.1节)中的属性“插入”和“值”可用于控制在叶列表中插入条目的位置。这些可以在“创建”操作期间用于插入新的叶列表条目,或在“合并”或“替换”操作期间用于插入新的叶列表条目或移动现有的叶列表条目。
The "insert" attribute can take the values "first", "last", "before", and "after". If the value is "before" or "after", the "value" attribute MUST also be used to specify an existing entry in the leaf-list.
“insert”属性可以采用值“first”、“last”、“before”和“after”。如果值为“before”或“after”,则“value”属性还必须用于指定叶列表中的现有条目。
If no "insert" attribute is present in the "create" operation, it defaults to "last".
如果“创建”操作中不存在“插入”属性,则默认为“最后”。
If several entries in an "ordered-by user" leaf-list are modified in the same <edit-config> request, the entries are modified one at the time, in the order of the XML elements in the request.
如果在同一<edit config>请求中修改了“ordered by user”叶列表中的多个条目,则这些条目将按照请求中XML元素的顺序一次修改一个。
In a <copy-config>, or an <edit-config> with a "replace" operation that covers the entire leaf-list, the leaf-list order is the same as the order of the XML elements in the request.
在包含整个叶列表的“replace”操作的<copy config>或<edit config>中,叶列表顺序与请求中XML元素的顺序相同。
When a NETCONF server processes an <edit-config> request, the elements of procedure for a leaf-list node are:
当NETCONF服务器处理<edit config>请求时,叶列表节点的过程元素包括:
If the operation is "merge" or "replace", the leaf-list entry is created if it does not exist.
如果操作为“合并”或“替换”,则会在叶列表条目不存在时创建该条目。
If the operation is "create", the leaf-list entry is created if it does not exist. If the leaf-list entry already exists, a "data-exists" error is returned.
如果操作为“创建”,则会创建不存在的叶列表条目。如果叶列表条目已经存在,则返回“数据存在”错误。
If the operation is "delete", the entry is deleted from the leaf-list if it exists. If the leaf-list entry does not exist, a "data-missing" error is returned.
如果操作为“删除”,则该条目将从叶列表中删除(如果存在)。如果叶列表条目不存在,则返回“数据丢失”错误。
leaf-list allow-user { type string; description "A list of user name patterns to allow"; }
leaf-list allow-user { type string; description "A list of user name patterns to allow"; }
A corresponding XML instance example:
对应的XML实例示例:
<allow-user>alice</allow-user> <allow-user>bob</allow-user>
<allow-user>alice</allow-user> <allow-user>bob</allow-user>
To create a new element in this list, using the default <edit-config> operation "merge":
要在此列表中创建新元素,请使用默认的<edit config>操作“merge”:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh> <allow-user>eric</allow-user> </ssh> </services> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh> <allow-user>eric</allow-user> </ssh> </services> </system> </config> </edit-config> </rpc>
Given the following ordered-by user leaf-list:
给定按用户叶列表排序的以下内容:
leaf-list cipher { type string; ordered-by user; description "A list of ciphers"; }
leaf-list cipher { type string; ordered-by user; description "A list of ciphers"; }
The following would be used to insert a new cipher "blowfish-cbc" after "3des-cbc":
以下内容将用于在“3des cbc”之后插入新密码“河豚cbc”:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:yang="urn:ietf:params:xml:ns:yang:1"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh> <cipher nc:operation="create" yang:insert="after" yang:value="3des-cbc">blowfish-cbc</cipher> </ssh> </services> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:yang="urn:ietf:params:xml:ns:yang:1"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <services> <ssh> <cipher nc:operation="create" yang:insert="after" yang:value="3des-cbc">blowfish-cbc</cipher> </ssh> </services> </system> </config> </edit-config> </rpc>
The "list" statement is used to define an interior data node in the schema tree. A list node may exist in multiple instances in the data tree. Each such instance is known as a list entry. The "list" statement takes one argument, which is an identifier, followed by a block of substatements that holds detailed list information.
“list”语句用于定义模式树中的内部数据节点。列表节点可能存在于数据树中的多个实例中。每个这样的实例称为列表条目。“list”语句接受一个参数,它是一个标识符,后跟一个包含详细列表信息的子语句块。
A list entry is uniquely identified by the values of the list's keys, if defined.
列表项由列表键的值唯一标识(如果已定义)。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | config | 7.19.1 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | key | 7.8.2 | 0..1 | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | max-elements | 7.7.4 | 0..1 | | min-elements | 7.7.3 | 0..1 | | must | 7.5.3 | 0..n | | ordered-by | 7.7.5 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | unique | 7.8.3 | 0..n | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | config | 7.19.1 | 0..1 | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | key | 7.8.2 | 0..1 | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | max-elements | 7.7.4 | 0..1 | | min-elements | 7.7.3 | 0..1 | | must | 7.5.3 | 0..n | | ordered-by | 7.7.5 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | unique | 7.8.3 | 0..n | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
The "key" statement, which MUST be present if the list represents configuration, and MAY be present otherwise, takes as an argument a string that specifies a space-separated list of leaf identifiers of this list. A leaf identifier MUST NOT appear more than once in the key. Each such leaf identifier MUST refer to a child leaf of the list. The leafs can be defined directly in substatements to the list, or in groupings used in the list.
如果列表表示配置,则“key”语句必须存在,否则可能存在。该语句将一个字符串作为参数,该字符串指定此列表的叶标识符的以空格分隔的列表。叶标识符在键中不能出现多次。每个这样的叶标识符必须引用列表的子叶。可以直接在列表的子状态或列表中使用的分组中定义LEAF。
The combined values of all the leafs specified in the key are used to uniquely identify a list entry. All key leafs MUST be given values when a list entry is created. Thus, any default values in the key leafs or their types are ignored. It also implies that any mandatory statement in the key leafs are ignored.
键中指定的所有叶的组合值用于唯一标识列表项。创建列表条目时,必须为所有键叶指定值。因此,将忽略键叶或其类型中的任何默认值。它还意味着忽略键叶中的任何强制语句。
A leaf that is part of the key can be of any built-in or derived type, except it MUST NOT be the built-in type "empty".
作为键的一部分的叶可以是任何内置类型或派生类型,但它不能是内置类型“empty”。
All key leafs in a list MUST have the same value for their "config" as the list itself.
列表中的所有键叶的“配置”值必须与列表本身的值相同。
The key string syntax is formally defined by the rule "key-arg" in Section 12.
键字符串语法由第12节中的规则“key arg”正式定义。
The "unique" statement is used to put constraints on valid list entries. It takes as an argument a string that contains a space-separated list of schema node identifiers, which MUST be given in the descendant form (see the rule "descendant-schema-nodeid" in Section 12). Each such schema node identifier MUST refer to a leaf.
“unique”语句用于对有效列表项进行约束。它接受一个字符串作为参数,该字符串包含一个以空格分隔的模式节点标识符列表,该列表必须以子代形式给出(请参阅第12节中的规则“子代模式节点ID”)。每个这样的模式节点标识符必须引用一个叶。
If one of the referenced leafs represents configuration data, then all of the referenced leafs MUST represent configuration data.
如果其中一个引用的leaf表示配置数据,那么所有引用的leaf都必须表示配置数据。
The "unique" constraint specifies that the combined values of all the leaf instances specified in the argument string, including leafs with default values, MUST be unique within all list entry instances in which all referenced leafs exist. The constraint is enforced according to the rules in Section 8.
“unique”约束指定参数字符串中指定的所有叶实例(包括具有默认值的叶)的组合值在所有引用叶存在的所有列表条目实例中必须是唯一的。根据第8节中的规则强制执行约束。
The unique string syntax is formally defined by the rule "unique-arg" in Section 12.
唯一字符串语法由第12节中的规则“unique arg”正式定义。
With the following list:
以下是:
list server { key "name"; unique "ip port"; leaf name { type string; } leaf ip { type inet:ip-address; } leaf port { type inet:port-number; } }
list server { key "name"; unique "ip port"; leaf name { type string; } leaf ip { type inet:ip-address; } leaf port { type inet:port-number; } }
The following configuration is not valid:
以下配置无效:
<server> <name>smtp</name> <ip>192.0.2.1</ip> <port>25</port> </server>
<server> <name>smtp</name> <ip>192.0.2.1</ip> <port>25</port> </server>
<server> <name>http</name> <ip>192.0.2.1</ip> <port>25</port> </server>
<server> <name>http</name> <ip>192.0.2.1</ip> <port>25</port> </server>
The following configuration is valid, since the "http" and "ftp" list entries do not have a value for all referenced leafs, and are thus not taken into account when the "unique" constraint is enforced:
以下配置是有效的,因为“http”和“ftp”列表项没有针对所有引用的leaf的值,因此在强制执行“unique”约束时不考虑这些值:
<server> <name>smtp</name> <ip>192.0.2.1</ip> <port>25</port> </server>
<server> <name>smtp</name> <ip>192.0.2.1</ip> <port>25</port> </server>
<server> <name>http</name> <ip>192.0.2.1</ip> </server>
<server> <name>http</name> <ip>192.0.2.1</ip> </server>
<server> <name>ftp</name> <ip>192.0.2.1</ip> </server>
<server> <name>ftp</name> <ip>192.0.2.1</ip> </server>
Within a list, the "container", "leaf", "list", "leaf-list", "uses", "choice", and "anyxml" statements can be used to define child nodes to the list.
在列表中,“container”、“leaf”、“list”、“leaf list”、“uses”、“choice”和“anyxml”语句可用于定义列表的子节点。
A list is encoded as a series of XML elements, one for each entry in the list. Each element's local name is the list's identifier, and its namespace is the module's XML namespace (see Section 7.1.3).
列表被编码为一系列XML元素,列表中的每个条目对应一个XML元素。每个元素的本地名称是列表的标识符,其名称空间是模块的XML名称空间(参见第7.1.3节)。
The list's key nodes are encoded as subelements to the list's identifier element, in the same order as they are defined within the "key" statement.
列表的关键节点被编码为列表标识符元素的子元素,其顺序与“key”语句中定义的顺序相同。
The rest of the list's child nodes are encoded as subelements to the list element, after the keys. If the list defines RPC input or output parameters, the subelements are encoded in the same order as they are defined within the "list" statement. Otherwise, the subelements are encoded in any order.
列表的其余子节点在键之后编码为列表元素的子元素。如果列表定义了RPC输入或输出参数,则子元素的编码顺序与“list”语句中定义的顺序相同。否则,子元素按任意顺序编码。
The XML elements representing list entries MUST appear in the order specified by the user if the list is "ordered-by user", otherwise the order is implementation-dependent. The XML elements representing list entries MAY be interleaved with other sibling elements, unless the list defines RPC input or output parameters.
如果列表是“按用户排序”的,则表示列表项的XML元素必须按照用户指定的顺序出现,否则顺序取决于实现。表示列表项的XML元素可以与其他同级元素交错,除非列表定义了RPC输入或输出参数。
List entries can be created, deleted, replaced, and modified through <edit-config>, by using the "operation" attribute in the list's XML element. In each case, the values of all keys are used to uniquely identify a list entry. If all keys are not specified for a list entry, a "missing-element" error is returned.
通过使用列表XML元素中的“operation”属性,可以通过<edit config>创建、删除、替换和修改列表条目。在每种情况下,所有键的值都用于唯一标识列表条目。如果没有为列表项指定所有键,则返回“缺少元素”错误。
In an "ordered-by user" list, the attributes "insert" and "key" in the YANG XML namespace (Section 5.3.1) can be used to control where in the list the entry is inserted. These can be used during "create" operations to insert a new list entry, or during "merge" or "replace" operations to insert a new list entry or move an existing one.
在“按用户排序”列表中,XML名称空间(第5.3.1节)中的属性“插入”和“键”可用于控制条目在列表中插入的位置。可以在“创建”操作期间插入新列表项,或在“合并”或“替换”操作期间插入新列表项或移动现有列表项。
The "insert" attribute can take the values "first", "last", "before", and "after". If the value is "before" or "after", the "key" attribute MUST also be used, to specify an existing element in the list. The value of the "key" attribute is the key predicates of the full instance identifier (see Section 9.13) for the list entry.
“insert”属性可以采用值“first”、“last”、“before”和“after”。如果值为“before”或“after”,则还必须使用“key”属性来指定列表中的现有元素。“key”属性的值是列表项的完整实例标识符(见第9.13节)的键谓词。
If no "insert" attribute is present in the "create" operation, it defaults to "last".
如果“创建”操作中不存在“插入”属性,则默认为“最后”。
If several entries in an "ordered-by user" list are modified in the same <edit-config> request, the entries are modified one at the time, in the order of the XML elements in the request.
如果在同一个<edit config>请求中修改了“ordered by user”(按用户排序)列表中的多个条目,则会按照请求中XML元素的顺序一次修改一个条目。
In a <copy-config>, or an <edit-config> with a "replace" operation that covers the entire list, the list entry order is the same as the order of the XML elements in the request.
在覆盖整个列表的带有“replace”操作的<copy config>或<edit config>中,列表条目顺序与请求中XML元素的顺序相同。
When a NETCONF server processes an <edit-config> request, the elements of procedure for a list node are:
当NETCONF服务器处理<edit config>请求时,列表节点的过程元素包括:
If the operation is "merge" or "replace", the list entry is created if it does not exist. If the list entry already exists and the "insert" and "key" attributes are present, the list entry is moved according to the values of the "insert" and "key" attributes. If the list entry exists and the "insert" and "key" attributes are not present, the list entry is not moved.
If the operation is "merge" or "replace", the list entry is created if it does not exist. If the list entry already exists and the "insert" and "key" attributes are present, the list entry is moved according to the values of the "insert" and "key" attributes. If the list entry exists and the "insert" and "key" attributes are not present, the list entry is not moved.translate error, please retry
If the operation is "create", the list entry is created if it does not exist. If the list entry already exists, a "data-exists" error is returned.
如果操作为“创建”,则在列表项不存在时创建列表项。如果列表条目已经存在,则返回“数据存在”错误。
If the operation is "delete", the entry is deleted from the list if it exists. If the list entry does not exist, a "data-missing" error is returned.
如果操作为“删除”,则该条目将从列表中删除(如果存在)。如果列表项不存在,则返回“数据丢失”错误。
Given the following list:
鉴于以下清单:
list user { key "name"; config true; description "This is a list of users in the system.";
list user { key "name"; config true; description "This is a list of users in the system.";
leaf name { type string; } leaf type { type string; } leaf full-name { type string; } }
leaf name { type string; } leaf type { type string; } leaf full-name { type string; } }
A corresponding XML instance example:
对应的XML实例示例:
<user> <name>fred</name> <type>admin</type> <full-name>Fred Flintstone</full-name> </user>
<user> <name>fred</name> <type>admin</type> <full-name>Fred Flintstone</full-name> </user>
To create a new user "barney":
要创建新用户“barney”:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <user nc:operation="create"> <name>barney</name> <type>admin</type> <full-name>Barney Rubble</full-name> </user> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <user nc:operation="create"> <name>barney</name> <type>admin</type> <full-name>Barney Rubble</full-name> </user> </system> </config> </edit-config> </rpc>
To change the type of "fred" to "superuser":
要将“fred”的类型更改为“超级用户”:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <user> <name>fred</name> <type>superuser</type> </user> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <user> <name>fred</name> <type>superuser</type> </user> </system> </config> </edit-config> </rpc>
Given the following ordered-by user list:
给定以下按用户顺序排列的列表:
list user { description "This is a list of users in the system."; ordered-by user; config true;
list user { description "This is a list of users in the system."; ordered-by user; config true;
key "name";
键“名称”;
leaf name { type string; } leaf type { type string; } leaf full-name { type string; } }
leaf name { type string; } leaf type { type string; } leaf full-name { type string; } }
The following would be used to insert a new user "barney" after the user "fred":
以下内容将用于在用户“fred”之后插入新用户“barney”:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:yang="urn:ietf:params:xml:ns:yang:1"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config" xmlns:ex="http://example.com/schema/config"> <user nc:operation="create" yang:insert="after" yang:key="[ex:name='fred']"> <name>barney</name> <type>admin</type> <full-name>Barney Rubble</full-name> </user> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:yang="urn:ietf:params:xml:ns:yang:1"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config" xmlns:ex="http://example.com/schema/config"> <user nc:operation="create" yang:insert="after" yang:key="[ex:name='fred']"> <name>barney</name> <type>admin</type> <full-name>Barney Rubble</full-name> </user> </system> </config> </edit-config> </rpc>
The following would be used to move the user "barney" before the user "fred":
以下内容将用于将用户“barney”移动到用户“fred”之前:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:yang="urn:ietf:params:xml:ns:yang:1"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config" xmlns:ex="http://example.com/schema/config"> <user nc:operation="merge" yang:insert="before" yang:key="[ex:name='fred']"> <name>barney</name> </user> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:yang="urn:ietf:params:xml:ns:yang:1"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config" xmlns:ex="http://example.com/schema/config"> <user nc:operation="merge" yang:insert="before" yang:key="[ex:name='fred']"> <name>barney</name> </user> </system> </config> </edit-config> </rpc>
The "choice" statement defines a set of alternatives, only one of which may exist at any one time. The argument is an identifier, followed by a block of substatements that holds detailed choice information. The identifier is used to identify the choice node in the schema tree. A choice node does not exist in the data tree.
“choice”语句定义了一组备选方案,在任何时候都只能存在其中一个。参数是一个标识符,后跟一个包含详细选择信息的子语句块。标识符用于标识模式树中的选择节点。数据树中不存在选择节点。
A choice consists of a number of branches, defined with the "case" substatement. Each branch contains a number of child nodes. The nodes from at most one of the choice's branches exist at the same time.
选项由许多分支组成,这些分支用“case”子语句定义。每个分支包含多个子节点。最多一个选项分支中的节点同时存在。
See Section 8.3.2 for additional information.
更多信息见第8.3.2节。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | case | 7.9.2 | 0..n | | config | 7.19.1 | 0..1 | | container | 7.5 | 0..n | | default | 7.9.3 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | mandatory | 7.9.4 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | case | 7.9.2 | 0..n | | config | 7.19.1 | 0..1 | | container | 7.5 | 0..n | | default | 7.9.3 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | mandatory | 7.9.4 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
The "case" statement is used to define branches of the choice. It takes as an argument an identifier, followed by a block of substatements that holds detailed case information.
“case”语句用于定义选项的分支。它将标识符作为参数,后跟一个包含详细案例信息的子语句块。
The identifier is used to identify the case node in the schema tree. A case node does not exist in the data tree.
标识符用于标识模式树中的案例节点。数据树中不存在案例节点。
Within a "case" statement, the "anyxml", "choice", "container", "leaf", "list", "leaf-list", and "uses" statements can be used to define child nodes to the case node. The identifiers of all these child nodes MUST be unique within all cases in a choice. For example, the following is illegal:
在“case”语句中,“anyxml”、“choice”、“container”、“leaf”、“list”、“leaf list”和“uses”语句可用于定义case节点的子节点。所有这些子节点的标识符在选项的所有情况下都必须是唯一的。例如,以下行为是非法的:
choice interface-type { // This example is illegal YANG case a { leaf ethernet { ... } } case b { container ethernet { ...} } }
choice interface-type { // This example is illegal YANG case a { leaf ethernet { ... } } case b { container ethernet { ...} } }
As a shorthand, the "case" statement can be omitted if the branch contains a single "anyxml", "container", "leaf", "list", or "leaf-list" statement. In this case, the identifier of the case node is the same as the identifier in the branch statement. The following example:
简而言之,如果分支包含单个“anyxml”、“container”、“leaf”、“list”或“leaf list”语句,则可以省略“case”语句。在这种情况下,案例节点的标识符与分支语句中的标识符相同。下面是一个例子:
choice interface-type { container ethernet { ... } }
choice interface-type { container ethernet { ... } }
is equivalent to:
相当于:
choice interface-type { case ethernet { container ethernet { ... } } }
choice interface-type { case ethernet { container ethernet { ... } } }
The case identifier MUST be unique within a choice.
案例标识符在选项中必须是唯一的。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
The "default" statement indicates if a case should be considered as the default if no child nodes from any of the choice's cases exist. The argument is the identifier of the "case" statement. If the "default" statement is missing, there is no default case.
“default”语句表示如果该选项的任何案例都不存在子节点,则该案例是否应被视为默认案例。参数是“case”语句的标识符。如果缺少“default”语句,则不存在默认情况。
The "default" statement MUST NOT be present on choices where "mandatory" is true.
“默认”语句不得出现在“强制”为真的选项上。
The default case is only important when considering the default values of nodes under the cases. The default values for nodes under the default case are used if none of the nodes under any of the cases are present.
只有在考虑案例下节点的默认值时,默认案例才很重要。如果任何情况下的节点均不存在,则使用默认情况下的节点的默认值。
There MUST NOT be any mandatory nodes (Section 3.1) directly under the default case.
默认情况下不得有任何强制节点(第3.1节)。
Default values for child nodes under a case are only used if one of the nodes under that case is present, or if that case is the default case. If none of the nodes under a case are present and the case is not the default case, the default values of the cases' child nodes are ignored.
仅当案例下的一个节点存在或该案例为默认案例时,才会使用该案例下的子节点的默认值。如果案例下的所有节点都不存在且案例不是默认案例,则案例子节点的默认值将被忽略。
In this example, the choice defaults to "interval", and the default value will be used if none of "daily", "time-of-day", or "manual" are present. If "daily" is present, the default value for "time-of-day" will be used.
在本例中,该选项默认为“interval”,如果“daily”、“time of day”或“manual”均不存在,则将使用默认值。如果存在“每日”,则将使用“每日时间”的默认值。
container transfer { choice how { default interval; case interval { leaf interval { type uint16; default 30; units minutes; } } case daily { leaf daily { type empty; } leaf time-of-day { type string; units 24-hour-clock; default 1am; } } case manual { leaf manual { type empty; } } } }
container transfer { choice how { default interval; case interval { leaf interval { type uint16; default 30; units minutes; } } case daily { leaf daily { type empty; } leaf time-of-day { type string; units 24-hour-clock; default 1am; } } case manual { leaf manual { type empty; } } } }
The "mandatory" statement, which is optional, takes as an argument the string "true" or "false", and puts a constraint on valid data. If "mandatory" is "true", at least one node from exactly one of the choice's case branches MUST exist.
“mandatory”语句是可选的,它将字符串“true”或“false”作为参数,并对有效数据进行约束。如果“mandatory”为“true”,则必须至少存在一个节点,该节点恰好来自该选项的一个案例分支。
If not specified, the default is "false".
如果未指定,则默认值为“false”。
The behavior of the constraint depends on the type of the choice's closest ancestor node in the schema tree which is not a non-presence container (see Section 7.5.1):
约束的行为取决于模式树中选择的最近祖先节点的类型,该节点不是非存在容器(参见第7.5.1节):
o If this ancestor is a case node, the constraint is enforced if any other node from the case exists.
o 如果此祖先是案例节点,则如果案例中存在任何其他节点,则强制执行约束。
o Otherwise, it is enforced if the ancestor node exists.
o 否则,如果祖先节点存在,则强制执行。
The constraint is further enforced according to the rules in Section 8.
根据第8节中的规则,进一步实施约束。
The choice and case nodes are not visible in XML.
choice和case节点在XML中不可见。
The child nodes of the selected "case" statement MUST be encoded in the same order as they are defined in the "case" statement if they are part of an RPC input or output parameter definition. Otherwise, the subelements are encoded in any order.
如果所选“case”语句的子节点是RPC输入或输出参数定义的一部分,则必须按照与“case”语句中定义的子节点相同的顺序对其进行编码。否则,子元素按任意顺序编码。
Since only one of the choice's cases can be valid at any time, the creation of a node from one case implicitly deletes all nodes from all other cases. If an <edit-config> operation creates a node from a case, the NETCONF server will delete any existing nodes that are defined in other cases inside the choice.
由于在任何时候只有一个选项的案例是有效的,因此从一个案例创建节点会隐式删除所有其他案例中的所有节点。如果<edit config>操作从案例中创建节点,NETCONF服务器将删除在选项中的其他案例中定义的任何现有节点。
Given the following choice:
鉴于以下选择:
container protocol { choice name { case a { leaf udp { type empty; } } case b { leaf tcp { type empty; } } } }
container protocol { choice name { case a { leaf udp { type empty; } } case b { leaf tcp { type empty; } } } }
A corresponding XML instance example:
对应的XML实例示例:
<protocol> <tcp/> </protocol>
<protocol> <tcp/> </protocol>
To change the protocol from tcp to udp:
要将协议从tcp更改为udp,请执行以下操作:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <protocol> <udp nc:operation="create"/> </protocol> </system> </config> </edit-config> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config> <target> <running/> </target> <config> <system xmlns="http://example.com/schema/config"> <protocol> <udp nc:operation="create"/> </protocol> </system> </config> </edit-config> </rpc>
The "anyxml" statement defines an interior node in the schema tree. It takes one argument, which is an identifier, followed by a block of substatements that holds detailed anyxml information.
“anyxml”语句在模式树中定义一个内部节点。它有一个参数,它是一个标识符,后跟一个包含详细的anyxml信息的子语句块。
The "anyxml" statement is used to represent an unknown chunk of XML. No restrictions are placed on the XML. This can be useful, for example, in RPC replies. An example is the <filter> parameter in the <get-config> operation.
“anyxml”语句用于表示未知的XML块。对XML没有任何限制。这可能很有用,例如,在RPC回复中。例如<get config>操作中的<filter>参数。
An anyxml node cannot be augmented (see Section 7.15).
不能扩充anyxml节点(参见第7.15节)。
Since the use of anyxml limits the manipulation of the content, it is RECOMMENDED that the "anyxml" statement not be used to represent configuration data.
由于anyxml的使用限制了对内容的操作,因此建议不要使用“anyxml”语句来表示配置数据。
An anyxml node exists in zero or one instances in the data tree.
anyxml节点存在于数据树中的零个或一个实例中。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | mandatory | 7.6.5 | 0..1 | | must | 7.5.3 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | mandatory | 7.6.5 | 0..1 | | must | 7.5.3 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
An anyxml node is encoded as an XML element. The element's local name is the anyxml's identifier, and its namespace is the module's XML namespace (see Section 7.1.3). The value of the anyxml node is encoded as XML content of this element.
anyxml节点编码为XML元素。元素的本地名称是anyxml的标识符,其名称空间是模块的XML名称空间(参见第7.1.3节)。anyxml节点的值被编码为该元素的XML内容。
Note that any prefixes used in the encoding are local to each instance encoding. This means that the same XML may be encoded differently by different implementations.
请注意,编码中使用的任何前缀都是每个实例编码的本地前缀。这意味着相同的XML可以通过不同的实现进行不同的编码。
An anyxml node is treated as an opaque chunk of data. This data can be modified in its entirety only.
anyxml节点被视为不透明的数据块。此数据只能全部修改。
Any "operation" attributes present on subelements of an anyxml node are ignored by the NETCONF server.
NETCONF服务器将忽略anyxml节点子元素上的任何“操作”属性。
When a NETCONF server processes an <edit-config> request, the elements of procedure for the anyxml node are:
当NETCONF服务器处理<edit config>请求时,anyxml节点的过程元素包括:
If the operation is "merge" or "replace", the node is created if it does not exist, and its value is set to the XML content of the anyxml node found in the XML RPC data.
如果操作为“merge”或“replace”,则将在节点不存在时创建该节点,并将其值设置为在XML RPC数据中找到的anyxml节点的XML内容。
If the operation is "create", the node is created if it does not exist, and its value is set to the XML content of the anyxml node found in the XML RPC data. If the node already exists, a "data-exists" error is returned.
如果操作为“create”,则将在节点不存在时创建该节点,并将其值设置为在XML RPC数据中找到的anyxml节点的XML内容。如果节点已经存在,则返回“数据存在”错误。
If the operation is "delete", the node is deleted if it exists. If the node does not exist, a "data-missing" error is returned.
如果操作为“删除”,则删除节点(如果存在)。如果节点不存在,则返回“数据丢失”错误。
Given the following "anyxml" statement:
给出以下“anyxml”语句:
anyxml data;
anyxml数据;
The following are two valid encodings of the same anyxml value:
以下是相同anyxml值的两个有效编码:
<data xmlns:if="http://example.com/ns/interface"> <if:interface> <if:ifIndex>1</if:ifIndex> </if:interface> </data>
<data xmlns:if="http://example.com/ns/interface"> <if:interface> <if:ifIndex>1</if:ifIndex> </if:interface> </data>
<data> <interface xmlns="http://example.com/ns/interface"> <ifIndex>1</ifIndex> </interface> </data>
<data> <interface xmlns="http://example.com/ns/interface"> <ifIndex>1</ifIndex> </interface> </data>
The "grouping" statement is used to define a reusable block of nodes, which may be used locally in the module, in modules that include it, and by other modules that import from it, according to the rules in Section 5.5. It takes one argument, which is an identifier, followed by a block of substatements that holds detailed grouping information.
“分组”语句用于定义一个可重用的节点块,根据第5.5节中的规则,该节点块可在模块、包含它的模块以及从中导入的其他模块中本地使用。它采用一个参数(标识符),后跟一个包含详细分组信息的子语句块。
The "grouping" statement is not a data definition statement and, as such, does not define any nodes in the schema tree.
“grouping”语句不是数据定义语句,因此不定义模式树中的任何节点。
A grouping is like a "structure" or a "record" in conventional programming languages.
分组就像传统编程语言中的“结构”或“记录”。
Once a grouping is defined, it can be referenced in a "uses" statement (see Section 7.12). A grouping MUST NOT reference itself, neither directly nor indirectly through a chain of other groupings.
定义分组后,可在“使用”语句中引用该分组(见第7.12节)。分组不得直接或间接通过其他分组链引用自身。
If the grouping is defined at the top level of a YANG module or submodule, the grouping's identifier MUST be unique within the module.
如果分组是在模块或子模块的顶层定义的,则分组的标识符在模块内必须是唯一的。
A grouping is more than just a mechanism for textual substitution, but defines a collection of nodes. Identifiers appearing inside the grouping are resolved relative to the scope in which the grouping is defined, not where it is used. Prefix mappings, type names, grouping names, and extension usage are evaluated in the hierarchy where the "grouping" statement appears. For extensions, this means that extensions are applied to the grouping node, not the uses node.
分组不仅仅是一种文本替换机制,还定义了一组节点。出现在分组中的标识符是相对于定义分组的范围而不是使用分组的位置来解析的。前缀映射、类型名称、分组名称和扩展使用在出现“grouping”语句的层次结构中进行评估。对于扩展,这意味着扩展应用于分组节点,而不是使用节点。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
import ietf-inet-types { prefix "inet"; }
import ietf-inet-types { prefix "inet"; }
grouping endpoint { description "A reusable endpoint group."; leaf ip { type inet:ip-address; } leaf port { type inet:port-number; } }
grouping endpoint { description "A reusable endpoint group."; leaf ip { type inet:ip-address; } leaf port { type inet:port-number; } }
The "uses" statement is used to reference a "grouping" definition. It takes one argument, which is the name of the grouping.
“uses”语句用于引用“grouping”定义。它接受一个参数,即分组的名称。
The effect of a "uses" reference to a grouping is that the nodes defined by the grouping are copied into the current schema tree, and then updated according to the "refine" and "augment" statements.
对分组的“uses”引用的效果是将分组定义的节点复制到当前模式树中,然后根据“refine”和“augment”语句进行更新。
The identifiers defined in the grouping are not bound to a namespace until the contents of the grouping are added to the schema tree via a "uses" statement that does not appear inside a "grouping" statement, at which point they are bound to the namespace of the current module.
分组中定义的标识符不会绑定到名称空间,直到分组的内容通过“uses”语句添加到架构树中,该语句不出现在“grouping”语句中,此时它们被绑定到当前模块的名称空间。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | augment | 7.15 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | refine | 7.12.2 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | augment | 7.15 | 0..1 | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | refine | 7.12.2 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
Some of the properties of each node in the grouping can be refined with the "refine" statement. The argument is a string that identifies a node in the grouping. This node is called the refine's target node. If a node in the grouping is not present as a target node of a "refine" statement, it is not refined, and thus used exactly as it was defined in the grouping.
分组中每个节点的某些属性可以使用“refine”语句进行细化。参数是标识分组中节点的字符串。此节点称为优化的目标节点。如果分组中的某个节点不作为“refine”语句的目标节点出现,则该节点不会被细化,因此其使用方式与分组中定义的完全相同。
The argument string is a descendant schema node identifier (see Section 6.5).
参数字符串是子模式节点标识符(参见第6.5节)。
The following refinements can be done:
可以进行以下改进:
o A leaf or choice node may get a default value, or a new default value if it already had one.
o 叶节点或选择节点可能会获得默认值,如果已经有默认值,则可能会获得新的默认值。
o Any node may get a specialized "description" string.
o 任何节点都可以获得专门的“描述”字符串。
o Any node may get a specialized "reference" string.
o 任何节点都可以获得专门的“引用”字符串。
o Any node may get a different "config" statement.
o 任何节点都可能得到不同的“config”语句。
o A leaf, anyxml, or choice node may get a different "mandatory" statement.
o leaf、anyxml或choice节点可能会得到不同的“强制”语句。
o A container node may get a "presence" statement.
o 容器节点可能会得到“presence”语句。
o A leaf, leaf-list, list, container, or anyxml node may get additional "must" expressions.
o 叶、叶列表、列表、容器或任意XML节点可能会获得其他“必须”表达式。
o A leaf-list or list node may get a different "min-elements" or "max-elements" statement.
o 叶列表或列表节点可能会得到不同的“最小元素”或“最大元素”语句。
Each node in the grouping is encoded as if it was defined inline, even if it is imported from another module with another XML namespace.
分组中的每个节点都被编码为内联定义,即使它是从另一个具有另一个XML命名空间的模块导入的。
To use the "endpoint" grouping defined in Section 7.11.2 in a definition of an HTTP server in some other module, we can do:
要在其他模块的HTTP服务器定义中使用第7.11.2节中定义的“端点”分组,我们可以执行以下操作:
import acme-system { prefix "acme"; }
import acme-system { prefix "acme"; }
container http-server { leaf name { type string; } uses acme:endpoint; }
container http-server { leaf name { type string; } uses acme:endpoint; }
A corresponding XML instance example:
对应的XML实例示例:
<http-server> <name>extern-web</name> <ip>192.0.2.1</ip> <port>80</port> </http-server>
<http-server> <name>extern-web</name> <ip>192.0.2.1</ip> <port>80</port> </http-server>
If port 80 should be the default for the HTTP server, default can be added:
如果HTTP服务器的默认端口为80,则可以添加默认端口:
container http-server { leaf name { type string; } uses acme:endpoint { refine port { default 80; } } }
container http-server { leaf name { type string; } uses acme:endpoint { refine port { default 80; } } }
If we want to define a list of servers, and each server has the ip and port as keys, we can do:
如果我们要定义一个服务器列表,并且每个服务器都有ip和端口作为密钥,我们可以执行以下操作:
list server { key "ip port"; leaf name { type string; } uses acme:endpoint; }
list server { key "ip port"; leaf name { type string; } uses acme:endpoint; }
The following is an error:
以下是一个错误:
container http-server { uses acme:endpoint; leaf ip { // illegal - same identifier "ip" used twice type string; } }
container http-server { uses acme:endpoint; leaf ip { // illegal - same identifier "ip" used twice type string; } }
The "rpc" statement is used to define a NETCONF RPC operation. It takes one argument, which is an identifier, followed by a block of substatements that holds detailed rpc information. This argument is the name of the RPC, and is used as the element name directly under the <rpc> element, as designated by the substitution group "rpcOperation" in [RFC4741].
“rpc”语句用于定义NETCONF rpc操作。它有一个参数,它是一个标识符,后跟一个包含详细rpc信息的子语句块。此参数是RPC的名称,直接用作<RPC>元素下的元素名称,由[RFC4741]中的替换组“rpcOperation”指定。
The "rpc" statement defines an rpc node in the schema tree. Under the rpc node, a schema node with the name "input", and a schema node with the name "output" are also defined. The nodes "input" and "output" are defined in the module's namespace.
“rpc”语句在模式树中定义了一个rpc节点。在rpc节点下,还定义了名为“input”的模式节点和名为“output”的模式节点。节点“输入”和“输出”在模块的命名空间中定义。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | input | 7.13.2 | 0..1 | | output | 7.13.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | input | 7.13.2 | 0..1 | | output | 7.13.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | +--------------+---------+-------------+
The "input" statement, which is optional, is used to define input parameters to the RPC operation. It does not take an argument. The substatements to "input" define nodes under the RPC's input node.
“input”语句是可选的,用于定义RPC操作的输入参数。这不需要争论。“input”的子语句定义RPC输入节点下的节点。
If a leaf in the input tree has a "mandatory" statement with the value "true", the leaf MUST be present in a NETCONF RPC invocation. Otherwise, the server MUST return a "missing-element" error.
如果输入树中的某个叶具有值为“true”的“mandatory”语句,则该叶必须存在于NETCONF RPC调用中。否则,服务器必须返回“缺少元素”错误。
If a leaf in the input tree has a default value, the NETCONF server MUST use this value in the same cases as described in Section 7.6.1. In these cases, the server MUST operationally behave as if the leaf was present in the NETCONF RPC invocation with the default value as its value.
如果输入树中的叶具有默认值,则NETCONF服务器必须在与第7.6.1节所述相同的情况下使用该值。在这些情况下,服务器在操作上的行为必须与NETCONF RPC调用中存在的叶一样,并以默认值作为其值。
If a "config" statement is present for any node in the input tree, the "config" statement is ignored.
如果输入树中的任何节点都有“config”语句,则忽略“config”语句。
If any node has a "when" statement that would evaluate to false, then this node MUST NOT be present in the input tree.
如果任何节点的“when”语句的计算结果为false,则该节点不得出现在输入树中。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | grouping | 7.11 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | grouping | 7.11 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
The "output" statement, which is optional, is used to define output parameters to the RPC operation. It does not take an argument. The substatements to "output" define nodes under the RPC's output node.
“output”语句是可选的,用于定义RPC操作的输出参数。这不需要争论。“output”的子语句定义RPC的输出节点下的节点。
If a leaf in the output tree has a "mandatory" statement with the value "true", the leaf MUST be present in a NETCONF RPC reply.
如果输出树中的某个叶具有值为“true”的“mandatory”语句,则该叶必须出现在NETCONF RPC应答中。
If a leaf in the output tree has a default value, the NETCONF client MUST use this value in the same cases as described in Section 7.6.1. In these cases, the client MUST operationally behave as if the leaf was present in the NETCONF RPC reply with the default value as its value.
如果输出树中的叶具有默认值,NETCONF客户端必须在与第7.6.1节所述相同的情况下使用该值。在这些情况下,客户机必须在操作上表现得像NETCONF RPC应答中存在叶一样,并使用默认值作为其值。
If a "config" statement is present for any node in the output tree, the "config" statement is ignored.
如果输出树中的任何节点都有“config”语句,则忽略“config”语句。
If any node has a "when" statement that would evaluate to false, then this node MUST NOT be present in the output tree.
如果任何节点的“when”语句的计算结果为false,则该节点不得出现在输出树中。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | grouping | 7.11 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | grouping | 7.11 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
An rpc node is encoded as a child XML element to the <rpc> element defined in [RFC4741]. The element's local name is the rpc's identifier, and its namespace is the module's XML namespace (see Section 7.1.3).
rpc节点被编码为[RFC4741]中定义的<rpc>元素的子XML元素。元素的本地名称是rpc的标识符,其名称空间是模块的XML名称空间(参见第7.1.3节)。
Input parameters are encoded as child XML elements to the rpc node's XML element, in the same order as they are defined within the "input" statement.
输入参数被编码为rpc节点XML元素的子XML元素,其顺序与“Input”语句中定义的顺序相同。
If the RPC operation invocation succeeded, and no output parameters are returned, the <rpc-reply> contains a single <ok/> element defined in [RFC4741]. If output parameters are returned, they are encoded as child elements to the <rpc-reply> element defined in [RFC4741], in the same order as they are defined within the "output" statement.
如果RPC操作调用成功,并且没有返回任何输出参数,<RPC reply>包含[RFC4741]中定义的单个<ok/>元素。如果返回输出参数,则将其编码为[RFC4741]中定义的<rpc reply>元素的子元素,其顺序与“output”语句中定义的顺序相同。
The following example defines an RPC operation:
以下示例定义了RPC操作:
module rock { namespace "http://example.net/rock"; prefix "rock";
module rock { namespace "http://example.net/rock"; prefix "rock";
rpc rock-the-house { input { leaf zip-code { type string; } } } }
rpc rock-the-house { input { leaf zip-code { type string; } } } }
A corresponding XML instance example of the complete rpc and rpc-reply:
完整rpc和rpc应答的对应XML实例示例:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <rock-the-house xmlns="http://example.net/rock"> <zip-code>27606-0100</zip-code> </rock-the-house> </rpc>
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <rock-the-house xmlns="http://example.net/rock"> <zip-code>27606-0100</zip-code> </rock-the-house> </rpc>
<rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <ok/> </rpc-reply>
<rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <ok/> </rpc-reply>
The "notification" statement is used to define a NETCONF notification. It takes one argument, which is an identifier, followed by a block of substatements that holds detailed notification information. The "notification" statement defines a notification node in the schema tree.
“notification”语句用于定义NETCONF通知。它有一个参数,它是一个标识符,后跟一个包含详细通知信息的子语句块。“notification”语句在模式树中定义了一个通知节点。
If a leaf in the notification tree has a "mandatory" statement with the value "true", the leaf MUST be present in a NETCONF notification.
如果通知树中的某个叶具有值为“true”的“强制”语句,则该叶必须出现在NETCONF通知中。
If a leaf in the notification tree has a default value, the NETCONF client MUST use this value in the same cases as described in Section 7.6.1. In these cases, the client MUST operationally behave as if the leaf was present in the NETCONF notification with the default value as its value.
如果通知树中的叶具有默认值,则NETCONF客户端必须在与第7.6.1节所述相同的情况下使用该值。在这些情况下,客户机必须在操作上表现得像NETCONF通知中的叶一样,并以默认值作为其值。
If a "config" statement is present for any node in the notification tree, the "config" statement is ignored.
如果通知树中的任何节点都有“config”语句,则忽略“config”语句。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | grouping | 7.11 | 0..n | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | typedef | 7.3 | 0..n | | uses | 7.12 | 0..n | +--------------+---------+-------------+
A notification node is encoded as a child XML element to the <notification> element defined in NETCONF Event Notifications [RFC5277]. The element's local name is the notification's identifier, and its namespace is the module's XML namespace (see Section 7.1.3).
通知节点被编码为NETCONF事件通知[RFC5277]中定义的<notification>元素的子XML元素。元素的本地名称是通知的标识符,其名称空间是模块的XML名称空间(参见第7.1.3节)。
The following example defines a notification:
以下示例定义了通知:
module event {
模块事件{
namespace "http://example.com/event"; prefix "ev";
namespace "http://example.com/event"; prefix "ev";
notification event { leaf event-class { type string; } anyxml reporting-entity; leaf severity { type string; } } }
notification event { leaf event-class { type string; } anyxml reporting-entity; leaf severity { type string; } } }
A corresponding XML instance example of the complete notification:
完整通知的对应XML实例示例:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <eventTime>2008-07-08T00:01:00Z</eventTime> <event xmlns="http://example.com/event"> <event-class>fault</event-class> <reporting-entity> <card>Ethernet0</card> </reporting-entity> <severity>major</severity> </event> </notification>
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <eventTime>2008-07-08T00:01:00Z</eventTime> <event xmlns="http://example.com/event"> <event-class>fault</event-class> <reporting-entity> <card>Ethernet0</card> </reporting-entity> <severity>major</severity> </event> </notification>
The "augment" statement allows a module or submodule to add to the schema tree defined in an external module, or the current module and its submodules, and to add to the nodes from a grouping in a "uses" statement. The argument is a string that identifies a node in the schema tree. This node is called the augment's target node. The target node MUST be either a container, list, choice, case, input, output, or notification node. It is augmented with the nodes defined in the substatements that follow the "augment" statement.
“augment”语句允许模块或子模块添加到外部模块或当前模块及其子模块中定义的模式树,并从“uses”语句中的分组添加到节点。参数是标识架构树中节点的字符串。此节点称为增强的目标节点。目标节点必须是容器、列表、选项、大小写、输入、输出或通知节点。它通过“augment”语句后面的子语句中定义的节点进行扩充。
The argument string is a schema node identifier (see Section 6.5). If the "augment" statement is on the top level in a module or submodule, the absolute form (defined by the rule
参数字符串是一个模式节点标识符(参见第6.5节)。如果“augment”语句位于模块或子模块的顶层,则绝对形式(由规则定义
"absolute-schema-nodeid" in Section 12) of a schema node identifier MUST be used. If the "augment" statement is a substatement to the "uses" statement, the descendant form (defined by the rule "descendant-schema-nodeid" in Section 12) MUST be used.
必须使用模式节点标识符第12)节中的“绝对模式节点ID”。如果“augment”语句是“uses”语句的子语句,则必须使用子体形式(由第12节中的“子体模式nodeid”规则定义)。
If the target node is a container, list, case, input, output, or notification node, the "container", "leaf", "list", "leaf-list", "uses", and "choice" statements can be used within the "augment" statement.
如果目标节点是容器、列表、案例、输入、输出或通知节点,“容器”、“叶”、“列表”、“叶列表”、“使用”和“选择”语句可以在“增强”语句中使用。
If the target node is a choice node, the "case" statement, or a case shorthand statement (see Section 7.9.2) can be used within the "augment" statement.
如果目标节点是选择节点,“case”语句或case速记语句(见第7.9.2节)可在“AUMMENT”语句中使用。
If the target node is in another module, then nodes added by the augmentation MUST NOT be mandatory nodes (see Section 3.1).
如果目标节点位于另一个模块中,则通过扩充添加的节点不得为强制节点(参见第3.1节)。
The "augment" statement MUST NOT add multiple nodes with the same name from the same module to the target node.
“augment”语句不能将同一模块中具有相同名称的多个节点添加到目标节点。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | case | 7.9.2 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | anyxml | 7.10 | 0..n | | case | 7.9.2 | 0..n | | choice | 7.9 | 0..n | | container | 7.5 | 0..n | | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | leaf | 7.6 | 0..n | | leaf-list | 7.7 | 0..n | | list | 7.8 | 0..n | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | uses | 7.12 | 0..n | | when | 7.19.5 | 0..1 | +--------------+---------+-------------+
All data nodes defined in the "augment" statement are defined as XML elements in the XML namespace of the module where the "augment" is specified.
“augment”语句中定义的所有数据节点都在指定“augment”的模块的XML命名空间中定义为XML元素。
When a node is augmented, the augmenting child nodes are encoded as subelements to the augmented node, in any order.
当一个节点被扩充时,扩充的子节点以任何顺序被编码为扩充节点的子元素。
In namespace http://example.com/schema/interfaces, we have:
在命名空间中http://example.com/schema/interfaces,我们有:
container interfaces { list ifEntry { key "ifIndex";
container interfaces { list ifEntry { key "ifIndex";
leaf ifIndex { type uint32; } leaf ifDescr { type string; } leaf ifType { type iana:IfType; } leaf ifMtu { type int32; } } }
leaf ifIndex { type uint32; } leaf ifDescr { type string; } leaf ifType { type iana:IfType; } leaf ifMtu { type int32; } } }
Then, in namespace http://example.com/schema/ds0, we have:
然后,在命名空间中http://example.com/schema/ds0,我们有:
import interface-module { prefix "if"; } augment "/if:interfaces/if:ifEntry" { when "if:ifType='ds0'"; leaf ds0ChannelNumber { type ChannelNumber; } }
import interface-module { prefix "if"; } augment "/if:interfaces/if:ifEntry" { when "if:ifType='ds0'"; leaf ds0ChannelNumber { type ChannelNumber; } }
A corresponding XML instance example:
对应的XML实例示例:
<interfaces xmlns="http://example.com/schema/interfaces" xmlns:ds0="http://example.com/schema/ds0"> <ifEntry> <ifIndex>1</ifIndex> <ifDescr>Flintstone Inc Ethernet A562</ifDescr> <ifType>ethernetCsmacd</ifType> <ifMtu>1500</ifMtu> </ifEntry> <ifEntry> <ifIndex>2</ifIndex> <ifDescr>Flintstone Inc DS0</ifDescr> <ifType>ds0</ifType> <ds0:ds0ChannelNumber>1</ds0:ds0ChannelNumber> </ifEntry> </interfaces>
<interfaces xmlns="http://example.com/schema/interfaces" xmlns:ds0="http://example.com/schema/ds0"> <ifEntry> <ifIndex>1</ifIndex> <ifDescr>Flintstone Inc Ethernet A562</ifDescr> <ifType>ethernetCsmacd</ifType> <ifMtu>1500</ifMtu> </ifEntry> <ifEntry> <ifIndex>2</ifIndex> <ifDescr>Flintstone Inc DS0</ifDescr> <ifType>ds0</ifType> <ds0:ds0ChannelNumber>1</ds0:ds0ChannelNumber> </ifEntry> </interfaces>
As another example, suppose we have the choice defined in Section 7.9.7. The following construct can be used to extend the protocol definition:
作为另一个例子,假设我们有第7.9.7节中定义的选择。以下构造可用于扩展协议定义:
augment /ex:system/ex:protocol/ex:name { case c { leaf smtp { type empty; } } }
augment /ex:system/ex:protocol/ex:name { case c { leaf smtp { type empty; } } }
A corresponding XML instance example:
对应的XML实例示例:
<ex:system> <ex:protocol> <ex:tcp/> </ex:protocol> </ex:system>
<ex:system> <ex:protocol> <ex:tcp/> </ex:protocol> </ex:system>
or
或
<ex:system> <ex:protocol> <other:smtp/> </ex:protocol> </ex:system>
<ex:system> <ex:protocol> <other:smtp/> </ex:protocol> </ex:system>
The "identity" statement is used to define a new globally unique, abstract, and untyped identity. Its only purpose is to denote its name, semantics, and existence. An identity can either be defined from scratch or derived from a base identity. The identity's argument is an identifier that is the name of the identity. It is followed by a block of substatements that holds detailed identity information.
“identity”语句用于定义新的全局唯一、抽象和非类型化标识。它的唯一目的是表示它的名称、语义和存在。标识可以从头定义,也可以从基本标识派生。标识的参数是标识名的标识符。它后面是一个包含详细身份信息的子状态块。
The built-in datatype "identityref" (see Section 9.10) can be used to reference identities within a data model.
内置数据类型“identityref”(见第9.10节)可用于引用数据模型中的标识。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | base | 7.16.2 | 0..1 | | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | base | 7.16.2 | 0..1 | | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | +--------------+---------+-------------+
The "base" statement, which is optional, takes as an argument a string that is the name of an existing identity, from which the new identity is derived. If no "base" statement is present, the identity is defined from scratch.
“base”语句是可选的,它将一个字符串作为参数,该字符串是从中派生新标识的现有标识的名称。如果不存在“base”语句,则从零开始定义标识。
If a prefix is present on the base name, it refers to an identity defined in the module that was imported with that prefix, or the local module if the prefix matches the local module's prefix. Otherwise, an identity with the matching name MUST be defined in the current module or an included submodule.
如果基名称上存在前缀,则它将引用在使用该前缀导入的模块中定义的标识,如果前缀与本地模块的前缀匹配,则它将引用本地模块中定义的标识。否则,必须在当前模块或包含的子模块中定义具有匹配名称的标识。
Since submodules cannot include the parent module, any identities in the module that need to be exposed to submodules MUST be defined in a submodule. Submodules can then include this submodule to find the definition of the identity.
由于子模块不能包含父模块,因此必须在子模块中定义模块中需要向子模块公开的任何标识。然后子模块可以包含此子模块以查找标识的定义。
An identity MUST NOT reference itself, neither directly nor indirectly through a chain of other identities.
身份不能直接或间接地通过一系列其他身份来引用自身。
module crypto-base { namespace "http://example.com/crypto-base"; prefix "crypto";
module crypto-base { namespace "http://example.com/crypto-base"; prefix "crypto";
identity crypto-alg { description "Base identity from which all crypto algorithms are derived."; } }
identity crypto-alg { description "Base identity from which all crypto algorithms are derived."; } }
module des { namespace "http://example.com/des"; prefix "des";
module des { namespace "http://example.com/des"; prefix "des";
import "crypto-base" { prefix "crypto"; }
import "crypto-base" { prefix "crypto"; }
identity des { base "crypto:crypto-alg"; description "DES crypto algorithm"; }
identity des { base "crypto:crypto-alg"; description "DES crypto algorithm"; }
identity des3 { base "crypto:crypto-alg"; description "Triple DES crypto algorithm"; } }
identity des3 { base "crypto:crypto-alg"; description "Triple DES crypto algorithm"; } }
The "extension" statement allows the definition of new statements within the YANG language. This new statement definition can be imported and used by other modules.
“extension”语句允许在YANG语言中定义新语句。这个新的语句定义可以被其他模块导入和使用。
The statement's argument is an identifier that is the new keyword for the extension and must be followed by a block of substatements that holds detailed extension information. The purpose of the "extension" statement is to define a keyword, so that it can be imported and used by other modules.
语句的参数是一个标识符,它是扩展的新关键字,后面必须跟一个包含详细扩展信息的子语句块。“extension”语句的目的是定义一个关键字,以便其他模块可以导入和使用它。
The extension can be used like a normal YANG statement, with the statement name followed by an argument if one is defined by the extension, and an optional block of substatements. The statement's name is created by combining the prefix of the module in which the
扩展可以像普通的YANG语句一样使用,如果扩展定义了一个参数,则语句名后面会跟一个参数,并有一个可选的子语句块。该语句的名称是通过组合语句所在模块的前缀创建的
extension was defined, a colon (":"), and the extension's keyword, with no interleaving whitespace. The substatements of an extension are defined by the extension, using some mechanism outside the scope of this specification. Syntactically, the substatements MUST be YANG statements, or also defined using "extension" statements. YANG statements in extensions MUST follow the syntactical rules in Section 12.
定义了扩展名,一个冒号(“:”)和扩展名的关键字,没有交错的空格。扩展的子状态由扩展定义,使用本规范范围之外的某种机制。从语法上讲,子语句必须是YANG语句,或者也可以使用“extension”语句定义。扩展中的YANG语句必须遵循第12节中的语法规则。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | argument | 7.17.2 | 0..1 | | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | argument | 7.17.2 | 0..1 | | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | +--------------+---------+-------------+
The "argument" statement, which is optional, takes as an argument a string that is the name of the argument to the keyword. If no argument statement is present, the keyword expects no argument when it is used.
“argument”语句是可选的,它将作为关键字参数名称的字符串作为参数。如果不存在参数语句,则使用关键字时不需要参数。
The argument's name is used in the YIN mapping, where it is used as an XML attribute or element name, depending on the argument's "yin-element" statement.
参数的名称在YIN映射中使用,根据参数的“YIN-element”语句,它被用作XML属性或元素名称。
+--------------+----------+-------------+ | substatement | section | cardinality | +--------------+----------+-------------+ | yin-element | 7.17.2.2 | 0..1 | +--------------+----------+-------------+
+--------------+----------+-------------+ | substatement | section | cardinality | +--------------+----------+-------------+ | yin-element | 7.17.2.2 | 0..1 | +--------------+----------+-------------+
The "yin-element" statement, which is optional, takes as an argument the string "true" or "false". This statement indicates if the argument is mapped to an XML element in YIN or to an XML attribute (see Section 11).
“yin元素”语句是可选的,它将字符串“true”或“false”作为参数。此语句指示参数是映射到YIN中的XML元素还是映射到XML属性(请参见第11节)。
If no "yin-element" statement is present, it defaults to "false".
如果不存在“阴元素”语句,则默认为“false”。
To define an extension:
要定义扩展,请执行以下操作:
module my-extensions { ...
模块我的扩展{。。。
extension c-define { description "Takes as argument a name string. Makes the code generator use the given name in the #define."; argument "name"; } }
extension c-define { description "Takes as argument a name string. Makes the code generator use the given name in the #define."; argument "name"; } }
To use the extension:
要使用扩展名,请执行以下操作:
module my-interfaces { ... import my-extensions { prefix "myext"; } ...
module my-interfaces { ... import my-extensions { prefix "myext"; } ...
container interfaces { ... myext:c-define "MY_INTERFACES"; } }
container interfaces { ... myext:c-define "MY_INTERFACES"; } }
This section defines statements related to conformance, as described in Section 5.6.
本节定义了与合规性相关的声明,如第5.6节所述。
The "feature" statement is used to define a mechanism by which portions of the schema are marked as conditional. A feature name is defined that can later be referenced using the "if-feature" statement (see Section 7.18.2). Schema nodes tagged with a feature are ignored by the device unless the device supports the given feature. This allows portions of the YANG module to be conditional based on conditions on the device. The model can represent the abilities of the device within the model, giving a richer model that allows for differing device abilities and roles.
“feature”语句用于定义一种机制,通过该机制将模式的某些部分标记为条件。定义了一个特征名称,可在以后使用“如果特征”语句引用该名称(见第7.18.2节)。除非设备支持给定功能,否则设备将忽略标记有功能的架构节点。这允许根据设备上的条件对模块的部分进行调节。该模型可以表示模型中设备的能力,提供更丰富的模型,允许不同的设备能力和角色。
The argument to the "feature" statement is the name of the new feature, and follows the rules for identifiers in Section 6.2. This name is used by the "if-feature" statement to tie the schema nodes to the feature.
“feature”语句的参数是新特性的名称,并遵循第6.2节中的标识符规则。“if-feature”语句使用此名称将架构节点绑定到该功能。
In this example, a feature called "local-storage" represents the ability for a device to store syslog messages on local storage of some sort. This feature is used to make the "local-storage-limit" leaf conditional on the presence of some sort of local storage. If the device does not report that it supports this feature, the "local-storage-limit" node is not supported.
在本例中,称为“本地存储”的功能表示设备能够在某种本地存储上存储系统日志消息。此功能用于使“本地存储限制”叶以存在某种本地存储为条件。如果设备未报告其支持此功能,则不支持“本地存储限制”节点。
module syslog { ... feature local-storage { description "This feature means the device supports local storage (memory, flash or disk) that can be used to store syslog messages."; }
module syslog { ... feature local-storage { description "This feature means the device supports local storage (memory, flash or disk) that can be used to store syslog messages."; }
container syslog { leaf local-storage-limit { if-feature local-storage; type uint64; units "kilobyte"; config false; description "The amount of local storage that can be used to hold syslog messages."; } } }
container syslog { leaf local-storage-limit { if-feature local-storage; type uint64; units "kilobyte"; config false; description "The amount of local storage that can be used to hold syslog messages."; } } }
The "if-feature" statement can be used in many places within the YANG syntax. Definitions tagged with "if-feature" are ignored when the device does not support that feature.
“if-feature”语句可以在YANG语法中的许多地方使用。当设备不支持“如果功能”时,将忽略标记为“如果功能”的定义。
A feature MUST NOT reference itself, neither directly nor indirectly through a chain of other features.
特征不得直接或间接通过一系列其他特征引用自身。
In order for a device to implement a feature that is dependent on any other features (i.e., the feature has one or more "if-feature" sub-statements), the device MUST also implement all the dependant features.
为了使设备实现依赖于任何其他功能的功能(即,该功能具有一个或多个“如果功能”子语句),设备还必须实现所有依赖功能。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | status | 7.19.2 | 0..1 | | reference | 7.19.4 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | if-feature | 7.18.2 | 0..n | | status | 7.19.2 | 0..1 | | reference | 7.19.4 | 0..1 | +--------------+---------+-------------+
The "if-feature" statement makes its parent statement conditional. The argument is the name of a feature, as defined by a "feature" statement. The parent statement is implemented by servers that support this feature. If a prefix is present on the feature name, it refers to a feature defined in the module that was imported with that prefix, or the local module if the prefix matches the local module's prefix. Otherwise, a feature with the matching name MUST be defined in the current module or an included submodule.
“if feature”语句使其父语句具有条件。参数是由“feature”语句定义的功能的名称。父语句由支持此功能的服务器实现。如果要素名称上存在前缀,则该前缀指的是使用该前缀导入的模块中定义的要素,如果前缀与本地模块的前缀匹配,则指的是本地模块。否则,必须在当前模块或包含的子模块中定义具有匹配名称的功能。
Since submodules cannot include the parent module, any features in the module that need to be exposed to submodules MUST be defined in a submodule. Submodules can then include this submodule to find the definition of the feature.
由于子模块不能包含父模块,因此必须在子模块中定义模块中需要向子模块公开的任何功能。然后子模块可以包含此子模块以查找特征的定义。
The "deviation" statement defines a hierarchy of a module that the device does not implement faithfully. The argument is a string that identifies the node in the schema tree where a deviation from the module occurs. This node is called the deviation's target node. The contents of the "deviation" statement give details about the deviation.
“偏差”语句定义了设备无法忠实实现的模块层次结构。参数是一个字符串,用于标识模式树中发生模块偏差的节点。该节点称为偏差的目标节点。“偏差”声明的内容给出了偏差的详细信息。
The argument string is an absolute schema node identifier (see Section 6.5).
参数字符串是绝对模式节点标识符(参见第6.5节)。
Deviations define the way a device or class of devices deviate from a standard. This means that deviations MUST never be part of a published standard, since they are the mechanism for learning how implementations vary from the standards.
偏差定义了设备或设备类别偏离标准的方式。这意味着偏差决不能成为已发布标准的一部分,因为它们是了解实现如何与标准不同的机制。
Device deviations are strongly discouraged and MUST only be used as a last resort. Telling the application how a device fails to follow a standard is no substitute for implementing the standard correctly. A device that deviates from a module is not fully compliant with the module.
强烈反对设备偏差,并且只能作为最后手段使用。告诉应用程序一个设备如何不遵循标准并不能代替正确实施标准。偏离模块的设备与模块不完全兼容。
However, in some cases, a particular device may not have the hardware or software ability to support parts of a standard module. When this occurs, the device makes a choice either to treat attempts to configure unsupported parts of the module as an error that is reported back to the unsuspecting application or ignore those incoming requests. Neither choice is acceptable.
然而,在某些情况下,特定设备可能没有硬件或软件能力来支持标准模块的部分。发生这种情况时,设备会选择将配置模块不受支持部分的尝试视为一个错误,并报告给不知情的应用程序,或者忽略这些传入的请求。这两种选择都是不可接受的。
Instead, YANG allows devices to document portions of a base module that are not supported or supported but with different syntax, by using the "deviation" statement.
相反,YANG允许设备使用“偏差”语句记录基本模块中不受支持或支持但语法不同的部分。
+--------------+----------+-------------+ | substatement | section | cardinality | +--------------+----------+-------------+ | description | 7.19.3 | 0..1 | | deviate | 7.18.3.2 | 1..n | | reference | 7.19.4 | 0..1 | +--------------+----------+-------------+
+--------------+----------+-------------+ | substatement | section | cardinality | +--------------+----------+-------------+ | description | 7.19.3 | 0..1 | | deviate | 7.18.3.2 | 1..n | | reference | 7.19.4 | 0..1 | +--------------+----------+-------------+
The "deviate" statement defines how the device's implementation of the target node deviates from its original definition. The argument is one of the strings "not-supported", "add", "replace", or "delete".
“偏离”语句定义了设备对目标节点的实现如何偏离其原始定义。参数是字符串“不支持”、“添加”、“替换”或“删除”之一。
The argument "not-supported" indicates that the target node is not implemented by this device.
参数“not SUPPORED”表示此设备未实现目标节点。
The argument "add" adds properties to the target node. The properties to add are identified by substatements to the "deviate" statement. If a property can only appear once, the property MUST NOT exist in the target node.
参数“add”将属性添加到目标节点。要添加的属性由“偏离”语句的子语句标识。如果属性只能出现一次,则该属性不得存在于目标节点中。
The argument "replace" replaces properties of the target node. The properties to replace are identified by substatements to the "deviate" statement. The properties to replace MUST exist in the target node.
参数“replace”替换目标节点的属性。要替换的属性由“偏离”语句的子语句标识。要替换的属性必须存在于目标节点中。
The argument "delete" deletes properties from the target node. The properties to delete are identified by substatements to the "delete" statement. The substatement's keyword MUST match a corresponding keyword in the target node, and the argument's string MUST be equal to the corresponding keyword's argument string in the target node.
参数“delete”从目标节点删除属性。要删除的属性由“delete”语句的子语句标识。子状态的关键字必须与目标节点中相应的关键字匹配,并且参数的字符串必须等于目标节点中相应关键字的参数字符串。
The deviates's Substatements
偏离的子状态
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | default | 7.6.4 | 0..1 | | mandatory | 7.6.5 | 0..1 | | max-elements | 7.7.4 | 0..1 | | min-elements | 7.7.3 | 0..1 | | must | 7.5.3 | 0..n | | type | 7.4 | 0..1 | | unique | 7.8.3 | 0..n | | units | 7.3.3 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | config | 7.19.1 | 0..1 | | default | 7.6.4 | 0..1 | | mandatory | 7.6.5 | 0..1 | | max-elements | 7.7.4 | 0..1 | | min-elements | 7.7.3 | 0..1 | | must | 7.5.3 | 0..n | | type | 7.4 | 0..1 | | unique | 7.8.3 | 0..n | | units | 7.3.3 | 0..1 | +--------------+---------+-------------+
In this example, the device is informing client applications that it does not support the "daytime" service in the style of RFC 867.
在此示例中,设备正在通知客户端应用程序它不支持RFC 867样式的“日间”服务。
deviation /base:system/base:daytime { deviate not-supported; }
deviation /base:system/base:daytime { deviate not-supported; }
The following example sets a device-specific default value to a leaf that does not have a default value defined:
以下示例将特定于设备的默认值设置为未定义默认值的叶:
deviation /base:system/base:user/base:type { deviate add { default "admin"; // new users are 'admin' by default } }
deviation /base:system/base:user/base:type { deviate add { default "admin"; // new users are 'admin' by default } }
In this example, the device limits the number of name servers to 3:
在此示例中,设备将名称服务器的数量限制为3:
deviation /base:system/base:name-server { deviate replace { max-elements 3; } }
deviation /base:system/base:name-server { deviate replace { max-elements 3; } }
If the original definition is:
如果原始定义为:
container system { must "daytime or time"; ... }
container system { must "daytime or time"; ... }
a device might remove this must constraint by doing:
设备可以通过执行以下操作来删除此“必须”约束:
deviation "/base:system" { deviate delete { must "daytime or time"; } }
deviation "/base:system" { deviate delete { must "daytime or time"; } }
This section defines substatements common to several other statements.
本节定义了几个其他语句共有的子语句。
The "config" statement takes as an argument the string "true" or "false". If "config" is "true", the definition represents configuration. Data nodes representing configuration will be part of the reply to a <get-config> request, and can be sent in a <copy-config> or <edit-config> request.
“config”语句将字符串“true”或“false”作为参数。如果“config”为“true”,则定义表示配置。表示配置的数据节点将是对<get config>请求的响应的一部分,可以在<copy config>或<edit config>请求中发送。
If "config" is "false", the definition represents state data. Data nodes representing state data will be part of the reply to a <get>, but not to a <get-config> request, and cannot be sent in a <copy-config> or <edit-config> request.
如果“config”为“false”,则定义表示状态数据。表示状态数据的数据节点将是回复<get>请求的一部分,而不是回复<get config>请求的一部分,并且不能在<copy config>或<edit config>请求中发送。
If "config" is not specified, the default is the same as the parent schema node's "config" value. If the parent node is a "case" node, the value is the same as the "case" node's parent "choice" node.
如果未指定“config”,则默认值与父架构节点的“config”值相同。如果父节点是“案例”节点,则该值与“案例”节点的父“选择”节点相同。
If the top node does not specify a "config" statement, the default is "true".
如果顶部节点未指定“config”语句,则默认值为“true”。
If a node has "config" set to "false", no node underneath it can have "config" set to "true".
如果一个节点的“config”设置为“false”,那么它下面的任何节点都不能将“config”设置为“true”。
The "status" statement takes as an argument one of the strings "current", "deprecated", or "obsolete".
“status”语句将字符串“current”、“deprecated”或“过时”中的一个作为参数。
o "current" means that the definition is current and valid.
o “当前”是指定义是当前有效的。
o "deprecated" indicates an obsolete definition, but it permits new/ continued implementation in order to foster interoperability with older/existing implementations.
o “弃用”表示一个过时的定义,但它允许新的/继续的实现,以促进与旧的/现有的实现的互操作性。
o "obsolete" means the definition is obsolete and SHOULD NOT be implemented and/or can be removed from implementations.
o “过时”是指该定义已过时,不应实施和/或可从实施中删除。
If no status is specified, the default is "current".
如果未指定状态,则默认为“当前”。
If a definition is "current", it MUST NOT reference a "deprecated" or "obsolete" definition within the same module.
如果定义是“当前的”,则它不得引用同一模块中的“已弃用”或“已过时”定义。
If a definition is "deprecated", it MUST NOT reference an "obsolete" definition within the same module.
如果定义是“不推荐的”,则它不得引用同一模块中的“过时”定义。
For example, the following is illegal:
例如,以下行为是非法的:
typedef my-type { status deprecated; type int32; }
typedef my-type { status deprecated; type int32; }
leaf my-leaf { status current; type my-type; // illegal, since my-type is deprecated }
leaf my-leaf { status current; type my-type; // illegal, since my-type is deprecated }
The "description" statement takes as an argument a string that contains a human-readable textual description of this definition. The text is provided in a language (or languages) chosen by the module developer; for the sake of interoperability, it is RECOMMENDED to choose a language that is widely understood among the community of network administrators who will use the module.
“description”语句将包含此定义的可读文本描述的字符串作为参数。文本以模块开发人员选择的一种(或多种)语言提供;为了实现互操作性,建议选择一种将使用该模块的网络管理员社区广泛理解的语言。
The "reference" statement takes as an argument a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.
“reference”语句将一个字符串作为参数,该字符串用于指定对外部文档、定义相关管理信息的另一个模块或提供与此定义相关的附加信息的文档的文本交叉引用。
For example, a typedef for a "uri" data type could look like:
例如,“uri”数据类型的typedef可能如下所示:
typedef uri { type string; reference "RFC 3986: Uniform Resource Identifier (URI): Generic Syntax"; ... }
typedef uri { type string; reference "RFC 3986: Uniform Resource Identifier (URI): Generic Syntax"; ... }
The "when" statement makes its parent data definition statement conditional. The node defined by the parent data definition statement is only valid when the condition specified by the "when" statement is satisfied. The statement's argument is an XPath expression (see Section 6.4), which is used to formally specify this condition. If the XPath expression conceptually evaluates to "true" for a particular instance, then the node defined by the parent data definition statement is valid; otherwise, it is not.
“when”语句使其父数据定义语句具有条件。父数据定义语句定义的节点仅在满足“when”语句指定的条件时有效。该语句的参数是一个XPath表达式(参见第6.4节),用于正式指定此条件。如果XPath表达式在概念上对特定实例的计算结果为“true”,则父数据定义语句定义的节点是有效的;否则,情况并非如此。
See Section 8.3.2 for additional information.
更多信息见第8.3.2节。
The XPath expression is conceptually evaluated in the following context, in addition to the definition in Section 6.4.1:
除了第6.4.1节中的定义外,XPath表达式在以下上下文中进行概念性评估:
o If the "when" statement is a child of an "augment" statement, then the context node is the augment's target node in the data tree, if the target node is a data node. Otherwise, the context node is the closest ancestor node to the target node that is also a data node.
o 如果“when”语句是“augment”语句的子语句,则上下文节点是数据树中的augment的目标节点(如果目标节点是数据节点)。否则,上下文节点是距离目标节点(也是数据节点)最近的祖先节点。
o If the "when" statement is a child of a "uses", "choice", or "case" statement, then the context node is the closest ancestor node to the "uses", "choice", or "case" node that is also a data node.
o 如果“when”语句是“uses”、“choice”或“case”语句的子语句,则上下文节点是与“uses”、“choice”或“case”节点(也是数据节点)最近的祖先节点。
o If the "when" statement is a child of any other data definition statement, the context node is the data definition's node in the data tree.
o 如果“when”语句是任何其他数据定义语句的子语句,则上下文节点是数据树中数据定义的节点。
o The accessible tree is made up of all nodes in the data tree, and all leafs with default values in use (see Section 7.6.1).
o 可访问树由数据树中的所有节点和使用默认值的所有叶组成(见第7.6.1节)。
The accessible tree depends on the context node:
可访问树取决于上下文节点:
o If the context node represents configuration, the tree is the data in the NETCONF datastore where the context node exists. The XPath root node has all top-level configuration data nodes in all modules as children.
o 如果上下文节点表示配置,则树是存在上下文节点的NETCONF数据存储中的数据。XPath根节点将所有模块中的所有顶级配置数据节点作为子节点。
o If the context node represents state data, the tree is all state data on the device, and the <running/> datastore. The XPath root node has all top-level data nodes in all modules as children.
o 如果上下文节点表示状态数据,则树是设备上的所有状态数据,以及<running/>数据存储。XPath根节点将所有模块中的所有顶级数据节点作为子节点。
o If the context node represents notification content, the tree is the notification XML instance document. The XPath root node has the element representing the notification being defined as the only child.
o 如果上下文节点表示通知内容,则树就是通知XML实例文档。XPath根节点具有表示被定义为唯一子节点的通知的元素。
o If the context node represents RPC input parameters, the tree is the RPC XML instance document. The XPath root node has the element representing the RPC operation being defined as the only child.
o 如果上下文节点表示RPC输入参数,则树就是RPC XML实例文档。XPath根节点将表示RPC操作的元素定义为唯一的子节点。
o If the context node represents RPC output parameters, the tree is the RPC reply instance document. The XPath root node has the elements representing the RPC output parameters as children.
o 如果上下文节点表示RPC输出参数,则树就是RPC应答实例文档。XPath根节点具有表示RPC输出参数的子元素。
The result of the XPath expression is converted to a boolean value using the standard XPath rules.
XPath表达式的结果使用标准XPath规则转换为布尔值。
Note that the XPath expression is conceptually evaluated. This means that an implementation does not have to use an XPath evaluator on the device. The "when" statement can very well be implemented with specially written code.
请注意,XPath表达式是在概念上进行计算的。这意味着实现不必在设备上使用XPath计算器。“when”语句可以用专门编写的代码很好地实现。
Several YANG statements define constraints on valid data. These constraints are enforced in different ways, depending on what type of data the statement defines.
几个语句定义了对有效数据的约束。根据语句定义的数据类型,这些约束以不同的方式强制执行。
o If the constraint is defined on configuration data, it MUST be true in a valid configuration data tree.
o 如果约束是在配置数据上定义的,则在有效的配置数据树中必须为true。
o If the constraint is defined on state data, it MUST be true in a reply to a <get> operation without a filter.
o 如果约束是在状态数据上定义的,则在对<get>操作的答复中,该约束必须为true,而不使用过滤器。
o If the constraint is defined on notification content, it MUST be true in any notification instance.
o 如果约束是在通知内容上定义的,则在任何通知实例中都必须为true。
o If the constraint is defined on RPC input parameters, it MUST be true in an invocation of the RPC operation.
o 如果约束是在RPC输入参数上定义的,则在调用RPC操作时必须为true。
o If the constraint is defined on RPC output parameters, it MUST be true in the RPC reply.
o 如果约束是在RPC输出参数上定义的,则它在RPC应答中必须为true。
Conditions on parent nodes affect constraints on child nodes as a natural consequence of the hierarchy of nodes. "must", "mandatory", "min-elements", and "max-elements" constraints are not enforced if the parent node has a "when" or "if-feature" property that is not satisfied on the current device.
父节点上的条件会影响子节点上的约束,这是节点层次结构的自然结果。如果父节点的“何时”或“如果功能”属性在当前设备上不满足,则不会强制执行“必须”、“必需”、“最小元素”和“最大元素”约束。
In this example, the "mandatory" constraint on the "longitude" leaf are not enforced on devices that lack the "has-gps" feature:
在本例中,“经度”叶上的“强制”约束不适用于缺少“具有gps”功能的设备:
container location { if-feature has-gps; leaf longitude { mandatory true; ... } }
container location { if-feature has-gps; leaf longitude { mandatory true; ... } }
For configuration data, there are three windows when constraints MUST be enforced:
对于配置数据,必须强制执行约束时有三个窗口:
o during parsing of RPC payloads
o 在分析RPC有效负载期间
o during processing of NETCONF operations
o 在处理NETCONF操作期间
o during validation
o 验证期间
Each of these scenarios is considered in the following sections.
以下各节将考虑其中的每种情况。
When content arrives in RPC payloads, it MUST be well-formed XML, following the hierarchy and content rules defined by the set of models the device implements.
当内容到达RPC有效负载时,它必须是格式良好的XML,遵循设备实现的模型集定义的层次结构和内容规则。
o If a leaf data value does not match the type constraints for the leaf, including those defined in the type's "range", "length", and "pattern" properties, the server MUST reply with an "invalid-value" error-tag in the rpc-error, and with the error-app-tag and error-message associated with the constraint, if any exist.
o 如果叶数据值与叶的类型约束(包括在类型的“范围”、“长度”和“模式”属性中定义的约束)不匹配,服务器必须在rpc错误中使用“无效值”错误标记以及与约束相关联的错误应用标记和错误消息(如果存在)进行回复。
o If all keys of a list entry are not present, the server MUST reply with a "missing-element" error-tag in the rpc-error.
o 如果列表项的所有键都不存在,服务器必须在rpc错误中使用“missing element”错误标记进行回复。
o If data for more than one case branch of a choice is present, the server MUST reply with a "bad-element" in the rpc-error.
o 如果存在一个选项的多个案例分支的数据,则服务器必须在rpc错误中使用“坏元素”进行回复。
o If data for a node tagged with "if-feature" is present, and the feature is not supported by the device, the server MUST reply with an "unknown-element" error-tag in the rpc-error.
o 如果存在标记为“If feature”的节点的数据,并且设备不支持该功能,则服务器必须在rpc错误中使用“unknown element”错误标记进行回复。
o If data for a node tagged with "when" is present, and the "when" condition evaluates to "false", the server MUST reply with an "unknown-element" error-tag in the rpc-error.
o 如果存在标记为“when”的节点的数据,并且“when”条件的计算结果为“false”,则服务器必须在rpc错误中使用“unknown element”错误标记进行回复。
o For insert handling, if the value for the attributes "before" and "after" are not valid for the type of the appropriate key leafs, the server MUST reply with a "bad-attribute" error-tag in the rpc-error.
o 对于插入处理,如果属性“before”和“after”的值对于相应密钥叶的类型无效,则服务器必须在rpc错误中使用“bad attribute”错误标记进行回复。
o If the attributes "before" and "after" appears in any element that is not a list whose "ordered-by" property is "user", the server MUST reply with an "unknown-attribute" error-tag in the rpc-error.
o 如果属性“before”和“after”出现在不是“ordered by”属性为“user”的列表的任何元素中,则服务器必须在rpc错误中使用“unknown attribute”错误标记进行回复。
After the incoming data is parsed, the NETCONF server performs the <edit-config> operation by applying the data to the configuration datastore. During this processing, the following errors MUST be detected:
解析传入数据后,NETCONF服务器通过将数据应用于配置数据存储来执行<edit config>操作。在此处理过程中,必须检测到以下错误:
o Delete requests for non-existent data.
o 删除对不存在数据的请求。
o Create requests for existent data.
o 创建对现有数据的请求。
o Insert requests with "before" or "after" parameters that do not exist.
o 使用不存在的“before”或“after”参数插入请求。
During <edit-config> processing:
在<edit config>处理过程中:
o If the NETCONF operation creates data nodes under a "choice", any existing nodes from other "case" branches are deleted by the server.
o 如果NETCONF操作在“choice”下创建数据节点,则服务器将删除其他“case”分支中的任何现有节点。
o If the NETCONF operation modifies a data node such that any node's "when" expression becomes false, then the node with the "when" expression is deleted by the server.
o 如果NETCONF操作修改数据节点,使任何节点的“when”表达式变为false,则服务器将删除带有“when”表达式的节点。
When datastore processing is complete, the final contents MUST obey all validation constraints. This validation processing is performed at differing times according to the datastore. If the datastore is <running/> or <startup/>, these constraints MUST be enforced at the end of the <edit-config> or <copy-config> operation. If the datastore is <candidate/>, the constraint enforcement is delayed until a <commit> or <validate> operation.
数据存储处理完成后,最终内容必须遵守所有验证约束。此验证处理根据数据存储在不同的时间执行。如果数据存储是<running/>或<startup/>,则必须在<edit config>或<copy config>操作结束时强制执行这些约束。如果数据存储是<candidate/>,则约束实施将延迟到<commit>或<validate>操作。
o Any "must" constraints MUST evaluate to "true".
o 任何“必须”约束都必须计算为“真”。
o Any referential integrity constraints defined via the "path" statement MUST be satisfied.
o 必须满足通过“path”语句定义的任何引用完整性约束。
o Any "unique" constraints on lists MUST be satisfied.
o 必须满足列表上的任何“唯一”约束。
o The "min-elements" and "max-elements" constraints are enforced for lists and leaf-lists.
o 列表和叶列表强制执行“最小元素”和“最大元素”约束。
YANG has a set of built-in types, similar to those of many programming languages, but with some differences due to special requirements from the management information model.
YANG有一组内置类型,类似于许多编程语言的类型,但由于管理信息模型的特殊要求而有所不同。
Additional types may be defined, derived from those built-in types or from other derived types. Derived types may use subtyping to formally restrict the set of possible values.
可以定义其他类型,从这些内置类型或其他派生类型派生。派生类型可以使用子类型来正式限制可能的值集。
The different built-in types and their derived types allow different kinds of subtyping, namely length and regular expression restrictions of strings (Sections 9.4.4 and 9.4.6) and range restrictions of numeric types (Section 9.2.4).
不同的内置类型及其派生类型允许不同类型的子类型,即字符串的长度和正则表达式限制(第9.4.4节和第9.4.6节)和数字类型的范围限制(第9.2.4节)。
The lexical representation of a value of a certain type is used in the NETCONF messages and when specifying default values and numerical ranges in YANG modules.
在NETCONF消息中以及在模块中指定默认值和数字范围时,使用特定类型值的词汇表示。
For most types, there is a single canonical representation of the type's values. Some types allow multiple lexical representations of the same value, for example, the positive integer "17" can be represented as "+17" or "17". Implementations MUST support all lexical representations specified in this document.
对于大多数类型,该类型的值只有一个规范表示形式。某些类型允许相同值的多个词汇表示,例如,正整数“17”可以表示为“+17”或“17”。实现必须支持本文档中指定的所有词汇表示。
When a NETCONF server sends data, it MUST be in the canonical form.
NETCONF服务器发送数据时,数据必须是规范格式。
Some types have a lexical representation that depends on the XML context in which they occur. These types do not have a canonical form.
某些类型的词汇表示取决于它们出现的XML上下文。这些类型没有规范形式。
The integer built-in types are int8, int16, int32, int64, uint8, uint16, uint32, and uint64. They represent signed and unsigned integers of different sizes:
内置的整数类型有int8、int16、int32、int64、uint8、uint16、uint32和uint64。它们表示大小不同的有符号和无符号整数:
int8 represents integer values between -128 and 127, inclusively.
int8表示介于-128和127之间的整数值。
int16 represents integer values between -32768 and 32767, inclusively.
int16表示介于-32768和32767之间的整数值。
int32 represents integer values between -2147483648 and 2147483647, inclusively.
int32表示介于-2147483648和2147483647之间的整数值。
int64 represents integer values between -9223372036854775808 and 9223372036854775807, inclusively.
int64表示介于-9223372036854775808和9223372036854775807之间的整数值(包括)。
uint8 represents integer values between 0 and 255, inclusively.
uint8表示介于0和255之间的整数值(包括)。
uint16 represents integer values between 0 and 65535, inclusively.
uint16表示介于0和65535之间的整数值。
uint32 represents integer values between 0 and 4294967295, inclusively.
uint32表示0和4294967295之间的整数值,包括0和4294967295。
uint64 represents integer values between 0 and 18446744073709551615, inclusively.
uint64表示介于0和18446744073709551615之间的整数值。
An integer value is lexically represented as an optional sign ("+" or "-"), followed by a sequence of decimal digits. If no sign is specified, "+" is assumed.
整数值在词汇上表示为可选符号(“+”或“-”),后跟一系列十进制数字。如果未指定符号,则假定为“+”。
For convenience, when specifying a default value for an integer in a YANG module, an alternative lexical representation can be used, which represents the value in a hexadecimal or octal notation. The hexadecimal notation consists of an optional sign ("+" or "-"), the characters "0x" followed a number of hexadecimal digits, where letters may be uppercase or lowercase. The octal notation consists of an optional sign ("+" or "-"), the character "0" followed a number of octal digits.
为方便起见,在YANG模块中为整数指定默认值时,可以使用另一种词汇表示法,它以十六进制或八进制表示值。十六进制表示法由可选符号(“+”或“-”)组成,字符“0x”后跟许多十六进制数字,其中字母可以是大写或小写。八进制表示法由可选符号(“+”或“-”)组成,字符“0”后跟许多八进制数字。
Note that if a default value in a YANG module has a leading zero ("0"), it is interpreted as an octal number. In the XML instance documents, an integer is always interpreted as a decimal number, and leading zeros are allowed.
请注意,如果YANG模块中的默认值具有前导零(“0”),则会将其解释为八进制数。在XML实例文档中,整数始终被解释为十进制数,并且允许前导零。
Examples:
示例:
// legal values +4711 // legal positive value 4711 // legal positive value -123 // legal negative value 0xf00f // legal positive hexadecimal value -0xf // legal negative hexadecimal value 052 // legal positive octal value
// legal values +4711 // legal positive value 4711 // legal positive value -123 // legal negative value 0xf00f // legal positive hexadecimal value -0xf // legal negative hexadecimal value 052 // legal positive octal value
// illegal values - 1 // illegal intermediate space
// illegal values - 1 // illegal intermediate space
The canonical form of a positive integer does not include the sign "+". Leading zeros are prohibited. The value zero is represented as "0".
正整数的标准形式不包括符号“+”。禁止使用前导零。值0表示为“0”。
All integer types can be restricted with the "range" statement (Section 9.2.4).
所有整数类型都可以用“range”语句进行限制(第9.2.4节)。
The "range" statement, which is an optional substatement to the "type" statement, takes as an argument a range expression string. It is used to restrict integer and decimal built-in types, or types derived from those.
“range”语句是“type”语句的可选子语句,它将range表达式字符串作为参数。它用于限制整数和十进制内置类型,或从这些类型派生的类型。
A range consists of an explicit value, or a lower-inclusive bound, two consecutive dots "..", and an upper-inclusive bound. Multiple values or ranges can be given, separated by "|". If multiple values or ranges are given, they all MUST be disjoint and MUST be in ascending order. If a range restriction is applied to an already range-restricted type, the new restriction MUST be equal or more limiting, that is raising the lower bounds, reducing the upper bounds, removing explicit values or ranges, or splitting ranges into multiple ranges with intermediate gaps. Each explicit value and range boundary value given in the range expression MUST match the type being restricted, or be one of the special values "min" or "max". "min" and "max" mean the minimum and maximum value accepted for the type being restricted, respectively.
范围由一个显式值或一个包含下限、两个连续点“.”和一个包含上限组成。可以给出多个值或范围,以“|”分隔。如果给定了多个值或范围,则它们都必须是不相交的,并且必须按升序排列。如果将范围限制应用于已受范围限制的类型,则新限制必须等于或大于限制,即提高下限、降低上限、删除显式值或范围,或将范围拆分为具有中间间隙的多个范围。范围表达式中给出的每个显式值和范围边界值必须与受限制的类型匹配,或者是特殊值“min”或“max”之一。“最小值”和“最大值”分别指受限制类型可接受的最小值和最大值。
The range expression syntax is formally defined by the rule "range-arg" in Section 12.
范围表达式语法由第12节中的规则“range arg”正式定义。
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
typedef my-base-int32-type { type int32 { range "1..4 | 10..20"; } }
typedef my-base-int32-type { type int32 { range "1..4 | 10..20"; } }
typedef my-type1 { type my-base-int32-type { // legal range restriction range "11..max"; // 11..20 } }
typedef my-type1 { type my-base-int32-type { // legal range restriction range "11..max"; // 11..20 } }
typedef my-type2 { type my-base-int32-type { // illegal range restriction range "11..100"; } }
typedef my-type2 { type my-base-int32-type { // illegal range restriction range "11..100"; } }
The decimal64 type represents a subset of the real numbers, which can be represented by decimal numerals. The value space of decimal64 is the set of numbers that can be obtained by multiplying a 64-bit signed integer by a negative power of ten, i.e., expressible as "i x 10^-n" where i is an integer64 and n is an integer between 1 and 18, inclusively.
decimal64类型表示实数的子集,可以用十进制数字表示。小数64的值空间是可通过将64位有符号整数乘以10的负幂而获得的一组数字,即,可表示为“i x 10^-n”,其中i是整数64,n是介于1和18之间的整数。
A decimal64 value is lexically represented as an optional sign ("+" or "-"), followed by a sequence of decimal digits, optionally followed by a period ('.') as a decimal indicator and a sequence of decimal digits. If no sign is specified, "+" is assumed.
十进制64值在词汇上表示为可选符号(“+”或“-”),后跟十进制数字序列,可选后跟句点(“.”)作为十进制指示符和十进制数字序列。如果未指定符号,则假定为“+”。
The canonical form of a positive decimal64 does not include the sign "+". The decimal point is required. Leading and trailing zeros are prohibited, subject to the rule that there MUST be at least one digit before and after the decimal point. The value zero is represented as "0.0".
正小数64的标准形式不包括符号“+”。小数点是必需的。禁止使用前导零和尾随零,前提是小数点前后必须至少有一位数字。值0表示为“0.0”。
A decimal64 type can be restricted with the "range" statement (Section 9.2.4).
小数64类型可通过“范围”语句进行限制(第9.2.4节)。
The "fraction-digits" statement, which is a substatement to the "type" statement, MUST be present if the type is "decimal64". It takes as an argument an integer between 1 and 18, inclusively. It controls the size of the minimum difference between values of a decimal64 type, by restricting the value space to numbers that are expressible as "i x 10^-n" where n is the fraction-digits argument.
“小数位数”语句是“type”语句的子语句,如果类型为“decimal64”,则必须存在该语句。它接受一个介于1和18之间的整数作为参数。它通过将值空间限制为可表示为“i x 10^-n”的数字,其中n是小数位数参数,来控制小数64类型的值之间最小差值的大小。
The following table lists the minimum and maximum value for each fraction-digit value:
下表列出了每个分数位数的最小值和最大值:
+----------------+-----------------------+----------------------+ | fraction-digit | min | max | +----------------+-----------------------+----------------------+ | 1 | -922337203685477580.8 | 922337203685477580.7 | | 2 | -92233720368547758.08 | 92233720368547758.07 | | 3 | -9223372036854775.808 | 9223372036854775.807 | | 4 | -922337203685477.5808 | 922337203685477.5807 | | 5 | -92233720368547.75808 | 92233720368547.75807 | | 6 | -9223372036854.775808 | 9223372036854.775807 | | 7 | -922337203685.4775808 | 922337203685.4775807 | | 8 | -92233720368.54775808 | 92233720368.54775807 | | 9 | -9223372036.854775808 | 9223372036.854775807 | | 10 | -922337203.6854775808 | 922337203.6854775807 | | 11 | -92233720.36854775808 | 92233720.36854775807 | | 12 | -9223372.036854775808 | 9223372.036854775807 | | 13 | -922337.2036854775808 | 922337.2036854775807 | | 14 | -92233.72036854775808 | 92233.72036854775807 | | 15 | -9223.372036854775808 | 9223.372036854775807 | | 16 | -922.3372036854775808 | 922.3372036854775807 | | 17 | -92.23372036854775808 | 92.23372036854775807 | | 18 | -9.223372036854775808 | 9.223372036854775807 | +----------------+-----------------------+----------------------+
+----------------+-----------------------+----------------------+ | fraction-digit | min | max | +----------------+-----------------------+----------------------+ | 1 | -922337203685477580.8 | 922337203685477580.7 | | 2 | -92233720368547758.08 | 92233720368547758.07 | | 3 | -9223372036854775.808 | 9223372036854775.807 | | 4 | -922337203685477.5808 | 922337203685477.5807 | | 5 | -92233720368547.75808 | 92233720368547.75807 | | 6 | -9223372036854.775808 | 9223372036854.775807 | | 7 | -922337203685.4775808 | 922337203685.4775807 | | 8 | -92233720368.54775808 | 92233720368.54775807 | | 9 | -9223372036.854775808 | 9223372036.854775807 | | 10 | -922337203.6854775808 | 922337203.6854775807 | | 11 | -92233720.36854775808 | 92233720.36854775807 | | 12 | -9223372.036854775808 | 9223372.036854775807 | | 13 | -922337.2036854775808 | 922337.2036854775807 | | 14 | -92233.72036854775808 | 92233.72036854775807 | | 15 | -9223.372036854775808 | 9223.372036854775807 | | 16 | -922.3372036854775808 | 922.3372036854775807 | | 17 | -92.23372036854775808 | 92.23372036854775807 | | 18 | -9.223372036854775808 | 9.223372036854775807 | +----------------+-----------------------+----------------------+
typedef my-decimal { type decimal64 { fraction-digits 2; range "1 .. 3.14 | 10 | 20..max"; } }
typedef my-decimal { type decimal64 { fraction-digits 2; range "1 .. 3.14 | 10 | 20..max"; } }
The string built-in type represents human-readable strings in YANG. Legal characters are tab, carriage return, line feed, and the legal characters of Unicode and ISO/IEC 10646 [ISO.10646]:
字符串内置类型表示YANG中的人类可读字符串。合法字符包括制表符、回车符、换行符以及Unicode和ISO/IEC 10646[ISO.10646]的合法字符:
;; any Unicode character, excluding the surrogate blocks, ;; FFFE, and FFFF. string = *char char = %x9 / %xA / %xD / %x20-D7FF / %xE000-FFFD / %x10000-10FFFF
;; any Unicode character, excluding the surrogate blocks, ;; FFFE, and FFFF. string = *char char = %x9 / %xA / %xD / %x20-D7FF / %xE000-FFFD / %x10000-10FFFF
A string value is lexically represented as character data in the XML instance documents.
在XML实例文档中,字符串值在词汇上表示为字符数据。
The canonical form is the same as the lexical representation. No Unicode normalization is performed of string values.
规范形式与词汇表示相同。不执行字符串值的Unicode规范化。
A string can be restricted with the "length" (Section 9.4.4) and "pattern" (Section 9.4.6) statements.
可以使用“长度”(第9.4.4节)和“模式”(第9.4.6节)语句限制字符串。
The "length" statement, which is an optional substatement to the "type" statement, takes as an argument a length expression string. It is used to restrict the built-in type "string", or types derived from "string".
“length”语句是“type”语句的可选子语句,它以长度表达式字符串作为参数。它用于限制内置类型“string”或从“string”派生的类型。
A "length" statement restricts the number of Unicode characters in the string.
“length”语句限制字符串中Unicode字符的数量。
A length range consists of an explicit value, or a lower bound, two consecutive dots "..", and an upper bound. Multiple values or ranges can be given, separated by "|". Length-restricting values MUST NOT be negative. If multiple values or ranges are given, they all MUST be disjoint and MUST be in ascending order. If a length restriction is applied to an already length-restricted type, the new restriction MUST be equal or more limiting, that is, raising the lower bounds, reducing the upper bounds, removing explicit length values or ranges, or splitting ranges into multiple ranges with intermediate gaps. A length value is a non-negative integer, or one of the special values "min" or "max". "min" and "max" mean the minimum and maximum length accepted for the type being restricted, respectively. An implementation is not required to support a length value larger than 18446744073709551615.
长度范围由一个显式值或一个下限、两个连续点“.”和一个上限组成。可以给出多个值或范围,以“|”分隔。长度限制值不得为负值。如果给定了多个值或范围,则它们都必须是不相交的,并且必须按升序排列。如果将长度限制应用于已受长度限制的类型,则新限制必须等于或大于限制,即提高下界、降低上界、删除显式长度值或范围,或将范围拆分为具有中间间隙的多个范围。长度值是非负整数,或特殊值“min”或“max”之一。“最小”和“最大”分别指受限制类型可接受的最小和最大长度。实现不需要支持大于18446744073709551615的长度值。
The length expression syntax is formally defined by the rule "length-arg" in Section 12.
长度表达式语法由第12节中的规则“length arg”正式定义。
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
typedef my-base-str-type { type string { length "1..255"; } }
typedef my-base-str-type { type string { length "1..255"; } }
type my-base-str-type { // legal length refinement length "11 | 42..max"; // 11 | 42..255 }
type my-base-str-type { // legal length refinement length "11 | 42..max"; // 11 | 42..255 }
type my-base-str-type { // illegal length refinement length "1..999"; }
type my-base-str-type { // illegal length refinement length "1..999"; }
The "pattern" statement, which is an optional substatement to the "type" statement, takes as an argument a regular expression string, as defined in [XSD-TYPES]. It is used to restrict the built-in type "string", or types derived from "string", to values that match the pattern.
“pattern”语句是“type”语句的可选子语句,它将[XSD-TYPES]中定义的正则表达式字符串作为参数。它用于将内置类型“string”或从“string”派生的类型限制为与模式匹配的值。
If the type has multiple "pattern" statements, the expressions are ANDed together, i.e., all such expressions have to match.
如果类型有多个“模式”语句,则表达式将被AND放在一起,即所有此类表达式都必须匹配。
If a pattern restriction is applied to an already pattern-restricted type, values must match all patterns in the base type, in addition to the new patterns.
如果对已受模式限制的类型应用了模式限制,则值必须与基类型中的所有模式(除了新模式)匹配。
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
+---------------+---------+-------------+ | substatement | section | cardinality | +---------------+---------+-------------+ | description | 7.19.3 | 0..1 | | error-app-tag | 7.5.4.2 | 0..1 | | error-message | 7.5.4.1 | 0..1 | | reference | 7.19.4 | 0..1 | +---------------+---------+-------------+
With the following type:
使用以下类型:
type string { length "0..4"; pattern "[0-9a-fA-F]*"; }
type string { length "0..4"; pattern "[0-9a-fA-F]*"; }
the following strings match:
以下字符串匹配:
AB // legal 9A00 // legal
AB // legal 9A00 // legal
and the following strings do not match:
并且以下字符串不匹配:
00ABAB // illegal, too long xx00 // illegal, bad characters
00ABAB // illegal, too long xx00 // illegal, bad characters
The boolean built-in type represents a boolean value.
布尔内置类型表示布尔值。
The lexical representation of a boolean value is a string with a value of "true" or "false". These values MUST be in lowercase.
布尔值的词汇表示是一个值为“真”或“假”的字符串。这些值必须为小写。
The canonical form is the same as the lexical representation.
规范形式与词汇表示相同。
A boolean cannot be restricted.
布尔值不能被限制。
The enumeration built-in type represents values from a set of assigned names.
枚举内置类型表示一组指定名称中的值。
The lexical representation of an enumeration value is the assigned name string.
枚举值的词法表示是指定的名称字符串。
The canonical form is the assigned name string.
规范形式是指定的名称字符串。
An enumeration cannot be restricted.
不能限制枚举。
The "enum" statement, which is a substatement to the "type" statement, MUST be present if the type is "enumeration". It is repeatedly used to specify each assigned name of an enumeration type. It takes as an argument a string which is the assigned name. The string MUST NOT be empty and MUST NOT have any leading or trailing whitespace characters. The use of Unicode control codes SHOULD be avoided.
“enum”语句是“type”语句的子语句,如果类型为“enumeration”,则必须存在该语句。它反复用于指定枚举类型的每个指定名称。它将指定名称的字符串作为参数。字符串不得为空,且不得有任何前导或尾随空格字符。应避免使用Unicode控制代码。
The statement is optionally followed by a block of substatements that holds detailed enum information.
该语句后面有一个包含详细枚举信息的子语句块(可选)。
All assigned names in an enumeration MUST be unique.
枚举中所有分配的名称都必须是唯一的。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | value | 9.6.4.2 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | value | 9.6.4.2 | 0..1 | +--------------+---------+-------------+
The "value" statement, which is optional, is used to associate an integer value with the assigned name for the enum. This integer value MUST be in the range -2147483648 to 2147483647, and it MUST be unique within the enumeration type. The value is unused by YANG and the XML encoding, but is carried as a convenience to implementors.
“value”语句是可选的,用于将整数值与枚举的指定名称相关联。此整数值必须在-2147483648到2147483647之间,并且在枚举类型中必须是唯一的。YANG和XML编码未使用该值,但为方便实现者而携带该值。
If a value is not specified, then one will be automatically assigned. If the "enum" substatement is the first one defined, the assigned value is zero (0); otherwise, the assigned value is one greater than the current highest enum value.
如果未指定值,则将自动指定一个值。如果“enum”子状态是第一个定义的子状态,则赋值为零(0);否则,指定的值比当前最高枚举值大一个。
If the current highest value is equal to 2147483647, then an enum value MUST be specified for "enum" substatements following the one with the current highest value.
如果当前最大值等于2147483647,则必须为具有当前最大值的子状态之后的“enum”子状态指定枚举值。
leaf myenum { type enumeration { enum zero; enum one; enum seven { value 7; } } }
leaf myenum { type enumeration { enum zero; enum one; enum seven { value 7; } } }
The lexical representation of the leaf "myenum" with value "seven" is:
值为“seven”的叶“myenum”的词汇表示为:
<myenum>seven</myenum>
<myenum>seven</myenum>
The bits built-in type represents a bit set. That is, a bits value is a set of flags identified by small integer position numbers starting at 0. Each bit number has an assigned name.
bits内置类型表示位集。也就是说,位值是由从0开始的小整数位置号标识的一组标志。每个位号都有一个指定的名称。
A bits type cannot be restricted.
不能限制位类型。
The lexical representation of the bits type is a space-separated list of the individual bit values that are set. An empty string thus represents a value where no bits are set.
bits类型的词法表示是设置的单个位值的空格分隔列表。因此,空字符串表示未设置位的值。
In the canonical form, the bit values are separated by a single space character and they appear ordered by their position (see Section 9.7.4.2).
在标准格式中,位值由单个空格字符分隔,并按其位置排列(见第9.7.4.2节)。
The "bit" statement, which is a substatement to the "type" statement, MUST be present if the type is "bits". It is repeatedly used to specify each assigned named bit of a bits type. It takes as an argument a string that is the assigned name of the bit. It is followed by a block of substatements that holds detailed bit information. The assigned name follows the same syntax rules as an identifier (see Section 6.2).
“bit”语句是“type”语句的子语句,如果类型为“bits”,则必须存在该语句。它反复用于指定位类型的每个指定的命名位。它接受一个字符串作为参数,该字符串是位的指定名称。它后面是一个包含详细位信息的子语句块。分配的名称遵循与标识符相同的语法规则(参见第6.2节)。
All assigned names in a bits type MUST be unique.
bits类型中所有分配的名称必须是唯一的。
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | position | 9.7.4.2 | 0..1 | +--------------+---------+-------------+
+--------------+---------+-------------+ | substatement | section | cardinality | +--------------+---------+-------------+ | description | 7.19.3 | 0..1 | | reference | 7.19.4 | 0..1 | | status | 7.19.2 | 0..1 | | position | 9.7.4.2 | 0..1 | +--------------+---------+-------------+
The "position" statement, which is optional, takes as an argument a non-negative integer value that specifies the bit's position within a hypothetical bit field. The position value MUST be in the range 0 to 4294967295, and it MUST be unique within the bits type. The value is unused by YANG and the NETCONF messages, but is carried as a convenience to implementors.
“position”语句是可选的,它接受一个非负整数值作为参数,该数值指定位在假设位字段中的位置。位置值必须在0到4294967295之间,并且在bits类型中必须是唯一的。YANG和NETCONF消息未使用该值,但为方便实现者而携带该值。
If a bit position is not specified, then one will be automatically assigned. If the "bit" substatement is the first one defined, the assigned value is zero (0); otherwise, the assigned value is one greater than the current highest bit position.
如果未指定位位置,则将自动分配一个位位置。如果“位”子状态是第一个定义的子状态,则赋值为零(0);否则,分配的值比当前最高位位置大一个。
If the current highest bit position value is equal to 4294967295, then a position value MUST be specified for "bit" substatements following the one with the current highest position value.
如果当前最高位位置值等于4294967295,则必须为具有当前最高位置值的子状态之后的“位”子状态指定位置值。
Given the following leaf:
鉴于以下情况:
leaf mybits { type bits { bit disable-nagle { position 0; } bit auto-sense-speed { position 1; } bit 10-Mb-only { position 2; } } default "auto-sense-speed"; }
leaf mybits { type bits { bit disable-nagle { position 0; } bit auto-sense-speed { position 1; } bit 10-Mb-only { position 2; } } default "auto-sense-speed"; }
The lexical representation of this leaf with bit values disable-nagle and 10-Mb-only set would be:
此叶的词法表示(位值为disable nagle且仅设置了10 Mb)为:
<mybits>disable-nagle 10-Mb-only</mybits>
<mybits>disable-nagle 10-Mb-only</mybits>
The binary built-in type represents any binary data, i.e., a sequence of octets.
二进制内置类型表示任何二进制数据,即八位字节序列。
A binary can be restricted with the "length" (Section 9.4.4) statement. The length of a binary value is the number of octets it contains.
二进制文件可以用“长度”(第9.4.4节)语句进行限制。二进制值的长度是它包含的八位字节数。
Binary values are encoded with the base64 encoding scheme (see [RFC4648], Section 4).
二进制值采用base64编码方案进行编码(参见[RFC4648],第4节)。
The canonical form of a binary value follows the rules in [RFC4648].
二进制值的标准形式遵循[RFC4648]中的规则。
The leafref type is used to reference a particular leaf instance in the data tree. The "path" substatement (Section 9.9.2) selects a set of leaf instances, and the leafref value space is the set of values of these leaf instances.
leafref类型用于引用数据树中的特定叶实例。“路径”子状态(第9.9.2节)选择一组叶实例,叶引用值空间是这些叶实例的值集。
If the leaf with the leafref type represents configuration data, the leaf it refers to MUST also represent configuration. Such a leaf puts a constraint on valid data. All leafref nodes MUST reference existing leaf instances or leafs with default values in use (see Section 7.6.1) for the data to be valid. This constraint is enforced according to the rules in Section 8.
如果leafref类型的叶表示配置数据,则其引用的叶也必须表示配置。这样的叶子对有效数据施加了约束。所有leafref节点必须引用现有叶实例或使用默认值的叶(见第7.6.1节),数据才有效。此约束根据第8节中的规则强制执行。
There MUST NOT be any circular chains of leafrefs.
叶参照不得有任何环形链。
If the leaf that the leafref refers to is conditional based on one or more features (see Section 7.18.2), then the leaf with the leafref type MUST also be conditional based on at least the same set of features.
如果leafref引用的叶基于一个或多个特征(见第7.18.2节),则具有leafref类型的叶也必须基于至少相同的特征集。
A leafref cannot be restricted.
不能限制leafref。
The "path" statement, which is a substatement to the "type" statement, MUST be present if the type is "leafref". It takes as an argument a string that MUST refer to a leaf or leaf-list node.
“path”语句是“type”语句的子语句,如果类型为“leafref”,则必须存在该语句。它接受一个必须引用叶或叶列表节点的字符串作为参数。
The syntax for a path argument is a subset of the XPath abbreviated syntax. Predicates are used only for constraining the values for the key nodes for list entries. Each predicate consists of exactly one equality test per key, and multiple adjacent predicates MAY be present if a list has multiple keys. The syntax is formally defined by the rule "path-arg" in Section 12.
path参数的语法是XPath缩写语法的子集。谓词仅用于约束列表项的关键节点的值。每个谓词对于每个键只包含一个相等测试,如果列表有多个键,则可能存在多个相邻谓词。语法由第12节中的规则“path arg”正式定义。
The predicates are only used when more than one key reference is needed to uniquely identify a leaf instance. This occurs if a list has multiple keys, or a reference to a leaf other than the key in a list is needed. In these cases, multiple leafrefs are typically specified, and predicates are used to tie them together.
谓词仅在需要多个键引用来唯一标识叶实例时使用。如果列表有多个键,或者需要对列表中键以外的叶的引用,则会发生这种情况。在这些情况下,通常会指定多个leafref,并使用谓词将它们连接在一起。
The "path" expression evaluates to a node set consisting of zero, one, or more nodes. If the leaf with the leafref type represents configuration data, this node set MUST be non-empty.
“路径”表达式的计算结果是由零个、一个或多个节点组成的节点集。如果leafref类型的叶表示配置数据,则此节点集必须为非空。
The "path" XPath expression is conceptually evaluated in the following context, in addition to the definition in Section 6.4.1:
除了第6.4.1节中的定义外,还将在以下上下文中对“path”XPath表达式进行概念性评估:
o The context node is the node in the data tree for which the "path" statement is defined.
o 上下文节点是数据树中定义了“path”语句的节点。
The accessible tree depends on the context node:
可访问树取决于上下文节点:
o If the context node represents configuration data, the tree is the data in the NETCONF datastore where the context node exists. The XPath root node has all top-level configuration data nodes in all modules as children.
o 如果上下文节点表示配置数据,则树是存在上下文节点的NETCONF数据存储中的数据。XPath根节点将所有模块中的所有顶级配置数据节点作为子节点。
o Otherwise, the tree is all state data on the device, and the <running/> datastore. The XPath root node has all top-level data nodes in all modules as children.
o 否则,树就是设备上的所有状态数据和<running/>数据存储。XPath根节点将所有模块中的所有顶级数据节点作为子节点。
A leafref value is encoded the same way as the leaf it references.
leafref值的编码方式与其引用的叶相同。
The canonical form of a leafref is the same as the canonical form of the leaf it references.
leafref的标准形式与它引用的叶的标准形式相同。
With the following list:
以下是:
list interface { key "name"; leaf name { type string; } leaf admin-status { type admin-status; } list address { key "ip"; leaf ip { type yang:ip-address; } } }
list interface { key "name"; leaf name { type string; } leaf admin-status { type admin-status; } list address { key "ip"; leaf ip { type yang:ip-address; } } }
The following leafref refers to an existing interface:
以下leafref引用现有接口:
leaf mgmt-interface { type leafref { path "../interface/name"; } }
leaf mgmt-interface { type leafref { path "../interface/name"; } }
An example of a corresponding XML snippet:
对应的XML代码段示例:
<interface> <name>eth0</name> </interface> <interface> <name>lo</name> </interface>
<interface> <name>eth0</name> </interface> <interface> <name>lo</name> </interface>
<mgmt-interface>eth0</mgmt-interface>
<mgmt-interface>eth0</mgmt-interface>
The following leafrefs refer to an existing address of an interface:
以下叶引用引用接口的现有地址:
container default-address { leaf ifname { type leafref { path "../../interface/name"; } } leaf address { type leafref { path "../../interface[name = current()/../ifname]" + "/address/ip"; } } }
container default-address { leaf ifname { type leafref { path "../../interface/name"; } } leaf address { type leafref { path "../../interface[name = current()/../ifname]" + "/address/ip"; } } }
An example of a corresponding XML snippet:
对应的XML代码段示例:
<interface> <name>eth0</name> <admin-status>up</admin-status> <address> <ip>192.0.2.1</ip> </address> <address> <ip>192.0.2.2</ip> </address> </interface> <interface> <name>lo</name> <admin-status>up</admin-status> <address> <ip>127.0.0.1</ip> </address> </interface>
<interface> <name>eth0</name> <admin-status>up</admin-status> <address> <ip>192.0.2.1</ip> </address> <address> <ip>192.0.2.2</ip> </address> </interface> <interface> <name>lo</name> <admin-status>up</admin-status> <address> <ip>127.0.0.1</ip> </address> </interface>
<default-address> <ifname>eth0</ifname> <address>192.0.2.2</address> </default-address>
<default-address> <ifname>eth0</ifname> <address>192.0.2.2</address> </default-address>
The following list uses a leafref for one of its keys. This is similar to a foreign key in a relational database.
下面的列表使用leafref作为其键之一。这类似于关系数据库中的外键。
list packet-filter { key "if-name filter-id"; leaf if-name { type leafref { path "/interface/name"; } } leaf filter-id { type uint32; } ... }
list packet-filter { key "if-name filter-id"; leaf if-name { type leafref { path "/interface/name"; } } leaf filter-id { type uint32; } ... }
An example of a corresponding XML snippet:
对应的XML代码段示例:
<interface> <name>eth0</name> <admin-status>up</admin-status> <address> <ip>192.0.2.1</ip> </address> <address> <ip>192.0.2.2</ip> </address> </interface>
<interface> <name>eth0</name> <admin-status>up</admin-status> <address> <ip>192.0.2.1</ip> </address> <address> <ip>192.0.2.2</ip> </address> </interface>
<packet-filter> <if-name>eth0</if-name> <filter-id>1</filter-id> ... </packet-filter> <packet-filter> <if-name>eth0</if-name> <filter-id>2</filter-id> ... </packet-filter>
<packet-filter> <if-name>eth0</if-name> <filter-id>1</filter-id> ... </packet-filter> <packet-filter> <if-name>eth0</if-name> <filter-id>2</filter-id> ... </packet-filter>
The following notification defines two leafrefs to refer to an existing admin-status:
以下通知定义了两个LeafRef以引用现有管理员状态:
notification link-failure { leaf if-name { type leafref { path "/interface/name"; } } leaf admin-status { type leafref { path "/interface[name = current()/../if-name]" + "/admin-status"; } } }
notification link-failure { leaf if-name { type leafref { path "/interface/name"; } } leaf admin-status { type leafref { path "/interface[name = current()/../if-name]" + "/admin-status"; } } }
An example of a corresponding XML notification:
相应的XML通知示例如下:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <eventTime>2008-04-01T00:01:00Z</eventTime> <link-failure xmlns="http://acme.example.com/system"> <if-name>eth0</if-name> <admin-status>up</admin-status> </link-failure> </notification>
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <eventTime>2008-04-01T00:01:00Z</eventTime> <link-failure xmlns="http://acme.example.com/system"> <if-name>eth0</if-name> <admin-status>up</admin-status> </link-failure> </notification>
The identityref type is used to reference an existing identity (see Section 7.16).
identityref类型用于引用现有标识(参见第7.16节)。
An identityref cannot be restricted.
无法限制identityref。
The "base" statement, which is a substatement to the "type" statement, MUST be present if the type is "identityref". The argument is the name of an identity, as defined by an "identity" statement. If a prefix is present on the identity name, it refers to an identity defined in the module that was imported with that prefix. Otherwise, an identity with the matching name MUST be defined in the current module or an included submodule.
如果类型为“identityref”,则作为“type”语句的子语句的“base”语句必须存在。参数是由“identity”语句定义的标识的名称。如果标识名上存在前缀,则它指的是使用该前缀导入的模块中定义的标识。否则,必须在当前模块或包含的子模块中定义具有匹配名称的标识。
Valid values for an identityref are any identities derived from the identityref's base identity. On a particular server, the valid values are further restricted to the set of identities defined in the modules supported by the server.
identityref的有效值是从identityref的基本标识派生的任何标识。在特定服务器上,有效值进一步限制为服务器支持的模块中定义的标识集。
An identityref is encoded as the referred identity's qualified name as defined in [XML-NAMES]. If the prefix is not present, the namespace of the identityref is the default namespace in effect on the element that contains the identityref value.
identityref编码为[XML-NAMES]中定义的引用标识的限定名称。如果前缀不存在,则identityref的命名空间是对包含identityref值的元素有效的默认命名空间。
When an identityref is given a default value using the "default" statement, the identity name in the default value MAY have a prefix. If a prefix is present on the identity name, it refers to an identity defined in the module that was imported with that prefix. Otherwise, an identity with the matching name MUST be defined in the current module or an included submodule.
当使用“default”语句为identityref指定默认值时,默认值中的标识名可能有前缀。如果标识名上存在前缀,则它指的是使用该前缀导入的模块中定义的标识。否则,必须在当前模块或包含的子模块中定义具有匹配名称的标识。
Since the lexical form depends on the XML context in which the value occurs, this type does not have a canonical form.
由于词汇形式取决于值出现的XML上下文,因此该类型没有规范形式。
With the identity definitions in Section 7.16.3 and the following module:
使用第7.16.3节中的标识定义和以下模块:
module my-crypto {
模块my crypto{
namespace "http://example.com/my-crypto"; prefix mc;
namespace "http://example.com/my-crypto"; prefix mc;
import "crypto-base" { prefix "crypto"; }
import "crypto-base" { prefix "crypto"; }
identity aes { base "crypto:crypto-alg"; }
identity aes { base "crypto:crypto-alg"; }
leaf crypto { type identityref { base "crypto:crypto-alg"; } } }
leaf crypto { type identityref { base "crypto:crypto-alg"; } } }
the leaf "crypto" will be encoded as follows, if the value is the "des3" identity defined in the "des" module:
如果值是“des”模块中定义的“des3”标识,则叶“crypto”将按如下方式编码:
<crypto xmlns:des="http://example.com/des">des:des3</crypto>
<crypto xmlns:des="http://example.com/des">des:des3</crypto>
Any prefixes used in the encoding are local to each instance encoding. This means that the same identityref may be encoded differently by different implementations. For example, the following example encodes the same leaf as above:
编码中使用的任何前缀都是每个实例编码的本地前缀。这意味着相同的identityref可以通过不同的实现进行不同的编码。例如,以下示例对与上面相同的叶进行编码:
<crypto xmlns:x="http://example.com/des">x:des3</crypto>
<crypto xmlns:x="http://example.com/des">x:des3</crypto>
If the "crypto" leaf's value instead is "aes" defined in the "my-crypto" module, it can be encoded as:
如果“加密”叶的值改为“我的加密”模块中定义的“aes”,则可以将其编码为:
<crypto xmlns:mc="http://example.com/my-crypto">mc:aes</crypto>
<crypto xmlns:mc="http://example.com/my-crypto">mc:aes</crypto>
or, using the default namespace:
或者,使用默认名称空间:
<crypto>aes</crypto>
<crypto>aes</crypto>
The empty built-in type represents a leaf that does not have any value, it conveys information by its presence or absence.
空的内置类型表示没有任何值的叶,它通过存在或不存在来传递信息。
An empty type cannot have a default value.
空类型不能有默认值。
An empty type cannot be restricted.
不能限制空类型。
Not applicable.
不适用。
Not applicable.
不适用。
The following leaf
下一页
leaf enable-qos { type empty; }
leaf enable-qos { type empty; }
will be encoded as
将被编码为
<enable-qos/>
<enable-qos/>
if it exists.
如果存在的话。
The union built-in type represents a value that corresponds to one of its member types.
union内置类型表示与其成员类型之一对应的值。
When the type is "union", the "type" statement (Section 7.4) MUST be present. It is used to repeatedly specify each member type of the union. It takes as an argument a string that is the name of a member type.
当类型为“union”时,“type”语句(第7.4节)必须存在。它用于重复指定联合的每个成员类型。它接受一个字符串作为参数,该字符串是成员类型的名称。
A member type can be of any built-in or derived type, except it MUST NOT be one of the built-in types "empty" or "leafref".
成员类型可以是任何内置类型或派生类型,但不能是内置类型“empty”或“leafref”之一。
When a string representing a union data type is validated, the string is validated against each member type, in the order they are specified in the "type" statement, until a match is found.
验证表示联合数据类型的字符串时,将按照“type”语句中指定的顺序针对每个成员类型验证该字符串,直到找到匹配项为止。
Any default value or "units" property defined in the member types is not inherited by the union type.
联合类型不会继承成员类型中定义的任何默认值或“units”属性。
Example:
例子:
type union { type int32; type enumeration { enum "unbounded"; } }
type union { type int32; type enumeration { enum "unbounded"; } }
A union cannot be restricted. However, each member type can be restricted, based on the rules defined in Section 9.
工会不能受到限制。但是,根据第9节中定义的规则,可以限制每种成员类型。
The lexical representation of a union is a value that corresponds to the representation of any one of the member types.
联合的词法表示是与任何一种成员类型的表示相对应的值。
The canonical form of a union value is the same as the canonical form of the member type of the value.
联合值的标准形式与值的成员类型的标准形式相同。
The instance-identifier built-in type is used to uniquely identify a particular instance node in the data tree.
实例标识符内置类型用于唯一标识数据树中的特定实例节点。
The syntax for an instance-identifier is a subset of the XPath abbreviated syntax, formally defined by the rule "instance-identifier" in Section 12. It is used to uniquely identify a node in the data tree. Predicates are used only for specifying the values for the key nodes for list entries, a value of a leaf-list entry, or a positional index for a list without keys. For identifying list entries with keys, each predicate consists of one equality test per key, and each key MUST have a corresponding predicate.
实例标识符的语法是XPath缩写语法的子集,由第12节中的规则“实例标识符”正式定义。它用于唯一标识数据树中的节点。谓词仅用于指定列表项的键节点值、叶列表项的值或无键列表的位置索引。为了用键标识列表项,每个谓词由每个键的一个相等性测试组成,每个键必须有一个对应的谓词。
If the leaf with the instance-identifier type represents configuration data, and the "require-instance" property (Section 9.13.2) is "true", the node it refers to MUST also represent configuration. Such a leaf puts a constraint on valid data. All such leaf nodes MUST reference existing nodes or leaf nodes with their default value in use (see Section 7.6.1) for the data to be valid. This constraint is enforced according to the rules in Section 8.
如果具有实例标识符类型的叶表示配置数据,并且“require instance”属性(第9.13.2节)为“true”,则其引用的节点也必须表示配置。这样的叶子对有效数据施加了约束。所有此类叶节点必须引用现有节点或使用默认值的叶节点(见第7.6.1节),数据才有效。此约束根据第8节中的规则强制执行。
The "instance-identifier" XPath expression is conceptually evaluated in the following context, in addition to the definition in Section 6.4.1:
除了第6.4.1节中的定义外,“实例标识符”XPath表达式在以下上下文中进行概念性评估:
o The context node is the root node in the accessible tree.
o 上下文节点是可访问树中的根节点。
The accessible tree depends on the leaf with the instance-identifier type:
可访问树取决于具有实例标识符类型的叶:
o If this leaf represents configuration data, the tree is the data in the NETCONF datastore where the leaf exists. The XPath root node has all top-level configuration data nodes in all modules as children.
o 如果此叶表示配置数据,则树是叶所在的NETCONF数据存储中的数据。XPath根节点将所有模块中的所有顶级配置数据节点作为子节点。
o Otherwise, the tree is all state data on the device, and the <running/> datastore. The XPath root node has all top-level data nodes in all modules as children.
o 否则,树就是设备上的所有状态数据和<running/>数据存储。XPath根节点将所有模块中的所有顶级数据节点作为子节点。
An instance-identifier can be restricted with the "require-instance" statement (Section 9.13.2).
实例标识符可以通过“require instance”语句进行限制(第9.13.2节)。
The "require-instance" statement, which is a substatement to the "type" statement, MAY be present if the type is "instance-identifier". It takes as an argument the string "true" or "false". If this statement is not present, it defaults to "true".
“require instance”语句是“type”语句的子语句,如果类型是“instance identifier”,则可能存在该语句。它将字符串“true”或“false”作为参数。如果此语句不存在,则默认为“true”。
If "require-instance" is "true", it means that the instance being referred MUST exist for the data to be valid. This constraint is enforced according to the rules in Section 8.
如果“require instance”为“true”,则表示引用的实例必须存在才能使数据有效。此约束根据第8节中的规则强制执行。
If "require-instance" is "false", it means that the instance being referred MAY exist in valid data.
如果“require instance”为“false”,则表示引用的实例可能存在于有效数据中。
An instance-identifier value is lexically represented as a string. All node names in an instance-identifier value MUST be qualified with explicit namespace prefixes, and these prefixes MUST be declared in the XML namespace scope in the instance-identifier's XML element.
实例标识符值在词汇上表示为字符串。实例标识符值中的所有节点名称都必须使用显式命名空间前缀限定,并且这些前缀必须在实例标识符的XML元素的XML命名空间范围中声明。
Any prefixes used in the encoding are local to each instance encoding. This means that the same instance-identifier may be encoded differently by different implementations.
编码中使用的任何前缀都是每个实例编码的本地前缀。这意味着相同的实例标识符可以通过不同的实现进行不同的编码。
Since the lexical form depends on the XML context in which the value occurs, this type does not have a canonical form.
由于词汇形式取决于值出现的XML上下文,因此该类型没有规范形式。
The following are examples of instance identifiers:
以下是实例标识符的示例:
/* instance-identifier for a container */ /ex:system/ex:services/ex:ssh
/* instance-identifier for a container */ /ex:system/ex:services/ex:ssh
/* instance-identifier for a leaf */ /ex:system/ex:services/ex:ssh/ex:port
/* instance-identifier for a leaf */ /ex:system/ex:services/ex:ssh/ex:port
/* instance-identifier for a list entry */ /ex:system/ex:user[ex:name='fred']
/* instance-identifier for a list entry */ /ex:system/ex:user[ex:name='fred']
/* instance-identifier for a leaf in a list entry */ /ex:system/ex:user[ex:name='fred']/ex:type
/* instance-identifier for a leaf in a list entry */ /ex:system/ex:user[ex:name='fred']/ex:type
/* instance-identifier for a list entry with two keys */ /ex:system/ex:server[ex:ip='192.0.2.1'][ex:port='80']
/* instance-identifier for a list entry with two keys */ /ex:system/ex:server[ex:ip='192.0.2.1'][ex:port='80']
/* instance-identifier for a leaf-list entry */ /ex:system/ex:services/ex:ssh/ex:cipher[.='blowfish-cbc']
/* instance-identifier for a leaf-list entry */ /ex:system/ex:services/ex:ssh/ex:cipher[.='blowfish-cbc']
/* instance-identifier for a list entry without keys */ /ex:stats/ex:port[3]
/* instance-identifier for a list entry without keys */ /ex:stats/ex:port[3]
As experience is gained with a module, it may be desirable to revise that module. However, changes are not allowed if they have any potential to cause interoperability problems between a client using an original specification and a server using an updated specification.
由于从一个模块中获得了经验,因此可能需要修改该模块。但是,如果更改可能导致使用原始规范的客户端和使用更新规范的服务器之间的互操作性问题,则不允许进行更改。
For any published change, a new "revision" statement (Section 7.1.9) MUST be included in front of the existing "revision" statements. If there are no existing "revision" statements, then one MUST be added to identify the new revision. Furthermore, any necessary changes MUST be applied to any meta-data statements, including the "organization" and "contact" statements (Sections 7.1.7, 7.1.8).
对于任何已发布的变更,必须在现有“修订”声明之前包含新的“修订”声明(第7.1.9节)。如果没有现有的“修订”声明,则必须添加一个以标识新修订。此外,任何必要的更改都必须应用于任何元数据语句,包括“组织”和“联系”语句(第7.1.7、7.1.8节)。
Note that definitions contained in a module are available to be imported by any other module, and are referenced in "import" statements via the module name. Thus, a module name MUST NOT be changed. Furthermore, the "namespace" statement MUST NOT be changed, since all XML elements are qualified by the namespace.
请注意,模块中包含的定义可由任何其他模块导入,并且在“导入”语句中通过模块名称引用。因此,模块名称不得更改。此外,“namespace”语句不能更改,因为所有XML元素都由名称空间限定。
Obsolete definitions MUST NOT be removed from modules since their identifiers may still be referenced by other modules.
不能从模块中删除过时的定义,因为它们的标识符仍可能被其他模块引用。
A definition may be revised in any of the following ways:
定义可通过以下任何方式进行修订:
o An "enumeration" type may have new enums added, provided the old enums's values do not change.
o “枚举”类型可以添加新的枚举,前提是旧枚举的值不变。
o A "bits" type may have new bits added, provided the old bit positions do not change.
o “位”类型可以添加新位,前提是旧位位置不变。
o A "range", "length", or "pattern" statement may expand the allowed value space.
o “range”、“length”或“pattern”语句可以扩展允许的值空间。
o A "default" statement may be added to a leaf that does not have a default value (either directly or indirectly through its type).
o “default”语句可以添加到没有默认值(直接或通过其类型间接)的叶中。
o A "units" statement may be added.
o 可以添加“单位”语句。
o A "reference" statement may be added or updated.
o 可以添加或更新“参考”声明。
o A "must" statement may be removed or its constraint relaxed.
o 可以删除“必须”语句或放松其约束。
o A "mandatory" statement may be removed or changed from "true" to "false".
o “强制性”声明可以删除或从“真”改为“假”。
o A "min-elements" statement may be removed, or changed to require fewer elements.
o “min elements”语句可以删除,也可以更改为需要更少的元素。
o A "max-elements" statement may be removed, or changed to allow more elements.
o “max elements”语句可以删除,也可以更改以允许更多元素。
o A "description" statement may be added or clarified without changing the semantics of the definition.
o 在不改变定义语义的情况下,可以添加或澄清“描述”语句。
o New typedefs, groupings, rpcs, notifications, extensions, features, and identities may be added.
o 可以添加新的类型定义、分组、RPC、通知、扩展、功能和标识。
o New data definition statements may be added if they do not add mandatory nodes (Section 3.1) to existing nodes or at the top level in a module or submodule, or if they are conditionally dependent on a new feature (i.e., have an "if-feature" statement that refers to a new feature).
o 如果新的数据定义语句没有向现有节点或模块或子模块的顶层添加强制性节点(第3.1节),或者如果它们有条件地依赖于新功能(即,具有引用新功能的“如果功能”语句),则可以添加新的数据定义语句。
o A new "case" statement may be added.
o 可以添加新的“案例”陈述。
o A node that represented state data may be changed to represent configuration, provided it is not mandatory (Section 3.1).
o 表示状态数据的节点可以更改为表示配置,前提是它不是强制性的(第3.1节)。
o An "if-feature" statement may be removed, provided its node is not mandatory (Section 3.1).
o 如果其节点不是强制性的,则可以删除“如果特征”语句(第3.1节)。
o A "status" statement may be added, or changed from "current" to "deprecated" or "obsolete", or from "deprecated" to "obsolete".
o 可以添加“状态”语句,或将其从“当前”更改为“已弃用”或“过时”,或从“已弃用”更改为“过时”。
o A "type" statement may be replaced with another "type" statement that does not change the syntax or semantics of the type. For example, an inline type definition may be replaced with a typedef, but an int8 type cannot be replaced by an int16, since the syntax would change.
o “type”语句可以替换为另一个“type”语句,该语句不会更改该类型的语法或语义。例如,内联类型定义可以替换为typedef,但int8类型不能替换为int16,因为语法会发生变化。
o Any set of data definition nodes may be replaced with another set of syntactically and semantically equivalent nodes. For example, a set of leafs may be replaced by a uses of a grouping with the same leafs.
o 任何一组数据定义节点都可以用另一组语法和语义上等价的节点来替换。例如,一组叶子可以被使用具有相同叶子的分组所代替。
o A module may be split into a set of submodules, or a submodule may be removed, provided the definitions in the module do not change in any other way than allowed here.
o 一个模块可以拆分为一组子模块,也可以删除子模块,前提是该模块中的定义不会以此处允许的任何其他方式发生更改。
o The "prefix" statement may be changed, provided all local uses of the prefix also are changed.
o “prefix”语句可能会更改,前提是前缀的所有本地使用也会更改。
Otherwise, if the semantics of any previous definition are changed (i.e., if a non-editorial change is made to any definition other than those specifically allowed above), then this MUST be achieved by a new definition with a new identifier.
否则,如果更改了任何先前定义的语义(即,如果对除上述明确允许的定义以外的任何定义进行了非编辑性更改),则必须通过使用新标识符的新定义来实现。
In statements that have any data definition statements as substatements, those data definition substatements MUST NOT be reordered.
在将任何数据定义语句作为子语句的语句中,不得对这些数据定义子语句重新排序。
A YANG module can be translated into an alternative XML-based syntax called YIN. The translated module is called a YIN module. This section describes symmetric mapping rules between the two formats.
YANG模块可以转换为另一种基于XML的语法,称为YIN。翻译后的模块称为阴模块。本节介绍两种格式之间的对称映射规则。
The YANG and YIN formats contain equivalent information using different notations. The YIN notation enables developers to represent YANG data models in XML and therefore use the rich set of XML-based tools for data filtering and validation, automated generation of code and documentation, and other tasks. Tools like XSLT or XML validators can be utilized.
阳和阴格式包含使用不同符号的等效信息。YIN符号使开发人员能够用XML表示YANG数据模型,从而使用丰富的基于XML的工具集进行数据过滤和验证、代码和文档的自动生成以及其他任务。可以使用XSLT或XML验证器等工具。
The mapping between YANG and YIN does not modify the information content of the model. Comments and whitespace are not preserved.
阳与阴之间的映射不会修改模型的信息内容。注释和空白不保留。
There is a one-to-one correspondence between YANG keywords and YIN elements. The local name of a YIN element is identical to the corresponding YANG keyword. This means, in particular, that the document element (root) of a YIN document is always <module> or <submodule>.
阳关键词和阴元素之间有一对一的对应关系。阴元素的本地名称与对应的阳关键字相同。这特别意味着,YIN文档的文档元素(根)总是<module>或<submodule>。
YIN elements corresponding to the YANG keywords belong to the namespace whose associated URI is "urn:ietf:params:xml:ns:yang:yin:1".
与YANG关键字对应的YIN元素属于名称空间,其关联URI为“urn:ietf:params:xml:ns:YANG:YIN:1”。
YIN elements corresponding to extension keywords belong to the namespace of the YANG module where the extension keyword is declared via the "extension" statement.
与扩展关键字对应的YIN元素属于YANG模块的名称空间,在该名称空间中,扩展关键字通过“extension”语句声明。
The names of all YIN elements MUST be properly qualified with their namespaces specified above using the standard mechanisms of [XML-NAMES], i.e., "xmlns" and "xmlns:xxx" attributes.
所有YIN元素的名称必须使用[XML-names]的标准机制,即“xmlns”和“xmlns:xxx”属性,使用上面指定的名称空间进行适当限定。
The argument of a YANG statement is represented in YIN either as an XML attribute or a subelement of the keyword element. Table 1 defines the mapping for the set of YANG keywords. For extensions, the argument mapping is specified within the "extension" statement (see Section 7.17). The following rules hold for arguments:
YANG语句的参数用YIN表示为XML属性或keyword元素的子元素。表1定义了YANG关键字集的映射。对于扩展,参数映射在“extension”语句中指定(参见第7.17节)。以下规则适用于参数:
o If the argument is represented as an attribute, this attribute has no namespace.
o 如果参数表示为属性,则此属性没有命名空间。
o If the argument is represented as an element, it is qualified by the same namespace as its parent keyword element.
o 如果参数表示为一个元素,则它由与其父关键字元素相同的命名空间限定。
o If the argument is represented as an element, it MUST be the first child of the keyword element.
o 如果参数表示为元素,则它必须是关键字元素的第一个子元素。
Substatements of a YANG statement are represented as (additional) children of the keyword element and their relative order MUST be the same as the order of substatements in YANG.
YANG语句的子语句表示为关键字元素的(附加)子语句,它们的相对顺序必须与YANG语句中的子语句的顺序相同。
Comments in YANG MAY be mapped to XML comments.
YANG中的注释可以映射到XML注释。
Mapping of arguments of the YANG statements.
YANG语句的参数映射。
+------------------+---------------+-------------+ | keyword | argument name | yin-element | +------------------+---------------+-------------+ | anyxml | name | false | | argument | name | false | | augment | target-node | false | | base | name | false | | belongs-to | module | false | | bit | name | false | | case | name | false | | choice | name | false | | config | value | false | | contact | text | true | | container | name | false | | default | value | false | | description | text | true | | deviate | value | false | | deviation | target-node | false | | enum | name | false | | error-app-tag | value | false | | error-message | value | true | | extension | name | false | | feature | name | false | | fraction-digits | value | false | | grouping | name | false | | identity | name | false | | if-feature | name | false | | import | module | false | | include | module | false | | input | <no argument> | n/a | | key | value | false | | leaf | name | false | | leaf-list | name | false | | length | value | false | | list | name | false | | mandatory | value | false | | max-elements | value | false | | min-elements | value | false | | module | name | false | | must | condition | false | | namespace | uri | false | | notification | name | false | | ordered-by | value | false | | organization | text | true | | output | <no argument> | n/a | | path | value | false |
+------------------+---------------+-------------+ | keyword | argument name | yin-element | +------------------+---------------+-------------+ | anyxml | name | false | | argument | name | false | | augment | target-node | false | | base | name | false | | belongs-to | module | false | | bit | name | false | | case | name | false | | choice | name | false | | config | value | false | | contact | text | true | | container | name | false | | default | value | false | | description | text | true | | deviate | value | false | | deviation | target-node | false | | enum | name | false | | error-app-tag | value | false | | error-message | value | true | | extension | name | false | | feature | name | false | | fraction-digits | value | false | | grouping | name | false | | identity | name | false | | if-feature | name | false | | import | module | false | | include | module | false | | input | <no argument> | n/a | | key | value | false | | leaf | name | false | | leaf-list | name | false | | length | value | false | | list | name | false | | mandatory | value | false | | max-elements | value | false | | min-elements | value | false | | module | name | false | | must | condition | false | | namespace | uri | false | | notification | name | false | | ordered-by | value | false | | organization | text | true | | output | <no argument> | n/a | | path | value | false |
| pattern | value | false | | position | value | false | | prefix | value | false | | presence | value | false | | range | value | false | | reference | text | true | | refine | target-node | false | | require-instance | value | false | | revision | date | false | | revision-date | date | false | | rpc | name | false | | status | value | false | | submodule | name | false | | type | name | false | | typedef | name | false | | unique | tag | false | | units | name | false | | uses | name | false | | value | value | false | | when | condition | false | | yang-version | value | false | | yin-element | value | false | +------------------+---------------+-------------+
| pattern | value | false | | position | value | false | | prefix | value | false | | presence | value | false | | range | value | false | | reference | text | true | | refine | target-node | false | | require-instance | value | false | | revision | date | false | | revision-date | date | false | | rpc | name | false | | status | value | false | | submodule | name | false | | type | name | false | | typedef | name | false | | unique | tag | false | | units | name | false | | uses | name | false | | value | value | false | | when | condition | false | | yang-version | value | false | | yin-element | value | false | +------------------+---------------+-------------+
Table 1
表1
The following YANG module:
以下模块:
module acme-foo { namespace "http://acme.example.com/foo"; prefix "acfoo";
module acme-foo { namespace "http://acme.example.com/foo"; prefix "acfoo";
import my-extensions { prefix "myext"; }
import my-extensions { prefix "myext"; }
list interface { key "name"; leaf name { type string; }
list interface { key "name"; leaf name { type string; }
leaf mtu { type uint32; description "The MTU of the interface."; myext:c-define "MY_MTU"; } } }
leaf mtu { type uint32; description "The MTU of the interface."; myext:c-define "MY_MTU"; } } }
where the extension "c-define" is defined in Section 7.17.3, is translated into the following YIN:
如果第7.17.3节中定义了扩展名“c-define”,则将其翻译为以下内容:
<module name="acme-foo" xmlns="urn:ietf:params:xml:ns:yang:yin:1" xmlns:acfoo="http://acme.example.com/foo" xmlns:myext="http://example.com/my-extensions">
<module name="acme-foo" xmlns="urn:ietf:params:xml:ns:yang:yin:1" xmlns:acfoo="http://acme.example.com/foo" xmlns:myext="http://example.com/my-extensions">
<namespace uri="http://acme.example.com/foo"/> <prefix value="acfoo"/>
<namespace uri="http://acme.example.com/foo"/> <prefix value="acfoo"/>
<import module="my-extensions"> <prefix value="myext"/> </import>
<import module="my-extensions"> <prefix value="myext"/> </import>
<list name="interface"> <key value="name"/> <leaf name="name"> <type name="string"/> </leaf> <leaf name="mtu"> <type name="uint32"/> <description> <text>The MTU of the interface.</text> </description> <myext:c-define name="MY_MTU"/> </leaf> </list> </module>
<list name="interface"> <key value="name"/> <leaf name="name"> <type name="string"/> </leaf> <leaf name="mtu"> <type name="uint32"/> <description> <text>The MTU of the interface.</text> </description> <myext:c-define name="MY_MTU"/> </leaf> </list> </module>
In YANG, almost all statements are unordered. The ABNF grammar [RFC5234] defines the canonical order. To improve module readability, it is RECOMMENDED that clauses be entered in this order.
在杨,几乎所有的陈述都是无序的。ABNF语法[RFC5234]定义了规范顺序。为了提高模块的可读性,建议按此顺序输入子句。
Within the ABNF grammar, unordered statements are marked with comments.
在ABNF语法中,无序语句用注释标记。
This grammar assumes that the scanner replaces YANG comments with a single space character.
此语法假定扫描程序使用单个空格字符替换注释。
<CODE BEGINS> file "yang.abnf"
<CODE start>文件“yang.abnf”
module-stmt = optsep module-keyword sep identifier-arg-str optsep "{" stmtsep module-header-stmts linkage-stmts meta-stmts revision-stmts body-stmts "}" optsep
模块stmt=optsep模块关键字sep标识符arg str optsep“{”stmtsep模块头stmts链接stmts元stmts修订stmts正文stmts“}”optsep
submodule-stmt = optsep submodule-keyword sep identifier-arg-str optsep "{" stmtsep submodule-header-stmts linkage-stmts meta-stmts revision-stmts body-stmts "}" optsep
子模块stmt=optsep子模块关键字sep标识符arg str optsep“{”stmtsep子模块头stmts链接stmts元stmts修订stmts正文stmts“}”optsep
module-header-stmts = ;; these stmts can appear in any order [yang-version-stmt stmtsep] namespace-stmt stmtsep prefix-stmt stmtsep
模块头stmts=;;这些stmt可以以任何顺序出现[yang version stmt stmtsep]命名空间stmt stmtsep前缀stmt stmtsep
submodule-header-stmts = ;; these stmts can appear in any order [yang-version-stmt stmtsep] belongs-to-stmt stmtsep
子模块头stmts=;;这些stmt可以以任何顺序出现[yang version stmt STMTSP]属于stmt STMTSP
meta-stmts = ;; these stmts can appear in any order [organization-stmt stmtsep] [contact-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
meta-stmts = ;; these stmts can appear in any order [organization-stmt stmtsep] [contact-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
linkage-stmts = ;; these stmts can appear in any order *(import-stmt stmtsep) *(include-stmt stmtsep)
linkage-stmts = ;; these stmts can appear in any order *(import-stmt stmtsep) *(include-stmt stmtsep)
revision-stmts = *(revision-stmt stmtsep)
revision-stmts = *(revision-stmt stmtsep)
body-stmts = *((extension-stmt / feature-stmt / identity-stmt / typedef-stmt / grouping-stmt / data-def-stmt / augment-stmt / rpc-stmt / notification-stmt / deviation-stmt) stmtsep)
body-stmts = *((extension-stmt / feature-stmt / identity-stmt / typedef-stmt / grouping-stmt / data-def-stmt / augment-stmt / rpc-stmt / notification-stmt / deviation-stmt) stmtsep)
data-def-stmt = container-stmt / leaf-stmt / leaf-list-stmt / list-stmt / choice-stmt / anyxml-stmt / uses-stmt
data def stmt=容器stmt/leaf stmt/leaf list stmt/list stmt/choice stmt/anyxml stmt/uses stmt
yang-version-stmt = yang-version-keyword sep yang-version-arg-str optsep stmtend
yang version stmt=yang version关键字sep yang version arg str optsep stmtend
yang-version-arg-str = < a string that matches the rule yang-version-arg >
yang-version-arg-str = < a string that matches the rule yang-version-arg >
yang-version-arg = "1"
yang-version-arg = "1"
import-stmt = import-keyword sep identifier-arg-str optsep "{" stmtsep prefix-stmt stmtsep [revision-date-stmt stmtsep] "}"
import stmt=导入关键字sep标识符arg str optsep“{”stmtsep prefix stmt stmtsep[修订日期stmt stmtsep]“}”
include-stmt = include-keyword sep identifier-arg-str optsep (";" / "{" stmtsep [revision-date-stmt stmtsep] "}")
include stmt=include关键字sep标识符arg str optsep(“;”/“{”stmtsep[修订日期stmt stmtsep]“}”)
namespace-stmt = namespace-keyword sep uri-str optsep stmtend
namespace stmt=命名空间关键字sep uri str optsep stmtend
uri-str = < a string that matches the rule URI in RFC 3986 >
uri-str = < a string that matches the rule URI in RFC 3986 >
prefix-stmt = prefix-keyword sep prefix-arg-str optsep stmtend
前缀stmt=前缀关键字sep prefix arg str optsep stmtend
belongs-to-stmt = belongs-to-keyword sep identifier-arg-str optsep "{" stmtsep prefix-stmt stmtsep "}"
属于stmt=属于关键字sep标识符arg str optsep“{”stmtsep prefix stmt stmtsep“}”
organization-stmt = organization-keyword sep string optsep stmtend
组织stmt=组织关键字sep字符串optsep stmtend
contact-stmt = contact-keyword sep string optsep stmtend
contact stmt=联系人关键字sep string optsep stmtend
description-stmt = description-keyword sep string optsep stmtend
description stmt=description关键字sep string optsep stmtend
reference-stmt = reference-keyword sep string optsep stmtend
reference stmt=参考关键字sep string optsep stmtend
units-stmt = units-keyword sep string optsep stmtend
units-stmt = units-keyword sep string optsep stmtend
revision-stmt = revision-keyword sep revision-date optsep (";" / "{" stmtsep [description-stmt stmtsep] [reference-stmt stmtsep] "}")
修订stmt=修订关键字sep修订日期optsep(“;”/“{”STMTSP[说明stmt STMTSP][参考stmt STMTSP]“}”)
revision-date = date-arg-str
revision-date = date-arg-str
revision-date-stmt = revision-date-keyword sep revision-date stmtend
修订日期stmt=修订日期关键字sep修订日期stmtend
extension-stmt = extension-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [argument-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
extension-stmt = extension-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [argument-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
argument-stmt = argument-keyword sep identifier-arg-str optsep (";" / "{" stmtsep [yin-element-stmt stmtsep] "}")
参数stmt=参数关键字sep标识符arg str optsep(“;”/“{”stmtsep[yin元素stmt stmtsep]“}”)
yin-element-stmt = yin-element-keyword sep yin-element-arg-str stmtend
yin element stmt=yin element关键字sep yin element arg str stmtend
yin-element-arg-str = < a string that matches the rule yin-element-arg >
yin-element-arg-str = < a string that matches the rule yin-element-arg >
yin-element-arg = true-keyword / false-keyword
yin-element-arg = true-keyword / false-keyword
identity-stmt = identity-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [base-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
identity-stmt = identity-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [base-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
base-stmt = base-keyword sep identifier-ref-arg-str optsep stmtend
base stmt=基本关键字sep标识符ref arg str optsep stmtend
feature-stmt = feature-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
feature-stmt = feature-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
if-feature-stmt = if-feature-keyword sep identifier-ref-arg-str optsep stmtend
if feature stmt=if feature关键字sep identifier ref arg str optsep stmtend
typedef-stmt = typedef-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order type-stmt stmtsep [units-stmt stmtsep] [default-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}"
typedef-stmt = typedef-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order type-stmt stmtsep [units-stmt stmtsep] [default-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}"
type-stmt = type-keyword sep identifier-ref-arg-str optsep (";" / "{" stmtsep type-body-stmts "}")
type stmt=type关键字sep标识符ref arg str optsep(“;”/“{”stmtsep type body stmts“}”)
type-body-stmts = numerical-restrictions / decimal64-specification / string-restrictions / enum-specification / leafref-specification / identityref-specification / instance-identifier-specification / bits-specification / union-specification
类型body stmts=数字限制/小数64规范/字符串限制/枚举规范/leafref规范/identityref规范/实例标识符规范/位规范/联合规范
numerical-restrictions = range-stmt stmtsep
numerical-restrictions = range-stmt stmtsep
range-stmt = range-keyword sep range-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
range-stmt = range-keyword sep range-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
decimal64-specification = fraction-digits-stmt
decimal64-specification = fraction-digits-stmt
fraction-digits-stmt = fraction-digits-keyword sep fraction-digits-arg-str stmtend
分数位数stmt=分数位数关键字sep分数位数arg str stmtend
fraction-digits-arg-str = < a string that matches the rule fraction-digits-arg >
fraction-digits-arg-str = < a string that matches the rule fraction-digits-arg >
fraction-digits-arg = ("1" ["0" / "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8"]) / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9"
fraction-digits-arg = ("1" ["0" / "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8"]) / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9"
string-restrictions = ;; these stmts can appear in any order [length-stmt stmtsep] *(pattern-stmt stmtsep)
字符串限制=;;这些stmt可以按任意顺序显示[长度stmt STMTSP]*(模式stmt STMTSP)
length-stmt = length-keyword sep length-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
length-stmt = length-keyword sep length-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
pattern-stmt = pattern-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
pattern-stmt = pattern-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
default-stmt = default-keyword sep string stmtend
default-stmt = default-keyword sep string stmtend
enum-specification = 1*(enum-stmt stmtsep)
enum-specification = 1*(enum-stmt stmtsep)
enum-stmt = enum-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order [value-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
enum-stmt = enum-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order [value-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
leafref-specification = ;; these stmts can appear in any order path-stmt stmtsep [require-instance-stmt stmtsep]
leafref规范=;;这些stmt可以以任何顺序出现路径stmt STMTSP[需要实例stmt STMTSP]
path-stmt = path-keyword sep path-arg-str stmtend
path-stmt = path-keyword sep path-arg-str stmtend
require-instance-stmt = require-instance-keyword sep require-instance-arg-str stmtend
require instance stmt=require instance关键字sep require instance arg str stmtend
require-instance-arg-str = < a string that matches the rule require-instance-arg >
require-instance-arg-str = < a string that matches the rule require-instance-arg >
require-instance-arg = true-keyword / false-keyword
require-instance-arg = true-keyword / false-keyword
instance-identifier-specification = [require-instance-stmt stmtsep]
实例标识符规范=[require instance stmt stmtsep]
identityref-specification = base-stmt stmtsep
identityref-specification = base-stmt stmtsep
union-specification = 1*(type-stmt stmtsep)
union-specification = 1*(type-stmt stmtsep)
bits-specification = 1*(bit-stmt stmtsep)
bits-specification = 1*(bit-stmt stmtsep)
bit-stmt = bit-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [position-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}" "}")
bit-stmt = bit-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [position-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}" "}")
position-stmt = position-keyword sep position-value-arg-str stmtend
position stmt=位置关键字sep位置值arg str stmtend
position-value-arg-str = < a string that matches the rule position-value-arg >
position-value-arg-str = < a string that matches the rule position-value-arg >
position-value-arg = non-negative-integer-value
position-value-arg = non-negative-integer-value
status-stmt = status-keyword sep status-arg-str stmtend
status stmt=状态关键字sep status arg str stmtend
status-arg-str = < a string that matches the rule status-arg >
status-arg-str = < a string that matches the rule status-arg >
status-arg = current-keyword / obsolete-keyword / deprecated-keyword
状态参数=当前关键字/过时关键字/弃用关键字
config-stmt = config-keyword sep config-arg-str stmtend
config stmt=config关键字sep config arg str stmtend
config-arg-str = < a string that matches the rule config-arg >
config-arg-str = < a string that matches the rule config-arg >
config-arg = true-keyword / false-keyword
config-arg = true-keyword / false-keyword
mandatory-stmt = mandatory-keyword sep mandatory-arg-str stmtend
mandatory stmt=强制关键字sep mandatory arg str stmtend
mandatory-arg-str = < a string that matches the rule mandatory-arg >
mandatory-arg-str = < a string that matches the rule mandatory-arg >
mandatory-arg = true-keyword / false-keyword
mandatory-arg = true-keyword / false-keyword
presence-stmt = presence-keyword sep string stmtend
presence-stmt = presence-keyword sep string stmtend
ordered-by-stmt = ordered-by-keyword sep ordered-by-arg-str stmtend
按stmt排序=按关键字sep排序按arg str stmtend排序
ordered-by-arg-str = < a string that matches the rule ordered-by-arg >
ordered-by-arg-str = < a string that matches the rule ordered-by-arg >
ordered-by-arg = user-keyword / system-keyword
ordered-by-arg = user-keyword / system-keyword
must-stmt = must-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
must-stmt = must-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order [error-message-stmt stmtsep] [error-app-tag-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
error-message-stmt = error-message-keyword sep string stmtend
error-message-stmt = error-message-keyword sep string stmtend
error-app-tag-stmt = error-app-tag-keyword sep string stmtend
error-app-tag-stmt = error-app-tag-keyword sep string stmtend
min-elements-stmt = min-elements-keyword sep min-value-arg-str stmtend
最小元素stmt=min元素关键字sep最小值arg str stmtend
min-value-arg-str = < a string that matches the rule min-value-arg >
min-value-arg-str = < a string that matches the rule min-value-arg >
min-value-arg = non-negative-integer-value
min-value-arg = non-negative-integer-value
max-elements-stmt = max-elements-keyword sep max-value-arg-str stmtend
max elements stmt=max elements关键字sep max value arg str stmtend
max-value-arg-str = < a string that matches the rule max-value-arg >
max-value-arg-str = < a string that matches the rule max-value-arg >
max-value-arg = unbounded-keyword / positive-integer-value
最大值arg=无界关键字/正整数值
value-stmt = value-keyword sep integer-value stmtend
value-stmt = value-keyword sep integer-value stmtend
grouping-stmt = grouping-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) *(data-def-stmt stmtsep) "}")
grouping-stmt = grouping-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) *(data-def-stmt stmtsep) "}")
container-stmt = container-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) *(must-stmt stmtsep) [presence-stmt stmtsep] [config-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) *(data-def-stmt stmtsep) "}")
container-stmt = container-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) *(must-stmt stmtsep) [presence-stmt stmtsep] [config-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) *(data-def-stmt stmtsep) "}")
leaf-stmt = leaf-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) type-stmt stmtsep [units-stmt stmtsep] *(must-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}"
leaf-stmt = leaf-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) type-stmt stmtsep [units-stmt stmtsep] *(must-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}"
leaf-list-stmt = leaf-list-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) type-stmt stmtsep [units-stmt stmtsep] *(must-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [ordered-by-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}"
leaf-list-stmt = leaf-list-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) type-stmt stmtsep [units-stmt stmtsep] *(must-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [ordered-by-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}"
list-stmt = list-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) *(must-stmt stmtsep) [key-stmt stmtsep] *(unique-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [ordered-by-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
list-stmt = list-keyword sep identifier-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) *(must-stmt stmtsep) [key-stmt stmtsep] *(unique-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [ordered-by-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
*((typedef-stmt / grouping-stmt) stmtsep) 1*(data-def-stmt stmtsep) "}"
*((类型定义stmt/分组stmt)STMTSP)1*(数据定义stmt STMTSP)“}”
key-stmt = key-keyword sep key-arg-str stmtend
key-stmt = key-keyword sep key-arg-str stmtend
key-arg-str = < a string that matches the rule key-arg >
key-arg-str = < a string that matches the rule key-arg >
key-arg = node-identifier *(sep node-identifier)
key arg=节点标识符*(sep节点标识符)
unique-stmt = unique-keyword sep unique-arg-str stmtend
unique stmt=unique关键字sep unique arg str stmtend
unique-arg-str = < a string that matches the rule unique-arg >
unique-arg-str = < a string that matches the rule unique-arg >
unique-arg = descendant-schema-nodeid *(sep descendant-schema-nodeid)
唯一arg=子代架构nodeid*(sep子代架构nodeid)
choice-stmt = choice-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((short-case-stmt / case-stmt) stmtsep) "}")
choice-stmt = choice-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((short-case-stmt / case-stmt) stmtsep) "}")
short-case-stmt = container-stmt / leaf-stmt / leaf-list-stmt / list-stmt / anyxml-stmt
short case stmt=容器stmt/leaf stmt/leaf list stmt/list stmt/anyxml stmt
case-stmt = case-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [status-stmt stmtsep]
case stmt=case关键字sep标识符arg str optsep(“;”/“{”stmtsep;;这些stmt可以以任何顺序出现[当stmt stmtsep]*(如果功能stmtsep)[状态stmtsep]
[description-stmt stmtsep] [reference-stmt stmtsep] *(data-def-stmt stmtsep) "}")
[说明stmt STMTSP][参考stmt STMTSP]*(数据定义stmt STMTSP)“}”)
anyxml-stmt = anyxml-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) *(must-stmt stmtsep) [config-stmt stmtsep] [mandatory-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
anyxml-stmt = anyxml-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) *(must-stmt stmtsep) [config-stmt stmtsep] [mandatory-stmt stmtsep] [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] "}")
uses-stmt = uses-keyword sep identifier-ref-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *(refine-stmt stmtsep) *(uses-augment-stmt stmtsep) "}")
uses-stmt = uses-keyword sep identifier-ref-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *(refine-stmt stmtsep) *(uses-augment-stmt stmtsep) "}")
refine-stmt = refine-keyword sep refine-arg-str optsep (";" / "{" stmtsep (refine-container-stmts / refine-leaf-stmts / refine-leaf-list-stmts / refine-list-stmts / refine-choice-stmts / refine-case-stmts / refine-anyxml-stmts) "}")
refine stmt=refine关键字sep refine arg str optsep(“;”/“{”stmtsep(refine container stmts/refine leaf stmts/refine leaf list stmts/refine choice stmts/refine case stmts/refine anyxml stmts)”)
refine-arg-str = < a string that matches the rule refine-arg >
refine-arg-str = < a string that matches the rule refine-arg >
refine-arg = descendant-schema-nodeid
refine-arg = descendant-schema-nodeid
refine-container-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [presence-stmt stmtsep] [config-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-container-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [presence-stmt stmtsep] [config-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-leaf-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-leaf-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-leaf-list-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-leaf-list-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-list-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-list-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [config-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-choice-stmts = ;; these stmts can appear in any order [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-choice-stmts = ;; these stmts can appear in any order [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
refine-case-stmts = ;; these stmts can appear in any order [description-stmt stmtsep] [reference-stmt stmtsep]
优化案例stmts=;;这些stmt可以以任何顺序出现[说明stmt STMTSP][参考stmt STMTSP]
refine-anyxml-stmts = ;; these stmts can appear in any order *(must-stmt stmtsep) [config-stmt stmtsep]
优化anyxml stmts=;;这些stmt可以以任何顺序出现*(必须是stmt STMTSP)[config stmt STMTSP]
[mandatory-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
[mandatory-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep]
uses-augment-stmt = augment-keyword sep uses-augment-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] 1*((data-def-stmt stmtsep) / (case-stmt stmtsep)) "}"
uses-augment-stmt = augment-keyword sep uses-augment-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] 1*((data-def-stmt stmtsep) / (case-stmt stmtsep)) "}"
uses-augment-arg-str = < a string that matches the rule uses-augment-arg >
uses-augment-arg-str = < a string that matches the rule uses-augment-arg >
uses-augment-arg = descendant-schema-nodeid
uses-augment-arg = descendant-schema-nodeid
augment-stmt = augment-keyword sep augment-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] 1*((data-def-stmt stmtsep) / (case-stmt stmtsep)) "}"
augment-stmt = augment-keyword sep augment-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [when-stmt stmtsep] *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] 1*((data-def-stmt stmtsep) / (case-stmt stmtsep)) "}"
augment-arg-str = < a string that matches the rule augment-arg >
augment-arg-str = < a string that matches the rule augment-arg >
augment-arg = absolute-schema-nodeid
augment-arg = absolute-schema-nodeid
unknown-statement = prefix ":" identifier [sep string] optsep (";" / "{" *unknown-statement2 "}")
unknown-statement = prefix ":" identifier [sep string] optsep (";" / "{" *unknown-statement2 "}")
unknown-statement2 = [prefix ":"] identifier [sep string] optsep (";" / "{" *unknown-statement2 "}")
unknown-statement2 = [prefix ":"] identifier [sep string] optsep (";" / "{" *unknown-statement2 "}")
when-stmt = when-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order
when-stmt = when-keyword sep string optsep (";" / "{" stmtsep ;; these stmts can appear in any order
[description-stmt stmtsep] [reference-stmt stmtsep] "}")
[说明stmt STMTSP][参考stmt STMTSP]“}”)
rpc-stmt = rpc-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) [input-stmt stmtsep] [output-stmt stmtsep] "}")
rpc-stmt = rpc-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) [input-stmt stmtsep] [output-stmt stmtsep] "}")
input-stmt = input-keyword optsep "{" stmtsep ;; these stmts can appear in any order *((typedef-stmt / grouping-stmt) stmtsep) 1*(data-def-stmt stmtsep) "}"
input-stmt = input-keyword optsep "{" stmtsep ;; these stmts can appear in any order *((typedef-stmt / grouping-stmt) stmtsep) 1*(data-def-stmt stmtsep) "}"
output-stmt = output-keyword optsep "{" stmtsep ;; these stmts can appear in any order *((typedef-stmt / grouping-stmt) stmtsep) 1*(data-def-stmt stmtsep) "}"
output-stmt = output-keyword optsep "{" stmtsep ;; these stmts can appear in any order *((typedef-stmt / grouping-stmt) stmtsep) 1*(data-def-stmt stmtsep) "}"
notification-stmt = notification-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) *(data-def-stmt stmtsep) "}")
notification-stmt = notification-keyword sep identifier-arg-str optsep (";" / "{" stmtsep ;; these stmts can appear in any order *(if-feature-stmt stmtsep) [status-stmt stmtsep] [description-stmt stmtsep] [reference-stmt stmtsep] *((typedef-stmt / grouping-stmt) stmtsep) *(data-def-stmt stmtsep) "}")
deviation-stmt = deviation-keyword sep deviation-arg-str optsep "{" stmtsep ;; these stmts can appear in any order [description-stmt stmtsep] [reference-stmt stmtsep] (deviate-not-supported-stmt / 1*(deviate-add-stmt / deviate-replace-stmt / deviate-delete-stmt)) "}"
偏差stmt=偏差关键字sep DEVISION arg str optsep“{”STMTSP;;这些stmt可以以任何顺序出现[说明stmt STMTSP][参考stmt STMTSP](不支持偏差stmt/1*(偏差添加stmt/偏差替换stmt/偏差删除stmt))“}”
deviation-arg-str = < a string that matches the rule deviation-arg >
deviation-arg-str = < a string that matches the rule deviation-arg >
deviation-arg = absolute-schema-nodeid
deviation-arg = absolute-schema-nodeid
deviate-not-supported-stmt = deviate-keyword sep not-supported-keyword optsep (";" / "{" stmtsep "}")
偏离不受支持的stmt=偏离关键字sep不受支持的关键字optsep(“;”/“{”STMTSP“}”)
deviate-add-stmt = deviate-keyword sep add-keyword optsep (";" / "{" stmtsep [units-stmt stmtsep] *(must-stmt stmtsep) *(unique-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] "}")
deviate-add-stmt = deviate-keyword sep add-keyword optsep (";" / "{" stmtsep [units-stmt stmtsep] *(must-stmt stmtsep) *(unique-stmt stmtsep) [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] "}")
deviate-delete-stmt = deviate-keyword sep delete-keyword optsep (";" / "{" stmtsep [units-stmt stmtsep] *(must-stmt stmtsep) *(unique-stmt stmtsep) [default-stmt stmtsep] "}")
DELEVEL delete stmt=DELEVEL关键字sep delete关键字optsep(“;”/“{”STMTSP[单位stmt STMTSP]*(必须是stmt STMTSP)*(唯一stmt STMTSP)[默认stmt STMTSP]“}”)
deviate-replace-stmt = deviate-keyword sep replace-keyword optsep (";" / "{" stmtsep [type-stmt stmtsep] [units-stmt stmtsep] [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] "}")
deviate-replace-stmt = deviate-keyword sep replace-keyword optsep (";" / "{" stmtsep [type-stmt stmtsep] [units-stmt stmtsep] [default-stmt stmtsep] [config-stmt stmtsep] [mandatory-stmt stmtsep] [min-elements-stmt stmtsep] [max-elements-stmt stmtsep] "}")
;; Ranges
;; 范围
range-arg-str = < a string that matches the rule range-arg >
range-arg-str = < a string that matches the rule range-arg >
range-arg = range-part *(optsep "|" optsep range-part)
范围参数=范围部分*(optsep“|”optsep范围部分)
range-part = range-boundary [optsep ".." optsep range-boundary]
范围部分=范围边界[optsep”。“optsep范围边界]
range-boundary = min-keyword / max-keyword / integer-value / decimal-value
range-boundary = min-keyword / max-keyword / integer-value / decimal-value
;; Lengths
;; 长度
length-arg-str = < a string that matches the rule length-arg >
length-arg-str = < a string that matches the rule length-arg >
length-arg = length-part *(optsep "|" optsep length-part)
长度arg=长度部分*(optsep“|”optsep长度部分)
length-part = length-boundary [optsep ".." optsep length-boundary]
长度部分=长度边界[optsep”。“optsep长度边界]
length-boundary = min-keyword / max-keyword / non-negative-integer-value
长度边界=最小关键字/最大关键字/非负整数值
;; Date
;; 日期
date-arg-str = < a string that matches the rule date-arg >
date-arg-str = < a string that matches the rule date-arg >
date-arg = 4DIGIT "-" 2DIGIT "-" 2DIGIT
日期arg=4DIGIT“-”2DIGIT“-”2DIGIT
;; Schema Node Identifiers
;; 模式节点标识符
schema-nodeid = absolute-schema-nodeid / descendant-schema-nodeid
schema nodeid=绝对模式nodeid/后代模式nodeid
absolute-schema-nodeid = 1*("/" node-identifier)
absolute-schema-nodeid = 1*("/" node-identifier)
descendant-schema-nodeid = node-identifier absolute-schema-nodeid
子代架构nodeid=节点标识符绝对架构nodeid
node-identifier = [prefix ":"] identifier
node-identifier = [prefix ":"] identifier
;; Instance Identifiers
;; 实例标识符
instance-identifier = 1*("/" (node-identifier *predicate))
instance-identifier = 1*("/" (node-identifier *predicate))
predicate = "[" *WSP (predicate-expr / pos) *WSP "]"
predicate = "[" *WSP (predicate-expr / pos) *WSP "]"
predicate-expr = (node-identifier / ".") *WSP "=" *WSP ((DQUOTE string DQUOTE) / (SQUOTE string SQUOTE))
predicate-expr = (node-identifier / ".") *WSP "=" *WSP ((DQUOTE string DQUOTE) / (SQUOTE string SQUOTE))
pos = non-negative-integer-value
pos = non-negative-integer-value
;; leafref path
;; 叶参考路径
path-arg-str = < a string that matches the rule path-arg >
path-arg-str = < a string that matches the rule path-arg >
path-arg = absolute-path / relative-path
path-arg = absolute-path / relative-path
absolute-path = 1*("/" (node-identifier *path-predicate))
absolute-path = 1*("/" (node-identifier *path-predicate))
relative-path = 1*(".." "/") descendant-path
relative-path = 1*(".." "/") descendant-path
descendant-path = node-identifier [*path-predicate absolute-path]
子体路径=节点标识符[*路径谓词绝对路径]
path-predicate = "[" *WSP path-equality-expr *WSP "]"
path-predicate = "[" *WSP path-equality-expr *WSP "]"
path-equality-expr = node-identifier *WSP "=" *WSP path-key-expr
path-equality-expr = node-identifier *WSP "=" *WSP path-key-expr
path-key-expr = current-function-invocation *WSP "/" *WSP rel-path-keyexpr
path-key-expr = current-function-invocation *WSP "/" *WSP rel-path-keyexpr
rel-path-keyexpr = 1*(".." *WSP "/" *WSP) *(node-identifier *WSP "/" *WSP) node-identifier
rel-path-keyexpr = 1*(".." *WSP "/" *WSP) *(node-identifier *WSP "/" *WSP) node-identifier
;;; Keywords, using abnfgen's syntax for case-sensitive strings
;;; Keywords, using abnfgen's syntax for case-sensitive strings
;; statement keywords anyxml-keyword = 'anyxml' argument-keyword = 'argument' augment-keyword = 'augment' base-keyword = 'base' belongs-to-keyword = 'belongs-to' bit-keyword = 'bit' case-keyword = 'case' choice-keyword = 'choice' config-keyword = 'config' contact-keyword = 'contact' container-keyword = 'container' default-keyword = 'default' description-keyword = 'description' enum-keyword = 'enum' error-app-tag-keyword = 'error-app-tag' error-message-keyword = 'error-message' extension-keyword = 'extension' deviation-keyword = 'deviation' deviate-keyword = 'deviate' feature-keyword = 'feature' fraction-digits-keyword = 'fraction-digits' grouping-keyword = 'grouping' identity-keyword = 'identity' if-feature-keyword = 'if-feature' import-keyword = 'import' include-keyword = 'include' input-keyword = 'input' key-keyword = 'key' leaf-keyword = 'leaf' leaf-list-keyword = 'leaf-list' length-keyword = 'length' list-keyword = 'list' mandatory-keyword = 'mandatory' max-elements-keyword = 'max-elements' min-elements-keyword = 'min-elements' module-keyword = 'module' must-keyword = 'must' namespace-keyword = 'namespace' notification-keyword= 'notification' ordered-by-keyword = 'ordered-by' organization-keyword= 'organization'
;; 语句关键字anyxml关键字='anyxml'参数关键字='argument'augment关键字='augment'base关键字='base'属于关键字='属于'bit关键字='bit'case关键字='case'选择关键字='choice'配置关键字='config'联系人关键字='contact'容器关键字='container'默认关键字='default'description关键字='description'enum关键字='enum'error-app-tag关键字='error-app-tag'错误消息关键字='error-message'扩展关键字='extension'偏差关键字='develope'偏差关键字='develope'特征关键字='feature'分数数字关键字='分数数字'分组关键字='grouping'标识关键字='identity'if feature keyword='if feature'导入关键字='import'include关键字='include'输入关键字='key'叶关键字='leaf'叶列表关键字='leaf'长度关键字='length'列表关键字='list'强制关键字='mandable'max elements关键字='max elements'min elements关键字=“最小元素”模块关键字=“模块”必须关键字=“必须”命名空间关键字=“命名空间”通知关键字=“通知”按关键字排序=“按组织关键字排序=“组织”
output-keyword = 'output' path-keyword = 'path' pattern-keyword = 'pattern' position-keyword = 'position' prefix-keyword = 'prefix' presence-keyword = 'presence' range-keyword = 'range' reference-keyword = 'reference' refine-keyword = 'refine' require-instance-keyword = 'require-instance' revision-keyword = 'revision' revision-date-keyword = 'revision-date' rpc-keyword = 'rpc' status-keyword = 'status' submodule-keyword = 'submodule' type-keyword = 'type' typedef-keyword = 'typedef' unique-keyword = 'unique' units-keyword = 'units' uses-keyword = 'uses' value-keyword = 'value' when-keyword = 'when' yang-version-keyword= 'yang-version' yin-element-keyword = 'yin-element'
输出关键字='output'path关键字='path'pattern关键字='pattern'position关键字='position'前缀关键字='prefix'presence关键字='presence'范围关键字='range'引用关键字='reference'优化关键字='reference'require实例关键字='require实例'修订关键字='revision'修订日期关键字=“修订日期”rpc关键字=“rpc”状态关键字=“状态”子模块关键字=“子模块”类型关键字=“类型”类型定义关键字=“类型定义”唯一关键字=“唯一”单位关键字=“单位”使用关键字=“使用”值关键字=“值”当关键字=“阳版关键字=“阳版”阴元素关键字=“阴元素”
;; other keywords
;; 其他关键字
add-keyword = 'add' current-keyword = 'current' delete-keyword = 'delete' deprecated-keyword = 'deprecated' false-keyword = 'false' max-keyword = 'max' min-keyword = 'min' not-supported-keyword = 'not-supported' obsolete-keyword = 'obsolete' replace-keyword = 'replace' system-keyword = 'system' true-keyword = 'true' unbounded-keyword = 'unbounded' user-keyword = 'user'
add关键字='add'current关键字='current'删除关键字='delete'弃用关键字='Disprecated'假关键字='false'最大关键字='max'最小关键字='min'不受支持关键字='not supported'过时关键字='Observed'替换关键字='replace'系统关键字='system'true关键字='true'无界关键字='unbounded'用户关键字='user'
current-function-invocation = current-keyword *WSP "(" *WSP ")"
current-function-invocation = current-keyword *WSP "(" *WSP ")"
;; Basic Rules
;; 基本规则
prefix-arg-str = < a string that matches the rule prefix-arg >
prefix-arg-str = < a string that matches the rule prefix-arg >
prefix-arg = prefix
prefix-arg = prefix
prefix = identifier
prefix = identifier
identifier-arg-str = < a string that matches the rule identifier-arg >
identifier-arg-str = < a string that matches the rule identifier-arg >
identifier-arg = identifier
identifier-arg = identifier
;; An identifier MUST NOT start with (('X'|'x') ('M'|'m') ('L'|'l')) identifier = (ALPHA / "_") *(ALPHA / DIGIT / "_" / "-" / ".")
;; An identifier MUST NOT start with (('X'|'x') ('M'|'m') ('L'|'l')) identifier = (ALPHA / "_") *(ALPHA / DIGIT / "_" / "-" / ".")
identifier-ref-arg-str = < a string that matches the rule identifier-ref-arg >
identifier-ref-arg-str = < a string that matches the rule identifier-ref-arg >
identifier-ref-arg = [prefix ":"] identifier
identifier-ref-arg = [prefix ":"] identifier
string = < an unquoted string as returned by the scanner >
string = < an unquoted string as returned by the scanner >
integer-value = ("-" non-negative-integer-value) / non-negative-integer-value
integer-value = ("-" non-negative-integer-value) / non-negative-integer-value
non-negative-integer-value = "0" / positive-integer-value
非负整数值=“0”/正整数值
positive-integer-value = (non-zero-digit *DIGIT)
positive-integer-value = (non-zero-digit *DIGIT)
zero-integer-value = 1*DIGIT
zero-integer-value = 1*DIGIT
stmtend = ";" / "{" *unknown-statement "}"
stmtend = ";" / "{" *unknown-statement "}"
sep = 1*(WSP / line-break) ; unconditional separator
sep = 1*(WSP / line-break) ; unconditional separator
optsep = *(WSP / line-break)
optsep = *(WSP / line-break)
stmtsep = *(WSP / line-break / unknown-statement)
stmtsep = *(WSP / line-break / unknown-statement)
line-break = CRLF / LF
line-break = CRLF / LF
non-zero-digit = %x31-39
non-zero-digit = %x31-39
decimal-value = integer-value ("." zero-integer-value)
十进制值=整数值(“.”零整数值)
SQUOTE = %x27 ; ' (Single Quote)
SQUOTE = %x27 ; ' (Single Quote)
;; ;; RFC 5234 core rules. ;;
;; ;; RFC 5234 core rules. ;;
ALPHA = %x41-5A / %x61-7A ; A-Z / a-z
ALPHA = %x41-5A / %x61-7A ; A-Z / a-z
CR = %x0D ; carriage return
CR = %x0D ; carriage return
CRLF = CR LF ; Internet standard new line
CRLF=CRLF;互联网标准新线
DIGIT = %x30-39 ; 0-9
DIGIT = %x30-39 ; 0-9
DQUOTE = %x22 ; " (Double Quote)
DQUOTE = %x22 ; " (Double Quote)
HEXDIG = DIGIT / %x61 / %x62 / %x63 / %x64 / %x65 / %x66 ; only lower-case a..f
HEXDIG = DIGIT / %x61 / %x62 / %x63 / %x64 / %x65 / %x66 ; only lower-case a..f
HTAB = %x09 ; horizontal tab
HTAB = %x09 ; horizontal tab
LF = %x0A ; linefeed
LF = %x0A ; linefeed
SP = %x20 ; space
SP = %x20 ; space
VCHAR = %x21-7E ; visible (printing) characters
VCHAR = %x21-7E ; visible (printing) characters
WSP = SP / HTAB ; whitespace
WSP=SP/HTAB;空白
<CODE ENDS>
<代码结束>
A number of NETCONF error responses are defined for error cases related to the data-model handling. If the relevant YANG statement has an "error-app-tag" substatement, that overrides the default value specified below.
为与数据模型处理相关的错误案例定义了许多NETCONF错误响应。如果相关语句具有“error-app-tag”子语句,则会覆盖下面指定的默认值。
If a NETCONF operation would result in configuration data where a unique constraint is invalidated, the following error is returned:
如果NETCONF操作将导致唯一约束失效的配置数据,则返回以下错误:
error-tag: operation-failed error-app-tag: data-not-unique error-info: <non-unique>: Contains an instance identifier that points to a leaf that invalidates the unique constraint. This element is present once for each non-unique leaf.
错误标记:操作失败错误应用程序标记:数据不唯一错误信息:<non-unique>:包含指向使唯一约束无效的叶的实例标识符。对于每个非唯一叶,此元素存在一次。
The <non-unique> element is in the YANG namespace ("urn:ietf:params:xml:ns:yang:1").
<non-unique>元素位于YANG名称空间(“urn:ietf:params:xml:ns:YANG:1”)中。
If a NETCONF operation would result in configuration data where a list or a leaf-list would have too many entries the following error is returned:
如果NETCONF操作将导致配置数据,其中列表或叶列表的条目过多,则返回以下错误:
error-tag: operation-failed error-app-tag: too-many-elements
错误标记:操作失败错误应用标记:元素太多
This error is returned once, with the error-path identifying the list node, even if there are more than one extra child present.
此错误返回一次,错误路径标识列表节点,即使存在多个子节点。
If a NETCONF operation would result in configuration data where a list or a leaf-list would have too few entries the following error is returned:
如果NETCONF操作将导致配置数据,其中列表或叶列表的条目太少,则返回以下错误:
error-tag: operation-failed error-app-tag: too-few-elements
错误标记:操作失败错误应用标记:元素太少
This error is returned once, with the error-path identifying the list node, even if there are more than one child missing.
此错误返回一次,错误路径标识列表节点,即使缺少多个子节点也是如此。
If a NETCONF operation would result in configuration data where the restrictions imposed by a "must" statement is violated the following error is returned, unless a specific "error-app-tag" substatement is present for the "must" statement.
如果NETCONF操作将导致配置数据违反“必须”语句施加的限制,则返回以下错误,除非“必须”语句存在特定的“错误应用程序标记”子语句。
error-tag: operation-failed error-app-tag: must-violation
错误标记:操作失败错误应用标记:必须违反
If a NETCONF operation would result in configuration data where a leaf of type "instance-identifier" marked with require-instance "true" refers to a non-existing instance, the following error is returned:
如果NETCONF操作将导致配置数据中带有require instance“true”标记的“instance identifier”类型的叶引用不存在的实例,则返回以下错误:
error-tag: data-missing error-app-tag: instance-required error-path: Path to the instance-identifier leaf.
错误标记:数据丢失错误应用标记:实例所需错误路径:实例标识符叶的路径。
If a NETCONF operation would result in configuration data where a leaf of type "leafref" refers to a non-existing instance, the following error is returned:
如果NETCONF操作将导致配置数据,其中类型为“leafref”的叶引用不存在的实例,则返回以下错误:
error-tag: data-missing error-app-tag: instance-required error-path: Path to the leafref leaf.
错误标记:数据丢失错误应用程序标记:实例所需错误路径:指向leafref叶的路径。
If a NETCONF operation would result in configuration data where no nodes exists in a mandatory choice, the following error is returned:
如果NETCONF操作将导致配置数据中不存在强制选项中的节点,则返回以下错误:
error-tag: data-missing error-app-tag: missing-choice error-path: Path to the element with the missing choice. error-info: <missing-choice>: Contains the name of the missing mandatory choice.
错误标记:数据丢失错误应用程序标记:缺少选项错误路径:缺少选项的元素的路径。错误信息:<missing choice>:包含缺少的强制选项的名称。
The <missing-choice> element is in the YANG namespace ("urn:ietf:params:xml:ns:yang:1").
<missing choice>元素位于YANG名称空间(“urn:ietf:params:xml:ns:YANG:1”)中。
If the "insert" and "key" or "value" attributes are used in an <edit-config> for a list or leaf-list node, and the "key" or "value" refers to a non-existing instance, the following error is returned:
如果在列表或叶列表节点的<edit config>中使用了“insert”和“key”或“value”属性,并且“key”或“value”指的是不存在的实例,则返回以下错误:
error-tag: bad-attribute error-app-tag: missing-instance
错误标记:错误属性错误应用标记:缺少实例
This document defines a registry for YANG module and submodule names. The name of the registry is "YANG Module Names".
本文档定义了模块和子模块名称的注册表。注册表的名称为“模块名称”。
The registry shall record for each entry:
登记处应记录每个条目:
o the name of the module or submodule
o 模块或子模块的名称
o for modules, the assigned XML namespace
o 对于模块,指定的XML名称空间
o for modules, the prefix of the module
o 对于模块,为模块的前缀
o for submodules, the name of the module it belongs to
o 对于子模块,它所属模块的名称
o a reference to the (sub)module's documentation (e.g., the RFC number)
o (子)模块文件的参考(如RFC编号)
There are no initial assignments.
没有初始任务。
For allocation, RFC publication is required as per RFC 5226 [RFC5226]. All registered YANG module names MUST comply with the rules for identifiers stated in Section 6.2, and MUST have a module name prefix.
按照RFC 5226[RFC5226]的规定,分配时需要发布RFC。所有注册模块名称必须符合第6.2节中规定的标识符规则,并且必须具有模块名称前缀。
The module name prefix 'ietf-' is reserved for IETF stream documents [RFC4844], while the module name prefix 'irtf-' is reserved for IRTF stream documents. Modules published in other RFC streams MUST have a similar suitable prefix.
模块名称前缀“ietf-”保留给ietf流文档[RFC4844],而模块名称前缀“irtf-”保留给irtf流文档。在其他RFC流中发布的模块必须具有类似的合适前缀。
All module and submodule names in the registry MUST be unique.
注册表中的所有模块和子模块名称必须唯一。
All XML namespaces in the registry MUST be unique.
注册表中的所有XML命名空间都必须是唯一的。
This document registers two URIs for the YANG and YIN XML namespaces in the IETF XML registry [RFC3688]. Following the format in RFC 3688, the following have been registered.
本文档在IETF XML注册表[RFC3688]中为阳和阴XML名称空间注册了两个URI。按照RFC 3688中的格式,注册了以下文件。
URI: urn:ietf:params:xml:ns:yang:yin:1
URI: urn:ietf:params:xml:ns:yang:yin:1
URI: urn:ietf:params:xml:ns:yang:1
URI: urn:ietf:params:xml:ns:yang:1
Registrant Contact: The IESG.
注册人联系人:IESG。
XML: N/A, the requested URIs are XML namespaces.
XML:不适用,请求的URI是XML名称空间。
This document registers two new media types as defined in the following sections.
本文档注册了两种新的媒体类型,如下节所述。
MIME media type name: application
MIME媒体类型名称:应用程序
MIME subtype name: yang
MIME子类型名称:yang
Mandatory parameters: none
强制参数:无
Optional parameters: none
可选参数:无
Encoding considerations: 8-bit
编码注意事项:8位
Security considerations: See Section 15 in RFC 6020
安全注意事项:见RFC 6020第15节
Interoperability considerations: None
互操作性注意事项:无
Published specification: RFC 6020
已发布规范:RFC 6020
Applications that use this media type:
使用此媒体类型的应用程序:
YANG module validators, web servers used for downloading YANG modules, email clients, etc.
YANG模块验证程序、用于下载YANG模块的web服务器、电子邮件客户端等。
Additional information:
其他信息:
Magic Number: None
神奇数字:无
File Extension: .yang
文件扩展名:.yang
Macintosh file type code: 'TEXT'
Macintosh文件类型代码:“文本”
Personal and email address for further information: Martin Bjorklund <mbj@tail-f.com>
Personal and email address for further information: Martin Bjorklund <mbj@tail-f.com>
Intended usage: COMMON
预期用途:普通
Author: This specification is a work item of the IETF NETMOD working group, with mailing list address <netmod@ietf.org>.
作者:本规范是IETF NETMOD工作组的工作项,具有邮件列表地址<netmod@ietf.org>.
Change controller: The IESG <iesg@ietf.org>
Change controller: The IESG <iesg@ietf.org>
MIME media type name: application
MIME媒体类型名称:应用程序
MIME subtype name: yin+xml
MIME子类型名称:yin+xml
Mandatory parameters: none
强制参数:无
Optional parameters:
可选参数:
"charset": This parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in [RFC3023].
“charset”:此参数与[RFC3023]中指定的“application/xml”媒体类型的charset参数具有相同的语义。
Encoding considerations:
编码注意事项:
Identical to those of "application/xml" as described in [RFC3023], Section 3.2.
与[RFC3023]第3.2节所述的“应用程序/xml”相同。
Security considerations: See Section 15 in RFC 6020
安全注意事项:见RFC 6020第15节
Interoperability considerations: None
互操作性注意事项:无
Published specification: RFC 6020
已发布规范:RFC 6020
Applications that use this media type:
使用此媒体类型的应用程序:
YANG module validators, web servers used for downloading YANG modules, email clients, etc.
YANG模块验证程序、用于下载YANG模块的web服务器、电子邮件客户端等。
Additional information:
其他信息:
Magic Number: As specified for "application/xml" in [RFC3023], Section 3.2.
幻数:如[RFC3023]第3.2节中“应用程序/xml”所述。
File Extension: .yin
文件扩展名:.yin
Macintosh file type code: 'TEXT'
Macintosh文件类型代码:“文本”
Personal and email address for further information: Martin Bjorklund <mbj@tail-f.com>
Personal and email address for further information: Martin Bjorklund <mbj@tail-f.com>
Intended usage: COMMON
预期用途:普通
Author: This specification is a work item of the IETF NETMOD working group, with mailing list address <netmod@ietf.org>.
作者:本规范是IETF NETMOD工作组的工作项,具有邮件列表地址<netmod@ietf.org>.
Change controller: The IESG <iesg@ietf.org>
Change controller: The IESG <iesg@ietf.org>
This document defines a language with which to write and read descriptions of management information. The language itself has no security impact on the Internet.
本文档定义了一种用于编写和读取管理信息描述的语言。这种语言本身对互联网没有安全影响。
The same considerations are relevant as for the base NETCONF protocol (see [RFC4741], Section 9).
与基本NETCONF协议相关的注意事项相同(参见[RFC4741],第9节)。
Data modeled in YANG might contain sensitive information. RPCs or notifications defined in YANG might transfer sensitive information.
在YANG中建模的数据可能包含敏感信息。中定义的RPC或通知可能会传输敏感信息。
Security issues are related to the usage of data modeled in YANG. Such issues shall be dealt with in documents describing the data models and documents about the interfaces used to manipulate the data e.g., the NETCONF documents.
安全问题与YANG中建模的数据的使用有关。此类问题应在描述数据模型的文件和用于操作数据的接口文件(如NETCONF文件)中处理。
Data modeled in YANG is dependent upon:
在YANG中建模的数据取决于:
o the security of the transmission infrastructure used to send sensitive information.
o 用于发送敏感信息的传输基础设施的安全性。
o the security of applications that store or release such sensitive information.
o 存储或发布此类敏感信息的应用程序的安全性。
o adequate authentication and access control mechanisms to restrict the usage of sensitive data.
o 充分的身份验证和访问控制机制,以限制敏感数据的使用。
YANG parsers need to be robust with respect to malformed documents. Reading malformed documents from unknown or untrusted sources could result in an attacker gaining privileges of the user running the YANG parser. In an extreme situation, the entire machine could be compromised.
YANG解析器需要对格式错误的文档具有健壮性。从未知或不受信任的来源读取格式错误的文档可能会导致攻击者获得运行语法分析器的用户的权限。在极端情况下,整个机器可能受到威胁。
The following people all contributed significantly to the initial YANG document:
以下人员都对最初的YANG文件做出了重大贡献:
- Andy Bierman (Brocade) - Balazs Lengyel (Ericsson) - David Partain (Ericsson) - Juergen Schoenwaelder (Jacobs University Bremen) - Phil Shafer (Juniper Networks)
- Andy Bierman(Brocade)-Balazs Lengyel(爱立信)-David Partain(爱立信)-Juergen Schoenwaeld(不来梅雅各布大学)-Phil Shafer(Juniper Networks)
The editor wishes to thank the following individuals, who all provided helpful comments on various versions of this document: Mehmet Ersue, Washam Fan, Joel Halpern, Leif Johansson, Ladislav Lhotka, Gerhard Muenz, Tom Petch, Randy Presuhn, David Reid, and Bert Wijnen.
编辑希望感谢以下个人,他们都对本文件的不同版本提供了有益的评论:Mehmet Ersue、Washam Fan、Joel Halpern、Leif Johansson、Ladislav Lhotka、Gerhard Muenz、Tom Petch、Randy Presohn、David Reid和Bert Wijnen。
[ISO.10646] International Organization for Standardization, "Information Technology - Universal Multiple-Octet Coded Character Set (UCS)", ISO Standard 10646:2003, 2003.
[ISO.10646]国际标准化组织,“信息技术-通用多八位编码字符集(UCS)”,ISO标准10646:2003,2003。
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2119]Bradner,S.,“RFC中用于表示需求水平的关键词”,BCP 14,RFC 2119,1997年3月。
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media Types", RFC 3023, January 2001.
[RFC3023]Murata,M.,St.Laurent,S.,和D.Kohn,“XML媒体类型”,RFC 3023,2001年1月。
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, November 2003.
[RFC3629]Yergeau,F.,“UTF-8,ISO 10646的转换格式”,STD 63,RFC 3629,2003年11月。
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004.
[RFC3688]Mealling,M.“IETF XML注册表”,BCP 81,RFC 3688,2004年1月。
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005.
[RFC3986]Berners Lee,T.,Fielding,R.,和L.Masinter,“统一资源标识符(URI):通用语法”,STD 66,RFC 3986,2005年1月。
[RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data Encodings", RFC 4648, October 2006.
[RFC4648]Josefsson,S.,“Base16、Base32和Base64数据编码”,RFC4648,2006年10月。
[RFC4741] Enns, R., "NETCONF Configuration Protocol", RFC 4741, December 2006.
[RFC4741]Enns,R.,“网络配置协议”,RFC 47412006年12月。
[RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 5226, May 2008.
[RFC5226]Narten,T.和H.Alvestrand,“在RFCs中编写IANA注意事项部分的指南”,BCP 26,RFC 5226,2008年5月。
[RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, January 2008.
[RFC5234]Crocker,D.和P.Overell,“语法规范的扩充BNF:ABNF”,STD 68,RFC 5234,2008年1月。
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event Notifications", RFC 5277, July 2008.
[RFC5277]Chisholm,S.和H.Trevino,“NETCONF事件通知”,RFC 5277,2008年7月。
[XML-NAMES] Hollander, D., Tobin, R., Thompson, H., Bray, T., and A. Layman, "Namespaces in XML 1.0 (Third Edition)", World Wide Web Consortium Recommendation REC-xml-names-20091208, December 2009, <http://www.w3.org/TR/2009/REC-xml-names-20091208>.
[XML-NAMES]Hollander,D.,Tobin,R.,Thompson,H.,Bray,T.,和A.Layman,“XML 1.0中的名称空间(第三版)”,万维网联盟建议REC-XML-NAMES-20091208,2009年12月<http://www.w3.org/TR/2009/REC-xml-names-20091208>.
[XPATH] Clark, J. and S. DeRose, "XML Path Language (XPath) Version 1.0", World Wide Web Consortium Recommendation REC-xpath-19991116, November 1999, <http://www.w3.org/TR/1999/REC-xpath-19991116>.
[XPATH]Clark,J.和S.DeRose,“XML路径语言(XPATH)1.0版”,万维网联盟建议REC-XPATH-19991116,1999年11月<http://www.w3.org/TR/1999/REC-xpath-19991116>.
[XSD-TYPES] Malhotra, A. and P. Biron, "XML Schema Part 2: Datatypes Second Edition", World Wide Web Consortium Recommendation REC-xmlschema-2-20041028, October 2004, <http://www.w3.org/TR/2004/REC-xmlschema-2-20041028>.
[XSD-TYPES]Malhotra,A.和P.Biron,“XML模式第2部分:数据类型第二版”,万维网联盟建议REC-xmlschema-2-20041028,2004年10月<http://www.w3.org/TR/2004/REC-xmlschema-2-20041028>.
[RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. Schoenwaelder, Ed., "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999.
[RFC2578]McCloghrie,K.,Ed.,Perkins,D.,Ed.,和J.Schoenwaeld,Ed.“管理信息的结构版本2(SMIv2)”,STD 58,RFC 2578,1999年4月。
[RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999.
[RFC2579]McCloghrie,K.,Ed.,Perkins,D.,Ed.,和J.Schoenwaeld,Ed.“SMIv2的文本约定”,STD 58,RFC 2579,1999年4月。
[RFC3780] Strauss, F. and J. Schoenwaelder, "SMIng - Next Generation Structure of Management Information", RFC 3780, May 2004.
[RFC3780]Strauss,F.和J.Schoenwaeld,“SMIng-下一代管理信息结构”,RFC 3780,2004年5月。
[RFC4844] Daigle, L. and Internet Architecture Board, "The RFC Series and RFC Editor", RFC 4844, July 2007.
[RFC4844]Daigle,L.和互联网架构委员会,“RFC系列和RFC编辑器”,RFC 48442007年7月。
[XPATH2.0] Berglund, A., Boag, S., Chamberlin, D., Fernandez, M., Kay, M., Robie, J., and J. Simeon, "XML Path Language (XPath) 2.0", World Wide Web Consortium Recommendation REC-xpath20-20070123, January 2007, <http://www.w3.org/TR/2007/REC-xpath20-20070123>.
[XPATH2.0]Berglund,A.,Boag,S.,Chamberlin,D.,Fernandez,M.,Kay,M.,Robie,J.,和J.Simeon,“XML路径语言(XPath)2.0”,万维网联盟建议REC-xpath20-20070123,2007年1月<http://www.w3.org/TR/2007/REC-xpath20-20070123>.
[XSLT] Clark, J., "XSL Transformations (XSLT) Version 1.0", World Wide Web Consortium Recommendation REC-xslt-19991116, November 1999, <http://www.w3.org/TR/1999/REC-xslt-19991116>.
[XSLT]Clark,J.,“XSL转换(XSLT)1.0版”,万维网联盟建议REC-XSLT-19991116,1999年11月<http://www.w3.org/TR/1999/REC-xslt-19991116>.
Author's Address
作者地址
Martin Bjorklund (editor) Tail-f Systems
Martin Bjorklund(编辑)Tail-f系统
EMail: mbj@tail-f.com
EMail: mbj@tail-f.com