[要約] RFC 9196は、システムとデータストアの更新通知の能力を記述するためのYANGモジュールに関するものです。この文書の目的は、ネットワーク機器やアプリケーションが変更を効率的に通知し合える標準的な方法を提供することです。主に、ネットワーク管理や自動化の文脈で利用されます。
Internet Engineering Task Force (IETF) B. Lengyel
Request for Comments: 9196 Ericsson
Category: Standards Track A. Clemm
ISSN: 2070-1721 Futurewei
B. Claise
Huawei
February 2022
YANG Modules Describing Capabilities for Systems and Datastore Update Notifications
システムとデータストアの更新通知の機能を説明するYANGモジュール
Abstract
概要
This document defines two YANG modules, "ietf-system-capabilities" and "ietf-notification-capabilities".
このドキュメントでは、「IETFシステム機能」、「IETF-Notification-Capabilities」2つのYANGモジュールを定義します。
The module "ietf-system-capabilities" provides a placeholder structure that can be used to discover YANG-related system capabilities for servers. The module can be used to report capability information from the server at runtime or at implementation time by making use of the YANG instance data file format.
モジュール「IETF-System-Capabilities」は、サーバーのYANG関連のシステム機能を検出するために使用できるプレースホルダ構造を提供します。このモジュールは、実行時または実行時にサーバからの機能情報を報告するために、YANNインスタンスデータファイル形式を使用することによって、サーバーからの機能情報を報告することができます。
The module "ietf-notification-capabilities" augments "ietf-system-capabilities" to specify capabilities related to "Subscription to YANG Notifications for Datastore Updates" (RFC 8641).
モジュール「IETF-Notification-Capabilities」は「IETF-System-Capabilities」を増強して、「データストア更新のためのヤン通知への購読」（RFC 8641）を指定します。
Status of This Memo
本文書の位置付け
This is an Internet Standards Track document.
これはインターネット規格のトラック文書です。
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.
この文書はインターネットエンジニアリングタスクフォース（IETF）の製品です。IETFコミュニティのコンセンサスを表します。それはパブリックレビューを受け、インターネットエンジニアリングステアリンググループ（IESG）による出版の承認を受けました。インターネット規格に関する詳細情報は、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/rfc9196.
この文書の現在のステータス、任意のエラータ、およびフィードバックを提供する方法は、https://www.rfc-editor.org/info/rfc9196で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2022 IETF Trust and the persons identified as the document authors. All rights reserved.
著作権（c）2022 IETF信頼と文書の著者として識別された人。全著作権所有。
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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.
この文書は、この文書の公開日に有効なIETF文書（https://trustee.ietf.org/License-Info）に関するBCP 78およびIETF信頼の法的規定の対象となります。この文書に関してあなたの権利と制限を説明するので、これらの文書をよくレビューしてください。この文書から抽出されたコードコンポーネントには、信託法定規定のセクション4。
Table of Contents
目次
1. Introduction
1.1. Terminology
2. Providing System Capability Information
3. Providing YANG-Push Notification Capabilities Information
4. System Capabilities Model
4.1. Tree Diagram
4.2. YANG Module
5. Notification Capabilities Model
5.1. Tree Diagram
5.2. YANG Module
6. Security Considerations
7. IANA Considerations
7.1. The IETF XML Registry
7.2. The YANG Module Names Registry
8. References
8.1. Normative References
8.2. Informative References
Appendix A. Instance Data Example #1
Appendix B. Instance Data Example #2
Acknowledgments
Authors' Addresses
Servers and/or publishers often have capabilities, which can be represented by values that designate operational behavior, that need to be conveyed to clients. The YANG modules that are defined in this document facilitate this.
サーバーおよび/または出版社はしばしば能力を持っています。これは、顧客に伝えられる必要がある運用行動を示す値で表すことができます。この文書で定義されているYangモジュールはこれを容易にします。
There is a need to publish this capability information as it is part of the API contract between the server and client. Examples include the maximum size of data that can be stored or transferred, information about counters (whether a node supports "on-change" telemetry), etc. Such capabilities are often dependent on a vendor's implementation or the available resources at deployment. Many such capabilities are specific to the complete system, individual YANG datastores [RFC8342], specific parts of the YANG schema, or even individual data nodes. It is a goal of this document to provide a common way to represent such capabilities in a format that is:
サーバーとクライアントの間のAPI契約の一部であるため、この機能情報を公開する必要があります。例としては、格納または転送することができるデータの最大サイズ、カウンタに関する情報（ノードがサポートしているかどうか）などの情報などがあります。そのような機能は、展開時のベンダーの実装または利用可能なリソースに依存します。多くのそのような機能は、完全なシステム、個々のYANGデータストア[RFC8342]、YANGスキーマの特定の部分、さらには個々のデータノードに固有のものです。この文書の目的は、次のような形式でそのような機能を表す一般的な方法を提供することです。
* vendor independent,
* ベンダーに依存しない、
* machine readable, and
* 機械読みやすい、そして
* available in an identical format both at implementation time and at runtime.
* 実装時と実行時の両方で同じ形式で利用可能です。
Implementation-time information is needed by Network Management System (NMS) implementers. An NMS implementation that supports notifications needs information about a system's capability so it can send "on-change" notifications. If the information is not documented in a way that is readily available to the NMS designer, but only as instance data from the network node once it is deployed, the NMS implementation will be delayed because it has to wait for the network node to be ready. In addition, the assumption that all NMS implementers will have a correctly configured network node available from which to retrieve data is an expensive proposition and may not always hold. (An NMS may need to be able to handle many dozens of network node types.) Often, a fully functional NMS is a requirement for introducing a new network node type into a network, so delaying NMS readiness effectively also delays the time at which a new network node type can be introduced into the network.
実装時刻情報は、ネットワーク管理システム（NMS）実装者によって必要です。通知をサポートするNMS実装は、システムの機能に関する情報を必要とし、「変更内容」通知を送信できるようにします。情報がNMSデザイナで容易に利用できるような方法で文書化されていない場合は、ネットワークノードからのインスタンスデータとしてのみデプロイされている場合、ネットワークノードが準備ができているのを待つため、NMS実装は遅延されます。。さらに、すべてのNMS実装者がデータを検索する正しく構成されたネットワークノードを持つと仮定すると、データを検索することは高価な命題です。（NMSは多くのダースのネットワークノードタイプを処理できる場合があります）しばしば、完全に機能的なNMSはネットワークに新しいネットワークノードタイプを導入するための要件であるため、NMSの準備が効果的に遅れると、新しいネットワークノードタイプをネットワークに導入することができます。
Implementation-time information is needed by system integrators. When introducing a network node type into their network, operators often need to integrate the node type into their own management system. The NMS may have management functions that depend on "on-change" notifications. The network operators need to plan their management practices and NMS implementation before they decide to buy the specific network node type. Moreover, the decision to buy the node type sometimes depends on these management possibilities.
実装時刻情報はシステムインテグレータによって必要です。ネットワークノードタイプをネットワークに導入するとき、オペレータはノードタイプを自分の管理システムに統合する必要があります。NMSには、「変更内」通知に依存する管理機能があります。ネットワークオペレータは、特定のネットワークノードタイプを購入することを決定する前に、管理慣行およびNMS実装を計画する必要があります。さらに、ノードタイプを購入するという決定は、これらの管理の可能性によって異なります。
Runtime capability information is needed:
実行時機能情報が必要です。
* for any "purely model-driven" application, e.g., a NETCONF browser. Such applications depend on reading models and capabilities at runtime to support all the publisher's available functionality.
* 任意の「純粋にモデル駆動される」アプリケーション、例えばNetConfブラウザについて。そのようなアプリケーションは、実行時のモデルと機能を読み取ることによって異なります.Publisherの利用可能な機能をすべてサポートします。
* in case the capability might change during runtime, e.g., due to licensing, hardware constraints, etc.
* 実行時に機能が変わる可能性がある場合は、例えばライセンス、ハードウェアの制約などによるものです。
* to check that that capability information provided earlier, at implementation time, is what the publisher has implemented.
* 実装時に、以前に提供された機能情報が実行時に実行されたことを確認するには、発行者が実装したものです。
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", "MAY", および "OPTIONAL" はBCP 14 [RFC2119] [RFC8174]で説明されているように、すべて大文字の場合にのみ解釈されます。
The terms "YANG-Push", "on-change subscription", and "periodic subscription" are used as defined in [RFC8641].
「Yang-Push」、「変更上購読」、および「定期的な購読」という用語は、[RFC8641]で定義されています。
The terms "subscriber", "publisher", and "receiver" are used as defined in [RFC8639].
「加入者」、「発行者」、および「受信機」は、[RFC8639]で定義されているように使用されます。
The term "server" is used as defined in [RFC8342].
「サーバー」という用語は[RFC8342]で定義されているように使用されます。
The terms "YANG instance data file format", "instance data", and "instance data set" are used as defined in [RFC9195].
「YANSインスタンスデータファイル形式」、「インスタンスデータ」、および「インスタンスデータセット」という用語は、[RFC9195]で定義されているように使用されます。
In addition, this document defines the following terms:
さらに、この文書は以下の条件を定義しています。
Implementation-time information: Information about the server's behavior that is made available during the implementation of the server, available from a source other than a running server.
実装時刻情報：実行中のサーバー以外のソースから入手可能なサーバーの実装中に使用可能にされるサーバーの動作に関する情報。
Runtime information: Information about the server's behavior that is available from the running server via management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040].
ランタイム情報：NetConf [RFC6241]またはRESTCONF [RFC8040]などの管理プロトコルを介して実行中のサーバーから入手可能なサーバーの動作に関する情報。
Capability information is represented by instance data based on one or more "capability-defining YANG modules". This allows a user to discover capabilities both at implementation time and at runtime.
能力情報は、1つ以上の「機能定義YANGモジュール」に基づくインスタンスデータによって表されます。これにより、ユーザーは実装時と実行時の両方で機能を検出できます。
For the implementation-time use case: Capabilities SHOULD be provided by the implementer as YANG instance data files complying with [RFC9195]. When provided, the file MUST already be available at implementation time and retrievable in a way that does not depend on a live network node, e.g., downloading from a product website.
実装時の使用例の場合：[RFC9195]に準拠したYangインスタンスデータファイルとして実装者によって機能を提供する必要があります。提供されると、ファイルはすでに実装時に利用可能でなければなりません。
For the runtime use case: Capabilities SHOULD be available via NETCONF [RFC6241] or RESTCONF [RFC8040] from the live server (implementing the publisher) during runtime. Implementations that support changing these capabilities at runtime SHOULD support "on-change" notifications about the system-capabilities container.
ランタイムユースケースの場合、実行時にライブサーバーからのNetConf [RFC6241]またはRESTCONF [RFC8040]を介して使用できるようになります。実行時にこれらの機能を変更する実装は、システム機能コンテナに関する「変更内容」通知をサポートする必要があります。
The module "ietf-system-capabilities" provides a placeholder structure to be used to specify any YANG-related system capability.
モジュール「IETF-System-Capabilities」は、Yang関連のシステム機能を指定するために使用されるプレースホルダ構造を提供します。
The module "ietf-notification-capabilities" is defined to allow a publisher to specify capabilities related to "Subscription to YANG Notifications for Datastore Updates" [RFC8641], also known as YANG-Push, augmenting "ietf-system-capabilities".
モジュール「IETF-Notification-Capabilities」は、パブリッシャが「データストア更新のためのヤン通知の購読」[RFC8641]に関連する機能を指定し、「IETFシステム機能」を増大させることができます。
The YANG data models in this document conform to the Network Management Datastore Architecture (NMDA) defined in [RFC8342].
この文書のYANDデータモデルは、[RFC8342]で定義されているネットワーク管理データストアアーキテクチャ（NMDA）に準拠しています。
A specific case is the need to specify capabilities in the YANG-Push functionality. As defined in [RFC8641], a publisher may allow subscribers to subscribe to updates from a datastore and will subsequently push such update notifications to the receiver. Notifications may be sent periodically or "on change" (more or less immediately after each change).
特定の場合は、Yang-Push機能に機能を指定する必要があります。[RFC8641]で定義されているように、発行者は、加入者がデータストアからの更新を購読することを可能にし、その後そのような更新通知を受信者にプッシュすることができる。通知は定期的にまたは「変更時に」（各変更後に多かれ少なかれ）送信されてもよい。
A publisher supporting YANG-Push has a number of capabilities defined in [RFC8641] that are often determined during the implementation of the publisher. These include:
Yang-Pushをサポートする出版社には、発行者の実装中にしばしば決定される[RFC8641]で定義されている機能がいくつかあります。これらは次のとおりです。
* supported (reporting) periods for "periodic" subscriptions.
* 「定期的な」サブスクリプションのサポートされている（報告）期間。
* the maximum number of objects that can be sent in an update.
* アップデートで送信できるオブジェクトの最大数。
* the set of datastores or data nodes for which "periodic" notification is supported.
* 「周期的な」通知がサポートされているデータストアまたはデータノードのセット。
Additional capabilities if the optional "on-change" feature is supported include:
オプションの「変更内容」機能がサポートされている場合は、追加機能が含まれています。
* supported dampening periods for "on-change" subscriptions.
* 「変更中」の購読のための減衰期間をサポートしました。
* the set of datastores or data nodes for which "on-change" notification is supported.
* 「変更内容」通知がサポートされているデータストアまたはデータノードのセット。
Publishers might have some capabilities (or limitations) to document -- for example, how many update notifications and how many datastore node updates they can send out in a certain time period. Other publishers might not support "periodic" subscriptions to all datastores. In some cases, a publisher supporting "on-change" notifications will not be able to push updates for some object types "on change". Reasons for this might be that the value of the datastore node changes frequently (e.g., in-octet counter), that small object changes are frequent and irrelevant to the receiver (e.g., a temperature gauge changing 0.1 degrees within a predetermined and acceptable range), or that the implementation is not capable of on-change notification for a particular object. In all those cases, it will be important for subscriber applications to have a way to identify the objects for which "on-change" notifications are supported and the objects for which they are not.
出版社には、文書化する機能（または制限事項）がある可能性があります。たとえば、たとえば、一定期間内に送信できるデータストアノードの更新の数といくつのデータストアノードの更新がいくつかあります。他の出版社は、すべてのデータストアに対して「周期的な」サブスクリプションをサポートしていない可能性があります。場合によっては、「変更内容」通知をサポートしている発行者は、いくつかのオブジェクト型「変更時に」の更新をプッシュすることはできません。この理由は、データストアノードの値が頻繁に（例えば、八オクテットカウンタ）が変化し、その小さなオブジェクトの変更は頻繁であり、受信機とは無関係であり（例えば、所定のおよび許容可能な範囲内の0.1度の変化）。あるいは、実装は特定のオブジェクトに対して変更された通知ができないことです。これらすべての場合において、加入者アプリケーションには、「変更内」通知がサポートされていないオブジェクトとそれらがそうでないオブジェクトを特定する方法が重要になるでしょう。
Support for "on-change" notifications does not mean that such notifications will be sent for any specific data node, as the ability to do so may not be supported for every data node. Therefore, subscriber/management applications cannot rely on the "on-change" functionality unless the subscriber has some means to identify the objects for which "on-change" notifications are in fact supported. YANG data models are meant to be used as an interface contract. Without identification of the data nodes actually supporting "on-change" notifications, this contract would be incomplete.
「変更内容」通知のサポートは、データノードごとにサポートされていない可能性があるため、そのような通知が任意の特定のデータノードに対して送信されることを意味するのではありません。したがって、サブスクライバに「変更内」通知が実際にサポートされているオブジェクトを識別するための手段がある場合を除き、加入者/管理アプリケーションは「変更内」機能に依存することはできません。Yangデータモデルは、インターフェース契約として使用されることを意図しています。実際に「変更内容」通知をサポートするデータノードを識別することなく、この契約は不完全です。
Clients of a server (and subscribers to a publisher, as subscribers are also clients) need a method to gather capability information.
サーバーのクライアント（および購読者が購読者がクライアントであるため）は、機能情報を収集する方法が必要です。
The module "ietf-system-capabilities" is defined to provide a structure that can be used to discover (as a read-only operational state) any YANG-related system capability.
モジュール「IETFシステム機能」は、（読み取り専用の運用状態として）任意のYang関連のシステム機能を検出するために使用できる構造を提供するように定義されています。
This module itself does not contain any capabilities; it provides augmentation points for capabilities to be defined in subsequent YANG modules. "ietf-system-capabilities" is used by other modules to augment in specific capability information. Every set of such capabilities MUST be wrapped in a container under the augment statement to cleanly separate different groups of capabilities. These "wrapper containers" SHALL be augmented at /sysc:system-capabilities and /sysc:system-capabilities/sysc:datastore-capabilities/sysc:per-node-capabilities.
このモジュール自体には機能は含まれていません。それはその後のYANGモジュールで定義される機能のための増大ポイントを提供します。「IETFシステム機能」は、特定の機能情報を強化するために他のモジュールによって使用されます。そのような機能のすべてのセットは、異なるグループの機能グループをきれいに分離するために、補正ステートメントの下でコンテナ内に折り返されなければなりません。これらの「ラッパーコンテナ」は/ syscで拡張され、システム機能と/ syssc：system-capabilities / syssc：datastore-capabilities / syssc：ノードごとの機能。
Capability values can be specified at the system level, at the datastore level (by selecting all nodes in the datastore), or for specific data nodes of a specific datastore (and their contained subtrees). Capability values specified for a specific datastore or node-set override values specified at the system level.
能力値は、（データストア内のすべてのノードを選択することによって）、データストアレベルで、または特定のデータストアの特定のデータノード（およびそれらの含有されたサブツリー）のシステムレベルで指定できます。システムレベルで指定された特定のデータストアまたはノードセットのオーバーライド値に指定された機能値。
Note: The solution is usable for both NMDA and non-NMDA systems. For non-NMDA servers, "config false" data is considered as if it were part of the running datastore.
注：解決策は、NMDAシステムと非NMDAシステムの両方に使用できます。NMDA以外のサーバーの場合、「Config False」データは、実行中のデータストアの一部であるかのように考慮されます。
The following tree diagram [RFC8340] provides an overview of the data model.
次のツリー図[RFC8340]は、データモデルの概要を示しています。
module: ietf-system-capabilities
+--ro system-capabilities
+--ro datastore-capabilities* [datastore]
+--ro datastore -> /yanglib:yang-library/datastore/name
+--ro per-node-capabilities* []
+--ro (node-selection)?
+--:(node-selector)
+--ro node-selector? nacm:node-instance-identifier
This YANG module imports typedefs from [RFC8341] and a reference path from [RFC8525].
このYangモジュールは[RFC8341]から[RFC8525]からの参照パスをインポートします。
<CODE BEGINS> file "ietf-system-capabilities@2022-02-17.yang"
module ietf-system-capabilities {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-system-capabilities";
prefix sysc;
import ietf-netconf-acm {
prefix nacm;
reference
"RFC 8341: Network Configuration Access Control Model";
}
import ietf-yang-library {
prefix yanglib;
description
"This module requires ietf-yang-library to be implemented.
Revision 2019-01-04 or a revision derived from it
is REQUIRED.";
reference
"RFC8525: YANG Library";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Editor: Balazs Lengyel <mailto:balazs.lengyel@ericsson.com>"; description "This module specifies a structure to specify system capabilities for a server or a publisher. System capabilities may include capabilities of a NETCONF or RESTCONF server or a notification publisher.
編集者：Balazs Lengyel <Mailto：balazs.lengyel@ericsson.com> ";説明"このモジュールは、サーバーまたは発行者のシステム機能を指定するための構造を指定します。システム機能には、NETCONFまたはRESTCONFサーバーまたは通知パブリッシャーの機能が含まれます。
This module does not contain any specific capabilities; it only provides a structure where containers containing the actual capabilities are augmented in.
このモジュールには特定の機能が含まれていません。実際の機能を含むコンテナが拡張されている構造のみを提供します。
Capability values can be specified at the system level, at the datastore level (by selecting all nodes in the datastore), or for specific data nodes of a specific datastore (and their contained subtrees). Capability values specified for a specific datastore or node-set override values specified on the system/publisher level.
能力値は、（データストア内のすべてのノードを選択することによって）、データストアレベルで、または特定のデータストアの特定のデータノード（およびそれらの含有されたサブツリー）のシステムレベルで指定できます。システム/発行者レベルで指定された特定のデータストアまたはノードセットのオーバーライド値に指定された機能値。
The same grouping MUST be used to define hierarchical capabilities supported both at the system level and at the datastore/data-node level.
システムレベルとデータストア/データノードレベルの両方でサポートされている階層機能を定義するために同じグループ化を使用する必要があります。
To find a capability value for a specific data node in a specific datastore, the user SHALL:
特定のデータストア内の特定のデータノードの機能値を見つけるには、ユーザーは次のことを行います。
1) search for a datastore-capabilities list entry for the specific datastore. When stating a specific capability, the relative path for any specific capability must be the same under the system-capabilities container and under the per-node-capabilities list.
1) 特定のデータストアのデータストア機能リストエントリを検索します。特定の機能を述べる場合、特定の機能の相対パスは、システム機能コンテナとノードごとの機能リストの下に同じでなければなりません。
2) If the datastore entry is found within that entry, process all per-node-capabilities entries in the order they appear in the list. The first entry that specifies the specific capability and has a node-selector selecting the specific data node defines the capability value.
2) データストアエントリがそのエントリ内に見つかった場合は、ノードごとの機能エントリをリストに表示されている順序で処理します。特定の機能を指定し、特定のデータノードを選択するノードセレクタを持つ最初のエントリは、能力値を定義します。
3) If the capability value is not found above and the specific capability is specified under the system-capabilities container (outside the datastore-capabilities list), this value shall be used.
3) 能力の値が上記で見つからない場合、（データストア機能リストの外部）システム機能コンテナの下に特定の機能が指定されている場合、この値を使用します。
4) If no values are found in the previous steps, the system/publisher is not capable of providing a value. Possible reasons are that it is unknown, the capability is changing for some reason, there is no specified limit, etc. In this case, the system's behavior is unspecified.
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 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here.
「必須」、「必須」、「SEQL」、「推奨する」、「推奨する」、「推奨」、「推奨」、「推奨する」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨する」、「推奨」、「推奨」、「推奨する」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨」、「オプション」、'この文書では、BCP 14（RFC 2119）（RFC 8174）に記載されているように解釈されるべきです。
Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved.
Copyright（C）2022 IETF信頼とコードの著者として識別された人。全著作権所有。
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 Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info).
修正の有無にかかわらず、ソースおよびバイナリ形式での再配布と使用は、IETF信託の法定条項の第4章に記載されている改訂されたBSDライセンスに準拠しており、これに含まれるライセンス条項に従って許可されています。https://trustee.ietf.org/License-info）。
This version of this YANG module is part of RFC 9196
(https://www.rfc-editor.org/info/rfc9196); see the RFC itself
for full legal notices.";
revision 2022-02-17 {
description
"Initial version";
reference
"RFC 9196: YANG Modules Describing Capabilities for Systems
and Datastore Update Notifications";
}
container system-capabilities {
config false;
description
"System capabilities.
Capability values specified here at the system level
are valid for all datastores and are used when the
capability is not specified at the datastore level
or for specific data nodes.";
/*
* "Augmentation point for system-level capabilities."
*/
list datastore-capabilities {
key "datastore";
description
"Capabilities values per datastore.
For non-NMDA servers/publishers, 'config false' data is
considered as if it were part of the running datastore.";
leaf datastore {
type leafref {
path
"/yanglib:yang-library/yanglib:datastore/yanglib:name";
}
description
"The datastore for which capabilities are defined.
Only one specific datastore can be specified,
e.g., ds:conventional must not be used, as it
represents a set of configuration datastores.";
}
list per-node-capabilities {
description
"Each list entry specifies capabilities for the selected
data nodes. The same capabilities apply to the data nodes
in the subtree below the selected nodes.
The system SHALL order the entries according to their precedence. The order of the entries MUST NOT change unless the underlying capabilities also change.
システムは彼らの優先順位に従ってエントリを注文するものとします。基礎となる機能も変わっていない限り、エントリの順序は変更しないでください。
Note that the longest patch matching can be achieved
by ordering more specific matches before less
specific ones.";
choice node-selection {
description
"A method to select some or all nodes within a
datastore.";
leaf node-selector {
type nacm:node-instance-identifier;
description
"Selects the data nodes for which capabilities are
specified. The special value '/' denotes all data
nodes in the datastore, consistent with the path
leaf node on page 41 of [RFC8341].";
reference
"RFC 8341: Network Configuration Access Control Model";
}
}
/*
* "Augmentation point for datastore- or data-node-level
* capabilities."
*/
}
}
}
}
<CODE ENDS>
The YANG module "ietf-notification-capabilities" provides information related to the YANG-Push capability.
YANGモジュール「IETF-Notification-Capabilities」は、Yang-Push機能に関する情報を提供します。
The following tree diagram [RFC8340] provides an overview of the data model.
次のツリー図[RFC8340]は、データモデルの概要を示しています。
module: ietf-notification-capabilities
augment /sysc:system-capabilities:
+--ro subscription-capabilities
+--ro max-nodes-per-update? uint32
+--ro periodic-notifications-supported? notification-support
+--ro (update-period)?
| +--:(minimum-update-period)
| | +--ro minimum-update-period? uint32
| +--:(supported-update-period)
| +--ro supported-update-period* uint32
+--ro on-change-supported? notification-support
| {yp:on-change}?
+--ro minimum-dampening-period? uint32
| {yp:on-change}?
+--ro supported-excluded-change-type* union
{yp:on-change}?
augment /sysc:system-capabilities/sysc:datastore-capabilities
/sysc:per-node-capabilities:
+--ro subscription-capabilities
+--ro max-nodes-per-update? uint32
+--ro periodic-notifications-supported? notification-support
+--ro (update-period)?
| +--:(minimum-update-period)
| | +--ro minimum-update-period? uint32
| +--:(supported-update-period)
| +--ro supported-update-period* uint32
+--ro on-change-supported? notification-support
| {yp:on-change}?
+--ro minimum-dampening-period? uint32
| {yp:on-change}?
+--ro supported-excluded-change-type* union
{yp:on-change}?
This YANG module imports a feature and typedefs from [RFC8641] and also imports the "ietf-system-capabilities" specified in this document.
このYANGモジュールは[RFC8641]から機能とTypedeFをインポートし、このドキュメントで指定されている「IETF-System-Capabilities」をインポートします。
<CODE BEGINS> file "ietf-notification-capabilities@2022-02-17.yang"
module ietf-notification-capabilities {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-notification-capabilities";
prefix notc;
import ietf-yang-push {
prefix yp;
description
"This module requires ietf-yang-push to be implemented.";
reference
"RFC 8641: Subscription to YANG Notifications for
Datastore Updates";
}
import ietf-system-capabilities {
prefix sysc;
description
"This module requires ietf-system-capabilities to be
implemented.";
reference
"RFC 9196: YANG Modules Describing Capabilities for Systems
and Datastore Update Notifications";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Editor: Balazs Lengyel <mailto:balazs.lengyel@ericsson.com>"; description "This module specifies publisher capabilities related to YANG-Push (RFC 8641).
編集者：Falazs Lengyel <mailto：balazs.lengyel@ericsson.com> ";説明"このモジュールは、Yang-Pushに関連する発行者機能を指定します（RFC 8641）。
The module contains:
モジュールには以下が含まれています。
- a specification of the data nodes that support 'on-change' or 'periodic' notifications.
- 「変更内容」または「周期的」通知をサポートするデータノードの仕様。
- capabilities related to the throughput of notification data that the publisher can support. (Note that for a specific subscription, the publisher MAY allow only longer periods or smaller updates depending on, e.g., actual load conditions.)
- パブリッシャがサポートできる通知データのスループットに関連する機能。（特定のサブスクリプションの場合、発行者は、例えば実際の負荷条件に応じて、より長い期間またはより小さな更新だけを可能にし得ることに注意してください。）
Capability values can be specified at the system/publisher level, at the datastore level, or for specific data nodes of a specific datastore (and their contained subtrees), as defined in the ietf-system-capabilities module.
Capability値は、IETFシステム機能モジュールで定義されているように、システム/発行者レベル、データストアレベルで、または特定のデータストアの特定のデータノード（およびそれらの含まれているサブツリー）の特定のデータノードで指定できます。
If different data nodes covered by a single subscription have different values for a specific capability, then using values that are only acceptable for some of these data nodes, but not for others, may result in the rejection of the subscription.
単一のサブスクリプションでカバーされている異なるデータノードが特定の機能に対して異なる値を持つ場合は、これらのデータノードの一部に対してのみ許容できる値を使用して、サブスクリプションを拒否する可能性があります。
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 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here.
「必須」、「必須」、「SEQL」、「推奨する」、「推奨する」、「推奨」、「推奨」、「推奨する」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨する」、「推奨」、「推奨」、「推奨する」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨」、「推奨」、「オプション」、'この文書では、BCP 14（RFC 2119）（RFC 8174）に記載されているように解釈されるべきです。
Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved.
Copyright（C）2022 IETF信頼とコードの著者として識別された人。全著作権所有。
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 Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info).
修正の有無にかかわらず、ソースおよびバイナリ形式での再配布と使用は、IETF信託の法定条項の第4章に記載されている改訂されたBSDライセンスに準拠しており、これに含まれるライセンス条項に従って許可されています。https://trustee.ietf.org/License-info）。
This version of this YANG module is part of RFC 9196
(https://www.rfc-editor.org/info/rfc9196); see the RFC itself
for full legal notices.";
revision 2022-02-17 {
description
"Initial version";
reference
"RFC 9196: YANG Modules Describing Capabilities for Systems
and Datastore Update Notifications";
}
grouping subscription-capabilities {
description
"Capabilities related to YANG-Push subscriptions
and notifications";
container subscription-capabilities {
description
"Capabilities related to YANG-Push subscriptions
and notifications";
typedef notification-support {
type bits {
bit config-changes {
description
"The publisher is capable of sending
notifications for 'config true' nodes for the
relevant scope and subscription type.";
}
bit state-changes {
description
"The publisher is capable of sending
notifications for 'config false' nodes for the
relevant scope and subscription type.";
}
}
description
"Type for defining whether 'on-change' or
'periodic' notifications are supported for all data nodes,
'config false' data nodes, 'config true' data nodes, or
no data nodes.
The bits config-changes or state-changes have no effect
when they are set for a datastore or for a set of nodes
that does not contain nodes with the indicated config
value. In those cases, the effect is the same as if no
support was declared. One example of this is indicating
support for state-changes for a candidate datastore that
has no effect.";
}
leaf max-nodes-per-update {
type uint32 {
range "1..max";
}
description
"Maximum number of data nodes that can be sent
in an update. The publisher MAY support more data nodes
but SHOULD support at least this number.
May be used to avoid the 'update-too-big' error
during subscription.";
reference
"RFC 8641: Subscription to YANG Notifications for
Datastore Updates, the 'update-too-big' error/identity";
}
leaf periodic-notifications-supported {
type notification-support;
description
"Specifies whether the publisher is capable of
sending 'periodic' notifications for the selected
data nodes, including any subtrees that may exist
below them.";
reference
"RFC 8641: Subscription to YANG Notifications for
Datastore Updates, 'periodic' subscription concept";
}
choice update-period {
description
"Supported update period value or values for
'periodic' subscriptions.";
leaf minimum-update-period {
type uint32;
units "centiseconds";
description
"Indicates the minimal update period that is
supported for a 'periodic' subscription.
A subscription request to the selected data nodes with
a smaller period than what this leaf specifies is
likely to result in a 'period-unsupported' error.";
reference
"RFC 8641: Subscription to YANG Notifications for
Datastore Updates, the period leaf in the ietf-yang-push
YANG module";
}
leaf-list supported-update-period {
type uint32;
units "centiseconds";
description
"Supported update period values for a 'periodic'
subscription.
A subscription request to the selected data nodes with a
period not included in the leaf-list will result in a
'period-unsupported' error.";
reference
"RFC 8641: Subscription to YANG Notifications for
Datastore Updates, the period leaf in the ietf-yang-push
YANG module";
}
}
leaf on-change-supported {
if-feature "yp:on-change";
type notification-support;
description
"Specifies whether the publisher is capable of
sending 'on-change' notifications for the selected
data nodes and the subtree below them.";
reference
"RFC 8641: Subscription to YANG Notifications for Datastore
Updates, on-change concept";
}
leaf minimum-dampening-period {
if-feature "yp:on-change";
type uint32;
units "centiseconds";
description
"The minimum dampening period supported for 'on-change'
subscriptions for the selected data nodes.
If this value is present and greater than zero,
that implies dampening is mandatory.";
reference
"RFC 8641: Subscription to YANG Notifications for
Datastore Updates, the dampening-period leaf in the
ietf-yang-push YANG module";
}
leaf-list supported-excluded-change-type {
if-feature "yp:on-change";
type union {
type enumeration {
enum none {
value -2;
description
"None of the change types can be excluded.";
}
enum all {
value -1;
description
"Any combination of change types can be excluded.";
}
}
type yp:change-type;
}
description
"The change types that can be excluded in
YANG-Push subscriptions for the selected data nodes.";
reference
"RFC 8641: Subscription to YANG Notifications for Datastore
Updates, the change-type typedef in the ietf-yang-push
YANG module";
}
}
}
augment "/sysc:system-capabilities" {
description
"Add system level capabilities";
uses subscription-capabilities {
refine
"subscription-capabilities/supported-excluded-change-type" {
default "none";
}
}
}
augment "/sysc:system-capabilities/sysc:datastore-capabilities"
+ "/sysc:per-node-capabilities" {
description
"Add datastore and node-level capabilities";
uses subscription-capabilities {
refine
"subscription-capabilities/supported-excluded-change-type" {
default "none";
}
}
}
}
<CODE ENDS>
<CODE ENDS>
<コード終了>
The YANG modules specified in this document define a schema for data that is designed to be accessed via network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040] or as YANG instance data. 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].
このドキュメントで指定されているYANDモジュールは、NetConf [RFC6241]またはRESTCONF [RFC8040]またはYANSインスタンスデータなどのネットワーク管理プロトコルを介してアクセスするように設計されているデータのスキーマを定義します。最低のNETCONFレイヤーはセキュアトランスポート層であり、必須のセキュアトランスポートはSecure Shell（SSH）[RFC6242]です。最低のRETCONFレイヤーはhttpsで、必須のセキュアトランスポートはTLS [RFC8446]です。
The Network Configuration Access Control Model (NACM) [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.
ネットワーク構成アクセス制御モデル（NACM）[RFC8341]は、特定のNETCONFまたはRESTCONFユーザへのアクセスを利用可能なすべてのNetConfまたはRESTCONFプロトコル操作およびコンテンツの事前設定されたサブセットに制限する手段を提供します。
This document outlines a framework for conveying system capability information that is inherently flexible and extensible. While the full set of use cases is not known now, they may range as wide as conveying the minimum update period for periodic subscription updates and what protocols might be used for such notifications. Knowledge of this type of value might, for example, allow an attacker to gain insight into how long unauthorized configuration changes might be active prior to detection and what communications channels might be disrupted to extend the period of non-detection. Documents adding additional capabilities via augmenting this module are encouraged to document the security considerations of the new YANG nodes, according to the guidance in BCP 216 [RFC8407].
この文書は、本質的に柔軟で拡張可能なシステム機能情報を伝達するためのフレームワークを概説しています。完全なユースケースが知られていないが、定期的な購読更新の最小更新期間を伝達するのと同じ範囲であり、そのような通知にどのようなプロトコルが使用される可能性があります。この種の値に関する知識は、例えば、検出前に不正な構成の変更がどのくらいの時間がかかり、非検出の期間を延ばすことができるかについて攻撃者が洞察を得ることができるかもしれない。このモジュールの拡張により追加の機能を追加する文書は、BCP 216 [RFC8407]のガイダンスに従って、新しいYangノードのセキュリティ上の考慮事項を文書化することをお勧めします。
All protocol-accessible data nodes in augmented modules are read-only and cannot be modified. Access control may be configured to avoid exposing any read-only data that is defined by the augmenting module documentation as being security sensitive.
拡張モジュール内のすべてのプロトコルアクセス可能データノードは読み取り専用であり、変更することはできません。Access Controlは、拡張モジュールのマニュアルによって定義された読み取り専用データをセキュリティに敏感にすることを避けるように構成されてもよい。
When that data is in file format, the data should be protected against modification or unauthorized access using normal file-handling mechanisms. The data in file format also inherits all the security considerations of [RFC9195], which includes additional considerations about read protections and distinguishes between data at rest and in motion.
そのデータがファイル形式である場合、通常のファイル処理メカニズムを使用してデータを変更または不正アクセスから保護する必要があります。ファイル形式のデータは、[RFC9195]のすべてのセキュリティ上の考慮事項も継承しており、これは読み取り保護に関する追加の考慮事項を含み、安静時および動きのデータを区別します。
This document registers the following URIs in the "IETF XML Registry" [RFC3688]:
このドキュメントでは、次のURIを "IETF XMLレジストリ" [RFC3688]に登録します。
URI: urn:ietf:params:xml:ns:yang:ietf-system-capabilities Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace.
URI：URN：IETF：Params：XML：NS：Yang：IETFシステム機能登録者連絡先：IESG。XML：N / A、要求されたURIはXMLネームスペースです。
URI: urn:ietf:params:xml:ns:yang:ietf-notification-capabilities Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace.
URI：URN：IETF：PARAMS：XML：NS：YANG：IETF-Notification-Capabilities登録者連絡先：IESG。XML：N / A、要求されたURIはXMLネームスペースです。
This document registers the following YANG modules in the "YANG Module Names" registry [RFC6020]:
このドキュメントでは、次のYANGモジュールを「Yang Module Names」レジストリ[RFC6020]に登録します。
name: ietf-system-capabilities
namespace: urn:ietf:params:xml:ns:yang:ietf-system-capabilities
prefix: sysc
reference: RFC 9196
name: ietf-notification-capabilities
namespace: urn:ietf:params:xml:ns:yang:ietf-notification-
capabilities
prefix: notc
reference: RFC 9196
[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>.
[RFC2119] BRADNER、S、「RFCで使用するためのキーワード」、BCP 14、RFC 2119、DOI 10.17487 / RFC2119、1997年3月、<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>.
[RFC3688] Mealling、M.、 "IETF XML Registry"、BCP 81、RFC 3688、DOI 10.17487 / RFC3688、2004年1月、<https：//www.rfc-editor.org/info/rfc3688>。
[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>.
[RFC6020] Bjorklund、M.、Ed。、 "Yang - ネットワーク構成プロトコルのデータモデリング言語（NetConf）"、RFC 6020、DOI 10.17487 / RFC6020、2010年10月、<https：//www.rfc-編集者。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>.
[RFC6241] ENNS、R.、ED。、Bjorklund、M.、Ed。、Schoenwaelder、J.、Ed。、およびA. Bierman、ED。、「ネットワーク構成プロトコル（NetConf）」、RFC 6241、DOI 10.17487 /RFC6241、2011年6月、<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>.
[RFC6242] Wasserman、M.、「Secure Shell（SSH）を介したNetConfプロトコルの使用」、RFC 6242、DOI 10.17487 / RFC6242、2011年6月、<https：//www.rfc-editor.org/info/rfc6242>。
[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>.
[RFC8040] Bierman、A.、Bjorklund、M.、K。Watsen、RESTCONFプロトコル、RFC 8040、DOI 10.17487 / RFC8040、2017年1月、<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>.
[RFC8174] Leiba、B.、RFC 2119キーワードの「大文字の曖昧さ」、BCP 14、RFC 8174、DOI 10.17487 / RFC8174、2017年5月、<https：//www.rfc-editor.org/info/RFC8174>。
[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>.
[RFC8341] Bierman、A.およびM.Bjorklund、「ネットワーク構成アクセス制御モデル」、STD 91、RFC 8341、DOI 10.17487 / RFC8341、2018年3月、<https：//www.rfc-editor.org/info/rfc8341>。
[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>.
[RFC8342] Bjorklund、M.、Schoenwaelder、J.、Shafer、P.、Watsen、K.、およびR.Wilton、「ネットワーク管理データストアアーキテクチャ（NMDA）」、RFC 8342、DOI 10.17487 / RFC8342、2018年3月、<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>.
[RFC8446] RESCORLA、E。、「トランスポート層セキュリティ（TLS）プロトコルバージョン1.3」、RFC 8446、DOI 10.17487 / RFC8446、<https：//www.rfc-editor.org/info/rfc8446>。
[RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., and R. Wilton, "YANG Library", RFC 8525, DOI 10.17487/RFC8525, March 2019, <https://www.rfc-editor.org/info/rfc8525>.
[RFC8525] Bierman、A.、Bjorklund、M.、Schoenwaelder、J.、Watsen、K.、およびR. Wilton、K.、RFC 8525、DOI 10.17487 / RFC8525、2019年3月、<HTTPS：// WWW.rfc-editor.org / info / rfc8525>。
[RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, E., and A. Tripathy, "Subscription to YANG Notifications", RFC 8639, DOI 10.17487/RFC8639, September 2019, <https://www.rfc-editor.org/info/rfc8639>.
[RFC8639] Voit、E.、Clemm、A.、Gonzalez Prieto、A.、Nilsen-Nygaard、E.、A. Tripathy、「Yang Notificationsの購読」、RFC 8639、DOI 10.17487 / RFC8639、2019年9月、<https://www.rfc-editor.org/info/rfc8639>。
[RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641, September 2019, <https://www.rfc-editor.org/info/rfc8641>.
[RFC8641] CLEMM、A.およびE. Voit、「データストア更新のためのヤン通知への購読」、RFC 8641、DOI 10.17487 / RFC8641、2019年9月、<https://www.rfc-editor.org/info/rfc8641>。
[RFC9195] Lengyel, B. and B. Claise, "A File Format for YANG Instance Data", RFC 9195, DOI 10.17487/RFC9195, February 2022, <https://www.rfc-editor.org/info/rfc9195>.
[RFC9195] Lengyel、B.およびB.Claise、「Yangインスタンスデータのファイル形式」、RFC 9195、DOI 10.17487 / RFC9195、2022年2月、<https://www.rfc-editor.org/info/rfc9195>。
[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>.
[RFC8340] Bjorklund、M.およびL. Berger、Ed。、「Yang Tree Diagress」、BCP 215、RFC 8340、DOI 10.17487 / RFC8340、2018年3月、<https：//www.rfc-editor.org/info/RFC8340>。
[RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models", BCP 216, RFC 8407, DOI 10.17487/RFC8407, October 2018, <https://www.rfc-editor.org/info/rfc8407>.
[RFC8407] Bierman、A。、「Yangデータモデルを含む文書の査読者のためのガイドライン」、BCP 216、RFC 8407、DOI 10.17487 / RFC8407、2018年10月、<https：//www.rfc-editor.org/info/ RFC8407>。
[RFC8792] Watsen, K., Auerswald, E., Farrel, A., and Q. Wu, "Handling Long Lines in Content of Internet-Drafts and RFCs", RFC 8792, DOI 10.17487/RFC8792, June 2020, <https://www.rfc-editor.org/info/rfc8792>.
[RFC8792] Watsen、K.、Auerswald、E.、Farrel、A.、およびQ. WU、「インターネットドラフトの内容の長い線の取り扱い」、RFC 8792、DOI 10.17487 / RFC8792、2020年6月2020年6月、<HTTPS//www.rfc-editor.org/info/rfc8792>。
Appendix A. Instance Data Example #1
付録A.インスタンスデータ例＃1
The following examples use artwork folding [RFC8792] for better formatting.
以下の例では、より良いフォーマットのためにアートワークの折りたたみ[RFC8792]を使用します。
The following instance data example describes the notification capabilities of a hypothetical "acme-router". The router implements the running and operational datastores. Every change can be reported "on-change" from the running datastore, but only "config false" nodes and some "config false" data can be reported on-change from the operational datastore. Interface statistics are not reported "on-change"; only two important counters are. Datastore subscription capabilities are not reported "on-change", as they never change on the acme-router during runtime.
次のインスタンスデータ例は、仮想の「ACME-Router」の通知機能について説明しています。ルータは実行および動作データストアを実装しています。実行中のデータストアから「変更内」の変更を報告することができますが、「Config False」ノードといくつかの「config false」データのみを運用データストアから変更されます。インターフェイス統計は「変更内容」と報告されていません。2つの重要なカウンタは2つだけです。データストアのサブスクリプション機能は、実行時にACME-Routerでは変更されたことがないため、「変更内容」は報告されていません。
========== NOTE: '\' line wrapping per RFC 8792) ===========
<?xml version="1.0" encoding="UTF-8"?>
<instance-data-set xmlns=\
"urn:ietf:params:xml:ns:yang:ietf-yang-instance-data">
<name>acme-router-notification-capabilities</name>
<content-schema>
<module>ietf-system-capabilities@2022-02-17</module>
<module>ietf-notification-capabilities@2022-02-17</module>
</content-schema>
<description>Defines the notification capabilities of an
acme-router. The router only has running and operational
datastores. Every change can be reported on-change from the
running datastore, but only "config false" nodes and some
"config false" data can be reported on-change from the
operational datastore. Statistics
are not reported on-change except for two important counters,
where a small dampening period is mandated.
</description>
<content-data>
<system-capabilities \
xmlns="urn:ietf:params:xml:ns:yang:ietf-system-capabilities" \
xmlns:notc=\
"urn:ietf:params:xml:ns:yang:ietf-notification-capabilities" \
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
<notc:subscription-capabilities>
<notc:minimum-update-period>500</notc:minimum-update-period>
<notc:max-nodes-per-update>2000</notc:max-nodes-per-update>
<notc:minimum-dampening-period>\
100\
</notc:minimum-dampening-period>
<notc:periodic-notifications-supported>\
config-changes state-changes\
</notc:periodic-notifications-supported>
<notc:on-change-supported>\
config-changes state-changes\
</notc:on-change-supported>
<notc:supported-excluded-change-type>\
all\
</notc:supported-excluded-change-type>
</notc:subscription-capabilities>
<datastore-capabilities>
<datastore>ds:operational</datastore>
<per-node-capabilities>
<node-selector>\
/if:interfaces/if:interface[if:name='lo']\
</node-selector>
<notc:subscription-capabilities>
<notc:on-change-supported/>
<notc:periodic-notifications-supported/>
</notc:subscription-capabilities>
</per-node-capabilities>
<per-node-capabilities>
<node-selector>\
/if:interfaces/if:interface/if:statistics/if:in-octets\
</node-selector>
<notc:subscription-capabilities>
<notc:minimum-dampening-period>10
</notc:minimum-dampening-period>
<notc:on-change-supported>\
state-changes\
</notc:on-change-supported>
</notc:subscription-capabilities>
</per-node-capabilities>
<per-node-capabilities>
<node-selector>\
/if:interfaces/if:interface/if:statistics/if:out-octets\
</node-selector>
<notc:subscription-capabilities>
<notc:minimum-dampening-period>10
</notc:minimum-dampening-period>
<notc:on-change-supported>\
state-changes\
</notc:on-change-supported>
</notc:subscription-capabilities>
</per-node-capabilities>
<per-node-capabilities>
<node-selector>\
/if:interfaces/if:interface/if:statistics\
</node-selector>
<notc:subscription-capabilities>
<notc:on-change-supported/>
</notc:subscription-capabilities>
</per-node-capabilities>
</datastore-capabilities>
</system-capabilities>
</content-data>
</instance-data-set>
Figure 1: Notification Capabilities with Settings Specific to the Data Node
図1：データノードに固有の設定を備えた通知機能
Appendix B. Instance Data Example #2
付録B.インスタンスデータの例＃2
The following examples use artwork folding [RFC8792] for better formatting.
以下の例では、より良いフォーマットのためにアートワークの折りたたみ[RFC8792]を使用します。
The following instance data example describes the notification capabilities of a hypothetical "acme-switch". The switch implements the running, candidate, and operational datastores. Every change can be reported "on-change" from the running datastore, nothing can be reported on-change from the candidate datastore, and all "config false" data can be reported on-change from the operational datastore. "Periodic" subscriptions are supported for running and operational but not for candidate datastores.
次のインスタンスデータ例は、仮説の「ACME-Switch」の通知機能について説明しています。スイッチは、実行、候補、および運用データストアを実装しています。実行中のデータストアから「変更内」に報告することはできません。候補データストアから変更されていないことは何も報告できません。また、すべての "Config False"データを運用データストアから変更されます。「定期的な」サブスクリプションは、実行および動作上の実行でサポートされていますが、候補データストアに対してはサポートされていません。
========== NOTE: '\' line wrapping per RFC 8792) ===========
<?xml version="1.0" encoding="UTF-8"?>
<instance-data-set xmlns=\
"urn:ietf:params:xml:ns:yang:ietf-yang-instance-data">
<name>acme-switch-notification-capabilities</name>
<content-schema>
<module>ietf-system-capabilities@2022-02-17</module>
<module>ietf-notification-capabilities@2022-02-17</module>
</content-schema>
<description>Notification capabilities of acme-switch.
Acme-switch implements the running, candidate, and operational
datastores. Every change can be reported on-change from the
running datastore, nothing from the candidate datastore and
all "config false" data from the operational datastore. Periodic
subscriptions are supported for running and operational, but not
for candidate datastore.
</description>
<content-data>
<system-capabilities \
xmlns="urn:ietf:params:xml:ns:yang:ietf-system-capabilities" \
xmlns:notc=\
"urn:ietf:params:xml:ns:yang:ietf-notification-capabilities" \
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
<notc:subscription-capabilities>
<notc:minimum-update-period>500</notc:minimum-update-period>
<notc:max-nodes-per-update>2000</notc:max-nodes-per-update>
<notc:minimum-dampening-period>\
100\
</notc:minimum-dampening-period>
<notc:periodic-notifications-supported>\
config-changes state-changes\
</notc:periodic-notifications-supported>
</notc:subscription-capabilities>
<datastore-capabilities>
<datastore>ds:operational</datastore>
<per-node-capabilities>
<node-selector>/</node-selector>
<notc:subscription-capabilities>
<notc:on-change-supported>\
state-changes\
</notc:on-change-supported>
</notc:subscription-capabilities>
</per-node-capabilities>
</datastore-capabilities>
<datastore-capabilities>
<datastore>ds:candidate</datastore>
<per-node-capabilities>
<node-selector>/</node-selector>
<notc:subscription-capabilities>
<notc:on-change-supported/>
<notc:periodic-notifications-supported/>
</notc:subscription-capabilities>
</per-node-capabilities>
</datastore-capabilities>
<datastore-capabilities>
<datastore>ds:running</datastore>
<per-node-capabilities>
<node-selector>/</node-selector>
<notc:subscription-capabilities>
<notc:on-change-supported>\
config-changes\
</notc:on-change-supported>
</notc:subscription-capabilities>
</per-node-capabilities>
</datastore-capabilities>
</system-capabilities>
</content-data>
</instance-data-set>
Figure 2: Notification Capabilities with Datastore-Level Settings
図2：データストアレベルの設定を備えた通知機能
Acknowledgments
謝辞
For their valuable comments, discussions, and feedback, we wish to acknowledge Andy Bierman, Juergen Schoenwaelder, Rob Wilton, Kent Watsen, Eric Voit, Joe Clarke, Martin Bjorklund, Ladislav Lhotka, Qin Wu, Mahesh Jethanandani, Ran Tao, Reshad Rahman, and other members of the Netmod Working Group.
彼らの貴重なコメント、議論、そしてフィードバックのために、私たちはAndy Bierman、Juergen Schoenwaelder、Rob Wilton、Kent Watsen、Eric Voit、Joe Clarke、Martin Bjorklund、Ladislav Lhotka、Qin Wu、Mahesh Jethanandani、Ran Tao、Reshad Rahman、そしてNetModワーキンググループの他のメンバー。
Authors' Addresses
著者の住所
Balazs Lengyel Ericsson Budapest Magyar Tudosok korutja 11 1117 Hungary Email: balazs.lengyel@ericsson.com
Balazs Lengyel Ericsson Budapest Magyar Tudosok Korutja 11 1117ハンガリーメール：Balazs.Lengyel@ericsson.com
Alexander Clemm Futurewei 2330 Central Expressway Santa Clara, CA 95050 United States of America Email: ludwig@clemm.org
Alexander Clemm Futurewei 2330 Central Expressway Santa Clara、CA 95050アメリカ合衆国Eメール：ludwig@clemm.org
Benoit Claise Huawei George's Court Townsend Street Dublin 2 Ireland Email: benoit.claise@huawei.com
Benoit Claise Huawei George's Court TownSend Street Dublin 2アイルランドメール：benoit.claise@huawei.com