YANGデータモデルを含むドキュメントの作成者とレビュー担当者向けのガイドライン
英文を機械翻訳で日本語訳としています。日本語訳が正しくないことが考えられますので原文をメインとし、参考程度にご利用ください。
日本語訳
Internet Engineering Task Force (IETF) A. Bierman
Request for Comments: 8407 YumaWorks
BCP: 216 October 2018
Obsoletes: 6087
Category: Best Current Practice
ISSN: 2070-1721
Guidelines for Authors and Reviewers of Documents
Containing YANG Data Models
YANGデータモデルを含むドキュメントの作成者とレビュー担当者向けのガイドライン
Abstract
概要
This memo provides guidelines for authors and reviewers of specifications containing YANG modules. Recommendations and procedures are defined, which are intended to increase interoperability and usability of Network Configuration Protocol (NETCONF) and RESTCONF protocol implementations that utilize YANG modules. This document obsoletes RFC 6087.
このメモは、YANGモジュールを含む仕様の作成者とレビューアーのためのガイドラインを提供します。 YANGモジュールを使用するネットワーク構成プロトコル（NETCONF）とRESTCONFプロトコルの実装の相互運用性と使いやすさを向上させることを目的とした推奨事項と手順が定義されています。 このドキュメントはRFC 6087を廃止します。
Status of This Memo
このメモのステータス
This memo documents an Internet Best Current Practice.
このメモは、インターネットの現在のベストプラクティスを文書化したものです。
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 BCPs is available in Section 2 of RFC 7841.
このドキュメントは、Internet Engineering Task Force（IETF）の製品です。 これは、IETFコミュニティのコンセンサスを表しています。 公開レビューを受け、インターネットエンジニアリングステアリンググループ（IESG）による公開が承認されました。 BCPの詳細については、RFC 7841のセクション2を参照してください。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc8407.
このドキュメントの現在のステータス、正誤表、およびフィードバックの提供方法に関する情報は、https：//www.rfc-editor.org/info/rfc8407で入手できます。
Copyright Notice Copyright (c) 2018 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://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トラストの法的規定（https://trustee.ietf.org/license-info）の対象となります。 これらのドキュメントは、このドキュメントに関するあなたの権利と制限について説明しているため、注意深く確認してください。 このドキュメントから抽出されたコードコンポーネントには、Trust Legal Provisionsのセクション4.eに記載されているSimplified BSD Licenseのテキストが含まれている必要があり、Simplified BSD Licenseに記載されているように保証なしで提供されます。
Bierman Best Current Practice [Page 1]
RFC 8407 Guidelines for YANG Documents October 2018
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1. Changes since RFC 6087 . . . . . . . . . . . . . . . . . 5
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1. NETCONF Terms . . . . . . . . . . . . . . . . . . . . . . 7
2.2. YANG Terms . . . . . . . . . . . . . . . . . . . . . . . 7
2.3. NMDA Terms . . . . . . . . . . . . . . . . . . . . . . . 7
2.4. Requirements Notation . . . . . . . . . . . . . . . . . . 8
3. General Documentation Guidelines . . . . . . . . . . . . . . 8
3.1. Module Copyright . . . . . . . . . . . . . . . . . . . . 9
3.2. Code Components . . . . . . . . . . . . . . . . . . . . . 9
3.2.1. Example Modules . . . . . . . . . . . . . . . . . . . 9
3.3. Terminology Section . . . . . . . . . . . . . . . . . . . 10
3.4. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 10
3.5. Narrative Sections . . . . . . . . . . . . . . . . . . . 10
3.6. Definitions Section . . . . . . . . . . . . . . . . . . . 11
3.7. Security Considerations Section . . . . . . . . . . . . . 11
3.7.1. Security Considerations Section Template . . . . . . 12
3.8. IANA Considerations Section . . . . . . . . . . . . . . . 13
3.8.1. Documents That Create a New Namespace . . . . . . . . 14
3.8.2. Documents That Extend an Existing Namespace . . . . . 14
3.9. References Sections . . . . . . . . . . . . . . . . . . . 14
3.10. Validation Tools . . . . . . . . . . . . . . . . . . . . 14
3.11. Module Extraction Tools . . . . . . . . . . . . . . . . . 15
3.12. Module Usage Examples . . . . . . . . . . . . . . . . . . 15
4. YANG Usage Guidelines . . . . . . . . . . . . . . . . . . . . 15
4.1. Module Naming Conventions . . . . . . . . . . . . . . . . 16
4.2. Prefixes . . . . . . . . . . . . . . . . . . . . . . . . 17
4.3. Identifiers . . . . . . . . . . . . . . . . . . . . . . . 18
4.3.1. Identifier Naming Conventions . . . . . . . . . . . . 18
4.4. Defaults . . . . . . . . . . . . . . . . . . . . . . . . 19
4.5. Conditional Statements . . . . . . . . . . . . . . . . . 19
4.6. XPath Usage . . . . . . . . . . . . . . . . . . . . . . . 20
4.6.1. XPath Evaluation Contexts . . . . . . . . . . . . . . 20
4.6.2. Function Library . . . . . . . . . . . . . . . . . . 21
4.6.3. Axes . . . . . . . . . . . . . . . . . . . . . . . . 22
4.6.4. Types . . . . . . . . . . . . . . . . . . . . . . . . 23
4.6.5. Wildcards . . . . . . . . . . . . . . . . . . . . . . 24
4.6.6. Boolean Expressions . . . . . . . . . . . . . . . . . 24
4.7. YANG Definition Lifecycle Management . . . . . . . . . . 25
4.8. Module Header, Meta, and Revision Statements . . . . . . 26
4.9. Namespace Assignments . . . . . . . . . . . . . . . . . . 28
4.10. Top-Level Data Definitions . . . . . . . . . . . . . . . 29
4.11. Data Types . . . . . . . . . . . . . . . . . . . . . . . 30
4.11.1. Fixed-Value Extensibility . . . . . . . . . . . . . 30
4.11.2. Patterns and Ranges . . . . . . . . . . . . . . . . 31
4.11.3. Enumerations and Bits . . . . . . . . . . . . . . . 32
Bierman Best Current Practice [Page 2]
RFC 8407 Guidelines for YANG Documents October 2018
4.11.4. Union Types . . . . . . . . . . . . . . . . . . . . 33
4.11.5. Empty and Boolean . . . . . . . . . . . . . . . . . 34
4.12. Reusable Type Definitions . . . . . . . . . . . . . . . . 35
4.13. Reusable Groupings . . . . . . . . . . . . . . . . . . . 35
4.14. Data Definitions . . . . . . . . . . . . . . . . . . . . 36
4.14.1. Non-Presence Containers . . . . . . . . . . . . . . 38
4.14.2. Top-Level Data Nodes . . . . . . . . . . . . . . . . 38
4.15. Operation Definitions . . . . . . . . . . . . . . . . . . 39
4.16. Notification Definitions . . . . . . . . . . . . . . . . 39
4.17. Feature Definitions . . . . . . . . . . . . . . . . . . . 40
4.18. YANG Data Node Constraints . . . . . . . . . . . . . . . 41
4.18.1. Controlling Quantity . . . . . . . . . . . . . . . . 41
4.18.2. "must" versus "when" . . . . . . . . . . . . . . . . 41
4.19. "augment" Statements . . . . . . . . . . . . . . . . . . 41
4.19.1. Conditional Augment Statements . . . . . . . . . . . 41
4.19.2. Conditionally Mandatory Data Definition Statements . 42
4.20. Deviation Statements . . . . . . . . . . . . . . . . . . 43
4.21. Extension Statements . . . . . . . . . . . . . . . . . . 44
4.22. Data Correlation . . . . . . . . . . . . . . . . . . . . 45
4.22.1. Use of "leafref" for Key Correlation . . . . . . . . 46
4.23. Operational State . . . . . . . . . . . . . . . . . . . . 47
4.23.1. Combining Operational State and Configuration Data . 47
4.23.2. Representing Operational Values of Configuration
Data . . . . . . . . . . . . . . . . . . . . . . . . 47
4.23.3. NMDA Transition Guidelines . . . . . . . . . . . . . 48
4.24. Performance Considerations . . . . . . . . . . . . . . . 52
4.25. Open Systems Considerations . . . . . . . . . . . . . . . 52
4.26. Guidelines for Constructs Specific to YANG 1.1 . . . . . 53
4.26.1. Importing Multiple Revisions . . . . . . . . . . . . 53
4.26.2. Using Feature Logic . . . . . . . . . . . . . . . . 53
4.26.3. "anyxml" versus "anydata" . . . . . . . . . . . . . 53
4.26.4. "action" versus "rpc" . . . . . . . . . . . . . . . 53
4.27. Updating YANG Modules (Published versus Unpublished) . . 54
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 55
6. Security Considerations . . . . . . . . . . . . . . . . . . . 55
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.1. Normative References . . . . . . . . . . . . . . . . . . 56
7.2. Informative References . . . . . . . . . . . . . . . . . 57
Appendix A. Module Review Checklist . . . . . . . . . . . . . . 59
Appendix B. YANG Module Template . . . . . . . . . . . . . . . . 61
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 62
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 63
1.はじめに. . . . . . . . . . . . . . . . . . . . . . . . 4
1.1. RFC 6087以降の変更. . . . . . . . . . . . . . . . . 5
2.用語. . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1. NETCONF規約. . . . . . . . . . . . . . . . . . . . . . 7
2.2.ヤン規約. . . . . . . . . . . . . . . . . . . . . . . 7
2.3. NMDA規約. . . . . . . . . . . . . . . . . . . . . . . 7
2.4.要件表記. . . . . . . . . . . . . . . . . . 8
3.一般的なドキュメントガイドライン. . . . . . . . . . . . . . 8
3.1.モジュールの著作権. . . . . . . . . . . . . . . . . . . . 9
3.2.コードコンポーネント. . . . . . . . . . . . . . . . . . . . . 9
3.2.1.モジュールの例. . . . . . . . . . . . . . . . . . 9
3.3.用語セクション. . . . . . . . . . . . . . . . . . . 10
3.4.ツリー図. . . . . . . . . . . . . . . . . . . . . . 10
3.5.物語セクション. . . . . . . . . . . . . . . . . . . 10
3.6.定義セクション. . . . . . . . . . . . . . . . . . . 11
3.7.セキュリティ問題セクション. . . . . . . . . . . . . 11
3.7.1.セキュリティ問題セクションテンプレート. . . . . . 12
3.8 IANA検討セクション. . . . . . . . . . . . . . . 13
3.8.1.新しい名前空間を作成するドキュメント. . . . . . . . 14
3.8.2.既存の名前空間を拡張するドキュメント. . . . . 14
3.9参照セクション. . . . . . . . . . . . . . . . . . 14
3.10.検証ツール. . . . . . . . . . . . . . . . . . . . 14
3.11.モジュール抽出ツール. . . . . . . . . . . . . . . . . 15
3.12.モジュール使用例. . . . . . . . . . . . . . . . . . 15
4. YANG使用ガイドライン. . . . . . . . . . . . . . . . . . . . 15
4.1.モジュール命名規約. . . . . . . . . . . . . . . . 16
4.2.接頭辞. . . . . . . . . . . . . . . . . . . . . . . . 17
4.3.識別子. . . . . . . . . . . . . . . . . . . . . . . 18
4.3.1.識別子命名規約. . . . . . . . . . . . 18
4.4.デフォルト. . . . . . . . . . . . . . . . . . . . . . . . 19
4.5.条件付きステートメント. . . . . . . . . . . . . . . . 19
4.6 XPathの使用法. . . . . . . . . . . . . . . . . . . . . . . 20
4.6.1. XPath評価コンテキスト. . . . . . . . . . . . . . 20
4.6.2.関数ライブラリ. . . . . . . . . . . . . . . . . . 21
4.6.3.軸. . . . . . . . . . . . . . . . . . . . . . . . 22
4.6.4.タイプ . . . . . . . . . . . . . . . . . . . . . . . . 23
4.6.5.ワイルドカード. . . . . . . . . . . . . . . . . . . . . . 24
4.6.6.ブール式. . . . . . . . . . . . . . . . . 24
4.7.ヤン定義ライフサイクル管理. . . . . . . . . . 25
4.8.モジュールヘッダー、メタ、リビジョンステートメント. . . . . . 26
4.9.名前空間の割り当て. . . . . . . . . . . . . . . . . . 28
4.10.トップレベルのデータ定義. . . . . . . . . . . . . . . 29
4.11.データ型. . . . . . . . . . . . . . . . . . . . . . . 30
4.11.1.固定値の拡張性. . . . . . . . . . . . . 30
4.11.2.パターンと範囲. . . . . . . . . . . . . . . . 31
4.11.3.列挙とビット. . . . . . . . . . . . . . . 32
4.11.4.ユニオンタイプ. . . . . . . . . . . . . . . . . . . 33
4.11.5.空とブール. . . . . . . . . . . . . . . . . 34
4.12.再利用可能な型定義. . . . . . . . . . . . . . . . 35
4.13.再利用可能なグループ. . . . . . . . . . . . . . . . . . . 35
4.14.データ定義. . . . . . . . . . . . . . . . . . . . 36
4.14.1.非存在コンテナ. . . . . . . . . . . . . . 38
4.14.2.トップレベルデータノード. . . . . . . . . . . . . . . . 38
4.15.オペレーション定義. . . . . . . . . . . . . . . . . . 39
4.16.通知定義. . . . . . . . . . . . . . . . 39
4.17.機能の定義. . . . . . . . . . . . . . . . . . . 40
4.18.ヤンデータノード制約. . . . . . . . . . . . . . . 41
4.18.1.数量の管理. . . . . . . . . . . . . . . 41
4.18.2. 「必須」と「いつ」. . . . . . . . . . . . . . . . 41
4.19. 「拡張」ステートメント. . . . . . . . . . . . . . . . . . 41
4.19.1.条件付き拡張ステートメント. . . . . . . . . . 41
4.19.2.条件付き必須データ定義ステートメント42
4.20.逸脱声明. . . . . . . . . . . . . . . . . . 43
4.21.拡張ステートメント. . . . . . . . . . . . . . . . . . 44
4.22.データ相関. . . . . . . . . . . . . . . . . . . . 45
4.22.1.キーの相関に「leafref」を使用します. . . . . . . . 46
4.23.運用状態. . . . . . . . . . . . . . . . . . . . 47
4.23.1.運用状態と構成データの結合. 47
4.23.2.構成の運用値の表現
データ. . . . . . . . . . . . . . . . . . . . . . . . 47
4.23.3. NMDA移行ガイドライン. . . . . . . . . . . . . 48
4.24.パフォーマンスに関する考察. . . . . . . . . . . . . . . 52
4.25.オープンシステムに関する考察. . . . . . . . . . . . . . . 52
4.26. YANG 1.1固有の構文のガイドライン. . . . . 53
4.26.1.複数のリビジョンのインポート. . . . . . . . . . . . 53
4.26.2.機能ロジックの使用. . . . . . . . . . . . . . . . 53
4.26.3. 「anyxml」対「anydata」 . . . . . . . . . . . . 53
4.26.4. 「アクション」対「rpc」. . . . . . . . . . . . . . . 53
4.27. YANGモジュールの更新（公開済みと未公開） . 54
5. IANAの考慮事項. . . . . . . . . . . . . . . . . . . . . 55
6.セキュリティに関する考慮事項. . . . . . . . . . . . . . . . . . . 55
7.参考資料. . . . . . . . . . . . . . . . . . . . . . . . . 56
7.1.規範的な参照. . . . . . . . . . . . . . . . . . 56
7.2.有益な参照. . . . . . . . . . . . . . . . . 57
付録A.モジュールレビューチェックリスト. . . . . . . . . . . . . . 59
付録B. YANGモジュールテンプレート. . . . . . . . . . . . . . . . 61
謝辞. . . . . . . . . . . . . . . . . . . . . . . . . 62
著者のアドレス. . . . . . . . . . . . . . . . . . . . . . . . 63
Bierman Best Current Practice [Page 3] RFC 8407 Guidelines for YANG Documents October 2018 1. Introduction
1.はじめに
The standardization of network configuration interfaces for use with network configuration management protocols, such as the Network Configuration Protocol [RFC6241] and the RESTCONF protocol [RFC8040], requires a modular set of data models that can be reused and extended over time.
ネットワーク構成プロトコル[RFC6241]やRESTCONFプロトコル[RFC8040]などのネットワーク構成管理プロトコルで使用するためのネットワーク構成インターフェースの標準化には、長期にわたって再利用および拡張できるモジュール式のデータモデルセットが必要です。
This document defines a set of usage guidelines for documents containing YANG 1.1 [RFC7950] and YANG 1.0 [RFC6020] data models. YANG is used to define the data structures, protocol operations, and notification content used within a NETCONF and/or RESTCONF server. A NETCONF or RESTCONF server that supports a particular YANG module will support client NETCONF and/or RESTCONF operation requests, as indicated by the specific content defined in the YANG module.
このドキュメントは、YANG 1.1 [RFC7950]およびYANG 1.0 [RFC6020]データモデルを含むドキュメントの一連の使用ガイドラインを定義しています。 YANGは、NETCONFサーバーまたはRESTCONFサーバー、あるいはその両方で使用されるデータ構造、プロトコル操作、および通知コンテンツを定義するために使用されます。 特定のYANGモジュールをサポートするNETCONFまたはRESTCONFサーバーは、YANGモジュールで定義された特定のコンテンツで示されているように、クライアントのNETCONFまたはRESTCONF操作要求、あるいはその両方をサポートします。
Many YANG constructs are defined as optional to use, such as the "description" statement. However, in order to make YANG modules more useful, it is desirable to define a set of usage guidelines that entails a higher level of compliance than the minimum level defined in the YANG specification [RFC7950].
多くのYANG構文は、「description」ステートメントなど、使用するオプションとして定義されています。 ただし、YANGモジュールをより有用にするために、YANG仕様[RFC7950]で定義されている最小レベルよりも高いレベルのコンプライアンスを伴う一連の使用ガイドラインを定義することが望ましいです。
In addition, YANG allows constructs such as infinite length identifiers and string values, or top-level mandatory nodes, that a compliant server is not required to support. Only constructs that all servers are required to support can be used in IETF YANG modules.
さらに、YANGでは、準拠するサーバーがサポートする必要のない、無限長の識別子や文字列値、または最上位の必須ノードなどの構造を使用できます。 IETF YANGモジュールでは、すべてのサーバーがサポートする必要がある構成体のみを使用できます。
This document defines usage guidelines related to the NETCONF operations layer and NETCONF content layer, as defined in [RFC6241], and the RESTCONF methods and RESTCONF resources, as defined in [RFC8040].
このドキュメントでは、[RFC6241]で定義されているNETCONF操作レイヤーとNETCONFコンテンツレイヤー、および[RFC8040]で定義されているRESTCONFメソッドとRESTCONFリソースに関連する使用ガイドラインを定義しています。
These guidelines are intended to be used by authors and reviewers to improve the readability and interoperability of published YANG data models.
これらのガイドラインは、公開されたYANGデータモデルの読みやすさと相互運用性を向上させるために、作成者とレビュー担当者が使用することを目的としています。
Note that this document is not a YANG tutorial, and the reader is expected to know the YANG data modeling language before implementing the guidance in this document.
このドキュメントはYANGチュートリアルではないことに注意してください。読者は、このドキュメントのガイダンスを実装する前に、YANGデータモデリング言語を理解している必要があります。
Bierman Best Current Practice [Page 4] RFC 8407 Guidelines for YANG Documents October 2018 1.1. Changes since RFC 6087
1.1。 RFC 6087以降の変更
The following changes have been made to the guidelines published in [RFC6087]:
[RFC6087]で公開されているガイドラインに次の変更が加えられました。
o Updated NETCONF reference from RFC 4741 to RFC 6241
NETCONFリファレンスをRFC 4741からRFC 6241に更新
o Updated NETCONF over the Secure Shell (SSH) citation from RFC 4742
to RFC 6242
Secure Shell（SSH）を介したNETCONFの引用をRFC 4742からRFC 6242に更新
o Updated YANG Types reference from RFC 6021 to RFC 6991
YANGタイプの参照をRFC 6021からRFC 6991に更新
o Updated obsolete URLs for IETF resources
IETFリソースの古いURLを更新
o Changed top-level data node guideline
トップレベルのデータノードガイドラインの変更
o Clarified XML Path Language (XPath) usage for a literal value
representing a YANG identity
YANG IDを表すリテラル値の明確化されたXMLパス言語（XPath）の使用法
o Clarified XPath usage for a when-stmt
when-stmtのXPathの使用法を明確化
o Clarified XPath usage for "preceding-sibling" and
"following-sibling" axes
「先行兄弟」および「後続兄弟」軸のXPathの使用法を明確化
o Added terminology guidelines
用語ガイドラインを追加
o Added mention of RFC 8174, which updates RFC 2119 by clarifying
the use of capitalized key words
大文字のキーワードの使用を明確にすることによりRFC 2119を更新するRFC 8174の言及を追加
o Added YANG tree diagram guidelines
YANGツリー図のガイドラインを追加
o Updated XPath guidelines for type conversions and function library
usage
型変換および関数ライブラリの使用に関する更新されたXPathガイドライン
o Updated "Data Types" section
「データ型」セクションを更新
o Updated "Notification Definitions" section
「通知定義」セクションを更新
o Clarified conditional key leaf nodes
明確化された条件付きキーリーフノード
o Clarified usage of "uint64" and "int64" data types
「uint64」および「int64」データ型の使用法を明確化
o Added text on YANG feature usage
YANG機能の使用に関するテキストを追加
o Added "Identifier Naming Conventions" section
「識別子の命名規則」セクションを追加
o Clarified use of mandatory nodes with conditional augmentations
条件付き拡張による必須ノードの使用の明確化
Bierman Best Current Practice [Page 5] RFC 8407 Guidelines for YANG Documents October 2018 o Clarified namespace and domain conventions for example modules
サンプルモジュールの名前空間とドメインの規則を明確化
o Clarified conventions for identifying code components
コードコンポーネントを識別するための明確な規則
o Added YANG 1.1 guidelines
YANG 1.1ガイドラインを追加
o Added "YANG Data Node Constraints" section
「YANGデータノードの制約」セクションを追加
o Added mention of the RESTCONF protocol
RESTCONFプロトコルに関する言及を追加
o Added guidelines for datastores revised by the Network Management
Datastore Architecture (NMDA)
ネットワーク管理データストアアーキテクチャ（NMDA）によって改訂されたデータストアのガイドラインを追加
2. Terminology
2.用語
The following terms are used throughout this document:
このドキュメントでは、次の用語が使用されています。
o published: A stable release of a module or submodule. For
example, the "Request for Comments" described in Section 2.1 of
[RFC2026] is considered a stable publication.
公開済み：モジュールまたはサブモジュールの安定版リリース。 たとえば、[RFC2026]のセクション2.1で説明されている「Request for Comments」は、安定した出版物と見なされています。
o unpublished: An unstable release of a module or submodule. For
example the "Internet-Draft" described in Section 2.2 of [RFC2026]
is considered an unstable publication that is a work in progress,
subject to change at any time.
非公開：モジュールまたはサブモジュールの不安定なリリース。 たとえば、[RFC2026]のセクション2.2で説明されている「インターネットドラフト」は、進行中の作業である不安定な出版物と見なされ、いつでも変更される可能性があります。
o YANG fragment: A set of YANG statements that are not intended to
represent a complete YANG module or submodule. These statements
are not intended for actual use, except to provide an example of
YANG statement usage. The invalid syntax "..." is sometimes used
to indicate that additional YANG statements would be present in a
real YANG module.
YANGフラグメント：完全なYANGモジュールまたはサブモジュールを表すことを意図していない一連のYANGステートメント。 これらのステートメントは、YANGステートメントの使用例を提供することを除いて、実際の使用を意図したものではありません。 無効な構文 "... 追加のYANGステートメントが実際のYANGモジュールに存在することを示すために時々使用されます。
o YANG tree diagram: A diagram representing the contents of a YANG
module, as defined in [RFC8340]. It is also called a "tree
diagram".
YANGツリー図：[RFC8340]で定義されている、YANGモジュールの内容を表す図。 「ツリー図」とも呼ばれます。
Bierman Best Current Practice [Page 6] RFC 8407 Guidelines for YANG Documents October 2018 2.1. NETCONF Terms
2.1。 NETCONF規約
The following terms are defined in [RFC6241] and are not redefined here:
以下の用語は[RFC6241]で定義されており、ここでは再定義されません。
o capabilities o client o operation o server 2.2. YANG Terms
2.2。 ヤン用語
The following terms are defined in [RFC7950] and are not redefined here:
以下の用語は[RFC7950]で定義されており、ここでは再定義されません。
o data node o module o namespace o submodule o version o YANG o YIN Note that the term 'module' may be used as a generic term for a YANG module or submodule. When describing properties that are specific to submodules, the term 'submodule' is used instead.
「モジュール」という用語は、YANGモジュールまたはサブモジュールの総称として使用される場合があることに注意してください。 サブモジュールに固有のプロパティを説明する場合、代わりに「サブモジュール」という用語が使用されます。
2.3. NMDA Terms
2.3。 NMDA規約
The following terms are defined in [RFC8342] and are not redefined here:
以下の用語は[RFC8342]で定義されており、ここでは再定義されません。
o configuration
構成
o conventional configuration datastore
従来の構成データストア
o datastore
データストア
Bierman Best Current Practice [Page 7] RFC 8407 Guidelines for YANG Documents October 2018 o operational state
稼働状態
o operational state datastore
運用状態データストア
2.4. Requirements Notation
2.4。 要件表記
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
キーワード「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「NOT RECOMMENDED」、「MAY」、「OPTIONAL このドキュメントの「」は、BCP 14 [RFC2119] [RFC8174]で説明されているように解釈されます。
3. General Documentation Guidelines
3.一般的なドキュメントのガイドライン
YANG modules under review are likely to be contained in Internet- Drafts (I-Ds). All guidelines for I-D authors [ID-Guidelines] MUST be followed. The guidelines for RFCs should be followed and are defined in the following: [RFC7322] (and any future RFCs that obsolete it), [RFC-STYLE], and [RFC7841].
レビュー中のYANGモジュールは、インターネットドラフト（I-D）に含まれている可能性があります。 I-D作成者向けのすべてのガイドライン[IDガイドライン]に従う必要があります。 RFCのガイドラインに従う必要があり、以下で定義されています：[RFC7322]（およびそれを廃止する将来のRFC）、[RFC-STYLE]、および[RFC7841]。
The following sections MUST be present in an I-D containing a module:
次のセクションは、モジュールを含むI-Dに存在する必要があります。
o Narrative sections
物語のセクション
o Definition sections
定義セクション
o Security Considerations section
セキュリティに関する考慮事項
o IANA Considerations section
IANAの考慮事項セクション
o References section
参照セクション
There are three usage scenarios for YANG that can appear in an I-D or RFC:
I-DまたはRFCに表示できるYANGの使用シナリオは3つあります。
o normative module or submodule
規範的なモジュールまたはサブモジュール
o example module or submodule
モジュールまたはサブモジュールの例
o example YANG fragment not part of any module or submodule
モジュールまたはサブモジュールの一部ではないYANGフラグメントの例
The guidelines in this document refer mainly to a normative module or submodule but may be applicable to example modules and YANG fragments as well.
このドキュメントのガイドラインは、主に規範的なモジュールまたはサブモジュールを参照していますが、サンプルモジュールやYANGフラグメントにも適用できる場合があります。
Bierman Best Current Practice [Page 8] RFC 8407 Guidelines for YANG Documents October 2018 3.1. Module Copyright
3.1。 モジュールの著作権
The module "description" statement MUST contain a reference to the latest approved IETF Trust Copyright statement, which is available online at:
モジュールの「説明」ステートメントには、最新の承認済みIETFトラスト著作権ステートメントへの参照を含める必要があります。
<https://trustee.ietf.org/license-info/>
3.2. Code Components
3.2。 コードコンポーネント
Each normative YANG module or submodule contained within an I-D or RFC is considered to be a code component. The strings "<CODE BEGINS>" and "<CODE ENDS>" MUST be used to identify each code component.
I-DまたはRFCに含まれる各標準YANGモジュールまたはサブモジュールは、コードコンポーネントと見なされます。 文字列 "<CODE BEGINS>"および "<CODE ENDS>"は、各コードコンポーネントを識別するために使用する必要があります。
The "<CODE BEGINS>" tag SHOULD be followed by a string identifying the file name specified in Section 5.2 of [RFC7950]. The name string form that includes the revision date SHOULD be used. The revision date MUST match the date used in the most recent revision of the module.
「<CODE BEGINS>」タグの後には、[RFC7950]のセクション5.2で指定されたファイル名を識別する文字列が続く必要があります（SHOULD）。 改訂日を含む名前文字列形式を使用する必要があります。 改訂日は、モジュールの最新の改訂で使用された日付と一致する必要があります。
The following example is for the "2016-03-20" revision of the "ietf-foo" module:
次の例は、「ietf-foo」モジュールの「2016-03-20」リビジョン用です。
<CODE BEGINS> file "ietf-foo@2016-03-20.yang"
module ietf-foo {
namespace "urn:ietf:params:xml:ns:yang:ietf-foo";
prefix "foo";
organization "...";
contact "...";
description "...";
revision 2016-03-20 {
description "Latest revision";
reference "RFC XXXX: Foo Protocol";
}
// ... more statements
}
<CODE ENDS>
3.2.1. Example Modules
3.2.1。 モジュールの例
Example modules are not code components. The <CODE BEGINS> convention MUST NOT be used for example modules.
サンプルモジュールはコードコンポーネントではありません。 <CODE BEGINS>規約は、サンプルモジュールに使用してはなりません（MUST NOT）。
An example module SHOULD be named using the term "example", followed by a hyphen, followed by a descriptive name, e.g., "example-toaster".
モジュールの例は、「example」という用語を使用して名前を付けるべきであり、その後にハイフンが続き、その後に説明的な名前が続きます（例：「example-toaster」）。
Bierman Best Current Practice [Page 9] RFC 8407 Guidelines for YANG Documents October 2018 See Section 4.9 regarding the namespace guidelines for example modules.
サンプルモジュールの名前空間のガイドラインについては、セクション4.9を参照してください。
3.3. Terminology Section
3.3。 用語セクション
A terminology section MUST be present if any terms are defined in the document or if any terms are imported from other documents.
用語がドキュメントで定義されている場合、または用語が他のドキュメントからインポートされている場合、用語セクションが存在する必要があります。
3.4. Tree Diagrams
3.4。 ツリー図
YANG tree diagrams provide a concise representation of a YANG module and SHOULD be included to help readers understand YANG module structure. Guidelines on tree diagrams can be found in Section 3 of [RFC8340].
YANGツリー図は、YANGモジュールの簡潔な表現を提供し、読者がYANGモジュールの構造を理解できるように含める必要があります。 ツリー図のガイドラインは、[RFC8340]のセクション3にあります。
If YANG tree diagrams are used, then an informative reference to the YANG tree diagrams specification MUST be included in the document. Refer to Section 2.2 of [RFC8349] for an example of such a reference.
YANGツリー図を使用する場合は、YANGツリー図の仕様への参考情報をドキュメントに含める必要があります。 そのような参照の例については、[RFC8349]のセクション2.2を参照してください。
3.5. Narrative Sections
3.5。 物語のセクション
The narrative part MUST include an overview section that describes the scope and field of application of the module(s) defined by the specification and that specifies the relationship (if any) of these modules to other standards, particularly to standards containing other YANG modules. The narrative part SHOULD include one or more sections to briefly describe the structure of the modules defined in the specification.
説明部分には、仕様で定義されたモジュールの適用範囲と適用分野を説明し、他の標準、特に他のYANGモジュールを含む標準とこれらのモジュールの関係（ある場合）を指定する概要セクションを含める必要があります。 ナラティブ部分には、仕様で定義されているモジュールの構造を簡単に説明するために、1つ以上のセクションを含める必要があります。
If the module or modules defined by the specification imports definitions from other modules (except for those defined in [RFC7950] or [RFC6991]) or are always implemented in conjunction with other modules, then those facts MUST be noted in the overview section; any special interpretations of definitions in other modules MUST be noted as well. Refer to Section 2.3 of [RFC8349] for an example of this overview section.
仕様で定義されているモジュールが他のモジュールから定義をインポートする場合（[RFC7950]または[RFC6991]で定義されているものを除く）、または常に他のモジュールと組み合わせて実装される場合、概要セクションでそれらの事実に注意する必要があります。 他のモジュールの定義の特別な解釈にも注意する必要があります。 この概要セクションの例については、[RFC8349]のセクション2.3を参照してください。
If the document contains a YANG module(s) that is compliant with NMDA [RFC8342], then the Introduction section should mention this fact.
ドキュメントにNMDA [RFC8342]に準拠するYANGモジュールが含まれている場合、概要セクションでこの事実について言及する必要があります。
Example:
例：
The YANG data model in this document conforms to the Network
Management Datastore Architecture defined in
RFC 8342.
このドキュメントのYANGデータモデルは、RFC 8342で定義されているネットワーク管理データストアアーキテクチャに準拠しています。
Bierman Best Current Practice [Page 10] RFC 8407 Guidelines for YANG Documents October 2018 Consistent indentation SHOULD be used for all examples, including YANG fragments and protocol message instance data. If line wrapping is done for formatting purposes, then this SHOULD be noted, as shown in the following example:
YANGフラグメントやプロトコルメッセージインスタンスデータを含むすべての例で、一貫したインデントを使用する必要があります（SHOULD）。 フォーマットの目的で行の折り返しを行う場合は、次の例に示すように、これに注意する必要があります。
[note: '\' line wrapping for formatting only]
<myleaf xmlns="tag:example.com,2017:example-two">\
this is a long value so the line needs to wrap to stay\
within 72 characters\
</myleaf>
3.6. Definitions Section
3.6。 定義セクション
This section contains the module(s) defined by the specification. These modules SHOULD be written using the YANG 1.1 [RFC7950] syntax. YANG 1.0 [RFC6020] syntax MAY be used if no YANG 1.1 constructs or semantics are needed in the module. If any of the imported YANG modules are written using YANG 1.1, then the module MUST be written using YANG 1.1.
このセクションには、仕様で定義されたモジュールが含まれています。 これらのモジュールは、YANG 1.1 [RFC7950]構文を使用して作成する必要があります（SHOULD）。 YANG 1.0 [RFC6020]構文は、モジュールにYANG 1.1構成またはセマンティクスが必要ない場合に使用できます。 インポートされたYANGモジュールのいずれかがYANG 1.1を使用して記述されている場合、モジュールはYANG 1.1を使用して記述されている必要があります。
A YIN syntax version of the module MAY also be present in the document. There MAY also be other types of modules present in the document, such as Structure of Management Information Version 2 (SMIv2), which are not affected by these guidelines.
モジュールのYIN構文バージョンもドキュメントに存在する場合があります。 これらのガイドラインの影響を受けない、管理情報バージョン2（SMIv2）のような他のタイプのモジュールがドキュメントに存在する場合もあります。
Note that if the module itself is considered normative and not an example module or example YANG fragment, then all YANG statements within a YANG module are considered normative. The use of keywords defined in [RFC2119] and [RFC8174] apply to YANG "description" statements in normative modules exactly as they would in any other normative section.
モジュール自体が規範的であり、サンプルモジュールまたはサンプルYANGフラグメントではないと見なされる場合、YANGモジュール内のすべてのYANGステートメントは規範的であると見なされることに注意してください。 [RFC2119]と[RFC8174]で定義されているキーワードの使用は、他の規範セクションとまったく同じように、規範モジュールのYANG "説明"ステートメントに適用されます。
Example YANG modules and example YANG fragments MUST NOT contain any normative text, including any all-uppercase reserved words from [RFC2119] and [RFC8174].
YANGモジュールの例とYANGフラグメントの例には、[RFC2119]と[RFC8174]のすべて大文字の予約語を含む、規範的なテキストを含めてはなりません（MUST NOT）。
Consistent indentation and formatting SHOULD be used in all YANG statements within a module.
一貫したインデントとフォーマットは、モジュール内のすべてのYANGステートメントで使用する必要があります（SHOULD）。
See Section 4 for guidelines on YANG usage.
YANGの使用に関するガイドラインについては、セクション4を参照してください。
3.7. Security Considerations Section
3.7。 セキュリティに関する考慮事項セクション
Each specification that defines one or more modules MUST contain a section that discusses security considerations relevant to those modules.
1つ以上のモジュールを定義する各仕様には、それらのモジュールに関連するセキュリティの考慮事項を説明するセクションが含まれている必要があります。
Bierman Best Current Practice [Page 11] RFC 8407 Guidelines for YANG Documents October 2018 This section MUST be patterned after the latest approved template (available at <https://trac.ietf.org/trac/ops/wiki/yang-security- guidelines>). Section 3.7.1 contains the security considerations template dated 2013-05-08 and last updated on 2018-07-02. Authors MUST check the web page at the URL listed above in case there is a more recent version available.
このセクションは、最新の承認済みテンプレート（<https://trac.ietf.org/trac/ops/wiki/yang-security- Guidelines>から入手可能）を模倣する必要があります。 セクション3.7.1には、2013-05-08日付で2018-07-02に最終更新されたセキュリティに関する考慮事項テンプレートが含まれています。 著者は、より新しいバージョンが利用できる場合に備えて、上記のURLでWebページを確認する必要があります。
In particular:
特に：
o Writable data nodes that could be especially disruptive if abused
MUST be explicitly listed by name, and the associated security
risks MUST be explained.
乱用された場合に特に混乱を招く可能性がある書き込み可能なデータノードは、名前で明示的にリストする必要があり、関連するセキュリティリスクを説明する必要があります。
o Readable data nodes that contain especially sensitive information
or that raise significant privacy concerns MUST be explicitly
listed by name, and the reasons for the sensitivity/privacy
concerns MUST be explained.
特に機密情報を含む、またはプライバシーの重大な懸念を引き起こす読み取り可能なデータノードは、名前で明示的にリストする必要があり、機密性/プライバシーの懸念の理由を説明する必要があります。
o Operations (i.e., YANG "rpc" statements) that are potentially
harmful to system behavior or that raise significant privacy
concerns MUST be explicitly listed by name, and the reasons for
the sensitivity/privacy concerns MUST be explained.
システムの動作に有害な可能性のある操作、または重大なプライバシーの懸念を引き起こす操作（つまり、YANGの「rpc」ステートメント）は、名前で明示的にリストする必要があり、機密性/プライバシーの懸念の理由を説明する必要があります。
3.7.1. Security Considerations Section Template
3.7.1。 セキュリティに関する考慮事項セクションテンプレート
X. Security Considerations
X.セキュリティに関する考慮事項
The YANG module specified in this document defines a schema for data that is designed to be accessed via network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446].
このドキュメントで指定されているYANGモジュールは、NETCONF [RFC6241]やRESTCONF [RFC8040]などのネットワーク管理プロトコルを介してアクセスするように設計されたデータのスキーマを定義します。 最下層のNETCONF層はセキュアなトランスポート層であり、実装に必須のセキュアなトランスポートはSecure Shell（SSH）[RFC6242]です。 最下位のRESTCONF層はHTTPSであり、実装に必須のセキュアなトランスポートはTLS [RFC8446]です。
The NETCONF access control model [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.
NETCONFアクセス制御モデル[RFC8341]は、特定のNETCONFまたはRESTCONFユーザーのアクセスを、利用可能なすべてのNETCONFまたはRESTCONFプロトコル操作およびコンテンツの事前構成されたサブセットに制限する手段を提供します。
-- if you have any writable data nodes (those are all the
-- "config true" nodes, and remember, that is the default)
-- describe their specific sensitivity or vulnerability.
書き込み可能なデータノードがある場合（それらはすべて「config true」ノードであり、覚えておいてください。これがデフォルトです）、特定の機密性または脆弱性を記述します。
There are a number of data nodes defined in this YANG module that are writable/creatable/deletable (i.e., "config true", which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) Bierman Best Current Practice [Page 12] RFC 8407 Guidelines for YANG Documents October 2018 to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability:
このYANGモジュールには、書き込み可能/作成可能/削除可能なデータノードがいくつか定義されています（つまり、「config true」、これがデフォルトです）。 これらのデータノードは、一部のネットワーク環境では機密または脆弱であると見なされる場合があります。 適切な保護なしにこれらのデータノードに書き込み操作（edit-configなど）を行うと、ネットワーク操作に悪影響を与える可能性があります。 これらは、サブツリーとデータノード、およびそれらの機密性/脆弱性です。
<list subtrees and data nodes and state why they are sensitive>
<サブツリーとデータノードを一覧表示し、それらがなぜ機密であるかを述べる>
-- for all YANG modules you must evaluate whether any readable data
-- nodes (those are all the "config false" nodes, but also all other
-- nodes, because they can also be read via operations like get or
-- get-config) are sensitive or vulnerable (for instance, if they
-- might reveal customer information or violate personal privacy
-- laws such as those of the European Union if exposed to
-- unauthorized parties)
すべてのYANGモジュールについて、読み取り可能なデータノード（これらはすべて「config false」ノードだけでなく、getまたはget-configなどの操作で読み取ることもできるため、他のすべてのノードでもある）が機密または脆弱かどうかを評価する必要があります（for たとえば、許可されていない当事者にさらされた場合に顧客情報を明らかにしたり、EUのような個人のプライバシー法に違反したりする可能性がある場合）
Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability:
このYANGモジュールの一部の読み取り可能なデータノードは、一部のネットワーク環境では機密または脆弱であると見なされる場合があります。 したがって、これらのデータノードへの読み取りアクセスを制御することが重要です（たとえば、get、get-config、または通知を介して）。 これらは、サブツリーとデータノード、およびそれらの機密性/脆弱性です。
<list subtrees and data nodes and state why they are sensitive>
<サブツリーとデータノードを一覧表示し、それらがなぜ機密であるかを述べる>
-- if your YANG module has defined any RPC operations
-- describe their specific sensitivity or vulnerability.
YANGモジュールでRPC操作が定義されている場合は、特定の機密性または脆弱性を説明します。
Some of the RPC operations in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. These are the operations and their sensitivity/vulnerability:
このYANGモジュールの一部のRPC操作は、一部のネットワーク環境では機密または脆弱であると見なされる場合があります。 したがって、これらの操作へのアクセスを制御することが重要です。 これらは操作とその感度/脆弱性です：
<list RPC operations and state why they are sensitive>
<RPC操作を一覧表示し、それらが重要な理由を述べる>
3.8. IANA Considerations Section
3.8 IANA考慮事項セクション
In order to comply with IESG policy as set forth in <https://www.ietf.org/id-info/checklist.html>, every I-D that is submitted to the IESG for publication MUST contain an IANA Considerations section. The requirements for this section vary depending on what actions are required of the IANA. If there are no IANA considerations applicable to the document, then the IANA Considerations section will state that "This document has no IANA actions". Refer to the guidelines in [RFC8126] for more details.
<https://www.ietf.org/id-info/checklist.html>に記載されているIESGポリシーに準拠するために、公開のためにIESGに送信されるすべてのI-Dには、IANAに関する考慮事項のセクションが含まれている必要があります。 このセクションの要件は、IANAに必要なアクションによって異なります。 ドキュメントに適用可能なIANAの考慮事項がない場合、IANAの考慮事項のセクションには「このドキュメントにはIANAのアクションはありません」と記載されています。 詳細については、[RFC8126]のガイドラインを参照してください。
Each normative YANG module MUST be registered in both the "IETF XML Registry" [RFC3688] [IANA-XML] and the "YANG Module Names" registry [RFC6020] [IANA-MOD-NAMES]. This applies to new modules and updated modules. An example of an update registration for the "ietf-template" module can be found in Section 5.
各標準YANGモジュールは、「IETF XMLレジストリ」[RFC3688] [IANA-XML]と「YANGモジュール名」レジストリ[RFC6020] [IANA-MOD-NAMES]の両方に登録する必要があります。 これは、新しいモジュールと更新されたモジュールに適用されます。 「ietf-template」モジュールの更新登録の例は、セクション5にあります。
Bierman Best Current Practice [Page 13] RFC 8407 Guidelines for YANG Documents October 2018 3.8.1. Documents That Create a New Namespace
3.8.1。 新しい名前空間を作成するドキュメント
If an I-D defines a new namespace that is to be administered by the IANA, then the document MUST include an IANA Considerations section that specifies how the namespace is to be administered.
I-DがIANAによって管理される新しい名前空間を定義する場合、ドキュメントには、名前空間の管理方法を指定するIANAの考慮事項セクションを含める必要があります。
Specifically, if any YANG module namespace statement value contained in the document is not already registered with IANA, then a new entry in the "ns" subregistry within the "IETF XML Registry" MUST be requested from the IANA.
特に、ドキュメントに含まれているYANGモジュール名前空間ステートメントの値がIANAにまだ登録されていない場合、「IETF XMLレジストリ」内の「ns」サブレジストリの新しいエントリをIANAに要求する必要があります。
3.8.2. Documents That Extend an Existing Namespace
3.8.2。 既存の名前空間を拡張するドキュメント
It is possible to extend an existing namespace using a YANG submodule that belongs to an existing module already administered by IANA. In this case, the document containing the main module MUST be updated to use the latest revision of the submodule.
IANAによってすでに管理されている既存のモジュールに属するYANGサブモジュールを使用して、既存の名前空間を拡張することが可能です。 この場合、メインモジュールを含むドキュメントは、サブモジュールの最新リビジョンを使用するように更新する必要があります。
3.9. References Sections
3.9 参照セクション
For every import or include statement that appears in a module contained in the specification that identifies a module in a separate document, a corresponding normative reference to that document MUST appear in the Normative References section. The reference MUST correspond to the specific module version actually used within the specification.
別のドキュメントのモジュールを識別する仕様に含まれるモジュールに表示されるすべてのインポートまたはインクルードステートメントについては、そのドキュメントへの対応する規範的な参照を規範的な参照セクションに表示する必要があります。 参照は、仕様内で実際に使用されている特定のモジュールバージョンに対応している必要があります。
For every normative reference statement that appears in a module contained in the specification that identifies a separate document, a corresponding normative reference to that document SHOULD appear in the Normative References section. The reference SHOULD correspond to the specific document version actually used within the specification. If the reference statement identifies an informative reference that identifies a separate document, a corresponding informative reference to that document MAY appear in the Informative References section.
別のドキュメントを識別する仕様に含まれるモジュールに現れるすべての規範的参照ステートメントについて、そのドキュメントへの対応する規範的参照は、規範的参照セクションに現れるべきです（SHOULD）。 参照は、仕様内で実際に使用される特定のドキュメントバージョンに対応する必要があります（SHOULD）。 参照ステートメントが別のドキュメントを識別する有益なリファレンスを識別する場合、そのドキュメントへの対応する有益なリファレンスが「情報リファレンス」セクションに表示される場合があります。
3.10. Validation Tools
3.10。 検証ツール
All modules need to be validated before submission in an I-D. The 'pyang' YANG compiler is freely available from GitHub:
I-Dで送信する前に、すべてのモジュールを検証する必要があります。 「pyang」YANGコンパイラーはGitHubから無料で入手できます。
<https://github.com/mbj4668/pyang>
If the 'pyang' compiler is used to validate a normative module, then
the "--ietf" command-line option MUST be used to identify any IETF
guideline issues.
'pyang'コンパイラを使用して標準モジュールを検証する場合は、IETFガイドラインの問題を特定するために、「-ietf」コマンドラインオプションを使用する必要があります。
Bierman Best Current Practice [Page 14] RFC 8407 Guidelines for YANG Documents October 2018 If the 'pyang' compiler is used to validate an example module, then the "--ietf" command-line option MAY be used to identify any IETF guideline issues.
'pyang'コンパイラを使用してサンプルモジュールを検証する場合、「-ietf」コマンドラインオプションを使用して、IETFガイドラインの問題を特定することができます。
The "yanglint" program is also freely available from GitHub.
「yanglint」プログラムもGitHubから無料で入手できます。
<https://github.com/CESNET/libyang>
This tool can be used to validate XPath statements within YANG
modules.
このツールを使用して、YANGモジュール内のXPathステートメントを検証できます。
3.11. Module Extraction Tools
3.11。 モジュール抽出ツール
A version of 'rfcstrip' that will extract YANG modules from an I-D or RFC is available. The 'rfcstrip' tool that supports YANG module extraction is freely available at:
I-DまたはRFCからYANGモジュールを抽出する「rfcstrip」のバージョンが利用可能です。 YANGモジュールの抽出をサポートする 'rfcstrip'ツールは、次のサイトから無料で入手できます。
<https://github.com/mbj4668/rfcstrip>
This tool can be used to verify that the "<CODE BEGINS>" and "<CODE
ENDS>" tags are used correctly and that the normative YANG modules
can be extracted correctly.
このツールを使用して、「<CODE BEGINS>」タグと「<CODE ENDS>」タグが正しく使用されていること、および規範的なYANGモジュールを正しく抽出できることを確認できます。
The "xym" tool is freely available on GitHub and can be used to extract YANG modules from a document.
「xym」ツールはGitHubで無料で利用でき、ドキュメントからYANGモジュールを抽出するために使用できます。
<https://github.com/xym-tool/xym>
3.12. Module Usage Examples
3.12。 モジュールの使用例
Each specification that defines one or more modules SHOULD contain usage examples, either throughout the document or in an appendix. This includes example instance document snippets in an appropriate encoding (e.g., XML and/or JSON) to demonstrate the intended usage of the YANG module(s). Example modules MUST be validated. Refer to Section 3.10 for tools that validate YANG modules. If IP addresses are used, then a mix of either IPv4 and IPv6 addresses or IPv6 addresses exclusively SHOULD be used in the examples.
1つまたは複数のモジュールを定義する各仕様には、ドキュメント全体または付録に使用例を含める必要があります（SHOULD）。 これには、YANGモジュールの意図した使用法を示すために、適切なエンコーディング（XMLやJSONなど）でのインスタンスドキュメントスニペットの例が含まれています。 モジュールの例を検証する必要があります。 YANGモジュールを検証するツールについては、セクション3.10を参照してください。 IPアドレスを使用する場合、IPv4アドレスとIPv6アドレスの組み合わせ、またはIPv6アドレスのみを例で使用する必要があります（SHOULD）。
4. YANG Usage Guidelines
4. YANG使用ガイドライン
Modules in IETF Standards Track specifications MUST comply with all syntactic and semantic requirements of YANG 1.1 [RFC7950]. See the exception for YANG 1.0 in Section 3.6. The guidelines in this section are intended to supplement the YANG specification [RFC7950], which is intended to define a minimum set of conformance requirements.
IETF Standards Track仕様のモジュールは、YANG 1.1 [RFC7950]のすべての構文要件および意味要件に準拠する必要があります。 セクション3.6のYANG 1.0の例外を参照してください。 このセクションのガイドラインは、YANG仕様[RFC7950]を補足することを目的としています。これは、最低限の適合要件を定義することを目的としています。
Bierman Best Current Practice [Page 15] RFC 8407 Guidelines for YANG Documents October 2018 In order to promote interoperability and establish a set of practices based on previous experience, the following sections establish usage guidelines for specific YANG constructs.
相互運用性を促進し、以前の経験に基づいて一連のプラクティスを確立するために、以下のセクションでは、特定のYANG構造の使用ガイドラインを確立します。
Only guidelines that clarify or restrict the minimum conformance requirements are included here.
ここでは、最低限の適合要件を明確にするか制限するガイドラインのみが含まれています。
4.1. Module Naming Conventions
4.1。 モジュールの命名規則
Normative modules contained in Standards Track documents MUST be named according to the guidelines in the IANA Considerations section of [RFC7950].
Standards Trackドキュメントに含まれる規範的なモジュールは、[RFC7950]のIANAに関する考慮事項セクションのガイドラインに従って名前を付ける必要があります。
A distinctive word or abbreviation (e.g., protocol name or working group abbreviation) SHOULD be used in the module name. If new definitions are being defined to extend one or more existing modules, then the same word or abbreviation should be reused, instead of creating a new one.
モジュール名には、特徴的な単語または略語（プロトコル名やワーキンググループの略語など）を使用する必要があります（SHOULD）。 1つ以上の既存のモジュールを拡張するために新しい定義が定義されている場合、新しいものを作成するのではなく、同じ単語または略語を再利用する必要があります。
All published module names MUST be unique. For a YANG module published in an RFC, this uniqueness is guaranteed by IANA. For unpublished modules, the authors need to check that no other work in progress is using the same module name.
公開されたすべてのモジュール名は一意である必要があります。 RFCで公開されているYANGモジュールの場合、この一意性はIANAによって保証されています。 未公開のモジュールの場合、作成者は、進行中の他の作業が同じモジュール名を使用していないことを確認する必要があります。
Example modules are non-normative and SHOULD be named with the prefix "example-".
モジュールの例は非規範的であり、「example-」という接頭辞を付けて名前を付ける必要があります。
It is suggested that a stable prefix be selected that represents the entire organization. All normative YANG modules published by the IETF MUST begin with the prefix "ietf-". Another standards organization, such as the IEEE, might use the prefix "ieee-" for all YANG modules.
組織全体を表す安定したプレフィックスを選択することをお勧めします。 IETFによって公開されたすべての標準YANGモジュールは、接頭辞「ietf-」で始まる必要があります。 IEEEなどの別の標準化団体では、すべてのYANGモジュールに接頭辞「ieee-」を使用する場合があります。
Once a module name is published, it MUST NOT be reused, even if the RFC containing the module is reclassified to "Historic" status. A module name cannot be changed in YANG, and this would be treated as a new module, not a name change.
モジュール名が公開されると、そのモジュールを含むRFCが「歴史的」ステータスに再分類された場合でも、再利用してはなりません。 YANGではモジュール名を変更できません。これは、名前の変更ではなく、新しいモジュールとして扱われます。
Bierman Best Current Practice [Page 16] RFC 8407 Guidelines for YANG Documents October 2018 4.2. Prefixes
4.2。 接頭辞
All YANG definitions are scoped by the module containing the definition being referenced. This allows definitions from multiple modules to be used, even if the names are not unique. In the example below, the identifier "foo" is used in all three modules:
すべてのYANG定義は、参照される定義を含むモジュールによってスコープされます。 これにより、名前が一意でなくても、複数のモジュールの定義を使用できます。 以下の例では、3つのモジュールすべてで識別子「foo」が使用されています。
module example-foo {
namespace "tag:example.com,2017:example-foo";
prefix f;
container foo;
}
module example-bar {
namespace "tag:example.com,2017:example-bar";
prefix b;
typedef foo { type uint32; }
}
module example-one {
namespace "tag:example.com,2017:example-one";
prefix one;
import example-foo { prefix f; }
import example-bar { prefix b; }
augment "/f:foo" {
leaf foo { type b:foo; }
}
}
YANG defines the following rules for prefix usage:
YANGは、接頭部の使用に関する以下の規則を定義します。
o Prefixes are never used for built-in data types and YANG keywords.
プレフィックスは、組み込みデータ型およびYANGキーワードには使用されません。
o A prefix MUST be used for any external statement (i.e., a
statement defined with the YANG "extension" statement).
接頭辞は、外部ステートメント（つまり、YANGの「拡張」ステートメントで定義されたステートメント）に使用する必要があります。
o The proper module prefix MUST be used for all identifiers imported
from other modules.
他のモジュールからインポートされたすべての識別子には、適切なモジュールプレフィックスを使用する必要があります。
o The proper module prefix MUST be used for all identifiers included
from a submodule.
サブモジュールから含まれるすべての識別子には、適切なモジュールプレフィックスを使用する必要があります。
Bierman Best Current Practice [Page 17] RFC 8407 Guidelines for YANG Documents October 2018 The following guidelines apply to prefix usage of the current (local) module:
次のガイドラインは、現在の（ローカル）モジュールの接頭辞の使用に適用されます。
o The local module prefix SHOULD be used instead of no prefix in all
path expressions.
ローカルモジュールの接頭辞は、すべてのパス式で接頭辞なしの代わりに使用する必要があります（SHOULD）。
o The local module prefix MUST be used instead of no prefix in all
"default" statements for an "identityref" or "instance-identifier"
data type.
「identityref」または「instance-identifier」データ型のすべての「デフォルト」ステートメントでは、プレフィックスなしの代わりにローカルモジュールプレフィックスを使用する必要があります。
o The local module prefix MAY be used for references to typedefs,
groupings, extensions, features, and identities defined in the
module.
ローカルモジュールプレフィックスは、モジュールで定義されているtypedef、グループ、拡張、機能、およびIDへの参照に使用できます。
Prefix values SHOULD be short but are also likely to be unique. Prefix values SHOULD NOT conflict with known modules that have been previously published.
プレフィックス値は短くする必要がありますが、一意である可能性もあります。 プレフィックス値は、以前に公開された既知のモジュールと競合してはなりません（SHOULD NOT）。
4.3. Identifiers
4.3。 識別子
Identifiers for all YANG identifiers in published modules MUST be between 1 and 64 characters in length. These include any construct specified as an "identifier-arg-str" token in the ABNF in Section 14 of [RFC7950].
公開されたモジュール内のすべてのYANG識別子の識別子は、長さが1～64文字でなければなりません。 これらには、[RFC7950]のセクション14のABNFで「identifier-arg-str」トークンとして指定された構成が含まれます。
4.3.1. Identifier Naming Conventions
4.3.1。 識別子の命名規則
Identifiers SHOULD follow a consistent naming pattern throughout the module. Only lowercase letters, numbers, and dashes SHOULD be used in identifier names. Uppercase characters, the period character, and the underscore character MAY be used if the identifier represents a well-known value that uses these characters. YANG does not permit any other characters in YANG identifiers.
識別子は、モジュール全体で一貫した命名パターンに従う必要があります。 識別子名には小文字、数字、ダッシュのみを使用してください。 識別子がこれらの文字を使用する既知の値を表す場合、大文字、ピリオド文字、およびアンダースコア文字を使用できます。 YANGでは、YANG識別子に他の文字を使用できません。
Identifiers SHOULD include complete words and/or well-known acronyms or abbreviations. Child nodes within a container or list SHOULD NOT replicate the parent identifier. YANG identifiers are hierarchical and are only meant to be unique within the set of sibling nodes defined in the same module namespace.
識別子には、完全な単語および/またはよく知られた頭字語または略語を含める必要があります（SHOULD）。 コンテナまたはリスト内の子ノードは、親識別子を複製するべきではありません。 YANG識別子は階層的であり、同じモジュール名前空間で定義された兄弟ノードのセット内で一意であることのみを目的としています。
It is permissible to use common identifiers such as "name" or "id" in data definition statements, especially if these data nodes share a common data type.
特にこれらのデータノードが共通のデータ型を共有する場合は、データ定義ステートメントで「name」や「id」などの共通の識別子を使用することが許可されます。
Identifiers SHOULD NOT carry any special semantics that identify data modeling properties. Only YANG statements and YANG extension statements are designed to convey machine-readable data modeling properties. For example, naming an object "config" or "state" does Bierman Best Current Practice [Page 18] RFC 8407 Guidelines for YANG Documents October 2018 not change whether it is configuration data or state data. Only defined YANG statements or YANG extension statements can be used to assign semantics in a machine-readable format in YANG.
識別子には、データモデリングプロパティを識別する特別なセマンティクスを含めないでください。 YANGステートメントとYANG拡張ステートメントのみが、機械可読なデータモデリングプロパティを伝えるように設計されています。 たとえば、オブジェクトに「config」または「state」という名前を付けても、オブジェクトが構成データであるか状態データであるかは変わりません。 定義されたYANGステートメントまたはYANG拡張ステートメントのみを使用して、YANGの機械可読形式でセマンティクスを割り当てることができます。
4.4. Defaults
4.4。 デフォルト
In general, it is suggested that substatements containing very common default values SHOULD NOT be present. The following substatements are commonly used with the default value, which would make the module difficult to read if used everywhere they are allowed.
一般に、非常に一般的なデフォルト値を含むサブステートメントは、存在すべきではありません（SHOULD NOT）。 以下のサブステートメントは、デフォルト値で一般的に使用されます。許可されるすべての場所で使用すると、モジュールが読みにくくなります。
+--------------+---------------+
| Statement | Default Value |
+--------------+---------------+
| config | true |
| mandatory | false |
| max-elements | unbounded |
| min-elements | 0 |
| ordered-by | system |
| status | current |
| yin-element | false |
+--------------+---------------+
Statement Defaults
4.5. Conditional Statements
4.5。 条件付きステートメント
A module may be conceptually partitioned in several ways, using the "if-feature" and/or "when" statements.
モジュールは、「if-feature」や「when」ステートメントを使用して、概念的にいくつかの方法で分割できます。
Data model designers need to carefully consider all modularity aspects, including the use of YANG conditional statements.
データモデル設計者は、YANG条件ステートメントの使用を含め、すべてのモジュール性の側面を慎重に検討する必要があります。
If a data definition is optional, depending on server support for a NETCONF or RESTCONF protocol capability, then a YANG "feature" statement SHOULD be defined. The defined "feature" statement SHOULD then be used in the conditional "if-feature" statement referencing the optional data definition.
データ定義がオプションの場合、NETCONFまたはRESTCONFプロトコル機能のサーバーサポートに応じて、YANGの「機能」ステートメントを定義する必要があります（SHOULD）。 定義された「feature」ステートメントは、オプションのデータ定義を参照する条件付きの「if-feature」ステートメントで使用する必要があります（SHOULD）。
If any notification data, or any data definition, for a non- configuration data node is not mandatory, then the server may or may not be required to return an instance of this data node. If any conditional requirements exist for returning the data node in a notification payload or retrieval request, they MUST be documented somewhere. For example, a "when" or "if-feature" statement could apply to the data node, or the conditional requirements could be explained in a "description" statement within the data node or one of its ancestors (if any).
非構成データノードの通知データまたはデータ定義が必須ではない場合、サーバーはこのデータノードのインスタンスを返す必要がある場合とない場合があります。 通知ペイロードまたは取得リクエストでデータノードを返すための条件付き要件が存在する場合は、それらをどこかに文書化する必要があります。 たとえば、「when」または「if-feature」ステートメントをデータノードに適用したり、条件要件をデータノード内の「description」ステートメントまたはその祖先（存在する場合）で説明したりできます。
Bierman Best Current Practice [Page 19] RFC 8407 Guidelines for YANG Documents October 2018 If any "if-feature" statements apply to a list node, then the same "if-feature" statements MUST apply to any key leaf nodes for the list. There MUST NOT be any "if-feature" statements applied to any key leafs that do not also apply to the parent list node.
「if-feature」ステートメントがリストノードに適用される場合、同じ「if-feature」ステートメントがリストのすべてのキーリーフノードに適用される必要があります。 親リストノードには適用されないキーリーフに適用される「if-feature」ステートメントがあってはなりません。
There SHOULD NOT be any "when" statements applied to a key leaf node. It is possible that a "when" statement for an ancestor node of a key leaf will have the exact node-set result as the key leaf. In such a case, the "when" statement for the key leaf is redundant and SHOULD be avoided.
キーリーフノードに適用される「when」ステートメントがあってはなりません。 キーリーフの祖先ノードの「when」ステートメントが、ノードセットの正確な結果をキーリーフとして持つ可能性があります。 そのような場合、キーリーフの "when"ステートメントは冗長であり、避けるべきです。
4.6. XPath Usage
4.6 XPathの使用法
This section describes guidelines for using the XML Path Language (XPath) [W3C.REC-xpath] within YANG modules.
このセクションでは、YANGモジュール内でXMLパス言語（XPath）[W3C.REC-xpath]を使用するためのガイドラインについて説明します。
4.6.1. XPath Evaluation Contexts
4.6.1。 XPath評価コンテキスト
YANG defines five separate contexts for evaluation of XPath statements:
YANGは、XPathステートメントの評価用に5つの個別のコンテキストを定義します。
1. The "running" datastore: collection of all YANG configuration
data nodes. The document root is the conceptual container (e.g.,
"config" in the "edit-config" operation), which is the parent of
all top-level data definition statements with a "config"
statement value of "true".
「実行中」のデータストア：すべてのYANG構成データノードのコレクション。 ドキュメントルートは概念的なコンテナー（「edit-config」操作の「config」など）であり、「config」ステートメントの値が「true」であるすべてのトップレベルのデータ定義ステートメントの親です。
2. State data + the "running" datastore: collection of all YANG data
nodes. The document root is the conceptual container, parent of
all top-level data definition statements.
状態データ+「実行中」のデータストア：すべてのYANGデータノードのコレクション。 ドキュメントルートは概念的なコンテナであり、すべてのトップレベルのデータ定義ステートメントの親です。
3. Notification: an event notification document. The document root
is the notification element.
通知：イベント通知ドキュメント。 ドキュメントルートは通知要素です。
4. RPC Input: The document root is the conceptual "input" node,
which is the parent of all RPC input parameter definitions.
RPC入力：ドキュメントルートは概念的な「入力」ノードであり、すべてのRPC入力パラメーター定義の親です。
5. RPC Output: The document root is the conceptual "output" node,
which is the parent of all RPC output parameter definitions.
RPC出力：ドキュメントルートは概念的な「出力」ノードであり、すべてのRPC出力パラメーター定義の親です。
Bierman Best Current Practice [Page 20] RFC 8407 Guidelines for YANG Documents October 2018 Note that these XPath contexts cannot be mixed. For example, a "when" statement in a notification context cannot reference configuration data.
これらのXPathコンテキストを混在させることはできません。 たとえば、通知コンテキストの「when」ステートメントは構成データを参照できません。
notification foo {
leaf mtu {
// NOT okay because when-stmt context is this notification
when "/if:interfaces/if:interface[name='eth0']";
type leafref {
// Okay because path-stmt has a different context
path "/if:interfaces/if:interface/if:mtu";
}
}
}
It is especially important to consider the XPath evaluation context
for XPath expressions defined in groupings. An XPath expression
defined in a grouping may not be portable, meaning it cannot be used
in multiple contexts and produce proper results.
グループ化で定義されたXPath式のXPath評価コンテキストを考慮することが特に重要です。 グループ化で定義されたXPath式は移植できない場合があります。つまり、複数のコンテキストで使用して適切な結果を生成することはできません。
If the XPath expressions defined in a grouping are intended for a particular context, then this context SHOULD be identified in the "description" statement for the grouping.
グループ化で定義されたXPath式が特定のコンテキストを対象としている場合、このコンテキストはグループ化の「説明」ステートメントで識別される必要があります（SHOULD）。
4.6.2. Function Library
4.6.2。 関数ライブラリ
The "position" and "last" functions SHOULD NOT be used. This applies to implicit use of the "position" function as well (e.g., '//chapter[42]'). A server is only required to maintain the relative XML document order of all instances of a particular user-ordered list or leaf-list. The "position" and "last" functions MAY be used if they are evaluated in a context where the context node is a user- ordered "list" or "leaf-list".
「位置」と「最後」の関数は使用すべきではありません。 これは、「position」関数の暗黙的な使用にも適用されます（例： '// chapter [42]'）。 サーバーは、特定のユーザー順リストまたはリーフリストのすべてのインスタンスの相対XMLドキュメント順序を維持するためにのみ必要です。 「position」関数と「last」関数は、コンテキストノードがユーザーが注文した「リスト」または「リーフリスト」であるコンテキストで評価される場合に使用できます。
The "id" function SHOULD NOT be used. The "ID" attribute is not present in YANG documents, so this function has no meaning. The YANG compiler SHOULD return an empty string for this function.
「id」関数は使用しないでください。 「ID」属性はYANGドキュメントには存在しないため、この関数には意味がありません。 YANGコンパイラは、この関数に対して空の文字列を返す必要があります（SHOULD）。
The "namespace-uri" and "name" functions SHOULD NOT be used. Expanded names in XPath are different than YANG. A specific canonical representation of a YANG-expanded name does not exist.
「namespace-uri」関数と「name」関数は使用しないでください。 XPathの拡張名はYANGとは異なります。 YANG展開された名前の特定の正規表現は存在しません。
The "lang" function SHOULD NOT be used. This function does not apply to YANG because there is no "lang" attribute set with the document. The YANG compiler SHOULD return 'false' for this function.
「lang」関数は使用すべきではありません。 ドキュメントには "lang"属性が設定されていないため、この関数はYANGには適用されません。 YANGコンパイラは、この関数に対して 'false'を返す必要があります（SHOULD）。
Bierman Best Current Practice [Page 21] RFC 8407 Guidelines for YANG Documents October 2018 The "local-name", "namespace-uri", "name", "string", and "number" functions SHOULD NOT be used if the argument is a node-set. If so, the function result will be determined by the document order of the node-set. Since this order can be different on each server, the function results can also be different. Any function call that implicitly converts a node-set to a string will also have this issue.
引数がノードセットの場合、「local-name」、「namespace-uri」、「name」、「string」、および「number」関数を使用しないでください。 その場合、関数の結果はノードセットのドキュメントの順序によって決まります。 この順序はサーバーごとに異なる可能性があるため、関数の結果も異なる可能性があります。 ノードセットを暗黙的に文字列に変換する関数呼び出しでも、この問題が発生します。
The "local-name" function SHOULD NOT be used to reference local names outside of the YANG module that defines the must or when expression containing the "local-name" function. Example of a "local-name" function that should not be used:
「local-name」関数は、「local-name」関数を含む必須またはwhen式を定義するYANGモジュールの外部のローカル名を参照するために使用してはなりません（SHOULD NOT）。 使用すべきでない「local-name」関数の例：
/*[local-name()='foo']
The "derived-from-or-self" function SHOULD be used instead of an
equality expression for identityref values. This allows the
identities to be conceptually augmented.
identityref値の等式の代わりに、「from-from-or-self」関数を使用する必要があります（SHOULD）。 これにより、アイデンティティを概念的に拡張できます。
Example:
// do not use
when "md-name-format = 'name-format-null'";
// this is preferred
when "derived-from-or-self(md-name-format, 'name-format-null')";
4.6.3. Axes
4.6.3。 軸
The "attribute" and "namespace" axes are not supported in YANG and MAY be empty in a NETCONF or RESTCONF server implementation.
「属性」軸と「名前空間」軸は、YANGではサポートされておらず、NETCONFまたはRESTCONFサーバー実装では空である場合があります。
The "preceding" and "following" axes SHOULD NOT be used. These constructs rely on XML document order within a NETCONF or RESTCONF server configuration database, which may not be supported consistently or produce reliable results across implementations. Predicate expressions based on static node properties (e.g., element name or value, and "ancestor" or "descendant" axes) SHOULD be used instead. The "preceding" and "following" axes MAY be used if document order is not relevant to the outcome of the expression (e.g., check for global uniqueness of a parameter value).
「先行」および「後続」軸は使用しないでください。 これらの構成体は、NETCONFまたはRESTCONFサーバー構成データベース内のXMLドキュメントの順序に依存しています。これは、一貫してサポートされていないか、実装全体で信頼できる結果を生成する可能性があります。 代わりに、静的ノードプロパティに基づく述語式（たとえば、要素名または値、および「祖先」または「子孫」の軸）を使用する必要があります。 「前の」軸と「次の」軸は、ドキュメントの順序が式の結果に関連していない場合に使用できます（たとえば、パラメーター値のグローバルな一意性を確認します）。
The "preceding-sibling" and "following-sibling" axes SHOULD NOT be used; however, they MAY be used if document order is not relevant to the outcome of the expression.
「先行兄弟」軸と「後続兄弟」軸は使用しないでください。 ただし、ドキュメントの順序が式の結果に関連しない場合は、それらを使用できます。
Bierman Best Current Practice [Page 22] RFC 8407 Guidelines for YANG Documents October 2018 A server is only required to maintain the relative XML document order of all instances of a particular user-ordered list or leaf-list. The "preceding-sibling" and "following-sibling" axes MAY be used if they are evaluated in a context where the context node is a user-ordered "list" or "leaf-list".
サーバーは、特定のユーザー順リストまたはリーフリストのすべてのインスタンスの相対XMLドキュメント順序を維持するためにのみ必要です。 「先行兄弟」軸と「後続兄弟」軸は、コンテキストノードがユーザー指定の「リスト」または「リーフリスト」であるコンテキストで評価される場合に使用できます。
4.6.4. Types
4.6.4。 タイプ
Data nodes that use the "int64" and "uint64" built-in type SHOULD NOT be used within numeric or boolean expressions. There are boundary conditions in which the translation from the YANG 64-bit type to an XPath number can cause incorrect results. Specifically, an XPath "double" precision floating-point number cannot represent very large positive or negative 64-bit numbers because it only provides a total precision of 53 bits. The "int64" and "uint64" data types MAY be used in numeric expressions if the value can be represented with no more than 53 bits of precision.
「int64」および「uint64」組み込みタイプを使用するデータノードは、数値式またはブール式内では使用しないでください（SHOULD NOT）。 YANG 64ビット型からXPath番号への変換が誤った結果を引き起こす可能性がある境界条件があります。 具体的には、XPathの「倍精度」浮動小数点数は、53ビットの合計精度しか提供しないため、非常に大きな正または負の64ビット数を表すことができません。 53ビット以下の精度で値を表現できる場合、「int64」および「uint64」データ型を数値式で使用できます。
Data modelers need to be careful not to confuse the YANG value space and the XPath value space. The data types are not the same in both, and conversion between YANG and XPath data types SHOULD be considered carefully.
データモデラーは、YANG値スペースとXPath値スペースを混同しないように注意する必要があります。 データ型は両方で同じではなく、YANGとXPathデータ型間の変換は慎重に検討する必要があります。
Explicit XPath data type conversions MAY be used (e.g., "string", "boolean", or "number" functions), instead of implicit XPath data type conversions.
暗黙のXPathデータ型変換の代わりに、明示的なXPathデータ型変換（「文字列」、「ブール」、「数値」関数など）を使用できます（MAY）。
XPath expressions that contain a literal value representing a YANG identity SHOULD always include the declared prefix of the module where the identity is defined.
YANG IDを表すリテラル値を含むXPath式には、IDが定義されているモジュールの宣言されたプレフィックスを常に含める必要があります（SHOULD）。
XPath expressions for "when" statements SHOULD NOT reference the context node or any descendant nodes of the context node. They MAY reference descendant nodes if the "when" statement is contained within an "augment" statement, and the referenced nodes are not defined within the "augment" statement.
「when」ステートメントのXPath式は、コンテキストノードまたはコンテキストノードの子孫ノードを参照してはなりません（SHOULD NOT）。 「when」ステートメントが「augment」ステートメント内に含まれ、参照されるノードが「augment」ステートメント内で定義されていない場合、それらは子孫ノードを参照する場合があります。
Example:
augment "/rt:active-route/rt:input/rt:destination-address" {
when "rt:address-family='v4ur:ipv4-unicast'" {
description
"This augment is valid only for IPv4 unicast.";
}
// nodes defined here within the augment-stmt
// cannot be referenced in the when-stmt
}
Bierman Best Current Practice [Page 23]
RFC 8407 Guidelines for YANG Documents October 2018
4.6.5. Wildcards
4.6.5。 ワイルドカード
It is possible to construct XPath expressions that will evaluate differently when combined with several modules within a server implementation rather than when evaluated within the single module. This is due to augmenting nodes from other modules.
単一のモジュール内で評価される場合ではなく、サーバー実装内の複数のモジュールと組み合わせた場合に異なる評価となるXPath式を構築することが可能です。 これは、他のモジュールからノードを拡張するためです。
Wildcard expansion is done within a server against all the nodes from all namespaces, so it is possible for a "must" or "when" expression that uses the '*' operator to always evaluate to false if processed within a single YANG module. In such cases, the "description" statement SHOULD clarify that augmenting objects are expected to match the wildcard expansion.
ワイルドカードの展開は、すべての名前空間のすべてのノードに対してサーバー内で行われるため、単一のYANGモジュール内で処理される場合、「*」演算子を使用する「必須」または「いつ」式は常にfalseと評価される可能性があります。 そのような場合、「説明」ステートメントは、拡張オブジェクトがワイルドカード展開と一致することが期待されることを明確にする必要があります。
when /foo/services/*/active {
description
"No services directly defined in this module.
Matches objects that have augmented the services container.";
}
4.6.6. Boolean Expressions
4.6.6。 ブール式
The YANG "must" and "when" statements use an XPath boolean expression to define the test condition for the statement. It is important to specify these expressions in a way that will not cause inadvertent changes in the result if the objects referenced in the expression are updated in future revisions of the module.
YANGの「必須」および「いつ」ステートメントは、XPathブール式を使用してステートメントのテスト条件を定義します。 これらの式を指定することは、式で参照されているオブジェクトが将来のモジュールのリビジョンで更新される場合に、結果に不注意による変更が生じないようにすることが重要です。
For example, the leaf "foo2" must exist if the leaf "foo1" is equal to "one" or "three":
たとえば、リーフ「foo1」が「one」または「three」に等しい場合、リーフ「foo2」は存在している必要があります。
leaf foo1 {
type enumeration {
enum one;
enum two;
enum three;
}
}
leaf foo2 {
// INCORRECT
must "/f:foo1 != 'two'";
type string;
}
Bierman Best Current Practice [Page 24]
RFC 8407 Guidelines for YANG Documents October 2018
leaf foo2 {
// CORRECT
must "/f:foo1 = 'one' or /f:foo1 = 'three'";
type string;
}
In the next revision of the module, leaf "foo1" is extended with a
new enum named "four":
モジュールの次のリビジョンでは、リーフ「foo1」が「four」という名前の新しい列挙型で拡張されます。
leaf foo1 {
type enumeration {
enum one;
enum two;
enum three;
enum four;
}
}
Now the first XPath expression will allow the enum "four" to be
accepted in addition to the "one" and "three" enum values.
最初のXPath式では、「1」および「3」の列挙値に加えて、「4」の列挙を受け入れることができます。
4.7. YANG Definition Lifecycle Management
4.7。 ヤン定義ライフサイクル管理
The YANG status statement MUST be present within a definition if its value is "deprecated" or "obsolete". The status SHOULD NOT be changed from "current" directly to "obsolete". An object SHOULD be available for at least one year with a "deprecated" status before it is changed to "obsolete".
YANGステータスステートメントは、その値が「非推奨」または「廃止」の場合、定義内に存在する必要があります。 ステータスを「現在」から「廃止」に直接変更してはなりません（SHOULD NOT）。 オブジェクトは、「廃止」に変更される前に、「非推奨」ステータスで少なくとも1年間使用できる必要があります（SHOULD）。
The module or submodule name MUST NOT be changed, once the document containing the module or submodule is published.
モジュールまたはサブモジュールを含むドキュメントが公開されたら、モジュールまたはサブモジュールの名前を変更してはなりません。
The module namespace URI value MUST NOT be changed, once the document containing the module is published.
モジュールを含むドキュメントが公開されたら、モジュールの名前空間URI値を変更してはなりません。
The revision date substatement within the import statement SHOULD be present if any groupings are used from the external module.
外部モジュールからグループ化が使用されている場合、インポートステートメント内の改訂日サブステートメントが存在する必要があります（SHOULD）。
The revision date substatement within the include statement SHOULD be present if any groupings are used from the external submodule.
includeサブステートメント内の改訂日サブステートメントは、外部サブモジュールからグループ化が使用されている場合に存在する必要があります。
Bierman Best Current Practice [Page 25] RFC 8407 Guidelines for YANG Documents October 2018 If an import statement is for a module from a stable source (e.g., an RFC for an IETF module), then a reference-stmt SHOULD be present within an import statement.
インポートステートメントが安定したソースからのモジュール（IETFモジュールのRFCなど）に対するものである場合、参照ステートメントはインポートステートメント内に存在する必要があります（SHOULD）。
import ietf-yang-types {
prefix yang;
reference "RFC 6991: Common YANG Data Types";
}
If submodules are used, then the document containing the main module
MUST be updated so that the main module revision date is equal to or
more recent than the revision date of any submodule that is (directly
or indirectly) included by the main module.
サブモジュールを使用する場合は、メインモジュールを含むドキュメントを更新して、メインモジュールの改訂日が、メインモジュールによって（直接または間接的に）含まれているサブモジュールの改訂日と同じかそれよりも新しいものにする必要があります。
Definitions for future use SHOULD NOT be specified in a module. Do not specify placeholder objects like the "reserved" example below:
将来の使用のための定義はモジュールで指定されるべきではありません。 以下の「予約済み」の例のようにプレースホルダーオブジェクトを指定しないでください。
leaf reserved {
type string;
description
"This object has no purpose at this time, but a future
revision of this module might define a purpose
for this object.";
}
}
4.8. Module Header, Meta, and Revision Statements
4.8。 モジュールヘッダー、メタ、リビジョンステートメント
For published modules, the namespace MUST be a globally unique URI, as defined in [RFC3986]. This value is usually assigned by the IANA.
公開されたモジュールの場合、名前空間は、[RFC3986]で定義されているように、グローバルに一意のURIである必要があります。 この値は通常、IANAによって割り当てられます。
The "organization" statement MUST be present. If the module is contained in a document intended for IETF Standards Track status, then the organization SHOULD be the IETF working group (WG) chartered to write the document. For other standards organizations, a similar approach is also suggested.
「組織」ステートメントが存在しなければなりません。 モジュールがIETF標準トラックステータス向けのドキュメントに含まれている場合、組織はドキュメントを作成するためにチャーターされたIETFワーキンググループ（WG）である必要があります。 他の標準化団体についても、同様のアプローチが推奨されます。
The "contact" statement MUST be present. If the module is contained in a document intended for Standards Track status, then the WG web and mailing information SHOULD be present, and the main document author or editor contact information SHOULD be present. If additional authors or editors exist, their contact information MAY be present. There is no need to include the contact information for WG Chairs.
「連絡先」ステートメントが存在する必要があります。 モジュールがスタンダードトラックステータス向けのドキュメントに含まれている場合は、WGのWebおよびメール情報が存在している必要があり、メインのドキュメントの作成者または編集者の連絡先情報が存在している必要があります。 追加の著者または編集者が存在する場合、それらの連絡先情報が存在する場合があります。 WG議長の連絡先情報を含める必要はありません。
The "description" statement MUST be present. For modules published within IETF documents, the appropriate IETF Trust Copyright text MUST be present, as described in Section 3.1.
「説明」ステートメントが存在している必要があります。 セクション3.1で説明されているように、IETFドキュメント内で公開されたモジュールの場合、適切なIETFトラスト著作権テキストが存在している必要があります。
Bierman Best Current Practice [Page 26] RFC 8407 Guidelines for YANG Documents October 2018 If the module relies on information contained in other documents, which are not the same documents implied by the import statements present in the module, then these documents MUST be identified in the reference statement.
モジュールが他のドキュメントに含まれている情報に依存している場合、これらのドキュメントは、モジュールに存在するインポートステートメントによって暗示されるドキュメントとは異なり、参照ステートメントでこれらのドキュメントを識別する必要があります。
A "revision" statement MUST be present for each published version of the module. The "revision" statement MUST have a "reference" substatement. It MUST identify the published document that contains the module. Modules are often extracted from their original documents, and it is useful for developers and operators to know how to find the original source document in a consistent manner. The "revision" statement MAY have a "description" substatement.
「改訂」ステートメントは、モジュールの公開されたバージョンごとに存在する必要があります。 「改訂」ステートメントには「参照」サブステートメントが必要です。 それはモジュールを含む公開されたドキュメントを識別しなければなりません。 多くの場合、モジュールは元のドキュメントから抽出されます。開発者やオペレーターは、一貫した方法で元のソースドキュメントを見つける方法を知っていると便利です。 「改訂」ステートメントには、「説明」サブステートメントが含まれる場合があります。
The following example shows the revision statement for a published YANG module:
次の例は、公開されたYANGモジュールのリビジョンステートメントを示しています。
revision "2012-02-22" {
description
"Initial version";
reference
"RFC 8341: Network Configuration
Access Control Model";
}
For an unpublished module, a complete history of each unpublished
module revision is not required. That is, within a sequence of draft
versions, only the most recent revision need be recorded in the
module. Do not remove or reuse a revision statement for a published
module. A new revision date is not required unless the module
contents have changed. If the module contents have changed, then the
revision date of that new module version MUST be updated to a date
later than that of the previous version.
非公開モジュールの場合、各非公開モジュールリビジョンの完全な履歴は必要ありません。 つまり、一連のドラフトバージョン内では、最新のリビジョンのみをモジュールに記録する必要があります。 公開されたモジュールのリビジョンステートメントを削除または再利用しないでください。 モジュールの内容が変更されていない限り、新しい改訂日は必要ありません。 モジュールの内容が変更されている場合は、その新しいモジュールバージョンの改訂日を、前のバージョンより後の日付に更新する必要があります。
Bierman Best Current Practice [Page 27] RFC 8407 Guidelines for YANG Documents October 2018 The following example shows the two revision statements for an unpublished update to a published YANG module:
次の例は、公開されたYANGモジュールに対する非公開の更新の2つのリビジョンステートメントを示しています。
revision "2017-12-11" {
description
"Added support for YANG 1.1 actions and notifications tied to
data nodes. Clarify how NACM extensions can be used by other
data models.";
reference
"RFC 8407: Network Configuration Protocol (NETCONF)
Access Control Model";
}
revision "2012-02-22" {
description
"Initial version";
reference
"RFC 8341: Network Configuration
Access Control Model";
}
4.9. Namespace Assignments
4.9。 名前空間の割り当て
It is RECOMMENDED that only valid YANG modules be included in documents, whether or not the modules are published yet. This allows:
モジュールがまだ公開されているかどうかに関係なく、有効なYANGモジュールのみをドキュメントに含めることをお勧めします。 これにより、次のことが可能になります。
o the module to compile correctly instead of generating disruptive
fatal errors.
破壊的な致命的なエラーを生成する代わりに、正しくコンパイルするためのモジュール。
o early implementors to use the modules without picking a random
value for the XML namespace.
初期の実装者は、XML名前空間にランダムな値を選択せずにモジュールを使用します。
o early interoperability testing since independent implementations
will use the same XML namespace value.
独立した実装は同じXML名前空間値を使用するため、初期の相互運用性テスト。
Until a URI is assigned by the IANA, a proposed namespace URI MUST be provided for the namespace statement in a YANG module. A value SHOULD be selected that is not likely to collide with other YANG namespaces. Standard module names, prefixes, and URI strings already listed in the "YANG Module Names" registry MUST NOT be used.
URIがIANAによって割り当てられるまで、提案されている名前空間URIは、YANGモジュールの名前空間ステートメントに提供する必要があります。 他のYANGネームスペースと衝突する可能性が低い値を選択する必要があります（SHOULD）。 「YANG Module Names」レジストリにすでにリストされている標準モジュール名、プレフィックス、およびURI文字列を使用してはなりません。
A standard namespace statement value SHOULD have the following form:
標準の名前空間ステートメントの値は、次の形式にする必要があります（SHOULD）。
<URN prefix string>:<module-name>
Bierman Best Current Practice [Page 28]
RFC 8407 Guidelines for YANG Documents October 2018
The following URN prefix string SHOULD be used for published and
unpublished YANG modules:
次のURNプレフィックス文字列は、公開および非公開のYANGモジュールに使用する必要があります（SHOULD）。
urn:ietf:params:xml:ns:yang:
The following example URNs would be valid namespace statement values
for Standards Track modules:
次のURNの例は、Standards Trackモジュールの有効な名前空間ステートメントの値です。
urn:ietf:params:xml:ns:yang:ietf-netconf-partial-lock
urn:ietf:params:xml:ns:yang:ietf-netconf-state
urn:ietf:params:xml:ns:yang:ietf-netconf
Note that a different URN prefix string SHOULD be used for modules
that are not Standards Track. The string SHOULD be selected
according to the guidelines in [RFC7950].
標準トラックではないモジュールには、別のURNプレフィックス文字列を使用する必要があることに注意してください。 文字列は、[RFC7950]のガイドラインに従って選択する必要があります（SHOULD）。
The following URIs exemplify what might be used by modules that are not Standards Track. Note that the domain "example.com" SHOULD be used by example modules in IETF I-Ds. These URIs are not intended to be dereferenced. They are used for module namespace identification only.
以下のURIは、Standards Trackではないモジュールが使用する可能性があるものを例示しています。 ドメイン「example.com」は、IETF I-Dのサンプルモジュールで使用する必要があることに注意してください。 これらのURIは逆参照されることを意図していません。 これらは、モジュール名前空間の識別にのみ使用されます。
Example URIs using URLs per [RFC3986]:
https://example.com/ns/example-interfaces
https://example.com/ns/example-system
Example URIs using tags per [RFC4151]:
tag:example.com,2017:example-interfaces
tag:example.com,2017:example-system
4.10. Top-Level Data Definitions
4.10。 トップレベルのデータ定義
The top-level data organization SHOULD be considered carefully, in advance. Data model designers need to consider how the functionality for a given protocol or protocol family will grow over time.
最上位のデータ編成は、事前に慎重に検討する必要があります。 データモデルの設計者は、特定のプロトコルまたはプロトコルファミリの機能が時間とともにどのように成長するかを考慮する必要があります。
The separation of configuration data and operational state SHOULD be considered carefully. It is sometimes useful to define separate top- level containers for configuration and non-configuration data. For some existing top-level data nodes, configuration data was not in scope, so only one container representing operational state was created. Refer to NMDA [RFC8342] for details.
構成データと運用状態の分離は慎重に検討する必要があります。 構成データと非構成データ用に個別の最上位コンテナを定義すると便利な場合があります。 一部の既存の最上位データノードでは、構成データがスコープ内になかったため、運用状態を表すコンテナーが1つだけ作成されました。 詳細については、NMDA [RFC8342]を参照してください。
Bierman Best Current Practice [Page 29] RFC 8407 Guidelines for YANG Documents October 2018 The number of top-level data nodes within a module SHOULD be minimized. It is often useful to retrieve related information within a single subtree. If data is too distributed, it becomes difficult to retrieve all at once.
モジュール内の最上位のデータノードの数は最小限に抑える必要があります。 多くの場合、単一のサブツリー内の関連情報を取得すると便利です。 データが分散しすぎると、一度にすべてを取得することが難しくなります。
The names and data organization SHOULD reflect persistent information, such as the name of a protocol. The name of the working group SHOULD NOT be used because this may change over time.
名前とデータ編成は、プロトコルの名前などの永続的な情報を反映する必要があります。 ワーキンググループの名前は、時間の経過とともに変更される可能性があるため、使用しないでください。
A mandatory database data definition is defined as a node that a client must provide for the database to be valid. The server is not required to provide a value.
必須のデータベースデータ定義は、データベースが有効になるためにクライアントが提供する必要があるノードとして定義されます。 サーバーは値を提供する必要はありません。
Top-level database data definitions MUST NOT be mandatory. If a mandatory node appears at the top level, it will immediately cause the database to be invalid. This can occur when the server boots or when a module is loaded dynamically at runtime.
トップレベルのデータベースデータ定義は必須ではありません。 必須ノードがトップレベルに表示されると、すぐにデータベースが無効になります。 これは、サーバーが起動するとき、またはモジュールが実行時に動的にロードされるときに発生します。
4.11. Data Types
4.11。 データ型
Selection of an appropriate data type (i.e., built-in type, existing derived type, or new derived type) is very subjective; therefore, few requirements can be specified on that subject.
適切なデータ型（組み込み型、既存の派生型、または新しい派生型）の選択は非常に主観的です。 したがって、その主題について指定できる要件はほとんどありません。
Data model designers SHOULD use the most appropriate built-in data type for the particular application.
データモデル設計者は、特定のアプリケーションに最も適切な組み込みデータ型を使用する必要があります（SHOULD）。
The signed numeric data types (i.e., "int8", "int16", "int32", and "int64") SHOULD NOT be used unless negative values are allowed for the desired semantics.
符号付き数値データ型（つまり、「int8」、「int16」、「int32」、および「int64」）は、目的のセマンティクスで負の値が許可されていない限り、使用しないでください。
4.11.1. Fixed-Value Extensibility
4.11.1。 固定値の拡張性
If the set of values is fixed and the data type contents are controlled by a single naming authority, then an enumeration data type SHOULD be used.
値のセットが固定されており、データ型の内容が単一の命名機関によって制御されている場合は、列挙データ型を使用する必要があります（SHOULD）。
leaf foo {
type enumeration {
enum one;
enum two;
}
}
If extensibility of enumerated values is required, then the
"identityref" data type SHOULD be used instead of an enumeration or
other built-in type.
列挙値の拡張性が必要な場合は、列挙型または他の組み込み型の代わりに「identityref」データ型を使用する必要があります（SHOULD）。
Bierman Best Current Practice [Page 30]
RFC 8407 Guidelines for YANG Documents October 2018
identity foo-type {
description "Base for the extensible type";
}
identity one {
base f:foo-type;
}
identity two {
base f:foo-type;
}
leaf foo {
type identityref {
base f:foo-type;
}
}
Note that any module can declare an identity with base "foo-type"
that is valid for the "foo" leaf. Identityref values are considered
to be qualified names.
どのモジュールでも、「foo」リーフに対して有効なベース「foo-type」を使用してIDを宣言できることに注意してください。 Identityref値は修飾名と見なされます。
4.11.2. Patterns and Ranges
4.11.2。 パターンと範囲
For string data types, if a machine-readable pattern can be defined for the desired semantics, then one or more pattern statements SHOULD be present. A single-quoted string SHOULD be used to specify the pattern, since a double-quoted string can modify the content. If the patterns used in a type definition have known limitations such as false negative or false positive matches, then these limitations SHOULD be documented within the typedef or data definition.
文字列データ型の場合、目的のセマンティクスに対して機械可読パターンを定義できる場合、1つ以上のパターンステートメントが存在する必要があります（SHOULD）。 二重引用符で囲まれた文字列はコンテンツを変更できるため、パターンを指定するために単一引用符で囲まれた文字列を使用する必要があります（SHOULD）。 タイプ定義で使用されるパターンに、偽陰性または偽陽性の一致などの既知の制限がある場合、これらの制限はtypedefまたはデータ定義内に文書化する必要があります（SHOULD）。
The following typedef from [RFC6991] demonstrates the proper use of the "pattern" statement:
[RFC6991]の次のtypedefは、「パターン」ステートメントの適切な使用法を示しています。
typedef ipv4-address-no-zone {
type inet:ipv4-address {
pattern '[0-9\.]*';
}
...
}
For string data types, if the length of the string is required to be
bounded in all implementations, then a length statement MUST be
present.
文字列データ型の場合、すべての実装で文字列の長さを制限する必要がある場合は、長さステートメントを指定する必要があります。
Bierman Best Current Practice [Page 31] RFC 8407 Guidelines for YANG Documents October 2018 The following typedef from [RFC6991] demonstrates the proper use of the "length" statement:
[RFC6991]の次のtypedefは、「長さ」ステートメントの適切な使用法を示しています。
typedef yang-identifier {
type string {
length "1..max";
pattern '[a-zA-Z_][a-zA-Z0-9\-_.]*';
pattern '.|..|[^xX].*|.[^mM].*|..[^lL].*';
}
...
}
For numeric data types, if the values allowed by the intended
semantics are different than those allowed by the unbounded intrinsic
data type (e.g., "int32"), then a range statement SHOULD be present.
数値データ型の場合、目的のセマンティクスで許可されている値が無制限の組み込みデータ型で許可されている値と異なる場合（たとえば、「int32」）、範囲ステートメントが存在する必要があります（SHOULD）。
The following typedef from [RFC6991] demonstrates the proper use of the "range" statement:
[RFC6991]の次のtypedefは、「範囲」ステートメントの適切な使用法を示しています。
typedef dscp {
type uint8 {
range "0..63";
}
...
}
4.11.3. Enumerations and Bits
4.11.3。 列挙とビット
For "enumeration" or "bits" data types, the semantics for each "enum" or "bit" SHOULD be documented. A separate "description" statement (within each "enum" or "bit" statement) SHOULD be present.
「列挙型」または「ビット」データ型の場合、各「列挙型」または「ビット」のセマンティクスを文書化する必要があります。 個別の「description」ステートメント（「enum」または「bit」ステートメント内）が存在する必要があります。
leaf foo {
// INCORRECT
type enumeration {
enum one;
enum two;
}
description
"The foo enum...
one: The first enum
two: The second enum";
}
Bierman Best Current Practice [Page 32]
RFC 8407 Guidelines for YANG Documents October 2018
leaf foo {
// CORRECT
type enumeration {
enum one {
description "The first enum";
}
enum two {
description "The second enum";
}
}
description
"The foo enum... ";
}
4.11.4. Union Types
4.11.4。 ユニオンタイプ
The YANG "union" type is evaluated by testing a value against each member type in the union. The first type definition that accepts a value as valid is the member type used. In general, member types SHOULD be ordered from most restrictive to least restrictive types.
YANGの「共用体」型は、共用体の各メンバー型に対して値をテストすることによって評価されます。 値を有効として受け入れる最初の型定義は、使用されるメンバー型です。 一般に、メンバータイプは、最も制限の厳しいタイプから最も制限の少ないタイプへと並べられる必要があります（SHOULD）。
In the following example, the "enumeration" type will never be matched because the preceding "string" type will match everything.
次の例では、前述の「string」タイプはすべてに一致するため、「列挙」タイプは決して一致しません。
Incorrect:
type union {
type string;
type enumeration {
enum up;
enum down;
}
}
Correct:
type union {
type enumeration {
enum up;
enum down;
}
type string;
}
It is possible for different member types to match, depending on the
input encoding format. In XML, all values are passed as string
nodes; but in JSON, there are different value types for numbers,
booleans, and strings.
入力エンコード形式に応じて、異なるメンバータイプが一致する可能性があります。 XMLでは、すべての値が文字列ノードとして渡されます。 しかし、JSONでは、数値、ブール値、文字列の値の型が異なります。
Bierman Best Current Practice [Page 33] RFC 8407 Guidelines for YANG Documents October 2018 In the following example, a JSON numeric value will always be matched by the "int32" type, but in XML the string value representing a number will be matched by the "string" type. The second version will match the "int32" member type no matter how the input is encoded.
次の例では、JSON数値は常に「int32」タイプに一致しますが、XMLでは、数値を表す文字列値は「文字列」タイプに一致します。 2番目のバージョンは、入力がどのようにエンコードされていても、「int32」メンバータイプと一致します。
Incorrect:
type union {
type string;
type int32;
}
Correct:
type union {
type int32;
type string;
}
4.11.5. Empty and Boolean
4.11.5。 空とブール
YANG provides an "empty" data type, which has one value (i.e., present). The default is "not present", which is not actually a value. When used within a list key, only one value can (and must) exist for this key leaf. The type "empty" SHOULD NOT be used for a key leaf since it is pointless.
YANGは、1つの値（つまり、存在）を持つ「空の」データ型を提供します。 デフォルトは「存在しない」で、実際には値ではありません。 リストキー内で使用する場合、このキーリーフに存在できる値は1つだけです（存在する必要があります）。 タイプ「空」は無意味なので、キーリーフには使用しないでください。
There is really no difference between a leaf of type "empty" and a leaf-list of type "empty". Both are limited to one instance. The type "empty" SHOULD NOT be used for a leaf-list.
タイプ「空」の葉とタイプ「空」の葉リストの間に違いはありません。 どちらも1つのインスタンスに制限されています。 タイプ「空」はリーフリストには使用しないでください。
The advantage of using type "empty" instead of type "boolean" is that the default (not present) does not take up any bytes in a representation. The disadvantage is that the client may not be sure if an empty leaf is missing because it was filtered somehow or not implemented. The client may not have a complete and accurate schema for the data returned by the server and may not be aware of the missing leaf.
「boolean」タイプの代わりに「empty」タイプを使用する利点は、デフォルト（存在しない）が表現でバイトを使用しないことです。 欠点は、何とかフィルタリングされたか、実装されていないため、空の葉が欠落しているかどうかがクライアントで確認できない可能性があることです。 クライアントは、サーバーから返されたデータの完全で正確なスキーマを持っていない可能性があり、欠落したリーフを認識していない可能性があります。
The YANG "boolean" data type provides two values ("true" and
"false"). When used within a list key, two entries can exist for
this key leaf. Default values are ignored for key leafs, but a
default statement is often used for plain boolean leafs. The
advantage of the "boolean" type is that the leaf or leaf-list has a
clear representation for both values. The default value is usually
not returned unless explicitly requested by the client, so no bytes
are used in a typical representation.
YANGの「ブール」データ型は、2つの値（「true」と「false」）を提供します。 リストキー内で使用すると、このキーリーフに2つのエントリが存在する可能性があります。 デフォルト値はキーリーフでは無視されますが、デフォルトのステートメントはプレーンブールリーフによく使用されます。 「ブール」タイプの利点は、リーフまたはリーフリストに両方の値の明確な表現があることです。 デフォルト値は通常、クライアントから明示的に要求されない限り返されないため、通常の表現ではバイトは使用されません。
Bierman Best Current Practice [Page 34] RFC 8407 Guidelines for YANG Documents October 2018 In general, the "boolean" data type SHOULD be used instead of the "empty" data type, as shown in the example below:
一般に、次の例に示すように、「空」のデータ型の代わりに「ブール」データ型を使用する必要があります。
Incorrect:
leaf flag1 {
type empty;
}
Correct:
leaf flag2 {
type boolean;
default false;
}
4.12. Reusable Type Definitions
4.12。 再利用可能な型定義
If an appropriate derived type exists in any standard module, such as [RFC6991], then it SHOULD be used instead of defining a new derived type.
[RFC6991]などの標準モジュールに適切な派生型が存在する場合は、新しい派生型を定義する代わりにそれを使用する必要があります。
If an appropriate units identifier can be associated with the desired semantics, then a units statement SHOULD be present.
適切な単位識別子を目的のセマンティクスに関連付けることができる場合、unitsステートメントが存在する必要があります（SHOULD）。
If an appropriate default value can be associated with the desired semantics, then a default statement SHOULD be present.
適切なデフォルト値を目的のセマンティクスに関連付けることができる場合、デフォルトのステートメントが存在する必要があります（SHOULD）。
If a significant number of derived types are defined, and it is anticipated that these data types will be reused by multiple modules, then these derived types SHOULD be contained in a separate module or submodule, to allow easier reuse without unnecessary coupling.
多数の派生型が定義されており、これらのデータ型が複数のモジュールで再利用されることが予想される場合、これらの派生型は別のモジュールまたはサブモジュールに含める必要があり（SHOULD）、不要なカップリングなしでの再利用を容易にします。
The "description" statement MUST be present.
「説明」ステートメントが存在している必要があります。
If the type definition semantics are defined in an external document (other than another YANG module indicated by an import statement), then the reference statement MUST be present.
タイプ定義のセマンティクスが外部ドキュメントで定義されている場合（インポートステートメントで示される別のYANGモジュール以外）、参照ステートメントが存在する必要があります。
4.13. Reusable Groupings
4.13。 再利用可能なグループ
A reusable grouping is a YANG grouping that can be imported by another module and is intended for use by other modules. This is not the same as a grouping that is used within the module in which it is defined, but it happens to be exportable to another module because it is defined at the top level of the YANG module.
再利用可能なグループは、別のモジュールでインポートできるYANGグループであり、他のモジュールでの使用を目的としています。 これは、それが定義されているモジュール内で使用されるグループ化とは異なりますが、YANGモジュールのトップレベルで定義されているため、たまたま別のモジュールにエクスポートできます。
Bierman Best Current Practice [Page 35] RFC 8407 Guidelines for YANG Documents October 2018 The following guidelines apply to reusable groupings, in order to make them as robust as possible:
次のガイドラインは、可能な限り堅牢にするために、再利用可能なグループに適用されます。
o Clearly identify the purpose of the grouping in the "description"
statement.
「説明」ステートメントでグループ化の目的を明確に識別します。
o There are five different XPath contexts in YANG (rpc/input, rpc/
output, notification, "config true" data nodes, and all data
nodes). Clearly identify which XPath contexts are applicable or
excluded for the grouping.
YANGには5つの異なるXPathコンテキストがあります（rpc / input、rpc / output、notification、 "config true"データノード、およびすべてのデータノード）。 グループ化に適用または除外されるXPathコンテキストを明確に識別します。
o Do not reference data outside the grouping in any "path", "must",
or "when" statements.
"path"、 "must"、または "when"ステートメントでは、グループ化されていないデータを参照しないでください。
o Do not include a "default" substatement on a leaf or choice unless
the value applies on all possible contexts.
可能なすべてのコンテキストに値が適用される場合を除いて、リーフまたは選択に「デフォルト」サブステートメントを含めないでください。
o Do not include a "config" substatement on a data node unless the
value applies on all possible contexts.
値がすべての可能なコンテキストに適用される場合を除き、データノードに「config」サブステートメントを含めないでください。
o Clearly identify any external dependencies in the grouping
"description" statement, such as nodes referenced by an absolute
path from a "path", "must", or "when" statement.
「path」、「must」、または「when」ステートメントからの絶対パスによって参照されるノードなど、グループ化する「description」ステートメントで外部依存関係を明確に識別します。
4.14. Data Definitions
4.14。 データ定義
The "description" statement MUST be present in the following YANG statements:
「説明」ステートメントは、次のYANGステートメントに存在する必要があります。
o anyxml o augment o choice o container o extension o feature o grouping o identity o leaf o leaf-list Bierman Best Current Practice [Page 36] RFC 8407 Guidelines for YANG Documents October 2018 o list o notification o rpc o typedef If the data definition semantics are defined in an external document, (other than another YANG module indicated by an import statement), then a reference statement MUST be present.
データ定義のセマンティクスが外部ドキュメントで定義されている場合（インポートステートメントで示される別のYANGモジュール以外）、参照ステートメントが存在する必要があります。
The "anyxml" construct may be useful to represent an HTML banner containing markup elements, such as "<b>" and "</b>", and MAY be used in such cases. However, this construct SHOULD NOT be used if other YANG data node types can be used instead to represent the desired syntax and semantics.
「anyxml」構造は、「<b>」や「</ b>」などのマークアップ要素を含むHTMLバナーを表すのに役立ちます。そのような場合に使用できます。 ただし、目的の構文とセマンティクスを表すために他のYANGデータノードタイプを代わりに使用できる場合は、この構成体を使用しないでください。
It has been found that the "anyxml" statement is not implemented consistently across all servers. It is possible that mixed-mode XML will not be supported or that configuration anyxml nodes will not supported.
「anyxml」ステートメントは、すべてのサーバー間で一貫して実装されていないことがわかっています。 混合モードのXMLがサポートされないか、anyXMLノードの構成がサポートされない可能性があります。
If there are referential integrity constraints associated with the desired semantics that can be represented with XPath, then one or more "must" statements SHOULD be present.
XPathで表現できる目的のセマンティクスに関連付けられている参照整合性制約がある場合、1つ以上の「必須」ステートメントが存在する必要があります（SHOULD）。
For list and leaf-list data definitions, if the number of possible instances is required to be bounded for all implementations, then the max-elements statements SHOULD be present.
リストおよびリーフリストデータ定義の場合、可能なインスタンスの数をすべての実装で制限する必要がある場合は、max-elementsステートメントが存在する必要があります（SHOULD）。
If any "must" or "when" statements are used within the data definition, then the data definition "description" statement SHOULD describe the purpose of each one.
データ定義内で「必須」または「いつ」ステートメントが使用されている場合、データ定義の「説明」ステートメントは、それぞれの目的を説明する必要があります。
The "choice" statement is allowed to be directly present within a "case" statement in YANG 1.1. This needs to be considered carefully. Consider simply including the nested "choice" as additional "case" statements within the parent "choice" statement. Note that the "mandatory" and "default" statements within a nested "choice" statement only apply if the "case" containing the nested "choice" statement is first selected.
「choice」ステートメントは、YANG 1.1の「case」ステートメント内に直接存在することが許可されています。 これは慎重に検討する必要があります。 ネストされた「choice」を、親の「choice」ステートメント内の追加の「case」ステートメントとして単に含めることを検討してください。 ネストされた「choice」ステートメント内の「必須」および「default」ステートメントは、ネストされた「choice」ステートメントを含む「case」が最初に選択された場合にのみ適用されることに注意してください。
If a list defines any key leafs, then these leafs SHOULD be defined in order, as the first child nodes within the list. The key leafs MAY be in a different order in some cases, e.g., they are defined in a grouping, and not inline in the list statement.
リストがキーリーフを定義する場合、これらのリーフはリスト内の最初の子ノードとして順番に定義する必要があります（SHOULD）。 キーリーフは異なる順序である場合があります。たとえば、それらはグループで定義されており、リストステートメントではインラインではありません。
Bierman Best Current Practice [Page 37] RFC 8407 Guidelines for YANG Documents October 2018 4.14.1. Non-Presence Containers
4.14.1。 非存在コンテナ
A non-presence container is used to organize data into specific subtrees. It is not intended to have semantics within the data model beyond this purpose, although YANG allows it (e.g., a "must" statement within the non-presence container).
非存在コンテナは、データを特定のサブツリーに編成するために使用されます。 YANGはそれを許可していますが（たとえば、非存在コンテナ内の「必須」ステートメントなど）、この目的を超えてデータモデル内にセマンティクスを持つことは意図されていません。
Example using container wrappers:
コンテナーラッパーの使用例：
container top {
container foos {
list foo { ... }
}
container bars {
list bar { ... }
}
}
Example without container wrappers:
コンテナーラッパーなしの例：
container top {
list foo { ... }
list bar { ... }
}
Use of non-presence containers to organize data is a subjective
matter similar to use of subdirectories in a file system. Although
these containers do not have any semantics, they can impact protocol
operations for the descendant data nodes within a non-presence
container, so use of these containers SHOULD be considered carefully.
存在しないコンテナを使用してデータを整理することは、ファイルシステムでサブディレクトリを使用することと同様の主観的な問題です。 これらのコンテナーにはセマンティクスはありませんが、非存在コンテナー内の子孫データノードのプロトコル操作に影響を与える可能性があるため、これらのコンテナーの使用は慎重に検討する必要があります。
The NETCONF and RESTCONF protocols do not currently support the ability to delete all list (or leaf-list) entries at once. This deficiency is sometimes avoided by use of a parent container (i.e., deleting the container also removes all child entries).
NETCONFおよびRESTCONFプロトコルは、現在、すべてのリスト（またはリーフリスト）エントリを一度に削除する機能をサポートしていません。 この欠陥は、親コンテナを使用することで回避できる場合があります（つまり、コンテナを削除すると、すべての子エントリも削除されます）。
4.14.2. Top-Level Data Nodes
4.14.2。 トップレベルのデータノード
Use of top-level objects needs to be considered carefully:
トップレベルのオブジェクトの使用は、慎重に検討する必要があります。
o top-level siblings are not ordered
トップレベルの兄弟は注文されていません
o top-level siblings are not static and depend on the modules that
are loaded
トップレベルの兄弟は静的ではなく、ロードされるモジュールに依存します
Bierman Best Current Practice [Page 38]
RFC 8407 Guidelines for YANG Documents October 2018
o for subtree filtering, retrieval of a top-level leaf-list will be
treated as a content-match node for all top-level-siblings
サブツリーフィルタリングの場合、トップレベルのリーフリストの取得は、すべてのトップレベルの兄弟のコンテンツ一致ノードとして扱われます
o a top-level list with many instances may impact performance
多くのインスタンスを含むトップレベルのリストはパフォーマンスに影響を与える可能性があります
4.15. Operation Definitions
4.15。 操作の定義
If the operation semantics are defined in an external document (other than another YANG module indicated by an import statement), then a reference statement MUST be present.
操作セマンティクスが外部ドキュメントで定義されている場合（インポートステートメントで示される別のYANGモジュール以外）、参照ステートメントが存在する必要があります。
If the operation impacts system behavior in some way, it SHOULD be mentioned in the "description" statement.
操作が何らかの方法でシステムの動作に影響を与える場合は、「説明」ステートメントで言及する必要があります。
If the operation is potentially harmful to system behavior in some way, it MUST be mentioned in the Security Considerations section of the document.
操作が何らかの方法でシステムの動作に有害である可能性がある場合は、ドキュメントの「セキュリティに関する考慮事項」セクションで言及する必要があります。
4.16. Notification Definitions
4.16。 通知の定義
The "description" statement MUST be present.
「説明」ステートメントが存在している必要があります。
If the notification semantics are defined in an external document (other than another YANG module indicated by an import statement), then a reference statement MUST be present.
通知セマンティクスが外部ドキュメントで定義されている場合（インポートステートメントで示される別のYANGモジュール以外）、参照ステートメントが存在する必要があります。
If the notification refers to a specific resource instance, then this instance SHOULD be identified in the notification data. This is usually done by including "leafref" leaf nodes with the key leaf values for the resource instance. For example:
通知が特定のリソースインスタンスを参照する場合、このインスタンスは通知データで識別されるべきです（SHOULD）。 これは通常、「leafref」リーフノードにリソースインスタンスのキーリーフ値を含めることによって行われます。 例えば：
notification interface-up {
description "Sent when an interface is activated.";
leaf name {
type leafref {
path "/if:interfaces/if:interface/if:name";
}
}
}
Note that there are no formal YANG statements to identify any data
node resources associated with a notification. The "description"
statement for the notification SHOULD specify if and how the
notification identifies any data node resources associated with the
specific event.
通知に関連付けられているデータノードリソースを識別する正式なYANGステートメントはありません。 通知の「説明」ステートメントは、通知が特定のイベントに関連付けられたデータノードリソースを識別するかどうかとその方法を指定する必要があります（SHOULD）。
Bierman Best Current Practice [Page 39] RFC 8407 Guidelines for YANG Documents October 2018 4.17. Feature Definitions
4.17。 機能の定義
The YANG "feature" statement is used to define a label for a set of optional functionality within a module. The "if-feature" statement is used in the YANG statements associated with a feature. The description-stmt within a feature-stmt MUST specify any interactions with other features.
YANGの「機能」ステートメントは、モジュール内の一連のオプション機能のラベルを定義するために使用されます。 「if-feature」ステートメントは、機能に関連付けられているYANGステートメントで使用されます。 feature-stmt内のdescription-stmtは、他の機能との相互作用を指定する必要があります。
The set of YANG features defined in a module should be considered carefully. Very fine granular features increase interoperability complexity and should be avoided. A likely misuse of the feature mechanism is the tagging of individual leafs (e.g., counters) with separate features.
モジュールで定義されているYANG機能のセットは、慎重に検討する必要があります。 非常に細かい機能は相互運用性の複雑さを増すため、避ける必要があります。 機能メカニズムの誤用の可能性は、個別の機能を持つ個々のリーフ（カウンターなど）のタグ付けです。
If there is a large set of objects associated with a YANG feature, then consider moving those objects to a separate module, instead of using a YANG feature. Note that the set of features within a module is easily discovered by the reader, but the set of related modules within the entire YANG library is not as easy to identity. Module names with a common prefix can help readers identity the set of related modules, but this assumes the reader will have discovered and installed all the relevant modules.
YANG機能に関連付けられたオブジェクトの大きなセットがある場合は、YANG機能を使用する代わりに、それらのオブジェクトを別のモジュールに移動することを検討してください。 モジュール内の一連の機能は、読者が簡単に発見できますが、YANGライブラリ全体に含まれる関連モジュールのセットは、簡単に識別できません。 共通の接頭辞が付いたモジュール名は、読者が関連モジュールのセットを識別するのに役立ちますが、これは、読者がすべての関連モジュールを検出してインストールしていることを前提としています。
Another consideration for deciding whether to create a new module or add a YANG feature is the stability of the module in question. It may be desirable to have a stable base module that is not changed frequently. If new functionality is placed in a separate module, then the base module does not need to be republished. If it is designed as a YANG feature, then the module will need to be republished.
新しいモジュールを作成するかYANG機能を追加するかを決定するためのもう1つの考慮事項は、問題のモジュールの安定性です。 頻繁に変更されない安定した基本モジュールを用意することが望ましい場合があります。 新しい機能が別のモジュールに配置されている場合、基本モジュールを再公開する必要はありません。 YANG機能として設計されている場合は、モジュールを再公開する必要があります。
If one feature requires implementation of another feature, then an "if-feature" statement SHOULD be used in the dependent "feature" statement.
ある機能が別の機能の実装を必要とする場合、 "if-feature"ステートメントは依存する "feature"ステートメントで使用されるべきです（SHOULD）。
For example, feature2 requires implementation of feature1:
たとえば、feature2にはfeature1の実装が必要です。
feature feature1 {
description "Some protocol feature";
}
feature feature2 {
if-feature "feature1";
description "Another protocol feature";
}
Bierman Best Current Practice [Page 40]
RFC 8407 Guidelines for YANG Documents October 2018
4.18. YANG Data Node Constraints
4.18。 YANGデータノードの制約
4.18.1. Controlling Quantity
4.18.1。 数量の管理
The "min-elements" and "max-elements" statements can be used to control how many list or leaf-list instances are required for a particular data node. YANG constraint statements SHOULD be used to identify conditions that apply to all implementations of the data model. If platform-specific limitations (e.g., the "max-elements" supported for a particular list) are relevant to operations, then a data model definition statement (e.g., "max-ports" leaf) SHOULD be used to identify the limit.
「min-elements」および「max-elements」ステートメントを使用して、特定のデータノードに必要なリストまたはリーフリストインスタンスの数を制御できます。 YANG制約ステートメントは、データモデルのすべての実装に適用される条件を識別するために使用する必要があります（SHOULD）。 プラットフォーム固有の制限（特定のリストでサポートされる「max-elements」など）が操作に関連している場合は、データモデル定義ステートメント（「max-ports」リーフなど）を使用して制限を特定する必要があります（SHOULD）。
4.18.2. "must" versus "when"
4.18.2。 「必須」と「いつ」
"must" and "when" YANG statements are used to provide cross-object referential tests. They have very different behavior. The "when" statement causes data node instances to be silently deleted as soon as the condition becomes false. A false "when" expression is not considered to be an error.
"must"および "when" YANGステートメントは、オブジェクト間の参照テストを提供するために使用されます。 彼らは非常に異なる動作を持っています。 「when」ステートメントを使用すると、条件がfalseになるとすぐに、データノードインスタンスが警告なしに削除されます。 偽の「when」式はエラーとは見なされません。
The "when" statement SHOULD be used together with "augment" or "uses" statements to achieve conditional model composition. The condition SHOULD be based on static properties of the augmented entry (e.g., list key leafs).
「when」ステートメントを「augment」または「uses」ステートメントとともに使用して、条件付きモデル構成を実現する必要があります（SHOULD）。 条件は、拡張されたエントリの静的プロパティに基づく必要があります（たとえば、キーリーフのリスト）。
The "must" statement causes a datastore validation error if the condition is false. This statement SHOULD be used for enforcing parameter value restrictions that involve more than one data node (e.g., end-time parameter must be after the start-time parameter).
条件がfalseの場合、「必須」ステートメントによりデータストア検証エラーが発生します。 このステートメントは、複数のデータノードに関係するパラメーター値の制限を適用するために使用する必要があります（たとえば、終了時刻パラメーターは開始時刻パラメーターの後にある必要があります）。
4.19. "augment" Statements
4.19。 「拡張」ステートメント
The YANG "augment" statement is used to define a set of data definition statements that will be added as child nodes of a target data node. The module namespace for these data nodes will be the augmenting module, not the augmented module.
YANG "augment"ステートメントは、ターゲットデータノードの子ノードとして追加されるデータ定義ステートメントのセットを定義するために使用されます。 これらのデータノードのモジュール名前空間は、拡張モジュールではなく、拡張モジュールになります。
A top-level "augment" statement SHOULD NOT be used if the target data node is in the same module or submodule as the evaluated "augment" statement. The data definition statements SHOULD be added inline instead.
ターゲットデータノードが評価された「augment」ステートメントと同じモジュールまたはサブモジュールにある場合は、トップレベルの「augment」ステートメントを使用しないでください。 代わりに、データ定義ステートメントをインラインで追加する必要があります。
4.19.1. Conditional Augment Statements
4.19.1。 条件付き拡張ステートメント
The "augment" statement is often used together with the "when" statement and/or "if-feature" statement to make the augmentation conditional on some portion of the data model.
「augment」ステートメントは、「when」ステートメントや「if-feature」ステートメントと一緒に使用され、データモデルの一部に条件付きの拡張を行います。
Bierman Best Current Practice [Page 41] RFC 8407 Guidelines for YANG Documents October 2018 The following example from [RFC7223] shows how a conditional container called "ethernet" is added to the "interface" list only for entries of the type "ethernetCsmacd".
[RFC7223]の次の例は、「ethernetCsmacd」タイプのエントリに対してのみ、「ethernet」という条件付きコンテナが「interface」リストに追加される方法を示しています。
augment "/if:interfaces/if:interface" {
when "if:type = 'ianaift:ethernetCsmacd'";
container ethernet {
leaf duplex {
...
}
}
}
4.19.2. Conditionally Mandatory Data Definition Statements
4.19.2。 条件付き必須データ定義ステートメント
YANG has very specific rules about how configuration data can be updated in new releases of a module. These rules allow an "old client" to continue interoperating with a "new server".
YANGには、モジュールの新しいリリースで構成データを更新する方法に関する非常に具体的なルールがあります。 これらのルールにより、「古いクライアント」は「新しいサーバー」との相互運用を継続できます。
If data nodes are added to an existing entry, the old client MUST NOT be required to provide any mandatory parameters that were not in the original module definition.
データノードが既存のエントリに追加される場合、古いクライアントは、元のモジュール定義になかった必須パラメーターを提供するよう要求されてはなりません（MUST NOT）。
It is possible to add conditional "augment" statements such that the old client would not know about the new condition and would not specify the new condition. The conditional "augment" statement can contain mandatory objects only if the condition is false, unless explicitly requested by the client.
古いクライアントが新しい条件を認識せず、新しい条件を指定しないように、条件付きの「拡張」ステートメントを追加することが可能です。 条件付きの "augment"ステートメントには、クライアントから明示的に要求されない限り、条件がfalseの場合にのみ必須オブジェクトを含めることができます。
Only a conditional "augment" statement that uses the "when" statement form of a condition can be used in this manner. The YANG features enabled on the server cannot be controlled by the client in any way, so it is not safe to add mandatory augmenting data nodes based on the "if-feature" statement.
この方法で使用できるのは、「when」ステートメント形式の条件を使用する条件付き「augment」ステートメントのみです。 サーバーで有効になっているYANG機能は、クライアントでは制御できないため、「if-feature」ステートメントに基づいて必須の拡張データノードを追加することは安全ではありません。
The XPath "when" statement condition MUST NOT reference data outside of the target data node because the client does not have any control over this external data.
XPathの "when"ステートメント条件は、クライアントがこの外部データを制御できないため、ターゲットデータノードの外部のデータを参照してはなりません（MUST NOT）。
In the following dummy example, it is okay to augment the "interface" entry with "mandatory-leaf" because the augmentation depends on support for "some-new-iftype". The old client does not know about this type, so it would never select this type; therefore, it would not add a mandatory data node.
次のダミーの例では、拡張が「some-new-iftype」のサポートに依存しているため、「interface」エントリを「mandatory-leaf」で拡張しても問題ありません。 古いクライアントはこのタイプを認識しないため、このタイプを選択することはありません。 したがって、必須のデータノードは追加されません。
Bierman Best Current Practice [Page 42]
RFC 8407 Guidelines for YANG Documents October 2018
module example-module {
yang-version 1.1;
namespace "tag:example.com,2017:example-module";
prefix mymod;
import iana-if-type { prefix iana; }
import ietf-interfaces { prefix if; }
identity some-new-iftype {
base iana:iana-interface-type;
}
augment "/if:interfaces/if:interface" {
when "if:type = 'mymod:some-new-iftype'";
leaf mandatory-leaf {
type string;
mandatory true;
}
}
}
Note that this practice is safe only for creating data resources. It
is not safe for replacing or modifying resources if the client does
not know about the new condition. The YANG data model MUST be
packaged in a way that requires the client to be aware of the
mandatory data nodes if it is aware of the condition for this data.
In the example above, the "some-new-iftype" identity is defined in
the same module as the "mandatory-leaf" data definition statement.
この方法は、データリソースを作成する場合にのみ安全であることに注意してください。 クライアントが新しい状態を知らない場合、リソースの交換または変更は安全ではありません。 YANGデータモデルは、クライアントがこのデータの条件を認識している場合に必須のデータノードを認識する必要がある方法でパッケージ化する必要があります。 上記の例では、「some-new-iftype」アイデンティティは「mandatory-leaf」データ定義ステートメントと同じモジュールで定義されています。
This practice is not safe for identities defined in a common module such as "iana-if-type" because the client is not required to know about "my-module" just because it knows about the "iana-if-type" module.
「iana-if-type」モジュールについて知っているからといって、クライアントが「my-module」について知る必要がないため、この方法は「iana-if-type」などの一般的なモジュールで定義されたIDには安全ではありません。
4.20. Deviation Statements
4.20。 偏差ステートメント
Per RFC 7950, Section 7.20.3, the YANG "deviation" statement is not allowed to appear in IETF YANG modules, but it can be useful for documenting server capabilities. Deviation statements are not reusable and typically not shared across all platforms.
RFC 7950のセクション7.20.3に従って、YANGの「偏差」ステートメントはIETF YANGモジュールに表示することはできませんが、サーバー機能の文書化には役立ちます。 偏差ステートメントは再利用できず、通常すべてのプラットフォームで共有されません。
There are several reasons that deviations might be needed in an implementation, e.g., an object cannot be supported on all platforms, or feature delivery is done in multiple development phases. Deviation statements can also be used to add annotations to a module, which does not affect the conformance requirements for the module.
実装で偏差が必要になる理由はいくつかあります。たとえば、オブジェクトがすべてのプラットフォームでサポートされているわけではない、または機能の提供が複数の開発フェーズで行われているなどです。 偏差ステートメントを使用して、モジュールにアノテーションを追加することもできます。これは、モジュールの適合要件に影響を与えません。
Bierman Best Current Practice [Page 43] RFC 8407 Guidelines for YANG Documents October 2018 It is suggested that deviation statements be defined in separate modules from regular YANG definitions. This allows the deviations to be platform specific and/or temporary.
通常のYANG定義とは別のモジュールで偏差ステートメントを定義することをお勧めします。 これにより、偏差をプラットフォーム固有および/または一時的なものにすることができます。
The order that deviation statements are evaluated can affect the result. Therefore, multiple deviation statements in the same module, for the same target object, SHOULD NOT be used.
偏差ステートメントが評価される順序は結果に影響を与える可能性があります。 したがって、同じモジュール内の同じターゲットオブジェクトに対して複数の偏差ステートメントを使用しないでください。
The "max-elements" statement is intended to describe an architectural limit to the number of list entries. It is not intended to describe platform limitations. It is better to use a "deviation" statement for the platforms that have a hard resource limit.
「max-elements」ステートメントは、リストエントリの数に対するアーキテクチャ上の制限を説明することを目的としています。 プラットフォームの制限を説明するものではありません。 ハードリソースの制限があるプラットフォームには、「偏差」ステートメントを使用することをお勧めします。
Example documenting platform resource limits:
プラットフォームのリソース制限を文書化する例：
Wrong: (max-elements in the list itself)
container backups {
list backup {
...
max-elements 10;
...
}
}
Correct: (max-elements in a deviation)
deviation /bk:backups/bk:backup {
deviate add {
max-elements 10;
}
}
4.21. Extension Statements
4.21。 拡張ステートメント
The YANG "extension" statement is used to specify external definitions. This appears in the YANG syntax as an "unknown-statement". Usage of extension statements in a published module needs to be considered carefully.
YANGの「拡張」ステートメントは、外部定義を指定するために使用されます。 これは、YANG構文では「不明なステートメント」として表示されます。 公開されたモジュールでの拡張ステートメントの使用は、慎重に検討する必要があります。
The following guidelines apply to the usage of YANG extensions:
次のガイドラインは、YANG拡張機能の使用に適用されます。
o The semantics of the extension MUST NOT contradict any YANG
statements. Extensions can add semantics not covered by the
normal YANG statements.
拡張機能のセマンティクスは、YANGステートメントと矛盾してはなりません。 拡張機能は、通常のYANGステートメントではカバーされないセマンティクスを追加できます。
Bierman Best Current Practice [Page 44]
RFC 8407 Guidelines for YANG Documents October 2018
o The module containing the extension statement MUST clearly
identify the conformance requirements for the extension. It
should be clear whether all implementations of the YANG module
containing the extension need to also implement the extension. If
not, identify what conditions apply that would require
implementation of the extension.
拡張ステートメントを含むモジュールは、拡張の適合要件を明確に識別しなければなりません。 拡張機能を含むYANGモジュールのすべての実装が拡張機能も実装する必要があるかどうかは明確でなければなりません。 そうでない場合は、拡張機能の実装を必要とするであろう条件を特定します。
o The extension MUST clearly identify where it can be used within
other YANG statements.
拡張機能は、他のYANGステートメント内で使用できる場所を明確に識別しなければなりません。
o The extension MUST clearly identify if YANG statements or other
extensions are allowed or required within the extension as
substatements.
拡張機能は、YANGステートメントまたはその他の拡張機能がサブステートメントとして拡張機能内で許可または要求されるかどうかを明確に識別しなければなりません。
4.22. Data Correlation
4.22。 データ相関
Data can be correlated in various ways, using common data types, common data naming, and common data organization. There are several ways to extend the functionality of a module, based on the degree of coupling between the old and new functionality:
データは、共通のデータタイプ、共通のデータ命名、共通のデータ編成を使用して、さまざまな方法で相関させることができます。 古い機能と新しい機能の結合の度合いに基づいて、モジュールの機能を拡張する方法はいくつかあります。
o inline: update the module with new protocol-accessible objects.
The naming and data organization of the original objects is used.
The new objects are in the original module namespace.
インライン：新しいプロトコルでアクセス可能なオブジェクトでモジュールを更新します。 元のオブジェクトの命名とデータ編成が使用されます。 新しいオブジェクトは元のモジュールの名前空間にあります。
o augment: create a new module with new protocol-accessible objects
that augment the original data structure. The naming and data
organization of the original objects is used. The new objects are
in the new module namespace.
augment：元のデータ構造を拡張する、プロトコルにアクセス可能な新しいオブジェクトを含む新しいモジュールを作成します。 元のオブジェクトの命名とデータ編成が使用されます。 新しいオブジェクトは新しいモジュールの名前空間にあります。
o mirror: create new objects in a new module or the original module,
except use a new naming scheme and data location. The naming can
be coupled in different ways. Tight coupling is achieved with a
"leafref" data type, with the "require-instance" substatement set
to "true". This method SHOULD be used.
ミラー：新しい名前付けスキームとデータの場所を使用することを除いて、新しいモジュールまたは元のモジュールで新しいオブジェクトを作成します。 命名はさまざまな方法で組み合わせることができます。 密結合は、「leafref」データ型と「require-instance」サブステートメントを「true」に設定して実現されます。 このメソッドを使用する必要があります。
If the new data instances are not limited to the values in use in the original data structure, then the "require-instance" substatement MUST be set to "false". Loose coupling is achieved by using key leafs with the same data type as the original data structure. This has the same semantics as setting the "require-instance" substatement to "false".
新しいデータインスタンスが元のデータ構造で使用されている値に限定されていない場合は、「require-instance」サブステートメントを「false」に設定する必要があります。 疎結合は、元のデータ構造と同じデータ型のキーリーフを使用することで実現されます。 これは、「require-instance」サブステートメントを「false」に設定するのと同じセマンティクスを持っています。
The relationship between configuration and operational state has been clarified in NMDA [RFC8342].
構成と動作状態の関係は、NMDA [RFC8342]で明確になっています。
Bierman Best Current Practice [Page 45] RFC 8407 Guidelines for YANG Documents October 2018 4.22.1. Use of "leafref" for Key Correlation
4.22.1。 キーの相関に「leafref」を使用
Sometimes it is not practical to augment a data structure. For example, the correlated data could have different keys or contain mandatory nodes.
データ構造を拡張することが実際的でない場合があります。 たとえば、相関するデータに異なるキーが含まれていたり、必須ノードが含まれている可能性があります。
The following example shows the use of the "leafref" data type for data correlation purposes:
次の例は、データの相関を目的とした「leafref」データ型の使用を示しています。
Not preferred:
望ましくない：
list foo {
key name;
leaf name {
type string;
}
...
}
list foo-addon {
key name;
config false;
leaf name {
type string;
}
...
}
Preferred:
優先：
list foo {
key name;
leaf name {
type string;
}
...
}
list foo-addon {
key name;
config false;
leaf name {
type leafref {
path "/foo/name";
require-instance false;
}
}
leaf addon {
Bierman Best Current Practice [Page 46]
RFC 8407 Guidelines for YANG Documents October 2018
type string;
mandatory true;
}
}
4.23. Operational State
4.23。 運用状態
The modeling of operational state with YANG has been refined over time. At first, only data that has a "config" statement value of "false" was considered to be operational state. This data was not considered to be part of any datastore, which made the YANG XPath definition much more complicated.
YANGを使用した運用状態のモデリングは、時間とともに改良されました。 最初は、「config」ステートメントの値が「false」であるデータのみが動作状態であると見なされていました。 このデータはデータストアの一部とは見なされなかったため、YANG XPathの定義がはるかに複雑になりました。
Operational state is now modeled using YANG according to the new NMDA [RFC8342] and conceptually contained in the operational state datastore, which also includes the operational values of configuration data. There is no longer any need to duplicate data structures to provide separate configuration and operational state sections.
運用状態は、新しいNMDA [RFC8342]に従ってYANGを使用してモデル化され、概念的には運用状態データストアに含まれています。これには、構成データの運用値も含まれます。 個別の構成セクションと運用状態セクションを提供するためにデータ構造を複製する必要がなくなりました。
This section describes some data modeling issues related to operational state and guidelines for transitioning YANG data model design to be NMDA compatible.
このセクションでは、運用状態に関連するいくつかのデータモデリングの問題と、YANGデータモデル設計をNMDA互換に移行するためのガイドラインについて説明します。
4.23.1. Combining Operational State and Configuration Data
4.23.1。 運用状態と構成データの組み合わせ
If possible, operational state SHOULD be combined with its associated configuration data. This prevents duplication of key leafs and ancestor nodes. It also prevents race conditions for retrieval of dynamic entries and allows configuration and operational state to be retrieved together with minimal message overhead.
可能であれば、運用状態は、関連する構成データと組み合わせる必要があります（SHOULD）。 これにより、主要なリーフと祖先ノードの重複が防止されます。 また、動的エントリを取得するための競合状態を防ぎ、最小限のメッセージオーバーヘッドで構成および動作状態を取得できるようにします。
container foo {
...
// contains "config true" and "config false" nodes that have
// no corresponding "config true" object (e.g., counters)
}
4.23.2. Representing Operational Values of Configuration Data
4.23.2。 構成データの運用値の表現
If possible, the same data type SHOULD be used to represent the configured value and the operational value, for a given leaf or leaf- list object.
可能な場合は、同じデータタイプを使用して、特定のリーフまたはリーフリストオブジェクトの設定値と運用値を表す必要があります。
Sometimes the configured value set is different than the operational value set for that object, for example, the "admin-status" and "oper-status" leafs in [RFC8343]. In this case, a separate object MAY be used to represent the configured and operational values.
設定された値セットは、そのオブジェクトに設定されている運用値と異なる場合があります。たとえば、[RFC8343]の「admin-status」と「oper-status」はリーフになっています。 この場合、個別のオブジェクトを使用して、構成済みの操作可能な値を表すことができます。
Bierman Best Current Practice [Page 47] RFC 8407 Guidelines for YANG Documents October 2018 Sometimes the list keys are not identical for configuration data and the corresponding operational state. In this case, separate lists MAY be used to represent the configured and operational values.
場合によっては、リストキーが構成データと対応する動作状態で同一ではありません。 この場合、個別のリストを使用して、構成済みの値と操作可能な値を表すことができます。
If it is not possible to combine configuration and operational state, then the keys used to represent list entries SHOULD be the same type. The "leafref" data type SHOULD be used in operational state for key leafs that have corresponding configuration instances. The "require-instance" statement MAY be set to "false" (in YANG 1.1 modules only) to indicate instances are allowed in the operational state that do not exist in the associated configuration data.
構成と動作状態を組み合わせることができない場合、リストエントリを表すために使用されるキーは同じタイプである必要があります（SHOULD）。 「leafref」データ型は、対応する構成インスタンスを持つキーリーフの運用状態で使用する必要があります（SHOULD）。 「require-instance」ステートメントを「false」に設定して（YANG 1.1モジュールのみ）、関連する構成データに存在しないインスタンスが操作状態で許可されることを示すことができます。
The need to replicate objects or define different operational state objects depends on the data model. It is not possible to define one approach that will be optimal for all data models.
オブジェクトを複製したり、さまざまな動作状態オブジェクトを定義したりする必要性は、データモデルによって異なります。 すべてのデータモデルに最適な1つのアプローチを定義することはできません。
Designers SHOULD describe and justify any NMDA exceptions in detail, such as the use of separate subtrees and/or separate leafs. The "description" statements for both the configuration and the operational state SHOULD be used for this purpose.
設計者は、個別のサブツリーや個別のリーフの使用など、NMDAの例外を詳細に説明し、正当化する必要があります。 この目的のために、構成と運用状態の両方の「説明」ステートメントを使用する必要があります（SHOULD）。
4.23.3. NMDA Transition Guidelines
4.23.3。 NMDA移行ガイドライン
YANG modules SHOULD be designed with the assumption that they will be used on servers supporting the operational state datastore. With this in mind, YANG modules SHOULD define "config false" nodes wherever they make sense to the data model. "Config false" nodes SHOULD NOT be defined to provide the operational value for configuration nodes, except when the value space of a configured and operational value may differ, in which case a distinct "config false" node SHOULD be defined to hold the operational value for the configured node.
YANGモジュールは、運用状態データストアをサポートするサーバーで使用されることを想定して設計する必要があります（SHOULD）。 これを念頭に置いて、YANGモジュールは、データモデルにとって意味のある場所ならどこでも「config false」ノードを定義する必要があります。 構成ノードの運用値を提供するために「構成false」ノードを定義しないでください。ただし、構成値と運用値の値スペースが異なる場合は、運用値を保持するために「構成false」ノードを定義する必要があります（SHOULD）。 構成されたノード用。
The following guidelines are meant to help modelers develop YANG modules that will maximize the utility of the model with both current and new implementations.
次のガイドラインは、モデラーが現在の実装と新しい実装の両方でモデルのユーティリティを最大化するYANGモジュールを開発するのに役立つことを目的としています。
New modules and modules that are not concerned with the operational state of configuration information SHOULD immediately be structured to be NMDA compatible, as described in Section 4.23.1. This transition MAY be deferred if the module does not contain any configuration datastore objects.
セクション4.23.1で説明されているように、構成情報の動作状態に関係のない新しいモジュールおよびモジュールは、NMDA互換になるようにすぐに構造化する必要があります。 モジュールに構成データストアオブジェクトが含まれていない場合、この遷移は延期される可能性があります。
Bierman Best Current Practice [Page 48] RFC 8407 Guidelines for YANG Documents October 2018 The remaining are options that MAY be followed during the time that NMDA mechanisms are being defined.
残りは、NMDAメカニズムが定義されている間に従うことができるオプションです。
(a) Modules that require immediate support for the NMDA features
SHOULD be structured for NMDA. A temporary non-NMDA version of
this type of module MAY exist, as either an existing model or a
model created by hand or with suitable tools that mirror the
current modeling strategies. Both the NMDA and the non-NMDA
modules SHOULD be published in the same document, with NMDA
modules in the document main body and the non-NMDA modules in a
non-normative appendix. The use of the non-NMDA module will
allow temporary bridging of the time period until NMDA
implementations are available.
NMDA機能の即時サポートを必要とするモジュールは、NMDA用に構造化する必要があります（SHOULD）。 このタイプのモジュールの一時的な非NMDAバージョンは、既存のモデルとして、または手動で、または現在のモデリング戦略を反映する適切なツールを使用して作成されたモデルとして存在する場合があります。 NMDAモジュールと非NMDAモジュールの両方を同じドキュメントで公開する必要があります。ドキュメントの本文にはNMDAモジュールがあり、非規範的な付録には非NMDAモジュールがあります。 非NMDAモジュールを使用すると、NMDA実装が使用可能になるまでの期間を一時的にブリッジできます。
(b) For published models, the model should be republished with an
NMDA-compatible structure, deprecating non-NMDA constructs. For
example, the "ietf-interfaces" model in [RFC7223] has been
restructured as an NMDA-compatible model in [RFC8343]. The
"/interfaces-state" hierarchy has been marked "status
deprecated". Models that mark their "/foo-state" hierarchy with
"status deprecated" will allow NMDA-capable implementations to
avoid the cost of duplicating the state nodes, while enabling
non-NMDA-capable implementations to utilize them for access to
the operational values.
公開されたモデルの場合、モデルはNMDA互換の構造で再公開され、非NMDA構造は非推奨になります。 たとえば、[RFC7223]の「ietf-interfaces」モデルは、[RFC8343]のNMDA互換モデルとして再構築されています。 「/ interfaces-state」階層は「status deprecated」とマークされています。 「/ foo-state」階層を「非推奨のステータス」でマークするモデルを使用すると、NMDA対応の実装で状態ノードを複製するコストを回避しながら、NMDA非対応の実装で運用値へのアクセスにそれらを利用できるようになります。
(c) For models that augment models that have not been structured
with the NMDA, the modeler will have to consider the structure
of the base model and the guidelines listed above. Where
possible, such models should move to new revisions of the base
model that are NMDA compatible. When that is not possible,
augmenting "state" containers SHOULD be avoided, with the
expectation that the base model will be re-released with the
state containers marked as deprecated. It is RECOMMENDED to
augment only the "/foo" hierarchy of the base model. Where this
recommendation cannot be followed, then any new "state" elements
SHOULD be included in their own module.
NMDAで構造化されていないモデルを補強するモデルの場合、モデラーは、ベースモデルの構造と上記のガイドラインを考慮する必要があります。 可能であれば、そのようなモデルは、NMDA互換のベースモデルの新しいリビジョンに移動する必要があります。 それが不可能な場合は、「状態」コンテナの拡張を回避する必要があります（SHOULD）。非推奨としてマークされた状態コンテナで基本モデルが再リリースされることを期待しています。 基本モデルの「/ foo」階層のみを拡張することをお勧めします。 この推奨に従うことができない場合は、新しい「状態」要素を独自のモジュールに含める必要があります（SHOULD）。
4.23.3.1. Temporary Non-NMDA Modules
4.23.3.1。 一時的な非NMDAモジュール
A temporary non-NMDA module allows a non-NMDA-aware client to access operational state from an NMDA-compliant server. It contains the top-level "config false" data nodes that would have been defined in a legacy YANG module (before NMDA).
一時的な非NMDAモジュールを使用すると、非NMDA対応のクライアントがNMDA準拠サーバーから動作状態にアクセスできます。 これには、レガシーYANGモジュール（NMDAの前）で定義されていたトップレベルの「config false」データノードが含まれています。
A server that needs to support both NMDA and non-NMDA clients can advertise both the new NMDA module and the temporary non-NMDA module. A non-NMDA client can use separate "foo" and "foo-state" subtrees, except the "foo-state" subtree is located in a different (temporary) Bierman Best Current Practice [Page 49] RFC 8407 Guidelines for YANG Documents October 2018 module. The NMDA module can be used by a non-NMDA client to access the conventional configuration datastores and the deprecated <get> operation to access nested "config false" data nodes.
NMDAクライアントと非NMDAクライアントの両方をサポートする必要があるサーバーは、新しいNMDAモジュールと一時的な非NMDAモジュールの両方を通知できます。 非NMDAクライアントは、「foo-state」サブツリーが別の（一時的な）モジュールにあることを除いて、別個の「foo」および「foo-state」サブツリーを使用できます。 NMDAモジュールを非NMDAクライアントで使用して、従来の構成データストアにアクセスしたり、非推奨の<get>操作を使用して、ネストされた「config false」データノードにアクセスしたりできます。
To create the temporary non-NMDA model from an NMDA model, the following steps can be taken:
NMDAモデルから一時的な非NMDAモデルを作成するには、次の手順を実行できます。
o Change the module name by appending "-state" to the original
module name
元のモジュール名に「-state」を追加してモジュール名を変更します
o Change the namespace by appending "-state" to the original
namespace value
元のネームスペース値に「-state」を追加してネームスペースを変更します
o Change the prefix by appending "-s" to the original prefix value
元の接頭辞の値に「-s」を追加して接頭辞を変更します
o Add an import to the original module (e.g., for typedef
definitions)
元のモジュールにインポートを追加します（例：typedef定義用）
o Retain or create only the top-level nodes that have a "config"
statement value "false". These subtrees represent "config false"
data nodes that were combined into the configuration subtree;
therefore, they are not available to non-NMDA aware clients. Set
the "status" statement to "deprecated" for each new node.
「config」ステートメントの値が「false」である最上位ノードのみを保持または作成します。 これらのサブツリーは、構成サブツリーに結合された「config false」データノードを表します。 したがって、非NMDA対応のクライアントは使用できません。 新しいノードごとに「ステータス」ステートメントを「非推奨」に設定します。
o The module description SHOULD clearly identify the module as a
temporary non-NMDA module
モジュールの説明は、モジュールを一時的な非NMDAモジュールとして明確に識別する必要があります（SHOULD）。
4.23.3.2. Example: Create a New NMDA Module
4.23.3.2。 例：新しいNMDAモジュールを作成する
Create an NMDA-compliant module, using combined configuration and state subtrees, whenever possible.
可能な場合は常に、構成と状態のサブツリーを組み合わせて、NMDA準拠のモジュールを作成します。
module example-foo {
namespace "urn:example.com:params:xml:ns:yang:example-foo";
prefix "foo";
container foo {
// configuration data child nodes
// operational value in operational state datastore only
// may contain "config false" nodes as needed
}
}
Bierman Best Current Practice [Page 50]
RFC 8407 Guidelines for YANG Documents October 2018
4.23.3.3. Example: Convert an Old Non-NMDA Module
4.23.3.3。 例：古い非NMDAモジュールを変換する
Do not remove non-compliant objects from existing modules. Instead, change the status to "deprecated". At some point, usually after 1 year, the status MAY be changed to "obsolete".
非準拠オブジェクトを既存のモジュールから削除しないでください。 代わりに、ステータスを「非推奨」に変更してください。 ある時点で、通常は1年後、ステータスが「廃止」に変更される場合があります。
Old Module:
古いモジュール：
module example-foo {
namespace "urn:example.com:params:xml:ns:yang:example-foo";
prefix "foo";
container foo {
// configuration data child nodes
}
container foo-state {
config false;
// operational state child nodes
}
}
Converted NMDA Module:
変換されたNMDAモジュール：
module example-foo {
namespace "urn:example.com:params:xml:ns:yang:example-foo";
prefix "foo";
container foo {
// configuration data child nodes
// operational value in operational state datastore only
// may contain "config false" nodes as needed
// will contain any data nodes from old foo-state
}
// keep original foo-state but change status to deprecated
container foo-state {
config false;
status deprecated;
// operational state child nodes
}
}
Bierman Best Current Practice [Page 51]
RFC 8407 Guidelines for YANG Documents October 2018
4.23.3.4. Example: Create a Temporary NMDA Module
4.23.3.4。 例：一時的なNMDAモジュールを作成する
Create a new module that contains the top-level operational state data nodes that would have been available before they were combined with configuration data nodes (to be NMDA compliant).
構成データノード（NMDA準拠）と組み合わせる前に使用可能であったトップレベルの運用状態データノードを含む新しいモジュールを作成します。
module example-foo-state {
namespace "urn:example.com:params:xml:ns:yang:example-foo-state";
prefix "foo-s";
// import new or converted module; not used in this example
import example-foo { prefix foo; }
container foo-state {
config false;
status deprecated;
// operational state child nodes
}
}
4.24. Performance Considerations
4.24。 パフォーマンスに関する考慮事項
It is generally likely that certain YANG statements require more runtime resources than other statements. Although there are no performance requirements for YANG validation, the following information MAY be considered when designing YANG data models:
一般的に、特定のYANGステートメントは、他のステートメントよりも多くのランタイムリソースを必要とする可能性があります。 YANG検証のパフォーマンス要件はありませんが、YANGデータモデルを設計するときは、次の情報を考慮する必要があります。
o Lists are generally more expensive than containers
リストは一般的にコンテナよりも高価です
o "when" statement evaluation is generally more expensive than
"if-feature" or "choice" statements
「いつ」ステートメントの評価は、「if-feature」ステートメントや「choice」ステートメントよりも一般にコストがかかります。
o "must" statements are generally more expensive than "min-entries",
"max-entries", "mandatory", or "unique" statements
「必須」ステートメントは一般に、「最小エントリ」、「最大エントリ」、「必須」、または「一意」ステートメントよりも高価です。
o "identityref" leafs are generally more expensive than
"enumeration" leafs
「identityref」リーフは一般に「列挙」リーフよりも高価です
o "leafref" and "instance-identifier" types with "require-instance"
set to true are generally more expensive than if
"require-instance" is set to false
"require-instance"がtrueに設定された "leafref"および "instance-identifier"タイプは、 "require-instance"がfalseに設定されている場合よりも一般にコストが高くなります。
4.25. Open Systems Considerations
4.25。 オープンシステムに関する考慮事項
Only the modules imported by a particular module can be assumed to be present in an implementation. An open system MAY include any combination of YANG modules.
特定のモジュールによってインポートされたモジュールのみが実装に存在すると見なすことができます。 オープンシステムには、YANGモジュールの任意の組み合わせが含まれる場合があります。
Bierman Best Current Practice [Page 52] RFC 8407 Guidelines for YANG Documents October 2018 4.26. Guidelines for Constructs Specific to YANG 1.1
4.26。 YANG 1.1に固有の構文のガイドライン
The set of guidelines for YANG 1.1 will grow as operational experience is gained with the new language features. This section contains an initial set of guidelines for new YANG 1.1 language features.
YANG 1.1の一連のガイドラインは、新しい言語機能を使用して操作上の経験が得られるにつれて拡大します。 このセクションには、新しいYANG 1.1言語機能のガイドラインの初期セットが含まれています。
4.26.1. Importing Multiple Revisions
4.26.1。 複数のリビジョンのインポート
Standard modules SHOULD NOT import multiple revisions of the same module into a module. This MAY be done if independent definitions (e.g., enumeration typedefs) from specific revisions are needed in the importing module.
標準モジュールは、同じモジュールの複数のリビジョンをモジュールにインポートするべきではありません。 これは、インポートモジュールで特定のリビジョンからの独立した定義（列挙型のtypedefなど）が必要な場合に実行できます。
4.26.2. Using Feature Logic
4.26.2。 機能ロジックの使用
The YANG 1.1 feature logic is much more expressive than YANG 1.0. A "description" statement SHOULD describe the "if-feature" logic in text, to help readers understand the module.
YANG 1.1機能ロジックは、YANG 1.0よりもはるかに表現力があります。 「説明」ステートメントは、読者がモジュールを理解できるように、「if-feature」ロジックをテキストで記述する必要があります（SHOULD）。
YANG features SHOULD be used instead of the "when" statement, if possible. Features are advertised by the server, and objects conditional by the "if-feature" statement are conceptually grouped together. There is no such commonality supported for "when" statements.
可能な場合は、「when」ステートメントの代わりにYANG機能を使用する必要があります。 機能はサーバーによってアドバタイズされ、「if-feature」ステートメントによって条件付きのオブジェクトは概念的に一緒にグループ化されます。 「when」ステートメントでサポートされるそのような共通性はありません。
Features generally require less server implementation complexity and runtime resources than objects that use "when" statements. Features are generally static (i.e., set when a module is loaded and not changed at runtime). However, every client edit might cause a "when" statement result to change.
通常、機能は、「when」ステートメントを使用するオブジェクトよりもサーバー実装の複雑さとランタイムリソースが少なくて済みます。 機能は一般に静的です（つまり、モジュールがロードされたときに設定され、実行時に変更されません）。 ただし、すべてのクライアント編集により、「when」ステートメントの結果が変更される可能性があります。
4.26.3. "anyxml" versus "anydata"
4.26.3。 「anyxml」対「anydata」
The "anyxml" statement MUST NOT be used to represent a conceptual subtree of YANG data nodes. The "anydata" statement MUST be used for this purpose.
「anyxml」ステートメントは、YANGデータノードの概念的なサブツリーを表すために使用してはなりません。 このためには、「anydata」ステートメントを使用する必要があります。
4.26.4. "action" versus "rpc"
4.26.4。 「アクション」対「rpc」
The use of "action" statements or "rpc" statements is a subjective design decision. RPC operations are not associated with any particular data node. Actions are associated with a specific data node definition. An "action" statement SHOULD be used if the protocol operation is specific to a subset of all data nodes instead of all possible data nodes.
「アクション」ステートメントまたは「rpc」ステートメントの使用は、主観的な設計上の決定です。 RPC操作は特定のデータノードに関連付けられていません。 アクションは特定のデータノード定義に関連付けられています。 プロトコル操作がすべての可能なデータノードではなく、すべてのデータノードのサブセットに固有である場合は、「アクション」ステートメントを使用する必要があります（SHOULD）。
Bierman Best Current Practice [Page 53] RFC 8407 Guidelines for YANG Documents October 2018 The same action name MAY be used in different definitions within different data node. For example, a "reset" action defined with a data node definition for an interface might have different parameters than for a power supply or a VLAN. The same action name SHOULD be used to represent similar semantics.
同じアクション名が、異なるデータノード内の異なる定義で使用される場合があります。 たとえば、インターフェースのデータノード定義で定義された「リセット」アクションには、電源またはVLANの場合とは異なるパラメーターがある場合があります。 同じアクション名を使用して、類似のセマンティクスを表す必要があります（SHOULD）。
The NETCONF Access Control Model (NACM) [RFC8341] does not support parameter-based access control for RPC operations. The user is given permission (or not) to invoke the RPC operation with any parameters. For example, if each client is only allowed to reset their own interface, then NACM cannot be used.
NETCONFアクセス制御モデル（NACM）[RFC8341]は、RPC操作のパラメーターベースのアクセス制御をサポートしていません。 ユーザーには、任意のパラメーターを使用してRPC操作を呼び出すための許可が与えられます（または与えられません）。 たとえば、各クライアントが自身のインターフェースのリセットのみを許可されている場合、NACMは使用できません。
For example, NACM cannot enforce access control based on the value of the "interface" parameter, only the "reset" operation itself:
たとえば、NACMは「インターフェース」パラメーターの値に基づいてアクセス制御を実施できません。「リセット」操作のみを実施できます。
rpc reset {
input {
leaf interface {
type if:interface-ref;
mandatory true;
description "The interface to reset.";
}
}
}
However, NACM can enforce access control for individual interface
instances, using a "reset" action. If the user does not have read
access to the specific "interface" instance, then it cannot invoke
the "reset" action for that interface instance:
ただし、NACMは「リセット」アクションを使用して、個々のインターフェースインスタンスのアクセス制御を実施できます。 ユーザーが特定の「インターフェース」インスタンスへの読み取りアクセス権を持っていない場合、そのインターフェースインスタンスの「リセット」アクションを呼び出すことができません。
container interfaces {
list interface {
...
action reset { }
}
}
4.27. Updating YANG Modules (Published versus Unpublished)
4.27。 YANGモジュールの更新（公開済みと未公開）
YANG modules can change over time. Typically, new data model definitions are needed to support new features. YANG update rules defined in Section 11 of [RFC7950] MUST be followed for published modules. They MAY be followed for unpublished modules.
YANGモジュールは時間とともに変化する可能性があります。 通常、新しい機能をサポートするには、新しいデータモデル定義が必要です。 [RFC7950]のセクション11で定義されているYANG更新規則は、公開されたモジュールに対して従わなければなりません。 未公開のモジュールについては、それらをフォローすることができます。
The YANG update rules only apply to published module revisions. Each organization will have their own way to identify published work that is considered to be stable and unpublished work that is considered to Bierman Best Current Practice [Page 54] RFC 8407 Guidelines for YANG Documents October 2018 be unstable. For example, in the IETF, the RFC document is used for published work, and the I-D is used for unpublished work.
YANG更新ルールは、公開されたモジュールリビジョンにのみ適用されます。 各組織は、安定していると見なされている公開済みの作業と、不安定であると見なされている未公開の作業を識別する独自の方法を備えています。 たとえば、IETFでは、RFCドキュメントは公開済みの作業に使用され、I-Dは未公開の作業に使用されます。
5. IANA Considerations
5. IANAに関する考慮事項
The following registration in the "ns" subregistry of the "IETF XML Registry" [RFC3688] was detailed in [RFC6087] and has been updated by IANA to reference this document.
「IETF XMLレジストリ」[RFC3688]の「ns」サブレジストリでの次の登録は、[RFC6087]で詳述されており、このドキュメントを参照するようにIANAによって更新されています。
URI: urn:ietf:params:xml:ns:yang:ietf-template
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
The following assignment was detailed in [RFC6087] and has been
updated by IANA in the "YANG Module Names" registry. This document
has also been added as a reference for the "YANG Module Names"
registry itself as it contains the template necessary for
registration in Appendix B.
次の割り当ては[RFC6087]で詳しく説明されており、「YANG Module Names」レジストリのIANAによって更新されています。 このドキュメントには、付録Bでの登録に必要なテンプレートが含まれているため、「YANGモジュール名」レジストリ自体の参照としても追加されています。
+-----------+-------------------------------------------+
| Field | Value |
+-----------+-------------------------------------------+
| Name | ietf-template |
| Namespace | urn:ietf:params:xml:ns:yang:ietf-template |
| Prefix | temp |
| Reference | RFC 8407 |
+-----------+-------------------------------------------+
YANG Registry Assignment
6. Security Considerations
6.セキュリティに関する考慮事項
This document defines documentation guidelines for NETCONF or RESTCONF content defined with the YANG data modeling language; therefore, it does not introduce any new or increased security risks into the management system.
このドキュメントは、YANGデータモデリング言語で定義されたNETCONFまたはRESTCONFコンテンツのドキュメントガイドラインを定義しています。 したがって、管理システムに新しいセキュリティリスクや増加したセキュリティリスクをもたらすことはありません。
Bierman Best Current Practice [Page 55]
RFC 8407 Guidelines for YANG Documents October 2018
7. References
7.1. Normative References
[ID-Guidelines]
Housley, R., "Guidelines to Authors of Internet-Drafts",
December 2010,
<https://www.ietf.org/standards/ids/guidelines/>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>.
[RFC5378] Bradner, S., Ed. and J. Contreras, Ed., "Rights
Contributors Provide to the IETF Trust", BCP 78, RFC 5378,
DOI 10.17487/RFC5378, November 2008,
<https://www.rfc-editor.org/info/rfc5378>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
Bierman Best Current Practice [Page 56]
RFC 8407 Guidelines for YANG Documents October 2018
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
[W3C.REC-xpath]
Clark, J. and S. DeRose, "XML Path Language (XPath)
Version 1.0", W3C Recommendation REC-xpath-19991116,
November 1999,
<http://www.w3.org/TR/1999/REC-xpath-19991116>.
7.2. Informative References
[IANA-MOD-NAMES]
IANA, "YANG Module Names",
<https://www.iana.org/assignments/yang-parameters/>.
[IANA-XML] IANA, "IETF XML Registry",
<https://www.iana.org/assignments/xml-registry/>.
[RFC-STYLE]
RFC Editor, "Style Guide",
<http://www.rfc-editor.org/styleguide/>.
[RFC2026] Bradner, S., "The Internet Standards Process -- Revision
3", BCP 9, RFC 2026, DOI 10.17487/RFC2026, October 1996,
<https://www.rfc-editor.org/info/rfc2026>.
[RFC4151] Kindberg, T. and S. Hawke, "The 'tag' URI Scheme",
RFC 4151, DOI 10.17487/RFC4151, October 2005,
<https://www.rfc-editor.org/info/rfc4151>.
[RFC4181] Heard, C., Ed., "Guidelines for Authors and Reviewers of
MIB Documents", BCP 111, RFC 4181, DOI 10.17487/RFC4181,
September 2005, <https://www.rfc-editor.org/info/rfc4181>.
Bierman Best Current Practice [Page 57]
RFC 8407 Guidelines for YANG Documents October 2018
[RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG
Data Model Documents", RFC 6087, DOI 10.17487/RFC6087,
January 2011, <https://www.rfc-editor.org/info/rfc6087>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7223] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 7223, DOI 10.17487/RFC7223, May 2014,
<https://www.rfc-editor.org/info/rfc7223>.
[RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322,
DOI 10.17487/RFC7322, September 2014,
<https://www.rfc-editor.org/info/rfc7322>.
[RFC7841] Halpern, J., Ed., Daigle, L., Ed., and O. Kolkman, Ed.,
"RFC Streams, Headers, and Boilerplates", RFC 7841,
DOI 10.17487/RFC7841, May 2016,
<https://www.rfc-editor.org/info/rfc7841>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/info/rfc8126>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC8343] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 8343, DOI 10.17487/RFC8343, March 2018,
<https://www.rfc-editor.org/info/rfc8343>.
[RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
Routing Management (NMDA Version)", RFC 8349,
DOI 10.17487/RFC8349, March 2018,
<https://www.rfc-editor.org/info/rfc8349>.
Bierman Best Current Practice [Page 58]
RFC 8407 Guidelines for YANG Documents October 2018
Appendix A. Module Review Checklist
付録A.モジュールレビューチェックリスト
This section is adapted from RFC 4181.
このセクションはRFC 4181を基にしています。
The purpose of a YANG module review is to review the YANG module for both technical correctness and adherence to IETF documentation requirements. The following checklist may be helpful when reviewing an I-D:
YANGモジュールのレビューの目的は、技術的な正確性とIETFのドキュメント要件の遵守の両方についてYANGモジュールをレビューすることです。 次のチェックリストは、I-Dを確認するときに役立ちます。
o I-D Boilerplate -- verify that the document contains the required
I-D boilerplate (see <https://www.ietf.org/id-info/
guidelines.html>), including the appropriate statement to permit
publication as an RFC, and that the I-D boilerplate does not
contain references or section numbers.
IDボイラープレート-ドキュメントに必要なIDボイラープレート（<https://www.ietf.org/id-info/guidelines.html>を参照）が含まれていて、RFCとして公開できるようにする適切なステートメントが含まれていること、および IDボイラープレートには、参照番号やセクション番号は含まれていません。
o Abstract -- verify that the abstract does not contain references,
that it does not have a section number, and that its content
follows the guidelines in <https://www.ietf.org/id-info/
guidelines.html>.
要約-要約に参照が含まれていないこと、セクション番号がないこと、およびその内容が<https://www.ietf.org/id-info/guideline.html>のガイドラインに従っていることを確認します。
o Copyright Notice -- verify that the document has the appropriate
text regarding the rights that document contributors provide to
the IETF Trust [RFC5378]. Verify that it contains the full IETF
Trust copyright notice at the beginning of the document. The IETF
Trust Legal Provisions (TLP) can be found at:
著作権通知-ドキュメントの寄稿者がIETF Trust [RFC5378]に提供する権利に関する適切なテキストがドキュメントに含まれていることを確認してください。 ドキュメントの冒頭に、IETF Trustの著作権表示がすべて含まれていることを確認してください。 IETF Trust Legal Provisions（TLP）は次の場所にあります。
<https://trustee.ietf.org/license-info/>
o Security Considerations section -- verify that the document uses
the latest approved template from the Operations and Management
(OPS) area website (see <https://trac.ietf.org/area/ops/trac/wiki/
yang-security-guidelines>) and that the guidelines therein have
been followed.
「セキュリティに関する考慮事項」セクション-ドキュメントが、運用と管理（OPS）エリアのWebサイトから最新の承認済みテンプレートを使用していることを確認します（<https://trac.ietf.org/area/ops/trac/wiki/ yang-security-guidelinesを参照） >）そしてその中のガイドラインが守られていること。
o IANA Considerations section -- this section must always be
present. For each module within the document, ensure that the
IANA Considerations section contains entries for the following
IANA registries:
IANAの考慮事項セクション-このセクションは常に存在している必要があります。 ドキュメント内の各モジュールについて、IANAの考慮事項セクションに次のIANAレジストリのエントリが含まれていることを確認してください。
XML Namespace Registry: Register the YANG module namespace.
XML名前空間レジストリ：YANGモジュール名前空間を登録します。
YANG Module Registry: Register the YANG module name, prefix,
namespace, and RFC number, according to the rules specified in
[RFC6020].
YANGモジュールレジストリ：[RFC6020]で指定された規則に従って、YANGモジュール名、プレフィックス、ネームスペース、およびRFC番号を登録します。
Bierman Best Current Practice [Page 59]
RFC 8407 Guidelines for YANG Documents October 2018
o References -- verify that the references are properly divided
between normative and informative references, that RFCs 2119 and
8174 are included as normative references if the terminology
defined therein is used in the document, that all references
required by the boilerplate are present, that all YANG modules
containing imported items are cited as normative references, and
that all citations point to the most current RFCs, unless there is
a valid reason to do otherwise (for example, it is okay to include
an informative reference to a previous version of a specification
to help explain a feature included for backward compatibility).
Be sure citations for all imported modules are present somewhere
in the document text (outside the YANG module). If a YANG module
contains reference or "description" statements that refer to an
I-D, then the I-D is included as an informative reference.
参考資料-参考資料が参考資料と参考資料に適切に分割されていること、RFC 2119および8174が規範的な参考資料として含まれていることを確認します。 インポートされたアイテムを含むモジュールは、規範的な参照として引用されており、他の方法で行う正当な理由がない限り、すべての引用は最新のRFCを指します（たとえば、以前のバージョンの仕様への有益な参照を含めても問題ありません） 下位互換性のために含まれている機能の説明に役立ちます）。 インポートされたすべてのモジュールの引用がドキュメントのテキストのどこかにあることを確認してください（YANGモジュールの外）。 YANGモジュールにI-Dを参照する参照または「説明」ステートメントが含まれている場合、I-Dは参考情報として含まれています。
o License -- verify that the document contains the Simplified BSD
License in each YANG module or submodule. Some guidelines related
to this requirement are described in Section 3.1. Make sure that
the correct year is used in all copyright dates. Use the approved
text from the latest TLP document, which can be found at:
ライセンス-ドキュメントに各YANGモジュールまたはサブモジュールのSimplified BSD Licenseが含まれていることを確認します この要件に関連するいくつかのガイドラインについては、セクション3.1で説明します。 すべての著作権の日付に正しい年が使用されていることを確認してください。 次の場所にある最新のTLPドキュメントから承認されたテキストを使用します。
<https://trustee.ietf.org/license-info/>
o Other Issues -- check for any issues mentioned in
<https://www.ietf.org/id-info/checklist.html> that are not covered
elsewhere.
その他の問題-<https://www.ietf.org/id-info/checklist.html>で言及されており、他ではカバーされていない問題がないか確認してください。
o Technical Content -- review the actual technical content for
compliance with the guidelines in this document. The use of a
YANG module compiler is recommended when checking for syntax
errors. A list of freely available tools and other information,
including formatting advice, can be found at:
技術コンテンツ-このドキュメントのガイドラインに準拠しているかどうか、実際の技術コンテンツを確認してください。 構文エラーをチェックする場合は、YANGモジュールコンパイラの使用をお勧めします。 自由に利用できるツールとフォーマットのアドバイスを含むその他の情報のリストは、次の場所にあります。
<https://trac.ietf.org/trac/netconf/wiki>
and
<https://trac.ietf.org/trac/netmod/wiki>
Checking for correct syntax, however, is only part of the job.
It is just as important to actually read the YANG module document
from the point of view of a potential implementor. It is
particularly important to check that "description" statements are
sufficiently clear and unambiguous to allow interoperable
implementations to be created.
ただし、正しい構文のチェックは、ジョブの一部にすぎません。 潜在的な実装者の観点からYANGモジュールのドキュメントを実際に読むことも同じくらい重要です。 「説明」ステートメントが十分に明確で明確であることを確認して、相互運用可能な実装を作成できるようにすることが特に重要です。
Bierman Best Current Practice [Page 60]
RFC 8407 Guidelines for YANG Documents October 2018
Appendix B. YANG Module Template
<CODE BEGINS> file "ietf-template@2016-03-20.yang"
module ietf-template {
yang-version 1.1;
// replace this string with a unique namespace URN value
namespace "urn:ietf:params:xml:ns:yang:ietf-template";
// replace this string, and try to pick a unique prefix
prefix temp;
// import statements here: e.g.,
// import ietf-yang-types { prefix yang; }
// import ietf-inet-types { prefix inet; }
// identify the IETF working group if applicable
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
// update this contact statement with your info
contact
"WG Web: <http://datatracker.ietf.org/wg/your-wg-name/>
WG List: <mailto:your-wg-name@ietf.org>
Editor: your-name
<mailto:your-email@example.com>";
// replace the first sentence in this description statement.
// replace the copyright notice with the most recent
// version, if it has been updated since the publication
// of this document
description
"This module defines a template for other YANG modules.
Copyright (c) <insert year> IETF Trust and the persons
identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Bierman Best Current Practice [Page 61]
RFC 8407 Guidelines for YANG Documents October 2018
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove
// this note
// replace '2016-03-20' with the module publication date
// the format is (year-month-day)
revision 2016-03-20 {
description
"what changed in this revision";
reference "RFC XXXX: <Replace With Document Title>";
}
// extension statements
// feature statements
// identity statements
// typedef statements
// grouping statements
// data definition statements
// augment statements
// rpc statements
// notification statements
// DO NOT put deviation statements in a published module
}
<CODE ENDS>
Acknowledgments
The structure and contents of this document are adapted from
"Guidelines for Authors and Reviewers of MIB Documents" [RFC4181], by
C. M. Heard.
The working group thanks Martin Bjorklund, Juergen Schoenwaelder,
Ladislav Lhotka, Jernej Tuljak, Lou Berger, Robert Wilton, Kent
Watsen, and William Lupton for their extensive reviews and
contributions to this document.
Bierman Best Current Practice [Page 62]
RFC 8407 Guidelines for YANG Documents October 2018
Author's Address
Andy Bierman
YumaWorks
Email: andy@yumaworks.com
Bierman Best Current Practice [Page 63]