[要約] RFC 8639は、YANG通知の購読に関する仕様であり、YANGモデルを使用してネットワークデバイスからのイベント通知を受け取るための方法を提供します。その目的は、ネットワーク管理者がネットワークの状態変化をリアルタイムで監視し、適切な対応を取ることです。
Internet Engineering Task Force (IETF) E. Voit
Request for Comments: 8639 Cisco Systems
Category: Standards Track A. Clemm
ISSN: 2070-1721 Futurewei
A. Gonzalez Prieto
Microsoft
E. Nilsen-Nygaard
A. Tripathy
Cisco Systems
September 2019
Subscription to YANG Notifications
YANG通知のサブスクリプション
Abstract
概要
This document defines a YANG data model and associated mechanisms enabling subscriber-specific subscriptions to a publisher's event streams. Applying these elements allows a subscriber to request and receive a continuous, customized feed of publisher-generated information.
このドキュメントでは、YANGデータモデルと、パブリッシャーのイベントストリームへのサブスクライバー固有のサブスクリプションを可能にする関連メカニズムを定義します。これらの要素を適用すると、サブスクライバーは、パブリッシャーが生成した情報の継続的でカスタマイズされたフィードを要求および受信できます。
Status of This Memo
本文書の状態
This is an Internet Standards Track document.
これはInternet Standards Trackドキュメントです。
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（Internet Engineering Task Force）の製品です。これは、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/rfc8639.
このドキュメントの現在のステータス、エラータ、およびフィードバックの提供方法に関する情報は、https：//www.rfc-editor.org/info/rfc8639で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright（c）2019 IETF Trustおよびドキュメントの作成者として識別された人物。全著作権所有。
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に記載されているように保証なしで提供されます。
This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English.
このドキュメントには、2008年11月10日より前に公開または公開されたIETFドキュメントまたはIETFコントリビューションの素材が含まれている場合があります。 IETF標準プロセス外。このような資料の著作権を管理する人から適切なライセンスを取得せずに、このドキュメントをIETF標準プロセス外で変更したり、その派生物をIETF標準プロセス外で作成したりすることはできません。 RFCとして、またはそれを英語以外の言語に翻訳するための出版物。
Table of Contents
目次
1. Introduction ....................................................3
1.1. Motivation .................................................4
1.2. Terminology ................................................4
1.3. Solution Overview ..........................................6
1.4. Relationship to RFC 5277 ...................................7
2. Solution ........................................................8
2.1. Event Streams ..............................................8
2.2. Event Stream Filters .......................................9
2.3. QoS ........................................................9
2.4. Dynamic Subscriptions .....................................10
2.5. Configured Subscriptions ..................................19
2.6. Event Record Delivery .....................................27
2.7. Subscription State Change Notifications ...................28
2.8. Subscription Monitoring ...................................33
2.9. Support for the "ietf-subscribed-notifications"
YANG Module ...............................................34
3. YANG Data Model Tree Diagrams ..................................34
3.1. The "streams" Container ...................................34
3.2. The "filters" Container ...................................35
3.3. The "subscriptions" Container .............................35
4. Event Notification Subscription YANG Module ....................37
5. IANA Considerations ............................................66
6. Implementation Considerations ..................................66
7. Transport Requirements .........................................67
8. Security Considerations ........................................68
9. References .....................................................72
9.1. Normative References ......................................72
9.2. Informative References ....................................74
Appendix A. Example Configured Transport Augmentation .............75
Acknowledgments ...................................................77
Authors' Addresses ................................................77
This document defines a YANG data model and associated mechanisms enabling subscriber-specific subscriptions to a publisher's event streams. This effectively enables a "subscribe, then publish" capability where the customized information needs and access permissions of each target receiver are understood by the publisher before subscribed event records are marshaled and pushed. The receiver then gets a continuous, customized feed of publisher-generated information.
このドキュメントでは、YANGデータモデルと、パブリッシャーのイベントストリームへのサブスクライバー固有のサブスクリプションを可能にする関連メカニズムを定義します。これにより、「サブスクライブしてからパブリッシュ」機能が有効になり、サブスクライブされたイベントレコードがマーシャリングされてプッシュされる前に、カスタマイズされた情報のニーズと各ターゲットレシーバーのアクセス許可がパブリッシャーによって理解されます。次に、受信者は、発行者が生成した情報のカスタマイズされた継続的なフィードを取得します。
While the functionality defined in this document is transport agnostic, transports like the Network Configuration Protocol (NETCONF) [RFC6241] or RESTCONF [RFC8040] can be used to configure or dynamically signal subscriptions. Bindings for subscribed event record delivery for NETCONF and RESTCONF are defined in [RFC8640] and [RESTCONF-Notif], respectively.
このドキュメントで定義されている機能はトランスポートに依存しませんが、ネットワーク構成プロトコル（NETCONF）[RFC6241]またはRESTCONF [RFC8040]などのトランスポートを使用して、サブスクリプションを構成または動的に通知できます。 NETCONFおよびRESTCONFのサブスクライブされたイベントレコード配信のバインディングは、それぞれ[RFC8640]および[RESTCONF-Notif]で定義されています。
The YANG data model defined in this document conforms to the Network Management Datastore Architecture defined in [RFC8342].
このドキュメントで定義されているYANGデータモデルは、[RFC8342]で定義されているネットワーク管理データストアアーキテクチャに準拠しています。
Various limitations to subscriptions as described in [RFC5277] were alleviated to some extent by the requirements provided in [RFC7923]. Resolving any remaining issues is the primary motivation for this work. Key capabilities supported by this document include:
[RFC5277]で説明されているサブスクリプションのさまざまな制限は、[RFC7923]で提供されている要件によってある程度緩和されました。残っている問題を解決することが、この作業の主な動機です。このドキュメントでサポートされている主な機能は次のとおりです。
o multiple subscriptions on a single transport session
o 単一のトランスポートセッションでの複数のサブスクリプション
o support for dynamic and configured subscriptions
o 動的および構成済みサブスクリプションのサポート
o modification of an existing subscription in progress
o 進行中の既存のサブスクリプションの変更
o per-subscription operational counters
o サブスクリプションごとの運用カウンター
o negotiation of subscription parameters (through the use of hints returned as part of declined subscription requests)
o サブスクリプションパラメータのネゴシエーション（拒否されたサブスクリプション要求の一部として返されたヒントを使用して）
o subscription state change notifications (e.g., publisher-driven suspension, parameter modification)
o サブスクリプションの状態変更通知（パブリッシャー主導の一時停止、パラメーターの変更など）
o independence from transport
o 輸送からの独立
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]で説明されているように解釈されます。
o Client: Defined in [RFC8342].
o クライアント：[RFC8342]で定義。
o Configuration: Defined in [RFC8342].
o 構成：[RFC8342]で定義されています。
o Configuration datastore: Defined in [RFC8342].
o 構成データストア：[RFC8342]で定義されています。
o Configured subscription: A subscription installed via configuration into a configuration datastore.
o 構成済みサブスクリプション：構成を介して構成データストアにインストールされたサブスクリプション。
o Dynamic subscription: A subscription created dynamically by a subscriber via a Remote Procedure Call (RPC).
o 動的サブスクリプション：リモートプロシージャコール（RPC）を介してサブスクライバーによって動的に作成されたサブスクリプション。
o Event: An occurrence of something that may be of interest. Examples include a configuration change, a fault, a change in status, crossing a threshold, or an external input to the system.
o イベント：興味があるかもしれない何かの発生。例としては、構成の変更、障害、ステータスの変更、しきい値の超過、システムへの外部入力などがあります。
o Event occurrence time: A timestamp matching the time an originating process identified as when an event happened.
o イベント発生時間：元のプロセスがイベントの発生として識別された時間と一致するタイムスタンプ。
o Event record: A set of information detailing an event.
o イベントレコード：イベントの詳細を示す一連の情報。
o Event stream: A continuous, chronologically ordered set of events aggregated under some context.
o イベントストリーム：コンテキストに基づいて集計された、時系列順に並べられた一連のイベント。
o Event stream filter: Evaluation criteria that may be applied against event records in an event stream. Event records pass the filter when specified criteria are met.
o イベントストリームフィルター：イベントストリームのイベントレコードに対して適用できる評価基準。イベントレコードは、指定された基準が満たされたときにフィルターを通過します。
o Notification message: Information intended for a receiver indicating that one or more events have occurred.
o 通知メッセージ：1つ以上のイベントが発生したことを示す受信者向けの情報。
o Publisher: An entity responsible for streaming notification messages per the terms of a subscription.
o パブリッシャー：サブスクリプションの条件ごとに通知メッセージのストリーミングを担当するエンティティ。
o Receiver: A target to which a publisher pushes subscribed event records. For dynamic subscriptions, the receiver and subscriber are the same entity.
o レシーバー：パブリッシャーがサブスクライブしたイベントレコードをプッシュするターゲット。動的サブスクリプションの場合、レシーバーとサブスクライバーは同じエンティティーです。
o Subscriber: A client able to request and negotiate a contract for the generation and push of event records from a publisher. For dynamic subscriptions, the receiver and subscriber are the same entity.
o サブスクライバ：パブリッシャからのイベントレコードの生成とプッシュの契約を要求および交渉できるクライアント。動的サブスクリプションの場合、レシーバーとサブスクライバーは同じエンティティーです。
o Subscription: A contract with a publisher, stipulating the information that one or more receivers wish to have pushed from the publisher without the need for further solicitation.
o サブスクリプション：パブリッシャーとの契約。1人または複数の受信者がパブリッシャーからプッシュしたい情報をさらに要求することなく規定します。
All YANG tree diagrams used in this document follow the notation defined in [RFC8340].
このドキュメントで使用されているすべてのYANGツリー図は、[RFC8340]で定義されている表記法に従います。
This document describes a transport-agnostic mechanism for subscribing to and receiving content from an event stream in a publisher. This mechanism operates through the use of a subscription.
このドキュメントでは、パブリッシャーのイベントストリームにサブスクライブしてコンテンツを受信するための、トランスポートに依存しないメカニズムについて説明します。このメカニズムは、サブスクリプションを使用して動作します。
Two types of subscriptions are supported:
次の2種類のサブスクリプションがサポートされています。
1. Dynamic subscriptions, where a subscriber initiates a subscription negotiation with a publisher via an RPC. If the publisher is able to serve this request, it accepts it and then starts pushing notification messages back to the subscriber. If the publisher is not able to serve it as requested, then an error response is returned. This response MAY include hints for subscription parameters that, had they been present, may have enabled the dynamic subscription request to be accepted.
1. 動的サブスクリプション。サブスクライバーは、RPCを介してパブリッシャーとのサブスクリプションネゴシエーションを開始します。パブリッシャーがこのリクエストを処理できる場合、パブリッシャーはそれを受け入れ、通知メッセージをサブスクライバーにプッシュバックし始めます。パブリッシャーが要求どおりにサービスを提供できない場合、エラー応答が返されます。この応答には、サブスクリプションパラメータのヒントが含まれている場合があります（それらのパラメータが存在していた場合は、動的サブスクリプション要求を受け入れることができる可能性があります）。
2. Configured subscriptions, which allow the management of subscriptions via a configuration so that a publisher can send notification messages to a receiver. Support for configured subscriptions is optional, with its availability advertised via a YANG feature.
2. 構成されたサブスクリプション。構成を介してサブスクリプションを管理できるため、パブリッシャーは通知メッセージを受信者に送信できます。構成済みサブスクリプションのサポートはオプションであり、その可用性はYANG機能によって通知されます。
Additional characteristics differentiating configured from dynamic subscriptions include the following:
動的サブスクリプションとは異なる追加の構成には、次のものがあります。
o The lifetime of a dynamic subscription is bound by the transport session used to establish it. For connection-oriented stateful transports like NETCONF, the loss of the transport session will result in the immediate termination of any associated dynamic subscriptions. For connectionless or stateless transports like HTTP, a lack of receipt acknowledgment of a sequential set of notification messages and/or keep-alives can be used to trigger a termination of a dynamic subscription. Contrast this to the lifetime of a configured subscription. This lifetime is driven by relevant configuration being present in the publisher's applied configuration. Being tied to configuration operations implies that (1) configured subscriptions can be configured to persist across reboots and (2) a configured subscription can persist even when its publisher is fully disconnected from any network.
o 動的サブスクリプションの存続期間は、それを確立するために使用されるトランスポートセッションによってバインドされます。 NETCONFのようなコネクション型のステートフルトランスポートの場合、トランスポートセッションが失われると、関連付けられている動的サブスクリプションが即座に終了します。 HTTPなどのコネクションレスまたはステートレストランスポートの場合、一連の通知メッセージの受信確認の欠如やキープアライブを使用して、動的サブスクリプションの終了をトリガーできます。これを、構成済みサブスクリプションの存続期間と比較してください。この存続期間は、関連する構成がパブリッシャーの適用された構成に存在することによって駆動されます。構成操作に関連付けられているということは、（1）構成済みサブスクリプションを再起動後も保持するように構成でき、（2）構成済みサブスクリプションが、パブリッシャーがネットワークから完全に切断されている場合でも保持できることを意味します。
o Configured subscriptions can be modified by any configuration client with write permission on the configuration of the subscription. Dynamic subscriptions can only be modified via an RPC request made by the original subscriber or by a change to configuration data referenced by the subscription.
o 構成済みサブスクリプションは、サブスクリプションの構成に対する書き込み権限を持つ任意の構成クライアントによって変更できます。動的サブスクリプションは、元のサブスクライバーによって行われたRPC要求によって、またはサブスクリプションによって参照される構成データの変更によってのみ変更できます。
Note that there is no mixing and matching of dynamic and configured operations on a single subscription. Specifically, a configured subscription cannot be modified or deleted using RPCs defined in this document. Similarly, a dynamic subscription cannot be directly modified or deleted by configuration operations. It is, however, possible to perform a configuration operation that indirectly impacts a dynamic subscription. By changing the value of a preconfigured filter referenced by an existing dynamic subscription, the selected event records passed to a receiver might change.
単一のサブスクリプションでは、動的な操作と構成された操作の混在や照合は行われないことに注意してください。具体的には、このドキュメントで定義されているRPCを使用して、構成されたサブスクリプションを変更または削除することはできません。同様に、動的サブスクリプションは、構成操作によって直接変更または削除することはできません。ただし、動的サブスクリプションに間接的に影響する構成操作を実行することは可能です。既存の動的サブスクリプションによって参照される事前構成されたフィルターの値を変更することにより、レシーバーに渡される選択されたイベントレコードが変更される場合があります。
Also note that transport-specific specifications based on this specification MUST detail the lifecycle of dynamic subscriptions as well as the lifecycle of configured subscriptions (if supported).
また、この仕様に基づくトランスポート固有の仕様は、動的サブスクリプションのライフサイクルと構成済みサブスクリプションのライフサイクル（サポートされている場合）を詳述しなければならないことに注意してください。
A publisher MAY terminate a dynamic subscription at any time. Similarly, it MAY decide to temporarily suspend the sending of notification messages for any dynamic subscription, or for one or more receivers of a configured subscription. Such termination or suspension is driven by internal considerations of the publisher.
パブリッシャーは、動的サブスクリプションをいつでも終了できます（MAY）。同様に、動的サブスクリプション、または構成されたサブスクリプションの1つ以上の受信者に対する通知メッセージの送信を一時的に停止することを決定する場合があります。そのような終了または停止は、出版社の内部の考慮事項によって推進されます。
This document is intended to provide a superset of the subscription capabilities initially defined in [RFC5277]. It is important to understand what has been reused and what has been replaced, especially when extending an existing implementation that is based on [RFC5277]. Key relationships between these two documents include the following:
このドキュメントは、[RFC5277]で最初に定義されたサブスクリプション機能のスーパーセットを提供することを目的としています。特に[RFC5277]に基づく既存の実装を拡張する場合は、何が再利用され、何が置き換えられたかを理解することが重要です。これら2つのドキュメント間の主な関係は次のとおりです。
o This document defines a transport-independent capability; [RFC5277] is specific to NETCONF.
o このドキュメントでは、トランスポートに依存しない機能を定義しています。 [RFC5277]はNETCONFに固有です。
o For the new operations, the data model defined in this document is used instead of the data model defined in Section 3.4 of [RFC5277].
o 新しい操作では、[RFC5277]のセクション3.4で定義されたデータモデルの代わりに、このドキュメントで定義されたデータモデルが使用されます。
o The RPC operations in this document replace the operation <create-subscription> as defined in [RFC5277], Section 4.
o このドキュメントのRPC操作は、[RFC5277]のセクション4で定義されている<create-subscription>操作に代わるものです。
o The <notification> message of [RFC5277], Section 4 is used.
o [RFC5277]の<notification>メッセージ、セクション4が使用されます。
o The included contents of the "NETCONF" event stream are identical between this document and [RFC5277].
o 「NETCONF」イベントストリームに含まれる内容は、このドキュメントと[RFC5277]で同じです。
o A publisher MAY implement both the Notification Management Schema and RPCs defined in [RFC5277] and this document concurrently.
o 発行者は、[RFC5277]で定義されている通知管理スキーマとRPCの両方と、このドキュメントを同時に実装してもよい（MAY）。
o Unlike [RFC5277], this document enables a single transport session to intermix notification messages and RPCs for different subscriptions.
o [RFC5277]とは異なり、このドキュメントでは、単一のトランスポートセッションで、異なるサブスクリプションの通知メッセージとRPCを混在させることができます。
o A subscription "stop-time" can be specified as part of a notification replay. This supports a capability analogous to the <stopTime> parameter of [RFC5277]. However, in this specification, a "stop-time" parameter can also be applied without replay.
o サブスクリプション「stop-time」は、通知の再生の一部として指定できます。これは、[RFC5277]の<stopTime>パラメータに類似した機能をサポートします。ただし、この仕様では、「stop-time」パラメーターを再生せずに適用することもできます。
Per the overview provided in Section 1.3, this section details the overall context, state machines, and subsystems that may be assembled to allow the subscription of events from a publisher.
セクション1.3で提供される概要に従って、このセクションでは、パブリッシャーからのイベントのサブスクリプションを可能にするためにアセンブルされる可能性のある全体的なコンテキスト、ステートマシン、およびサブシステムについて詳しく説明します。
An event stream is a named entity on a publisher; this entity exposes a continuously updating set of YANG-defined event records. An event record is an instantiation of a "notification" YANG statement. If the "notification" is defined as a child to a data node, the instantiation includes the hierarchy of nodes that identifies the data node in the datastore (see Section 7.16.2 of [RFC7950]). Each event stream is available for subscription. Identifying a) how event streams are defined (other than the NETCONF stream), b) how event records are defined/generated, and c) how event records are assigned to event streams is out of scope for this document.
イベントストリームは、パブリッシャーの名前付きエンティティです。このエンティティは、継続的に更新されるYANG定義のイベントレコードのセットを公開します。イベントレコードは、「通知」YANGステートメントのインスタンス化です。 「通知」がデータノードの子として定義されている場合、インスタンス化には、データストア内のデータノードを識別するノードの階層が含まれます（[RFC7950]のセクション7.16.2を参照）。各イベントストリームはサブスクリプションに使用できます。 a）イベントストリームの定義方法（NETCONFストリーム以外）、b）イベントレコードの定義/生成方法、c）イベントレコードがイベントストリームに割り当てられる方法は、このドキュメントの範囲外です。
There is only one reserved event stream name in this document: "NETCONF". The "NETCONF" event stream contains all NETCONF event record information supported by the publisher, except where an event record has explicitly been excluded from the stream. Beyond the "NETCONF" stream, implementations MAY define additional event streams.
このドキュメントで予約されているイベントストリーム名は「NETCONF」のみです。 「NETCONF」イベントストリームには、イベントレコードがストリームから明示的に除外されている場合を除き、パブリッシャーがサポートするすべてのNETCONFイベントレコード情報が含まれています。 "NETCONF"ストリーム以外に、実装は追加のイベントストリームを定義してもよい（MAY）。
As YANG-defined event records are created by a system, they may be assigned to one or more streams. The event record is distributed to a subscription's receiver(s) where (1) a subscription includes the identified stream and (2) subscription filtering does not exclude the event record from that receiver.
YANG定義のイベントレコードはシステムによって作成されるため、1つ以上のストリームに割り当てることができます。イベントレコードはサブスクリプションのレシーバーに配布され、（1）サブスクリプションは識別されたストリームを含み、（2）サブスクリプションフィルタリングはそのレシーバーからイベントレコードを除外しません。
Access control permissions may be used to silently exclude event records from an event stream for which the receiver has no read access. See [RFC8341], Section 3.4.6 for an example of how this might be accomplished. Note that per Section 2.7 of this document, subscription state change notifications are never filtered out.
アクセス制御権限を使用して、受信者が読み取りアクセス権を持たないイベントストリームからイベントレコードをサイレントに除外できます。これを実現する方法の例については、[RFC8341]のセクション3.4.6を参照してください。このドキュメントのセクション2.7によると、サブスクリプションの状態変更通知がフィルターで除外されることはありません。
If no access control permissions are in place for event records on an event stream, then a receiver MUST be allowed access to all the event records. If subscriber permissions change during the lifecycle of a subscription and event stream access is no longer permitted, then the subscription MUST be terminated.
イベントストリームのイベントレコードに対するアクセス制御権限がない場合、受信者はすべてのイベントレコードへのアクセスを許可されている必要があります。サブスクリプションのライフサイクル中にサブスクライバーのアクセス許可が変更され、イベントストリームアクセスが許可されなくなった場合、サブスクリプションを終了する必要があります。
Event records MUST NOT be delivered to a receiver in a different order than the order in which they were placed on an event stream.
イベントレコードは、イベントストリームに配置された順序とは異なる順序でレシーバーに配信してはなりません（MUST NOT）。
This document defines an extensible filtering mechanism. The filter itself is a boolean test that is placed on the content of an event record. A "false" filtering result causes the event record to be excluded from delivery to a receiver. A filter never results in information being stripped from an event record prior to that event record being encapsulated in a notification message. The two optional event stream filtering syntaxes supported are [XPATH] and subtree [RFC6241].
このドキュメントでは、拡張可能なフィルタリングメカニズムを定義します。フィルター自体は、イベントレコードのコンテンツに配置されるブールテストです。 「偽」のフィルタリング結果により、イベントレコードが受信者への配信から除外されます。フィルターによって、イベントレコードが通知メッセージにカプセル化される前に、イベントレコードから情報が削除されることはありません。サポートされている2つのオプションのイベントストリームフィルタリング構文は、[XPATH]とサブツリー[RFC6241]です。
If no event stream filter is provided in a subscription, all event records on an event stream are to be sent.
サブスクリプションでイベントストリームフィルターが提供されていない場合、イベントストリームのすべてのイベントレコードが送信されます。
This document provides for several Quality of Service (QoS) parameters. These parameters indicate the treatment of a subscription relative to other traffic between publisher and receiver. Included are:
このドキュメントでは、いくつかのサービス品質（QoS）パラメータについて説明します。これらのパラメーターは、パブリッシャーとレシーバーの間の他のトラフィックに関連するサブスクリプションの扱いを示します。含まれています：
o A "dscp" marking to differentiate prioritization of notification messages during network transit.
o ネットワーク転送中の通知メッセージの優先順位を区別するための「dscp」マーキング。
o A "weighting" so that bandwidth proportional to this weighting can be allocated to this subscription relative to other subscriptions.
o この重み付けに比例する帯域幅を他のサブスクリプションと比較してこのサブスクリプションに割り当てることができるようにする「重み付け」。
o A "dependency" upon another subscription.
o 別のサブスクリプションへの「依存」。
If the publisher supports the "dscp" feature, then a subscription with a "dscp" leaf MUST result in a corresponding Differentiated Services Code Point (DSCP) marking [RFC2474] being placed in the IP header of any resulting notification messages and subscription state change notifications. A publisher MUST respect the DSCP markings for subscription traffic egressing that publisher.
パブリッシャーが "dscp"機能をサポートしている場合、 "dscp"リーフを使用したサブスクリプションは、対応するDiffServコードポイント（DSCP）マーキング[RFC2474]を、結果の通知メッセージおよびサブスクリプション状態の変更のIPヘッダーに配置する必要があります。通知。パブリッシャーは、そのパブリッシャーから出力されるサブスクリプショントラフィックのDSCPマーキングを尊重する必要があります。
Different DSCP code points require different transport connections. As a result, where TCP is used, a publisher that supports the "dscp" feature must ensure that a subscription's notification messages are returned in a single TCP transport session where all traffic shares the subscription's "dscp" leaf value. If this cannot be guaranteed, any "establish-subscription" RPC request SHOULD be rejected with a "dscp-unavailable" error.
異なるDSCPコードポイントには、異なるトランスポート接続が必要です。その結果、TCPが使用される場合、「dscp」機能をサポートするパブリッシャーは、すべてのトラフィックがサブスクリプションの「dscp」リーフ値を共有する単一のTCPトランスポートセッションでサブスクリプションの通知メッセージが返されるようにする必要があります。これが保証できない場合、「確立-サブスクリプション」RPC要求は「dscp-unavailable」エラーで拒否される必要があります（SHOULD）。
For the "weighting" parameter, when concurrently dequeuing notification messages from multiple subscriptions to a receiver, the publisher MUST allocate bandwidth to each subscription proportional to the weights assigned to those subscriptions. "Weighting" is an optional capability of the publisher; support for it is identified via the "qos" feature.
「重み付け」パラメータの場合、通知メッセージを複数のサブスクリプションからレシーバに同時にデキューするとき、パブリッシャは、それらのサブスクリプションに割り当てられた重みに比例して、各サブスクリプションに帯域幅を割り当てなければなりません（MUST）。 「重み付け」はパブリッシャーのオプション機能です。それに対するサポートは、「qos」機能によって識別されます。
If a subscription has the "dependency" parameter set, then any buffered notification messages containing event records selected by the parent subscription MUST be dequeued prior to the notification messages of the dependent subscription. If notification messages have dependencies on each other, the notification message queued the longest MUST go first. If a "dependency" included in an RPC references a subscription that does not exist or is no longer accessible to that subscriber, that "dependency" MUST be silently removed. "Dependency" is an optional capability of the publisher; support for it is identified via the "qos" feature.
サブスクリプションに "dependency"パラメータセットがある場合、親サブスクリプションによって選択されたイベントレコードを含むバッファリングされた通知メッセージは、依存サブスクリプションの通知メッセージの前にデキューする必要があります。通知メッセージが相互に依存している場合、キューに入れられた最長の通知メッセージが最初に移動する必要があります。 RPCに含まれている「依存関係」が、存在しないサブスクリプションを参照しているか、そのサブスクライバーがアクセスできなくなっている場合、その「依存関係」はサイレントに削除する必要があります。 「依存関係」はパブリッシャーのオプション機能です。それに対するサポートは、「qos」機能によって識別されます。
"Dependency" and "weighting" parameters will only be respected and enforced between subscriptions that share the same "dscp" leaf value.
「依存関係」および「重み付け」パラメーターは、同じ「dscp」リーフ値を共有するサブスクリプション間でのみ尊重および適用されます。
There are additional types of publisher capacity overload that this specification does not address, as they are out of scope. For example, the prioritization of which subscriptions have precedence when the publisher CPU is overloaded is not discussed. As a result, implementation choices will need to be made to address such considerations.
これらの仕様は範囲外であるため、この仕様では扱わない追加のタイプのパブリッシャー容量オーバーロードがあります。たとえば、パブリッシャーのCPUが過負荷になったときに優先されるサブスクリプションの優先順位付けについては説明されていません。その結果、そのような考慮事項に対処するために実装の選択を行う必要があります。
Dynamic subscriptions are managed via protocol operations (in the form of RPCs, per [RFC7950], Section 7.14) made against targets located in the publisher. These RPCs have been designed extensibly so that they may be augmented for subscription targets beyond event streams. For examples of such augmentations, see the RPC augmentations in the YANG data model provided in [RFC8641].
動的サブスクリプションは、パブリッシャー内にあるターゲットに対して行われたプロトコル操作（RPCの形式、[RFC7950]、セクション7.14）によって管理されます。これらのRPCは、イベントストリームを超えてサブスクリプションターゲット用に拡張できるように拡張可能に設計されています。このような拡張の例については、[RFC8641]で提供されているYANGデータモデルのRPC拡張を参照してください。
Below is the publisher's state machine for a dynamic subscription. Each state is shown in its own box. It is important to note that such a subscription doesn't exist at the publisher until an "establish-subscription" RPC is accepted. The mere request by a subscriber to establish a subscription is not sufficient for that subscription to be externally visible. Start and end states are depicted to reflect subscription creation and deletion events.
以下は、動的サブスクリプションのパブリッシャーの状態マシンです。各状態はそれぞれのボックスに表示されます。そのようなサブスクリプションは、「確立サブスクリプション」RPCが受け入れられるまでパブリッシャーに存在しないことに注意することが重要です。サブスクリプションを確立するためのサブスクライバーによる単なる要求だけでは、そのサブスクリプションを外部から見ることができません。開始と終了の状態は、サブスクリプションの作成と削除のイベントを反映するために示されています。
.........
: start :
:.......:
|
establish-subscription
|
| .-------modify-subscription--------.
v v |
.-----------. .-----------.
.--------. | receiver |--insufficient CPU, b/w-->| receiver |
modify- '| active | | suspended |
subscription | |<----CPU, b/w sufficient--| |
---------->'-----------' '-----------'
| |
delete/kill-subscription delete/kill-
| subscription
v |
......... |
: end :<---------------------------------'
:.......:
Figure 1: Publisher's State Machine for a Dynamic Subscription
図1：動的サブスクリプションのパブリッシャーの状態マシン
Of interest in this state machine are the following:
このステートマシンで興味深いのは次のとおりです。
o Successful "establish-subscription" or "modify-subscription" RPCs move the subscription to the "active" state.
o 「establish-subscription」または「modify-subscription」RPCが成功すると、サブスクリプションが「アクティブ」状態に移行します。
o Failed "modify-subscription" RPCs will leave the subscription in its previous state, with no visible change to any streaming updates.
o 失敗した「modify-subscription」RPCは、サブスクリプションを以前の状態のままにし、ストリーミング更新に目に見える変化はありません。
o A "delete-subscription" or "kill-subscription" RPC will end the subscription, as will reaching a "stop-time".
o 「delete-subscription」または「kill-subscription」RPCはサブスクリプションを終了し、「stop-time」に到達します。
o A publisher may choose to suspend a subscription when there is not sufficient CPU or bandwidth available to service the subscription. This is announced to the subscriber via the "subscription-suspended" subscription state change notification.
o パブリッシャーは、サブスクリプションを処理するのに十分なCPUまたは帯域幅が利用できない場合、サブスクリプションを一時停止することを選択できます。これは、「サブスクリプションが一時停止された」サブスクリプション状態変更通知を介してサブスクライバーに通知されます。
o A suspended subscription may be modified by the subscriber (for example, in an attempt to use fewer resources). Successful modification returns the subscription to the "active" state.
o 一時停止されたサブスクリプションは、サブスクライバーによって変更される可能性があります（たとえば、使用するリソースを減らすため）。変更が成功すると、サブスクリプションが「アクティブ」状態に戻ります。
o Even without a "modify-subscription" request, a publisher may return a subscription to the "active" state when sufficient resources are again available. This is announced to the subscriber via the "subscription-resumed" subscription state change notification.
o 「サブスクリプションの変更」リクエストがない場合でも、パブリッシャーは、十分なリソースが再び利用可能になると、サブスクリプションを「アクティブ」状態に戻すことがあります。これは、「サブスクリプション再開」サブスクリプション状態変更通知を介してサブスクライバーに通知されます。
The "establish-subscription" RPC allows a subscriber to request the creation of a subscription.
「establish-subscription」RPCにより、サブスクライバーはサブスクリプションの作成を要求できます。
The input parameters of the operation are:
操作の入力パラメーターは次のとおりです。
o A "stream" name, which identifies the targeted event stream against which the subscription is applied.
o サブスクリプションが適用される対象のイベントストリームを識別する「ストリーム」名。
o An event stream filter, which may reduce the set of event records pushed.
o プッシュされるイベントレコードのセットを減らすことができるイベントストリームフィルター。
o If the transport used by the RPC supports multiple encodings, an optional "encoding" for the event records pushed. If no "encoding" is included, the encoding of the RPC MUST be used.
o RPCで使用されるトランスポートが複数のエンコーディングをサポートしている場合、イベントレコードのオプションの「エンコーディング」がプッシュされます。 「エンコーディング」が含まれていない場合は、RPCのエンコーディングを使用する必要があります。
o An optional "stop-time" for the subscription. If no "stop-time" is present, notification messages will continue to be sent until the subscription is terminated.
o サブスクリプションのオプションの「停止時間」。 「stop-time」がない場合、サブスクリプションが終了するまで通知メッセージが送信され続けます。
o An optional "replay-start-time" for the subscription. The "replay-start-time" MUST be in the past and indicates that the subscription is requesting a replay of previously generated information from the event stream. For more on replay, see Section 2.4.2.1. If there is no "replay-start-time", the subscription starts immediately.
o サブスクリプションのオプションの「再生開始時間」。 「replay-start-time」は過去でなければならず、サブスクリプションがイベントストリームから以前に生成された情報の再生を要求していることを示します。再生の詳細については、2.4.2.1項を参照してください。 「replay-start-time」がない場合、サブスクリプションはすぐに開始されます。
If the publisher can satisfy the "establish-subscription" request, it replies with an identifier for the subscription and then immediately starts streaming notification messages.
パブリッシャーが「establish-subscription」リクエストを満たすことができる場合、パブリッシャーはサブスクリプションの識別子で応答し、すぐに通知メッセージのストリーミングを開始します。
Below is a tree diagram for "establish-subscription". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「establish-subscription」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---x establish-subscription
+---w input
| +---w (target)
| | +--:(stream)
| | +---w (stream-filter)?
| | | +--:(by-reference)
| | | | +---w stream-filter-name
| | | | stream-filter-ref
| | | +--:(within-subscription)
| | | +---w (filter-spec)?
| | | +--:(stream-subtree-filter)
| | | | +---w stream-subtree-filter? <anydata>
| | | | {subtree}?
| | | +--:(stream-xpath-filter)
| | | +---w stream-xpath-filter?
| | | yang:xpath1.0 {xpath}?
| | +---w stream stream-ref
| | +---w replay-start-time?
| | yang:date-and-time {replay}?
| +---w stop-time?
| | yang:date-and-time
| +---w dscp? inet:dscp
| | {dscp}?
| +---w weighting? uint8
| | {qos}?
| +---w dependency?
| | subscription-id {qos}?
| +---w encoding? encoding
+--ro output
+--ro id subscription-id
+--ro replay-start-time-revision? yang:date-and-time
{replay}?
Figure 2: "establish-subscription" RPC Tree Diagram
図2：「establish-subscription」RPCツリー図
A publisher MAY reject the "establish-subscription" RPC for many reasons, as described in Section 2.4.6. The contents of the resulting RPC error response MAY include details on input parameters that, if considered in a subsequent "establish-subscription" RPC, may result in successful subscription establishment. Any such hints MUST be transported in a yang-data "establish-subscription-stream-error-info" container included in the RPC error response.
セクション2.4.6で説明されているように、パブリッシャは多くの理由で「確立サブスクリプション」RPCを拒否してもよい（MAY）。結果のRPCエラー応答の内容には、後続の「establish-subscription」RPCで考慮された場合に、サブスクリプションの確立が成功する可能性がある入力パラメーターの詳細が含まれる場合があります。このようなヒントは、RPCエラー応答に含まれるyang-data "establish-subscription-stream-error-info"コンテナで転送する必要があります。
Below is a tree diagram for "establish-subscription-stream-error-info" RPC yang-data. All objects contained in this tree are described in the YANG module in Section 4.
以下は、「establish-subscription-stream-error-info」RPC yang-dataのツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
yang-data establish-subscription-stream-error-info
+--ro establish-subscription-stream-error-info
+--ro reason? identityref
+--ro filter-failure-hint? string
Figure 3: "establish-subscription-stream-error-info" RPC yang-data Tree Diagram
図3：「establish-subscription-stream-error-info」RPCヤンデータツリー図
Replay provides the ability to establish a subscription that is also capable of passing event records generated in the recent past. In other words, as the subscription initializes itself, it sends any event records in the target event stream that meet the filter criteria that have an event time that is after the "replay-start-time" and also have an event time before the "stop-time" should this "stop-time" exist. The end of these historical event records is identified via a "replay-completed" subscription state change notification. Any event records generated since the subscription establishment may then follow. For a particular subscription, all event records will be delivered in the order in which they are placed in the event stream.
リプレイは、最近生成されたイベントレコードを渡すこともできるサブスクリプションを確立する機能を提供します。言い換えると、サブスクリプションはそれ自体を初期化するときに、「replay-start-time」より後のイベント時間を持ち、「この「停止時間」が存在する場合は、「停止時間」。これらの履歴イベントレコードの終わりは、「再生完了」サブスクリプション状態変更通知によって識別されます。その後、サブスクリプションの確立以降に生成されたイベントレコードが続く場合があります。特定のサブスクリプションの場合、すべてのイベントレコードは、イベントストリームに配置された順序で配信されます。
Replay is an optional feature that is dependent on an event stream supporting some form of logging. This document puts no restrictions on the size or form of the log, where it resides in the publisher, or when event record entries in the log are purged.
再生は、何らかの形式のロギングをサポートするイベントストリームに依存するオプション機能です。このドキュメントでは、ログのサイズや形式、パブリッシャー内にあるログ、またはログのイベントレコードエントリが削除されるタイミングに制限はありません。
The inclusion of a "replay-start-time" in an "establish-subscription" RPC indicates a replay request. If the "replay-start-time" contains a value that is earlier than what a publisher's retained history supports, then if the subscription is accepted, the actual publisher's revised start time MUST be set in the returned "replay-start-time-revision" object.
「establish-subscription」RPCに「replay-start-time」が含まれている場合は、再生要求を示します。 「replay-start-time」に、パブリッシャーの保持履歴がサポートする値よりも早い値が含まれている場合、サブスクリプションが受け入れられる場合、実際のパブリッシャーの改訂された開始時刻を、返された「replay-start-time-revision」に設定する必要があります。 "オブジェクト。
A "stop-time" parameter may be included in a replay subscription. For a replay subscription, the "stop-time" MAY be earlier than the current time but MUST be later than the "replay-start-time".
「stop-time」パラメータは、再生サブスクリプションに含めることができます。リプレイサブスクリプションの場合、 "stop-time"は現在の時刻よりも早くてもかまいませんが、 "replay-start-time"よりも遅くする必要があります。
If the given "replay-start-time" is later than the time marked in any event records retained in the replay buffer, then the publisher MUST send a "replay-completed" notification immediately after a successful "establish-subscription" RPC response.
指定された「replay-start-time」が、リプレイバッファーに保持されているイベントレコードでマークされた時間よりも遅い場合、パブリッシャーは、「establish-subscription」RPC応答が成功した直後に「replay-completed」通知を送信する必要があります。
If an event stream supports replay, the "replay-support" leaf is present in the "/streams/stream" list entry for the event stream. An event stream that does support replay is not expected to have an unlimited supply of saved notifications available to accommodate any given replay request. To assess the timeframe available for replay, subscribers can read the leafs "replay-log-creation-time" and "replay-log-aged-time". See Figure 18 for the YANG tree and Section 4 for the YANG module describing these elements. The actual size of the replay log at any given time is a publisher-specific matter. Control parameters for the replay log are outside the scope of this document.
イベントストリームが再生をサポートする場合、「replay-support」リーフは、イベントストリームの「/ streams / stream」リストエントリに存在します。リプレイをサポートするイベントストリームは、任意のリプレイリクエストに対応するために保存された通知を無制限に提供できるとは想定されていません。リプレイに利用可能な時間枠を評価するために、サブスクライバーはリーフの「リプレイログ作成時間」と「リプレイログ保存時間」を読み取ることができます。 YANGツリーについては図18を、これらの要素を説明するYANGモジュールについてはセクション4を参照してください。任意の時点での再生ログの実際のサイズは、発行元固有の問題です。再生ログの制御パラメーターは、このドキュメントの範囲外です。
The "modify-subscription" operation permits changing the terms of an existing dynamic subscription. Dynamic subscriptions can be modified any number of times. Dynamic subscriptions can only be modified via this RPC using a transport session connecting to the subscriber. If the publisher accepts the requested modifications, it acknowledges success to the subscriber, then immediately starts sending event records based on the new terms.
「変更サブスクリプション」操作では、既存の動的サブスクリプションの条件を変更できます。動的サブスクリプションは何度でも変更できます。動的サブスクリプションは、サブスクライバーに接続するトランスポートセッションを使用してこのRPC経由でのみ変更できます。パブリッシャーが要求された変更を受け入れると、サブスクライバーに成功を認め、すぐに新しい条件に基づいてイベントレコードの送信を開始します。
Subscriptions created by configuration cannot be modified via this RPC. However, configuration may be used to modify objects referenced by the subscription (such as a referenced filter).
構成によって作成されたサブスクリプションは、このRPCを介して変更できません。ただし、構成は、サブスクリプションによって参照されるオブジェクト（参照されるフィルターなど）を変更するために使用できます。
Below is a tree diagram for "modify-subscription". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「変更サブスクリプション」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---x modify-subscription
+---w input
+---w id
| subscription-id
+---w (target)
| +--:(stream)
| +---w (stream-filter)?
| +--:(by-reference)
| | +---w stream-filter-name
| | stream-filter-ref
| +--:(within-subscription)
| +---w (filter-spec)?
| +--:(stream-subtree-filter)
| | +---w stream-subtree-filter? <anydata>
| | {subtree}?
| +--:(stream-xpath-filter)
| +---w stream-xpath-filter?
| yang:xpath1.0 {xpath}?
+---w stop-time?
yang:date-and-time
Figure 4: "modify-subscription" RPC Tree Diagram
図4：「modify-subscription」RPCツリー図
If the publisher accepts the requested modifications on a currently suspended subscription, the subscription will immediately be resumed (i.e., the modified subscription is returned to the "active" state). The publisher MAY immediately suspend this newly modified subscription through the "subscription-suspended" notification before any event records are sent.
パブリッシャーが現在一時停止中のサブスクリプションで要求された変更を受け入れると、サブスクリプションはすぐに再開されます（つまり、変更されたサブスクリプションは「アクティブ」状態に戻ります）。パブリッシャーは、イベントレコードが送信される前に、「subscription-suspended」通知を介して、この新しく変更されたサブスクリプションをすぐに一時停止できます。
If the publisher rejects the RPC request, the subscription remains as it was prior to the request. That is, the request has no impact whatsoever. Rejection of the RPC for any reason is indicated via an RPC error as described in Section 2.4.6. The contents of such a rejected RPC MAY include hints on inputs that (if considered) may result in a successfully modified subscription. These hints MUST be transported in a yang-data "modify-subscription-stream-error-info" container inserted into the RPC error response.
パブリッシャーがRPC要求を拒否した場合、サブスクリプションは要求の前と同じままです。つまり、リクエストはまったく影響しません。何らかの理由によるRPCの拒否は、セクション2.4.6で説明されているRPCエラーによって示されます。そのような拒否されたRPCの内容には、（考慮された場合）サブスクリプションが正常に変更される可能性がある入力に関するヒントが含まれる場合があります。これらのヒントは、RPCエラー応答に挿入されたyang-data "modify-subscription-stream-error-info"コンテナーで転送する必要があります。
Below is a tree diagram for "modify-subscription-stream-error-info" RPC yang-data. All objects contained in this tree are described in the YANG module in Section 4.
以下は、「modify-subscription-stream-error-info」RPC yang-dataのツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
yang-data modify-subscription-stream-error-info
+--ro modify-subscription-stream-error-info
+--ro reason? identityref
+--ro filter-failure-hint? string
Figure 5: "modify-subscription-stream-error-info" RPC yang-data Tree Diagram
図5：「modify-subscription-stream-error-info」RPCヤンデータツリー図
The "delete-subscription" operation permits canceling an existing subscription. If the publisher accepts the request and the publisher has indicated success, the publisher MUST NOT send any more notification messages for this subscription.
「サブスクリプションの削除」操作では、既存のサブスクリプションをキャンセルできます。パブリッシャーが要求を受け入れ、パブリッシャーが成功を示した場合、パブリッシャーはこのサブスクリプションに対してこれ以上の通知メッセージを送信してはなりません（MUST NOT）。
Below is a tree diagram for "delete-subscription". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「delete-subscription」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---x delete-subscription
+---w input
+---w id subscription-id
Figure 6: "delete-subscription" RPC Tree Diagram
図6： "delete-subscription" RPCツリー図
Dynamic subscriptions can only be deleted via this RPC using a transport session connecting to the subscriber. Configured subscriptions cannot be deleted using RPCs.
動的サブスクリプションは、サブスクライバーに接続するトランスポートセッションを使用してこのRPC経由でのみ削除できます。構成されたサブスクリプションは、RPCを使用して削除することはできません。
The "kill-subscription" operation permits an operator to end a dynamic subscription that is not associated with the transport session used for the RPC. A publisher MUST terminate any dynamic subscription identified by the "id" parameter in the RPC request, if such a subscription exists.
「kill-subscription」操作により、オペレーターはRPCに使用されるトランスポートセッションに関連付けられていない動的サブスクリプションを終了できます。そのようなサブスクリプションが存在する場合、パブリッシャーはRPCリクエストの「id」パラメーターで識別される動的サブスクリプションを終了する必要があります。
Configured subscriptions cannot be killed using this RPC. Instead, configured subscriptions are deleted as part of regular configuration operations. Publishers MUST reject any RPC attempt to kill a configured subscription.
このRPCを使用して、構成されたサブスクリプションを強制終了することはできません。代わりに、構成済みのサブスクリプションは、通常の構成操作の一部として削除されます。パブリッシャーは、構成されたサブスクリプションを強制終了するRPCの試みを拒否する必要があります。
Below is a tree diagram for "kill-subscription". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「kill-subscription」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---x kill-subscription
+---w input
+---w id subscription-id
Figure 7: "kill-subscription" RPC Tree Diagram
図7：「kill-subscription」RPCツリー図
Whenever an RPC is unsuccessful, the publisher returns relevant information as part of the RPC error response. Transport-level error processing MUST be done before the RPC error processing described in this section. In all cases, RPC error information returned by the publisher will use existing transport-layer RPC structures, such as those seen with NETCONF (Appendix A of [RFC6241]) or RESTCONF (Section 7.1 of [RFC8040]). These structures MUST be able to encode subscription-specific errors identified below and defined in this document's YANG data model.
RPCが失敗すると、パブリッシャーはRPCエラー応答の一部として関連情報を返します。このセクションで説明するRPCエラー処理の前に、トランスポートレベルのエラー処理を実行する必要があります。すべての場合において、パブリッシャーによって返されるRPCエラー情報は、NETCONF（[RFC6241]の付録A）またはRESTCONF（[RFC8040]のセクション7.1）で見られるものなど、既存のトランスポート層RPC構造を使用します。これらの構造は、以下で識別され、このドキュメントのYANGデータモデルで定義されているサブスクリプション固有のエラーをエンコードできる必要があります。
As a result of this variety, how subscription errors are encoded in an RPC error response is transport dependent. Valid errors that can occur for each RPC are as follows:
この多様性の結果、RPCエラー応答でサブスクリプションエラーがどのようにエンコードされるかは、トランスポートに依存します。各RPCで発生する可能性のある有効なエラーは次のとおりです。
establish-subscription modify-subscription
---------------------- ----------------------
dscp-unavailable filter-unsupported
encoding-unsupported insufficient-resources
filter-unsupported no-such-subscription
insufficient-resources
replay-unsupported
delete-subscription kill-subscription
---------------------- ----------------------
no-such-subscription no-such-subscription
To see a NETCONF-based example of an error response from the list above, see the "no-such-subscription" error response illustrated in [RFC8640], Figure 10.
上記のリストのエラー応答のNETCONFベースの例を確認するには、[RFC8640]の図10に示されている「no-such-subscription」エラー応答を参照してください。
There is one final set of transport-independent RPC error elements included in the YANG data model defined in this document: three yang-data structures that enable the publisher to provide to the receiver any error information that does not fit into existing transport-layer RPC structures. These structures are:
このドキュメントで定義されているYANGデータモデルには、トランスポートに依存しないRPCエラー要素の最後のセットが1つあります。パブリッシャーが既存のトランスポートレイヤーRPCに適合しないエラー情報をレシーバーに提供できるようにする3つのヤンデータ構造構造。これらの構造は次のとおりです。
1. "establish-subscription-stream-error-info": This MUST be returned with the leaf "reason" populated if an RPC error reason has not been placed elsewhere in the transport portion of a failed "establish-subscription" RPC response. This MUST be sent if hints on how to overcome the RPC error are included.
1. "establish-subscription-stream-error-info"：失敗した "establish-subscription" RPC応答のトランスポート部分の他の場所にRPCエラー理由が配置されていない場合は、リーフ "reason"が入力された状態で返される必要があります。 RPCエラーを克服する方法に関するヒントが含まれている場合、これを送信する必要があります。
2. "modify-subscription-stream-error-info": This MUST be returned with the leaf "reason" populated if an RPC error reason has not been placed elsewhere in the transport portion of a failed "modify-subscription" RPC response. This MUST be sent if hints on how to overcome the RPC error are included.
2. 「modify-subscription-stream-error-info」：失敗した「modify-subscription」RPC応答のトランスポート部分の他の場所にRPCエラー理由が配置されていない場合は、リーフ「reason」が入力された状態で返される必要があります。 RPCエラーを克服する方法に関するヒントが含まれている場合、これを送信する必要があります。
3. "delete-subscription-error-info": This MUST be returned with the leaf "reason" populated if an RPC error reason has not been placed elsewhere in the transport portion of a failed "delete-subscription" or "kill-subscription" RPC response.
3. "delete-subscription-error-info"：失敗した "delete-subscription"または "kill-subscription" RPCのトランスポート部分の他の場所にRPCエラー理由が配置されていない場合は、リーフ "reason"が入力された状態で返される必要があります応答。
A configured subscription is a subscription installed via configuration. Configured subscriptions may be modified by any configuration client with the proper permissions. Subscriptions can be modified or terminated via configuration at any point during their lifetime. Multiple configured subscriptions MUST be supportable over a single transport session.
構成済みサブスクリプションは、構成を介してインストールされるサブスクリプションです。構成されたサブスクリプションは、適切な権限を持つ任意の構成クライアントによって変更できます。サブスクリプションは、その存続期間中いつでも構成を介して変更または終了できます。複数の構成済みサブスクリプションは、単一のトランスポートセッションでサポート可能である必要があります。
Configured subscriptions have several characteristics distinguishing them from dynamic subscriptions:
構成済みサブスクリプションには、動的サブスクリプションとは異なるいくつかの特性があります。
o persistence across publisher reboots,
o パブリッシャーの再起動後の持続性、
o persistence even when transport is unavailable, and
o トランスポートが利用できない場合でも永続性
o an ability to send notification messages to more than one receiver. (Note that receivers are unaware of the existence of any other receivers.)
o 通知メッセージを複数の受信者に送信する機能。 （レシーバーは他のレシーバーの存在を認識しないことに注意してください。）
On the publisher, support for configured subscriptions is optional and advertised using the "configured" feature. On a receiver of a configured subscription, support for dynamic subscriptions is optional. However, if replaying missed event records is required for a configured subscription, support for dynamic subscription is highly recommended. In this case, a separate dynamic subscription can be established to retransmit the missing event records.
パブリッシャーでは、構成済みサブスクリプションのサポートはオプションであり、「構成済み」機能を使用してアドバタイズされます。構成済みサブスクリプションの受信側では、動的サブスクリプションのサポートはオプションです。ただし、構成されたサブスクリプションで欠落したイベントレコードを再生する必要がある場合は、動的サブスクリプションのサポートを強くお勧めします。この場合、別の動的サブスクリプションを確立して、欠落しているイベントレコードを再送信できます。
In addition to the subscription parameters available to dynamic subscriptions as described in Section 2.4.2, the following additional parameters are also available to configured subscriptions:
セクション2.4.2で説明されている動的サブスクリプションで使用可能なサブスクリプションパラメータに加えて、次の追加パラメータも構成済みサブスクリプションで使用できます。
o A "transport", which identifies the transport protocol to use to connect with all subscription receivers.
o すべてのサブスクリプションレシーバーとの接続に使用するトランスポートプロトコルを識別する「トランスポート」。
o One or more receivers, each intended as the destination for event records. Note that each individual receiver is identifiable by its "name".
o それぞれがイベントレコードの宛先として意図された1つ以上のレシーバー。個々のレシーバーはそれぞれ「名前」で識別できることに注意してください。
o Optional parameters to identify where traffic should egress a publisher:
o トラフィックがパブリッシャーを出て行く場所を特定するオプションのパラメーター：
* A "source-interface", which identifies the egress interface to use from the publisher. Publisher support for this parameter is optional and advertised using the "interface-designation" feature.
* パブリッシャーから使用する出力インターフェースを識別する「ソースインターフェース」。このパラメーターに対するパブリッシャーのサポートはオプションであり、「インターフェース指定」機能を使用してアドバタイズされます。
* A "source-address" address, which identifies the IP address to stamp on notification messages destined for the receiver.
* 「送信元アドレス」アドレス。これは、受信者宛ての通知メッセージにスタンプするIPアドレスを識別します。
* A "source-vrf", which identifies the Virtual Routing and Forwarding (VRF) instance on which to reach receivers. This VRF is a network instance as defined in [RFC8529]. Publisher support for VRFs is optional and advertised using the "supports-vrf" feature.
* 「source-vrf」は、レシーバーに到達する仮想ルーティングおよび転送（VRF）インスタンスを識別します。このVRFは、[RFC8529]で定義されているネットワークインスタンスです。 VRFのパブリッシャーサポートはオプションであり、「supports-vrf」機能を使用してアドバタイズされます。
If none of the above parameters are set, notification messages MUST egress the publisher's default interface.
上記のパラメーターのいずれも設定されていない場合、通知メッセージはパブリッシャーのデフォルトインターフェイスから出力する必要があります。
A tree diagram that includes these parameters is provided in Figure 20 in Section 3.3. These parameters are described in the YANG module in Section 4.
これらのパラメーターを含むツリー図は、セクション3.3の図20に示されています。これらのパラメータは、セクション4のYANGモジュールで説明されています。
Below is the state machine for a configured subscription on the publisher. This state machine describes the three states ("valid", "invalid", and "concluded") as well as the transitions between these states. Start and end states are depicted to reflect configured subscription creation and deletion events. The creation or modification of a configured subscription initiates an evaluation by the publisher to determine if the subscription is in the
以下は、パブリッシャーで構成されたサブスクリプションの状態マシンです。この状態マシンは、3つの状態（「有効」、「無効」、および「結論」）と、これらの状態間の遷移を記述します。開始および終了状態は、構成されたサブスクリプションの作成および削除イベントを反映するように示されています。構成されたサブスクリプションの作成または変更により、パブリッシャーによる評価が開始され、サブスクリプションが
"valid" state or the "invalid" state. The publisher uses its own criteria in making this determination. If in the "valid" state, the subscription becomes operational. See (1) in the diagram below.
「有効」状態または「無効」状態。パブリッシャーは、この決定を行う際に独自の基準を使用します。 「有効」状態の場合、サブスクリプションは操作可能になります。下図の（1）を参照してください。
.........
: start :-.
:.......: |
create .---modify-----.----------------------------------.
| | | |
V V .-------. ....... .---------.
.----[evaluate]--no--->|invalid|-delete->: end :<-delete-|concluded|
| '-------' :.....: '---------'
|-[evaluate]--no-(2). ^ ^ ^
| ^ | | | |
yes | '->unsupportable delete stop-time
| modify (subscription- (subscription- (subscription-
| | terminated*) terminated*) concluded*)
| | | | |
(1) | (3) (4) (5)
| .---------------------------------------------------------------.
'-->| valid |
'---------------------------------------------------------------'
Legend: Dotted boxes: subscription added or removed via configuration Dashed boxes: states for a subscription [evaluate]: decision point on whether the subscription is supportable (*): resulting subscription state change notification
凡例：点線のボックス：構成によって追加または削除されたサブスクリプション破線のボックス：サブスクリプションの状態[評価]：サブスクリプションがサポート可能かどうかの決定ポイント（*）：結果のサブスクリプションの状態変更通知
Figure 8: Publisher's State Machine for a Configured Subscription
図8：構成されたサブスクリプションのパブリッシャーの状態マシン
A subscription in the "valid" state may move to the "invalid" state in one of two ways. First, it may be modified in a way that fails a re-evaluation. See (2) in the diagram. Second, the publisher might determine that the subscription is no longer supportable. This could be because of an unexpected but sustained increase in an event stream's event records, degraded CPU capacity, a more complex referenced filter, or other subscriptions that have usurped resources. See (3) in the diagram. No matter the case, a "subscription-terminated" notification is sent to any receivers in the "active" or "suspended" state. A subscription in the "valid" state may also transition to the "concluded" state via (5) if a configured stop time has been reached. In this case, a "subscription-concluded" notification is sent to any receivers in the "active" or "suspended" state. Finally, a subscription may be deleted by configuration (4).
「有効」状態のサブスクリプションは、2つの方法のいずれかで「無効」状態に移行する可能性があります。まず、再評価に失敗するように修正される可能性があります。図の（2）を参照してください。次に、パブリッシャーはサブスクリプションがサポートされなくなったと判断する場合があります。これは、イベントストリームのイベントレコードの予期しないが持続的な増加、CPU容量の低下、より複雑な参照フィルター、またはリソースを奪われた他のサブスクリプションが原因である可能性があります。図の（3）を参照してください。いずれの場合でも、「サブスクリプション終了」通知は、「アクティブ」または「一時停止」状態の受信者に送信されます。 「有効」状態のサブスクリプションは、構成された停止時間に達した場合、（5）を介して「確定」状態に移行することもあります。この場合、「サブスクリプション契約」通知は、「アクティブ」または「一時停止」状態の受信者に送信されます。最後に、サブスクリプションは構成（4）によって削除できます。
When a subscription is in the "valid" state, a publisher will attempt to connect with all receivers of a configured subscription and deliver notification messages. Below is the state machine for each receiver of a configured subscription. This receiver state machine is fully contained in the state machine of the configured subscription and is only relevant when the configured subscription is in the "valid" state.
サブスクリプションが「有効」な状態の場合、パブリッシャーは、構成されたサブスクリプションのすべてのレシーバーに接続し、通知メッセージを配信しようとします。以下は、構成済みサブスクリプションの各レシーバーのステートマシンです。このレシーバー状態マシンは、構成済みサブスクリプションの状態マシンに完全に含まれており、構成済みサブスクリプションが「有効」状態にある場合にのみ関係します。
.-----------------------------------------------------------------.
| valid |
| .----------. .------------. |
| | receiver |---timeout---------------->| receiver | |
| |connecting|<----------------reset--(c)|disconnected| |
| | |<-transport '------------' |
| '----------' loss,reset------------------------------. |
| (a) | | |
| subscription- (b) (b) |
| started* .--------. .---------. |
| '----->| |(d)-insufficient CPU,------->| | |
| |receiver| buffer overflow |receiver | |
| subscription-| active | |suspended| |
| modified* | |<----CPU, b/w sufficient,-(e)| | |
| '---->'--------' subscription-modified* '---------' |
'-----------------------------------------------------------------'
Legend: Dashed boxes that include the word "receiver" show the possible states for an individual receiver of a valid configured subscription.
凡例：「レシーバー」という単語を含む破線のボックスは、有効な構成済みサブスクリプションの個々のレシーバーの可能な状態を示しています。
* indicates a subscription state change notification
* サブスクリプションの状態変更通知を示します
Figure 9: Receiver State Machine for a Configured Subscription on a Publisher
図9：パブリッシャーで構成されたサブスクリプションのレシーバーステートマシン
When a configured subscription first moves to the "valid" state, the "state" leaf of each receiver is initialized to the "connecting" state. If transport connectivity is not available to any receivers and there are any notification messages to deliver, a transport session is established (e.g., per [RFC8071]). Individual receivers are moved to the "active" state when a "subscription-started" subscription state change notification is successfully passed to that receiver (a). Event records are only sent to active receivers. Receivers of a configured subscription remain active on the publisher if both (1) transport connectivity to the receiver is active and (2) event records are not being dropped due to a publisher's sending capacity being reached. In addition, a configured subscription's receiver MUST be moved to the "connecting" state if the receiver is reset via the "reset" action (b), (c). For more on the "reset" action, see Section 2.5.5. If transport connectivity cannot be achieved while in the "connecting" state, the receiver MAY be moved to the "disconnected" state.
構成済みのサブスクリプションが最初に「有効」状態に移行すると、各レシーバーの「状態」リーフが「接続中」状態に初期化されます。トランスポート接続がレシーバーで利用できず、配信する通知メッセージがある場合、トランスポートセッションが確立されます（[RFC8071]など）。 「サブスクリプション開始」サブスクリプション状態変更通知がそのレシーバーに正常に渡されると、個々のレシーバーは「アクティブ」状態に移行します（a）。イベントレコードはアクティブな受信者にのみ送信されます。 （1）レシーバーへのトランスポート接続がアクティブであり、（2）パブリッシャーの送信容量に達したためにイベントレコードがドロップされない場合、構成されたサブスクリプションのレシーバーはパブリッシャーでアクティブなままです。さらに、レシーバーが「リセット」アクション（b）、（c）を介してリセットされた場合、構成されたサブスクリプションのレシーバーは「接続中」状態に移行する必要があります。 「リセット」アクションの詳細については、セクション2.5.5を参照してください。 「接続中」の状態でトランスポート接続が達成できない場合、レシーバーは「切断」状態に移行する場合があります。
A configured subscription's receiver MUST be moved to the "suspended" state if there is transport connectivity between the publisher and receiver but (1) delivery of notification messages is failing due to a publisher's buffer capacity being reached or (2) notification messages cannot be generated for that receiver due to insufficient CPU (d). This is indicated to the receiver by the "subscription-suspended" subscription state change notification.
パブリッシャーとレシーバーの間にトランスポート接続があるが、（1）パブリッシャーのバッファー容量に達したために通知メッセージの配信が失敗した、または（2）通知メッセージを生成できない場合、構成済みサブスクリプションのレシーバーを「一時停止」状態に移動する必要があります不十分なCPU（d）によるその受信機の場合。これは、「サブスクリプションが中断された」サブスクリプション状態変更通知によって受信者に示されます。
A configured subscription's receiver MUST be returned to the "active" state from the "suspended" state when notification messages can be generated, bandwidth is sufficient to handle the notification messages, and a receiver has successfully been sent a "subscription-resumed" or "subscription-modified" subscription state change notification (e). The choice as to which of these two subscription state change notifications is sent is determined by whether the subscription was modified during the period of suspension.
通知メッセージを生成でき、通知メッセージを処理するのに十分な帯域幅があり、受信者に「サブスクリプション再開」または「サブスクリプション再開」が正常に送信された場合、構成済みサブスクリプションの受信者を「一時停止」状態から「アクティブ」状態に戻す必要がありますsubscription-modified "サブスクリプション状態変更通知（e）。これら2つのサブスクリプション状態変更通知のどちらを送信するかは、一時停止中にサブスクリプションが変更されたかどうかによって決まります。
Modification of a configured subscription is possible at any time. A "subscription-modified" subscription state change notification will be sent to all active receivers, immediately followed by notification messages conforming to the new parameters. Suspended receivers will also be informed of the modification. However, this notification will await the end of the suspension for that receiver (e).
構成されたサブスクリプションの変更はいつでも可能です。 「サブスクリプションが変更された」サブスクリプション状態変更通知がすべてのアクティブな受信者に送信され、その後すぐに新しいパラメーターに準拠した通知メッセージが送信されます。中断された受信者にも変更が通知されます。ただし、この通知は、その受信者の一時停止の終了を待機します（e）。
The mechanisms described above are mirrored in the RPCs and notifications defined in this document. It should be noted that these RPCs and notifications have been designed to be extensible and allow subscriptions into targets other than event streams. For instance, the YANG module defined in Section 5 of [RFC8641] augments "/sn:modify-subscription/sn:input/sn:target".
上記のメカニズムは、このドキュメントで定義されているRPCと通知に反映されています。これらのRPCと通知は拡張可能で、イベントストリーム以外のターゲットへのサブスクリプションを許可するように設計されていることに注意してください。たとえば、[RFC8641]のセクション5で定義されているYANGモジュールは、「/ sn：modify-subscription / sn：input / sn：target」を拡張します。
Configured subscriptions are established using configuration operations against the top-level "subscriptions" subtree.
構成されたサブスクリプションは、トップレベルの「サブスクリプション」サブツリーに対する構成操作を使用して確立されます。
Because there is no explicit association with an existing transport session, configuration operations MUST include additional parameters beyond those of dynamic subscriptions. These parameters identify each receiver, how to connect with that receiver, and possibly whether the notification messages need to come from a specific egress interface on the publisher. Receiver-specific transport connectivity parameters MUST be configured via transport-specific augmentations to this specification. See Section 2.5.7 for details.
既存のトランスポートセッションとの明示的な関連付けがないため、構成操作には、動的サブスクリプションのパラメーターを超える追加のパラメーターを含める必要があります。これらのパラメーターは、各レシーバー、そのレシーバーとの接続方法、およびおそらく通知メッセージがパブリッシャーの特定の出力インターフェースから送信される必要があるかどうかを識別します。レシーバー固有のトランスポート接続パラメーターは、この仕様のトランスポート固有の拡張機能を介して構成する必要があります。詳細については、セクション2.5.7を参照してください。
After a subscription is successfully established, the publisher immediately sends a "subscription-started" subscription state change notification to each receiver. It is quite possible that upon configuration, reboot, or even steady-state operations, a transport session may not be currently available to the receiver. In this case, when there is something to transport for an active subscription, transport-specific "call home" operations [RFC8071] will be used to establish the connection. When transport connectivity is available, notification messages may then be pushed.
サブスクリプションが正常に確立された後、パブリッシャーはすぐに「サブスクリプション開始」サブスクリプション状態変更通知を各レシーバーに送信します。構成、再起動、または定常状態の操作でさえ、トランスポートセッションが現在レシーバーで利用できない可能性があります。この場合、アクティブなサブスクリプションに対してトランスポートするものが存在する場合、トランスポート固有の「call home」操作[RFC8071]を使用して接続が確立されます。トランスポート接続が利用可能な場合、通知メッセージがプッシュされることがあります。
With active configured subscriptions, it is allowable to buffer event records even after a "subscription-started" has been sent. However, if events are lost (rather than just delayed) due to replay buffer capacity being reached, a new "subscription-started" must be sent. This new "subscription-started" indicates an event record discontinuity.
アクティブに構成されたサブスクリプションでは、「サブスクリプション開始」が送信された後でも、イベントレコードをバッファリングすることができます。ただし、リプレイバッファーの容量に達したためにイベントが（単に遅延するのではなく）失われた場合は、新しい "サブスクリプション開始"を送信する必要があります。この新しい「サブスクリプション開始」は、イベントレコードの不連続を示します。
To see an example of subscription creation using configuration operations over NETCONF, see Appendix A.
NETCONFを介した構成操作を使用したサブスクリプション作成の例については、付録Aを参照してください。
Configured subscriptions can be modified using configuration operations against the top-level "subscriptions" subtree.
構成されたサブスクリプションは、最上位の「サブスクリプション」サブツリーに対する構成操作を使用して変更できます。
If the modification involves adding receivers, added receivers are placed in the "connecting" state. If a receiver is removed, the subscription state change notification "subscription-terminated" is sent to that receiver if that receiver is active or suspended.
変更にレシーバーの追加が含まれる場合、追加されたレシーバーは「接続中」の状態になります。レシーバーが削除された場合、そのレシーバーがアクティブまたは一時停止されていると、サブスクリプション状態変更通知「サブスクリプション終了」がそのレシーバーに送信されます。
If the modification involves changing the policies for the subscription, the publisher sends to currently active receivers a "subscription-modified" notification. For any suspended receivers, a "subscription-modified" notification will be delayed until the receiver's subscription has been resumed. (Note: In this case, the "subscription-modified" notification informs the receiver that the subscription has been resumed, so no additional "subscription-resumed" need be sent. Also note that if multiple modifications have occurred during the suspension, only the "subscription-modified" notification describing the latest one need be sent to the receiver.)
変更にサブスクリプションのポリシーの変更が含まれる場合、パブリッシャーは現在アクティブなレシーバーに「サブスクリプション変更」通知を送信します。中断された受信者の場合、「サブスクリプションが変更されました」通知は、受信者のサブスクリプションが再開されるまで遅延されます。 （注：この場合、「subscription-modified」通知はサブスクリプションが再開されたことを受信者に通知するため、追加の「subscription-resumed」を送信する必要はありません。また、一時停止中に複数の変更が発生した場合は、最新のものを説明する「サブスクリプション変更」通知を受信者に送信する必要があります。）
Subscriptions can be deleted through configuration against the top-level "subscriptions" subtree.
サブスクリプションは、最上位の「サブスクリプション」サブツリーに対する構成を通じて削除できます。
Immediately after a subscription is successfully deleted, the publisher sends to all receivers of that subscription a subscription state change notification stating that the subscription has ended (i.e., "subscription-terminated").
サブスクリプションが正常に削除された直後に、パブリッシャーはそのサブスクリプションのすべての受信者に、サブスクリプションが終了した（つまり、「サブスクリプション終了」）ことを示すサブスクリプション状態変更通知を送信します。
It is possible that a configured subscription to a receiver needs to be reset. This is accomplished via the "reset" action in the YANG module at "/subscriptions/subscription/receivers/receiver/reset". This action may be useful in cases where a publisher has timed out trying to reach a receiver. When such a reset occurs, a transport session will be initiated if necessary, and a new "subscription-started" notification will be sent. This action does not have any effect on transport connectivity if the needed connectivity already exists.
レシーバーへの構成済みサブスクリプションをリセットする必要がある可能性があります。これは、 "/ subscriptions / subscription / receivers / receiver / reset"にあるYANGモジュールの "reset"アクションを介して実行されます。このアクションは、パブリッシャーがレシーバーに到達しようとしてタイムアウトになった場合に役立ちます。このようなリセットが発生すると、必要に応じてトランスポートセッションが開始され、新しい「サブスクリプション開始」通知が送信されます。必要な接続がすでに存在する場合、このアクションはトランスポートの接続に影響を与えません。
It is possible to do replay on a configured subscription. This is supported via the configuration of the "configured-replay" object on the subscription. The setting of this object enables the streaming of the buffered event records for the subscribed event stream. All buffered event records that have been retained since the last publisher restart will be sent to each configured receiver.
構成済みのサブスクリプションで再生を行うことができます。これは、サブスクリプションの「configured-replay」オブジェクトの構成を介してサポートされます。このオブジェクトの設定により、サブスクライブされたイベントストリームのバッファされたイベントレコードのストリーミングが可能になります。パブリッシャーが最後に再起動してから保持されているすべてのバッファーされたイベントレコードは、構成された各レシーバーに送信されます。
Replay of event records created since restart is useful. It allows event records generated before transport connectivity establishment to be passed to a receiver. Setting the restart time as the earliest configured replay time precludes the possibility of resending event records that were logged prior to publisher restart. It also ensures that the same records will be sent to each configured receiver, regardless of the speed of transport connectivity establishment to each receiver. Finally, by establishing restart as the earliest potential time for event records to be included in notification messages, a well-understood timeframe for replay is defined.
再起動以降に作成されたイベントレコードの再生が役立ちます。トランスポート接続の確立前に生成されたイベントレコードをレシーバーに渡すことができます。再構成時刻を最も早い構成済みの再生時間として設定すると、パブリッシャーの再始動前にログに記録されたイベントレコードが再送信される可能性がなくなります。また、各レシーバーへのトランスポート接続の確立速度に関係なく、構成された各レシーバーに同じレコードが送信されるようにします。最後に、イベントレコードが通知メッセージに含まれる可能性のある最も早い可能性のある時間として再起動を確立することにより、再生の十分に理解された時間枠が定義されます。
As a result, when any configured subscription's receivers become active, buffered event records will be sent immediately after the "subscription-started" notification. If the publisher knows the last event record sent to a receiver and the publisher has not rebooted, the next event record on the event stream that meets filtering criteria will be the leading event record sent. Otherwise, the leading event record will be the first event record meeting filtering criteria subsequent to the latest of three different times: the "replay-log-creation-time", the "replay-log-aged-time", or the most recent publisher boot time. The "replay-log-creation-time" and "replay-log-aged-time" are discussed in Section 2.4.2.1. The most recent publisher boot time ensures that duplicate event records are not replayed from a previous time the publisher was booted.
その結果、構成済みのサブスクリプションのレシーバーがアクティブになると、「サブスクリプション開始」通知の直後に、バッファリングされたイベントレコードが送信されます。パブリッシャーがレシーバーに送信された最後のイベントレコードを知っていて、パブリッシャーが再起動していない場合、フィルター基準を満たすイベントストリームの次のイベントレコードは、送信された最初のイベントレコードになります。それ以外の場合、先頭のイベントレコードは、「replay-log-creation-time」、「replay-log-aged-time」、または最新の3つの異なる時間のうちの最新の後に続くフィルタリング基準を満たす最初のイベントレコードになります。パブリッシャーの起動時間。 「replay-log-creation-time」および「replay-log-aged-time」については、2.4.2.1項で説明します。最新のパブリッシャーの起動時間により、パブリッシャーが前回起動されたときから重複したイベントレコードが再生されなくなります。
It is quite possible that a receiver might want to retrieve event records from an event stream prior to the latest boot. If such records exist where there is a configured replay, the publisher MUST send the time of the event record immediately preceding the "replay-start-time" in the "replay-previous-event-time" leaf. Through the existence of the "replay-previous-event-time", the receiver will know that earlier events prior to reboot exist. In addition, if the subscriber was previously receiving event records with the same subscription "id", the receiver can determine if there was a time gap where records generated on the publisher were not successfully received. And with this information, the receiver may choose to dynamically subscribe to retrieve any event records placed in the event stream before the most recent boot time.
最新の起動の前に、レシーバーがイベントストリームからイベントレコードを取得したい場合があります。構成された再生がある場所にそのようなレコードが存在する場合、パブリッシャーは、「replay-previous-event-time」リーフの「replay-start-time」の直前のイベントレコードの時刻を送信する必要があります。 「replay-previous-event-time」が存在することにより、レシーバーはリブート前の以前のイベントが存在することを認識します。さらに、サブスクライバーが以前に同じサブスクリプション "id"のイベントレコードを受信していた場合、受信者は、パブリッシャーで生成されたレコードが正常に受信されなかった時間ギャップがあったかどうかを判断できます。そして、この情報を使用して、レシーバーは動的にサブスクライブして、最新のブート時間の前にイベントストリームに配置されたイベントレコードを取得することを選択できます。
All other replay functionality remains the same as with dynamic subscriptions as described in Section 2.4.2.1.
その他のすべての再生機能は、2.4.2.1項で説明されている動的サブスクリプションの場合と同じです。
This specification is transport independent. However, supporting a configured subscription will often require the establishment of transport connectivity. And the parameters used for this transport connectivity establishment are transport specific. As a result, the YANG module defined in Section 4 is not able to directly define and expose these transport parameters.
この仕様はトランスポートに依存しません。ただし、構成されたサブスクリプションをサポートするには、トランスポート接続の確立が必要になることがよくあります。また、このトランスポート接続の確立に使用されるパラメーターは、トランスポート固有です。その結果、セクション4で定義されているYANGモジュールは、これらのトランスポートパラメータを直接定義して公開することができません。
It is necessary for an implementation to support the connection establishment process. To support this function, the YANG data model defined in this document includes a node where transport-specific parameters for a particular receiver may be augmented. This node is "/subscriptions/subscription/receivers/receiver". By augmenting transport parameters from this node, system developers are able to incorporate the YANG objects necessary to support the transport connectivity establishment process.
実装では、接続確立プロセスをサポートする必要があります。この機能をサポートするために、このドキュメントで定義されているYANGデータモデルには、特定のレシーバーのトランスポート固有のパラメーターを拡張できるノードが含まれています。このノードは「/ subscriptions / subscription / receivers / receiver」です。システム開発者は、このノードからトランスポートパラメータを拡張することにより、トランスポート接続確立プロセスをサポートするために必要なYANGオブジェクトを組み込むことができます。
The result of this is the following requirement. A publisher supporting the feature "configured" MUST also support at least one YANG data model that augments transport connectivity parameters on "/subscriptions/subscription/receivers/receiver". For an example of such an augmentation, see Appendix A.
これの結果は次の要件です。 "configured"機能をサポートするパブリッシャーは、 "/ subscriptions / subscription / receivers / receiver"のトランスポート接続パラメーターを拡張する少なくとも1つのYANGデータモデルもサポートする必要があります。このような拡張の例については、付録Aを参照してください。
Whether dynamic or configured, once a subscription has been set up, the publisher streams event records via notification messages per the terms of the subscription. For dynamic subscriptions, notification messages are sent over the session used to establish the subscription. For configured subscriptions, notification messages are sent over the connections specified by the transport and each receiver of a configured subscription.
動的または構成にかかわらず、サブスクリプションがセットアップされると、パブリッシャーはサブスクリプションの条件ごとに通知メッセージを介してイベントレコードをストリーミングします。動的サブスクリプションの場合、サブスクリプションの確立に使用されたセッションを介して通知メッセージが送信されます。構成されたサブスクリプションの場合、通知メッセージは、構成されたサブスクリプションのトランスポートおよび各レシーバーによって指定された接続を介して送信されます。
A notification message is sent to a receiver when an event record is not blocked by either the specified filter criteria or receiver permissions. This notification message MUST include an <eventTime> object, as shown in [RFC5277], Section 4. This <eventTime> MUST be at the top level of a YANG structured event record.
イベントレコードが指定されたフィルター基準または受信者権限のいずれによってもブロックされていない場合、通知メッセージが受信者に送信されます。 [RFC5277]のセクション4に示すように、この通知メッセージには<eventTime>オブジェクトを含める必要があります。この<eventTime>は、YANG構造化イベントレコードの最上位にある必要があります。
The following example of XML [W3C.REC-xml-20081126], adapted from Section 4.2.10 of [RFC7950], illustrates a compliant message:
[RFC7950]のセクション4.2.10を基にした次のXML [W3C.REC-xml-20081126]の例は、準拠メッセージを示しています。
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2007-09-01T10:00:00Z</eventTime>
<link-failure xmlns="https://acme.example.com/system">
<if-name>so-1/2/3.0</if-name>
<if-admin-status>up</if-admin-status>
<if-oper-status>down</if-oper-status>
</link-failure>
</notification>
Figure 10: Subscribed Notification Message
図10：サブスクライブされた通知メッセージ
[RFC5277], Section 2.2.1 states that a notification message is to be sent to a subscriber that initiated a <create-subscription>. With this document, this statement from [RFC5277] should be more broadly interpreted to mean that notification messages can also be sent to a subscriber that initiated an "establish-subscription" or to a configured receiver that has been sent a "subscription-started".
[RFC5277]のセクション2.2.1には、<create-subscription>を開始したサブスクライバーに通知メッセージが送信されることが記載されています。このドキュメントでは、[RFC5277]のこのステートメントをより広く解釈して、「確立サブスクリプション」を開始したサブスクライバーまたは「サブスクリプション開始」を送信した構成済みの受信者にも通知メッセージを送信できることを意味します。 。
When a dynamic subscription has been started or modified with "establish-subscription" or "modify-subscription", respectively, event records matching the newly applied filter criteria MUST NOT be sent until after the RPC reply has been sent.
動的サブスクリプションが開始または「establish-subscription」または「modify-subscription」でそれぞれ変更された場合、RPC応答が送信されるまで、新しく適用されたフィルター基準に一致するイベントレコードを送信してはなりません。
When a configured subscription has been started or modified, event records matching the newly applied filter criteria MUST NOT be sent until after the "subscription-started" or "subscription-modified" notification has been sent, respectively.
構成されたサブスクリプションが開始または変更された場合、新しく適用されたフィルター基準に一致するイベントレコードは、それぞれ「サブスクリプション開始」または「サブスクリプション変更」通知が送信されるまで送信してはなりません。
In addition to sending event records to receivers, a publisher MUST also send subscription state change notifications when events related to subscription management have occurred.
イベントレコードをレシーバーに送信することに加えて、パブリッシャーはサブスクリプション管理に関連するイベントが発生したときにサブスクリプション状態変更通知も送信する必要があります。
Subscription state change notifications are unlike other notifications in that they are never included in any event stream. Instead, they are inserted (as defined in this section) into the sequence of notification messages sent to a particular receiver. Subscription state change notifications cannot be dropped or filtered out, they cannot be stored in replay buffers, and they are delivered only to impacted receivers of a subscription. The identification of subscription state change notifications is easy to separate from other notification messages through the use of the YANG extension "subscription-state-notif". This extension tags a notification as a subscription state change notification.
サブスクリプション状態変更通知は、イベントストリームに含まれないという点で他の通知とは異なります。代わりに、（このセクションで定義されているように）特定の受信者に送信される一連の通知メッセージに挿入されます。サブスクリプションの状態変更通知は削除またはフィルターで除外することはできず、再生バッファーに格納することはできず、影響を受けるサブスクリプションの受信者にのみ配信されます。サブスクリプション状態変更通知の識別は、YANG拡張機能「サブスクリプション状態通知」を使用することにより、他の通知メッセージから簡単に分離できます。この拡張機能は、通知にサブスクリプション状態変更通知のタグを付けます。
The complete set of subscription state change notifications is described in the following subsections.
サブスクリプションの状態変更通知の完全なセットについては、次のサブセクションで説明します。
This notification indicates that a configured subscription has started, and event records may be sent. Included in this subscription state change notification are all the parameters of the subscription, except for (1) transport connection information for one or more receivers and (2) origin information indicating where notification messages will egress the publisher. Note that if a referenced filter from the "filters" container has been used in the subscription, the notification still provides the contents of that referenced filter under the "within-subscription" subtree.
この通知は、構成されたサブスクリプションが開始されたことを示し、イベントレコードが送信される場合があります。このサブスクリプションの状態変更通知には、サブスクリプションのすべてのパラメーターが含まれます。ただし、（1）1つまたは複数のレシーバーのトランスポート接続情報と、（2）通知メッセージがパブリッシャーから出力される場所を示すオリジン情報は除きます。 「filters」コンテナからの参照されたフィルタがサブスクリプションで使用されている場合、通知は、「within-subscription」サブツリーの下にその参照されたフィルタのコンテンツを提供することに注意してください。
Note that for dynamic subscriptions, no "subscription-started" notifications are ever sent.
動的サブスクリプションの場合、「サブスクリプション開始」通知は送信されないことに注意してください。
Below is a tree diagram for "subscription-started". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「サブスクリプション開始」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---n subscription-started {configured}?
+--ro id
| subscription-id
+--ro (target)
| +--:(stream)
| +--ro (stream-filter)?
| | +--:(by-reference)
| | | +--ro stream-filter-name
| | | stream-filter-ref
| | +--:(within-subscription)
| | +--ro (filter-spec)?
| | +--:(stream-subtree-filter)
| | | +--ro stream-subtree-filter? <anydata>
| | | {subtree}?
| | +--:(stream-xpath-filter)
| | +--ro stream-xpath-filter? yang:xpath1.0
| | {xpath}?
| +--ro stream stream-ref
| +--ro replay-start-time?
| | yang:date-and-time {replay}?
| +--ro replay-previous-event-time?
| yang:date-and-time {replay}?
+--ro stop-time?
| yang:date-and-time
+--ro dscp? inet:dscp
| {dscp}?
+--ro weighting? uint8 {qos}?
+--ro dependency?
| subscription-id {qos}?
+--ro transport? transport
| {configured}?
+--ro encoding? encoding
+--ro purpose? string
{configured}?
Figure 11: "subscription-started" Notification Tree Diagram
図11：「サブスクリプション開始」通知ツリー図
This notification indicates that a subscription has been modified by configuration operations. It is delivered directly after the last event records processed using the previous subscription parameters, and before any event records processed after the modification.
この通知は、サブスクリプションが構成操作によって変更されたことを示しています。以前のサブスクリプションパラメータを使用して処理された最後のイベントレコードの直後、および変更後に処理されたイベントレコードの前に直接配信されます。
Below is a tree diagram for "subscription-modified". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「サブスクリプション変更」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---n subscription-modified
+--ro id
| subscription-id
+--ro (target)
| +--:(stream)
| +--ro (stream-filter)?
| | +--:(by-reference)
| | | +--ro stream-filter-name
| | | stream-filter-ref
| | +--:(within-subscription)
| | +--ro (filter-spec)?
| | +--:(stream-subtree-filter)
| | | +--ro stream-subtree-filter? <anydata>
| | | {subtree}?
| | +--:(stream-xpath-filter)
| | +--ro stream-xpath-filter? yang:xpath1.0
| | {xpath}?
| +--ro stream stream-ref
| +--ro replay-start-time?
| yang:date-and-time {replay}?
+--ro stop-time?
| yang:date-and-time
+--ro dscp? inet:dscp
| {dscp}?
+--ro weighting? uint8 {qos}?
+--ro dependency?
| subscription-id {qos}?
+--ro transport? transport
| {configured}?
+--ro encoding? encoding
+--ro purpose? string
{configured}?
Figure 12: "subscription-modified" Notification Tree Diagram
図12：「サブスクリプションが変更されました」通知ツリー図
A publisher most often sends this notification directly after the modification of any configuration parameters impacting a configured subscription. But it may also be sent at two other times:
パブリッシャーは、ほとんどの場合、構成済みサブスクリプションに影響を与える構成パラメーターを変更した直後にこの通知を送信します。ただし、他の2つのタイミングで送信されることもあります。
1. If a configured subscription has been modified during the suspension of a receiver, the notification will be delayed until the receiver's suspension is lifted. In this situation, the notification indicates that the subscription has been both modified and resumed.
1. レシーバーの一時停止中に構成済みサブスクリプションが変更された場合、レシーバーの一時停止が解除されるまで通知は遅延されます。この状況では、通知はサブスクリプションが変更および再開されたことを示しています。
2. A "subscription-modified" subscription state change notification MUST be sent if the contents of the filter identified by the subscription's "stream-filter-ref" leaf have changed. This state change notification is to be sent for a filter change impacting any active receivers of a configured or dynamic subscription.
2. サブスクリプションの「stream-filter-ref」リーフで識別されるフィルターのコンテンツが変更された場合、「サブスクリプションが変更された」サブスクリプション状態変更通知を送信する必要があります。この状態変更通知は、構成済みまたは動的サブスクリプションのアクティブなレシーバーに影響を与えるフィルター変更について送信されます。
This notification indicates that no further event records for this subscription should be expected from the publisher. A publisher may terminate the sending of event records to a receiver for the following reasons:
この通知は、このサブスクリプションのイベントレコードがパブリッシャーから予期されないことを示しています。パブリッシャーは、次の理由により、レシーバーへのイベントレコードの送信を終了する場合があります。
1. Configuration that removes a configured subscription, or a "kill-subscription" RPC that ends a dynamic subscription. These are identified via the reason "no-such-subscription".
1. 構成されたサブスクリプション、または動的サブスクリプションを終了する「kill-subscription」RPCを削除する構成。これらは、「no-such-subscription」という理由で識別されます。
2. A referenced filter is no longer accessible. This reason is identified by the "filter-unavailable" identity.
2. 参照されているフィルターにアクセスできなくなりました。この理由は、「フィルターを利用できない」IDによって識別されます。
3. The event stream referenced by a subscription is no longer accessible by the receiver. This reason is identified by the "stream-unavailable" identity.
3. サブスクリプションによって参照されるイベントストリームは、レシーバーからアクセスできなくなります。この理由は、「ストリームを利用できない」IDによって識別されます。
4. A suspended subscription has exceeded some timeout. This reason is identified by the "suspension-timeout" identity.
4. 一時停止されたサブスクリプションがタイムアウトを超えました。この理由は、「一時停止タイムアウト」アイデンティティによって識別されます。
Each reason listed above derives from the "subscription-terminated-reason" base identity specified in the YANG data model in this document.
上記の各理由は、このドキュメントのYANGデータモデルで指定されている「サブスクリプション終了理由」のベースアイデンティティに由来しています。
Below is a tree diagram for "subscription-terminated". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「サブスクリプション終了」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---n subscription-terminated
+--ro id subscription-id
+--ro reason identityref
Figure 13: "subscription-terminated" Notification Tree Diagram
図13：「サブスクリプション終了」通知ツリー図
Note: This subscription state change notification MUST be sent to a dynamic subscription's receiver when the subscription ends unexpectedly. This might happen when a "kill-subscription" RPC is successful or when some other event, not including reaching the subscription's "stop-time", results in a publisher choosing to end the subscription.
注：このサブスクリプション状態変更通知は、サブスクリプションが予期せず終了したときに動的サブスクリプションの受信者に送信する必要があります。これは、「kill-subscription」RPCが成功した場合、またはサブスクリプションの「stop-time」への到達を含まないその他のイベントの結果、パブリッシャーがサブスクリプションの終了を選択した場合に発生する可能性があります。
This notification indicates that a publisher has suspended the sending of event records to a receiver and also indicates the possible loss of events. Suspension happens when capacity constraints stop a publisher from serving a valid subscription. The two conditions where this is possible are:
この通知は、パブリッシャーがレシーバーへのイベントレコードの送信を一時停止したことと、イベントが失われた可能性があることを示しています。容量の制約により、パブリッシャーが有効なサブスクリプションを提供できなくなると、一時停止が発生します。これが可能な2つの条件は次のとおりです。
1. "insufficient-resources", when a publisher is unable to produce the requested event stream of notification messages, and
1. 「不十分なリソース」、パブリッシャーが通知メッセージの要求されたイベントストリームを生成できない場合、および
2. "unsupportable-volume", when the bandwidth needed to get generated notification messages to a receiver exceeds a threshold.
2. 「サポートされていないボリューム」、受信者に生成された通知メッセージを取得するために必要な帯域幅がしきい値を超えた場合。
These conditions are encoded in the "reason" object. No further notifications will be sent until the subscription resumes or is terminated.
これらの条件は、「reason」オブジェクトにエンコードされています。サブスクリプションが再開または終了するまで、通知は送信されません。
Below is a tree diagram for "subscription-suspended". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「サブスクリプションの一時停止」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---n subscription-suspended
+--ro id subscription-id
+--ro reason identityref
Figure 14: "subscription-suspended" Notification Tree Diagram
図14：「サブスクリプション一時停止」通知ツリーの図
This notification indicates that a previously suspended subscription has been resumed under the unmodified terms previously in place. Subscribed event records generated after the issuance of this subscription state change notification may now be sent.
この通知は、以前に中断されていたサブスクリプションが、以前に変更されていない条件に基づいて再開されたことを示しています。このサブスクリプション状態変更通知の発行後に生成されたサブスクライブイベントレコードを送信できるようになりました。
Below is a tree diagram for "subscription-resumed". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「サブスクリプション再開」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---n subscription-resumed
+--ro id subscription-id
Figure 15: "subscription-resumed" Notification Tree Diagram
図15：「サブスクリプション再開」通知ツリー図
This notification indicates that a subscription that includes a "stop-time" has successfully finished passing event records upon reaching that time.
この通知は、「stop-time」を含むサブスクリプションがその時間に達したときにイベントレコードの受け渡しを正常に終了したことを示しています。
Below is a tree diagram for "subscription-completed". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「サブスクリプション完了」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---n subscription-completed {configured}?
+--ro id subscription-id
Figure 16: "subscription-completed" Notification Tree Diagram
図16：「サブスクリプション完了」通知ツリー図
This notification indicates that all of the event records prior to the current time have been passed to a receiver. It is sent before any notification messages containing an event record with a timestamp later than (1) the "stop-time" or (2) the subscription's start time.
この通知は、現在時刻より前のすべてのイベントレコードが受信側に渡されたことを示しています。これは、（1）「stop-time」または（2）サブスクリプションの開始時刻より後のタイムスタンプを持つイベントレコードを含む通知メッセージの前に送信されます。
If a subscription does not contain a "stop-time" or has a "stop-time" that has not been reached, then after the "replay-completed" notification has been sent, additional event records will be sent in sequence as they arise naturally on the publisher.
サブスクリプションに「stop-time」が含まれていないか、「stop-time」に達していない場合、「replay-completed」通知が送信された後、追加のイベントレコードが発生順に送信されます自然に出版社に。
Below is a tree diagram for "replay-completed". All objects contained in this tree are described in the YANG module in Section 4.
以下は、「リプレイ完了」のツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+---n replay-completed {replay}?
+--ro id subscription-id
Figure 17: "replay-completed" Notification Tree Diagram
図17：「リプレイ完了」通知ツリー図
In the operational state datastore, the "subscriptions" container maintains the state of all dynamic subscriptions as well as all configured subscriptions. Using datastore retrieval operations [RFC8641] or subscribing to the "subscriptions" container (Section 3.3) allows the state of subscriptions and their connectivity to receivers to be monitored.
運用状態データストアでは、「サブスクリプション」コンテナは、すべての動的サブスクリプションとすべての構成済みサブスクリプションの状態を維持します。データストア取得操作[RFC8641]を使用するか、「サブスクリプション」コンテナにサブスクライブする（3.3節）と、サブスクリプションの状態とレシーバーへの接続を監視できます。
Each subscription in the operational state datastore is represented as a list element. Included in this list are event counters for each receiver, the state of each receiver, and the subscription parameters currently in effect. The appearance of the leaf "configured-subscription-state" indicates that a particular subscription came into being via configuration. This leaf also indicates whether the current state of that subscription is "valid", "invalid", or "concluded".
運用状態データストアの各サブスクリプションは、リスト要素として表されます。このリストには、各レシーバーのイベントカウンター、各レシーバーの状態、および現在有効なサブスクリプションパラメーターが含まれています。リーフ「configured-subscription-state」の表示は、特定のサブスクリプションが構成を介して行われたことを示しています。このリーフは、そのサブスクリプションの現在の状態が「有効」、「無効」、または「確定」であるかどうかも示します。
To understand the flow of event records in a subscription, there are two counters available for each receiver. The first counter is "sent-event-records", which shows the number of events identified for sending to a receiver. The second counter is "excluded-event-records", which shows the number of event records not sent to a receiver. "excluded-event-records" shows the combined results of both access control and per-subscription filtering. For configured subscriptions, counters are reset whenever the subscription's state is evaluated as "valid" (see (1) in Figure 8).
サブスクリプションのイベントレコードのフローを理解するために、各レシーバーで使用可能な2つのカウンターがあります。最初のカウンターは「sent-event-records」で、これは受信者に送信するために識別されたイベントの数を示します。 2番目のカウンターは「excluded-event-records」です。これは、レシーバーに送信されなかったイベントレコードの数を示します。 「excluded-event-records」は、アクセス制御とサブスクリプションごとのフィルタリングの両方を組み合わせた結果を示します。構成されたサブスクリプションの場合、サブスクリプションの状態が「有効」と評価されるたびにカウンターがリセットされます（図8の（1）を参照）。
Dynamic subscriptions are removed from the operational state datastore once they expire (reaching "stop-time") or when they are terminated. While many subscription objects are shown as configurable, dynamic subscriptions are only included in the operational state datastore and as a result are not configurable.
動的サブスクリプションは、期限切れになる（「stop-time」に達する）か、または終了すると、運用状態データストアから削除されます。多くのサブスクリプションオブジェクトは構成可能として示されていますが、動的サブスクリプションは運用状態データストアにのみ含まれているため、構成できません。
Publishers supporting this document MUST indicate support of the YANG module "ietf-subscribed-notifications" in the YANG library of the publisher. In addition, if supported, the optional features "encode-xml", "encode-json", "configured", "supports-vrf", "qos", "xpath", "subtree", "interface-designation", "dscp", and "replay" MUST be indicated.
このドキュメントをサポートするパブリッシャーは、パブリッシャーのYANGライブラリーにおけるYANGモジュール「ietf-subscribed-notifications」のサポートを示さなければなりません。さらに、サポートされている場合、オプション機能「encode-xml」、「encode-json」、「configured」、「supports-vrf」、「qos」、「xpath」、「subtree」、「interface-designation」、「 dscp」、および「replay」を指定する必要があります。
This section contains tree diagrams for nodes defined in Section 4. For tree diagrams of subscription state change notifications, see Section 2.7. For the tree diagrams for the RPCs, see Section 2.4.
このセクションには、セクション4で定義されたノードのツリー図が含まれます。サブスクリプション状態変更通知のツリー図については、セクション2.7を参照してください。 RPCのツリー図については、セクション2.4を参照してください。
A publisher maintains a list of available event streams as operational data. This list contains both standardized and vendor-specific event streams. This enables subscribers to discover what streams a publisher supports.
パブリッシャーは、使用可能なイベントストリームのリストを運用データとして保持します。このリストには、標準化されたイベントストリームとベンダー固有のイベントストリームの両方が含まれています。これにより、サブスクライバーは、パブリッシャーがサポートするストリームを検出できます。
Below is a tree diagram for the "streams" container. All objects contained in this tree are described in the YANG module in Section 4.
以下は、「ストリーム」コンテナのツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+--ro streams
+--ro stream* [name]
+--ro name string
+--ro description string
+--ro replay-support? empty {replay}?
+--ro replay-log-creation-time yang:date-and-time
| {replay}?
+--ro replay-log-aged-time? yang:date-and-time
{replay}?
Figure 18: "streams" Container Tree Diagram
図18：「ストリーム」コンテナツリー図
The "filters" container maintains a list of all subscription filters that persist outside the lifecycle of a single subscription. This enables predefined filters that may be referenced by more than one subscription.
「filters」コンテナは、単一のサブスクリプションのライフサイクル外で存続するすべてのサブスクリプションフィルタのリストを保持します。これにより、複数のサブスクリプションによって参照される可能性がある事前定義のフィルターが有効になります。
Below is a tree diagram for the "filters" container. All objects contained in this tree are described in the YANG module in Section 4.
以下は、「フィルター」コンテナーのツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+--rw filters
+--rw stream-filter* [name]
+--rw name string
+--rw (filter-spec)?
+--:(stream-subtree-filter)
| +--rw stream-subtree-filter? <anydata> {subtree}?
+--:(stream-xpath-filter)
+--rw stream-xpath-filter? yang:xpath1.0 {xpath}?
Figure 19: "filters" Container Tree Diagram
図19：「フィルター」コンテナーツリー図
The "subscriptions" container maintains a list of all subscriptions on a publisher, both configured and dynamic. It can be used to retrieve information about the subscriptions that a publisher is serving.
「サブスクリプション」コンテナは、パブリッシャのすべてのサブスクリプションのリストを、構成済みおよび動的の両方で保持します。パブリッシャーが提供しているサブスクリプションに関する情報を取得するために使用できます。
Below is a tree diagram for the "subscriptions" container. All objects contained in this tree are described in the YANG module in Section 4.
以下は、「サブスクリプション」コンテナのツリー図です。このツリーに含まれるすべてのオブジェクトは、セクション4のYANGモジュールで説明されています。
+--rw subscriptions
+--rw subscription* [id]
+--rw id
| subscription-id
+--rw (target)
| +--:(stream)
| +--rw (stream-filter)?
| | +--:(by-reference)
| | | +--rw stream-filter-name
| | | stream-filter-ref
| | +--:(within-subscription)
| | +--rw (filter-spec)?
| | +--:(stream-subtree-filter)
| | | +--rw stream-subtree-filter? <anydata>
| | | {subtree}?
| | +--:(stream-xpath-filter)
| | +--rw stream-xpath-filter?
| | yang:xpath1.0 {xpath}?
| +--rw stream stream-ref
| +--ro replay-start-time?
| | yang:date-and-time {replay}?
| +--rw configured-replay? empty
| {configured,replay}?
+--rw stop-time?
| yang:date-and-time
+--rw dscp? inet:dscp
| {dscp}?
+--rw weighting? uint8 {qos}?
+--rw dependency?
| subscription-id {qos}?
+--rw transport? transport
| {configured}?
+--rw encoding? encoding
+--rw purpose? string
| {configured}?
+--rw (notification-message-origin)? {configured}?
| +--:(interface-originated)
| | +--rw source-interface?
| | if:interface-ref {interface-designation}?
| +--:(address-originated)
| +--rw source-vrf?
| | -> /ni:network-instances/network-instance/name
| | {supports-vrf}?
| +--rw source-address?
| inet:ip-address-no-zone
+--ro configured-subscription-state? enumeration
| {configured}?
+--rw receivers
+--rw receiver* [name]
+--rw name string
+--ro sent-event-records?
| yang:zero-based-counter64
+--ro excluded-event-records?
| yang:zero-based-counter64
+--ro state enumeration
+---x reset {configured}?
+--ro output
+--ro time yang:date-and-time
Figure 20: "subscriptions" Container Tree Diagram
図20：「サブスクリプション」コンテナツリー図
This module imports typedefs from [RFC6991], [RFC8343], [RFC8341], [RFC8529], and [RFC8040]. It references [RFC6241], [XPATH] ("XML Path Language (XPath) Version 1.0"), [RFC7049], [RFC8259], [RFC7950], [RFC7951], and [RFC7540].
このモジュールは、[RFC6991]、[RFC8343]、[RFC8341]、[RFC8529]、および[RFC8040]からtypedefをインポートします。 [RFC6241]、[XPATH]（ "XMLパス言語（XPath）バージョン1.0"）、[RFC7049]、[RFC8259]、[RFC7950]、[RFC7951]、および[RFC7540]を参照しています。
<CODE BEGINS> file "ietf-subscribed-notifications@2019-09-09.yang"
module ietf-subscribed-notifications {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications";
prefix sn;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-interfaces {
prefix if;
reference
"RFC 8343: A YANG Data Model for Interface Management";
}
import ietf-netconf-acm {
prefix nacm;
reference
"RFC 8341: Network Configuration Access Control Model";
}
import ietf-network-instance {
prefix ni;
reference
"RFC 8529: YANG Data Model for Network Instances";
}
import ietf-restconf {
prefix rc;
reference
"RFC 8040: RESTCONF Protocol";
}
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <https:/datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Alexander Clemm
<mailto:ludwig@clemm.org>
Author: Eric Voit
<mailto:evoit@cisco.com>
Author: Alberto Gonzalez Prieto
<mailto:alberto.gonzalez@microsoft.com>
Author: Einar Nilsen-Nygaard
<mailto:einarnn@cisco.com>
Author: Ambika Prasad Tripathy <mailto:ambtripa@cisco.com>"; description "This module defines a YANG data model for subscribing to event records and receiving matching content in notification messages.
作成者：Ambika Prasad Tripathy <mailto：ambtripa@cisco.com> ";説明"このモジュールは、イベントレコードをサブスクライブし、一致するコンテンツを通知メッセージで受信するためのYANGデータモデルを定義します。
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
キーワード「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.
このドキュメントの「MAY」および「OPTIONAL」は、BCP 14（RFC 2119）（RFC 8174）で説明されているように解釈されます。
Copyright (c) 2019 IETF Trust and the persons identified as authors of the code. All rights reserved.
Copyright（c）2019 IETF Trustおよびコードの作成者として識別された人物。全著作権所有。
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 Relating to IETF Documents (https://trustee.ietf.org/license-info).
ソースおよびバイナリ形式での再配布および使用は、変更の有無にかかわらず、IETF文書に関連するIETFトラストの法的規定のセクション4.cに記載されているSimplified BSD Licenseに従い、それに含まれるライセンス条項に従って許可されます（ https://trustee.ietf.org/license-info）。
This version of this YANG module is part of RFC 8639; see the RFC itself for full legal notices.";
このYANGモジュールのこのバージョンはRFC 8639の一部です。完全な法的通知については、RFC自体を参照してください。 ";
revision 2019-09-09 {
description
"Initial version.";
reference
"RFC 8639: A YANG Data Model for Subscriptions to
Event Notifications";
}
/*
* FEATURES
*/
feature configured {
description
"This feature indicates that configuration of subscriptions is
supported.";
}
feature dscp {
description
"This feature indicates that a publisher supports the ability
to set the Differentiated Services Code Point (DSCP) value in
outgoing packets.";
}
feature encode-json {
description
"This feature indicates that JSON encoding of notification
messages is supported.";
}
feature encode-xml {
description
"This feature indicates that XML encoding of notification
messages is supported.";
}
feature interface-designation {
description
"This feature indicates that a publisher supports sourcing all
receiver interactions for a configured subscription from a
single designated egress interface.";
}
feature qos {
description
"This feature indicates that a publisher supports absolute
dependencies of one subscription's traffic over another
as well as weighted bandwidth sharing between subscriptions.
Both of these are Quality of Service (QoS) features that allow
differentiated treatment of notification messages between a
publisher and a specific receiver.";
}
feature replay {
description
"This feature indicates that historical event record replay is
supported. With replay, it is possible for past event records
to be streamed in chronological order.";
}
feature subtree {
description
"This feature indicates support for YANG subtree filtering.";
reference
"RFC 6241: Network Configuration Protocol (NETCONF),
Section 6";
}
feature supports-vrf {
description
"This feature indicates that a publisher supports VRF
configuration for configured subscriptions. VRF support for
dynamic subscriptions does not require this feature.";
reference
"RFC 8529: YANG Data Model for Network Instances,
Section 6";
}
feature xpath {
description
"This feature indicates support for XPath filtering.";
reference
"XML Path Language (XPath) Version 1.0
(https://www.w3.org/TR/1999/REC-xpath-19991116)";
}
/*
* EXTENSIONS
*/
extension subscription-state-notification {
description
"This statement applies only to notifications. It indicates
that the notification is a subscription state change
notification. Therefore, it does not participate in a regular
event stream and does not need to be specifically subscribed
to in order to be received. This statement can only occur as
a substatement of the YANG 'notification' statement. This
statement is not for use outside of this YANG module.";
}
/*
* IDENTITIES
*/
/* Identities for RPC and notification errors */
identity delete-subscription-error {
description
"Base identity for the problem found while attempting to
fulfill either a 'delete-subscription' RPC request or a
'kill-subscription' RPC request.";
}
identity establish-subscription-error {
description
"Base identity for the problem found while attempting to
fulfill an 'establish-subscription' RPC request.";
}
identity modify-subscription-error {
description
"Base identity for the problem found while attempting to
fulfill a 'modify-subscription' RPC request.";
}
identity subscription-suspended-reason {
IDサブスクリプションの一時停止理由{
description
"Base identity for the problem condition communicated to a
receiver as part of a 'subscription-suspended'
notification.";
}
identity subscription-terminated-reason {
description
"Base identity for the problem condition communicated to a
receiver as part of a 'subscription-terminated'
notification.";
}
identity dscp-unavailable {
base establish-subscription-error;
if-feature "dscp";
description
"The publisher is unable to mark notification messages with
prioritization information in a way that will be respected
during network transit.";
}
identity encoding-unsupported {
base establish-subscription-error;
description
"Unable to encode notification messages in the desired
format.";
}
identity filter-unavailable {
base subscription-terminated-reason;
description
"Referenced filter does not exist. This means a receiver is
referencing a filter that doesn't exist or to which it
does not have access permissions.";
}
identity filter-unsupported {
base establish-subscription-error;
base modify-subscription-error;
description
"Cannot parse syntax in the filter. This failure can be from
a syntax error or a syntax too complex to be processed by the
publisher.";
}
identity insufficient-resources {
base establish-subscription-error;
base modify-subscription-error;
base subscription-suspended-reason;
description
"The publisher does not have sufficient resources to support
the requested subscription. An example might be that
allocated CPU is too limited to generate the desired set of
notification messages.";
}
identity no-such-subscription {
base modify-subscription-error;
base delete-subscription-error;
base subscription-terminated-reason;
description
"Referenced subscription doesn't exist. This may be as a
result of a nonexistent subscription ID, an ID that belongs to
another subscriber, or an ID for a configured subscription.";
}
identity replay-unsupported {
base establish-subscription-error;
if-feature "replay";
description
"Replay cannot be performed for this subscription. This means
the publisher will not provide the requested historic
information from the event stream via replay to this
receiver.";
}
identity stream-unavailable {
base subscription-terminated-reason;
description
"Not a subscribable event stream. This means the referenced
event stream is not available for subscription by the
receiver.";
}
identity suspension-timeout {
base subscription-terminated-reason;
description
"Termination of a previously suspended subscription. The
publisher has eliminated the subscription, as it exceeded a
time limit for suspension.";
}
identity unsupportable-volume {
base subscription-suspended-reason;
description
"The publisher does not have the network bandwidth needed to
get the volume of generated information intended for a
receiver.";
}
/* Identities for encodings */
identity configurable-encoding {
description
"If a transport identity derives from this identity, it means
that it supports configurable encodings. An example of a
configurable encoding might be a new identity such as
'encode-cbor'. Such an identity could use
'configurable-encoding' as its base. This would allow a
dynamic subscription encoded in JSON (RFC 8259) to request
that notification messages be encoded via the Concise Binary
Object Representation (CBOR) (RFC 7049). Further details for
any specific configurable encoding would be explored in a
transport document based on this specification.";
reference
"RFC 8259: The JavaScript Object Notation (JSON) Data
Interchange Format
RFC 7049: Concise Binary Object Representation (CBOR)";
}
identity encoding {
description
"Base identity to represent data encodings.";
}
identity encode-xml {
base encoding;
if-feature "encode-xml";
description
"Encode data using XML as described in RFC 7950.";
reference
"RFC 7950: The YANG 1.1 Data Modeling Language";
}
identity encode-json {
base encoding;
if-feature "encode-json";
description
"Encode data using JSON as described in RFC 7951.";
reference
"RFC 7951: JSON Encoding of Data Modeled with YANG";
}
/* Identities for transports */
identity transport {
description
"An identity that represents the underlying mechanism for
passing notification messages.";
}
/*
* TYPEDEFs
*/
typedef encoding {
type identityref {
base encoding;
}
description
"Specifies a data encoding, e.g., for a data subscription.";
}
typedef stream-filter-ref {
type leafref {
path "/sn:filters/sn:stream-filter/sn:name";
}
description
"This type is used to reference an event stream filter.";
}
typedef stream-ref {
type leafref {
path "/sn:streams/sn:stream/sn:name";
}
description
"This type is used to reference a system-provided
event stream.";
}
typedef subscription-id {
type uint32;
description
"A type for subscription identifiers.";
}
typedef transport {
type identityref {
base transport;
}
description
"Specifies the transport used to send notification messages
to a receiver.";
}
/*
* GROUPINGS
*/
grouping stream-filter-elements {
description
"This grouping defines the base for filters applied to event
streams.";
choice filter-spec {
description
"The content filter specification for this request.";
anydata stream-subtree-filter {
if-feature "subtree";
description
"Event stream evaluation criteria encoded in the syntax of
a subtree filter as defined in RFC 6241, Section 6.
The subtree filter is applied to the representation of individual, delineated event records as contained in the event stream.
サブツリーフィルターは、イベントストリームに含まれている、個別のイベントイベントレコードの表現に適用されます。
If the subtree filter returns a non-empty node set, the
filter matches the event record, and the event record is
included in the notification message sent to the
receivers.";
reference
"RFC 6241: Network Configuration Protocol (NETCONF),
Section 6";
}
leaf stream-xpath-filter {
if-feature "xpath";
type yang:xpath1.0;
description
"Event stream evaluation criteria encoded in the syntax of
an XPath 1.0 expression.
The XPath expression is evaluated on the representation of individual, delineated event records as contained in the event stream.
XPath式は、イベントストリームに含まれている、個別のイベントイベントレコードの表現で評価されます。
The result of the XPath expression is converted to a boolean value using the standard XPath 1.0 rules. If the boolean value is 'true', the filter matches the event record, and the event record is included in the notification message sent to the receivers.
XPath式の結果は、標準のXPath 1.0ルールを使用してブール値に変換されます。ブール値が「true」の場合、フィルターはイベントレコードに一致し、イベントレコードは受信者に送信される通知メッセージに含まれます。
The expression is evaluated in the following XPath context:
式は、次のXPathコンテキストで評価されます。
o The set of namespace declarations is the set of prefix and namespace pairs for all YANG modules implemented by the server, where the prefix is the YANG module name and the namespace is as defined by the 'namespace' statement in the YANG module.
o 名前空間宣言のセットは、サーバーによって実装されたすべてのYANGモジュールの接頭辞と名前空間のペアのセットです。ここで、接頭辞はYANGモジュール名であり、名前空間はYANGモジュールの 'namespace'ステートメントで定義されています。
If the leaf is encoded in XML, all namespace declarations in scope on the 'stream-xpath-filter' leaf element are added to the set of namespace declarations. If a prefix found in the XML is already present in the set of namespace declarations, the namespace in the XML is used.
リーフがXMLでエンコードされている場合、「stream-xpath-filter」リーフ要素のスコープ内のすべての名前空間宣言が名前空間宣言のセットに追加されます。 XMLで見つかったプレフィックスが名前空間宣言のセットに既に存在する場合、XMLの名前空間が使用されます。
o The set of variable bindings is empty.
o 変数バインディングのセットが空です。
o The function library is comprised of the core function library and the XPath functions defined in Section 10 in RFC 7950.
o 関数ライブラリは、RFC 7950のセクション10で定義されているコア関数ライブラリとXPath関数で構成されています。
o The context node is the root node.";
reference
"XML Path Language (XPath) Version 1.0
(https://www.w3.org/TR/1999/REC-xpath-19991116)
RFC 7950: The YANG 1.1 Data Modeling Language,
Section 10";
}
}
}
grouping update-qos {
description
"This grouping describes QoS information concerning a
subscription. This information is passed to lower layers
for transport prioritization and treatment.";
leaf dscp {
if-feature "dscp";
type inet:dscp;
default "0";
description
"The desired network transport priority level. This is the
priority set on notification messages encapsulating the
results of the subscription. This transport priority is
shared for all receivers of a given subscription.";
}
leaf weighting {
if-feature "qos";
type uint8 {
range "0 .. 255";
}
description
"Relative weighting for a subscription. Larger weights get
more resources. Allows an underlying transport layer to
perform informed load-balance allocations between various
subscriptions.";
reference
"RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2),
Section 5.3.2";
}
leaf dependency {
if-feature "qos";
type subscription-id;
description
"Provides the 'subscription-id' of a parent subscription.
The parent subscription has absolute precedence should
that parent have push updates ready to egress the publisher.
In other words, there should be no streaming of objects from
the current subscription if the parent has something ready
to push.
If a dependency is asserted via configuration or via an RPC
but the referenced 'subscription-id' does not exist, the
dependency is silently discarded. If a referenced
subscription is deleted, this dependency is removed.";
reference
"RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2),
Section 5.3.1";
}
}
grouping subscription-policy-modifiable {
description
"This grouping describes all objects that may be changed
in a subscription.";
choice target {
mandatory true;
description
"Identifies the source of information against which a
subscription is being applied as well as specifics on the
subset of information desired from that source.";
case stream {
choice stream-filter {
description
"An event stream filter can be applied to a subscription.
That filter will either come referenced from a global
list or be provided in the subscription itself.";
case by-reference {
description
"Apply a filter that has been configured separately.";
leaf stream-filter-name {
type stream-filter-ref;
mandatory true;
description
"References an existing event stream filter that is
to be applied to an event stream for the
subscription.";
}
}
case within-subscription {
description
"A local definition allows a filter to have the same
lifecycle as the subscription.";
uses stream-filter-elements;
}
}
}
}
leaf stop-time {
type yang:date-and-time;
description
"Identifies a time after which notification messages for a
subscription should not be sent. If 'stop-time' is not
present, the notification messages will continue until the
subscription is terminated. If 'replay-start-time' exists,
'stop-time' must be for a subsequent time. If
'replay-start-time' doesn't exist, 'stop-time', when
established, must be for a future time.";
}
}
grouping subscription-policy-dynamic {
description
"This grouping describes the only information concerning a
subscription that can be passed over the RPCs defined in this
data model.";
uses subscription-policy-modifiable {
augment "target/stream" {
description
"Adds additional objects that can be modified by an RPC.";
leaf stream {
type stream-ref {
require-instance false;
}
mandatory true;
description
"Indicates the event stream to be considered for
this subscription.";
}
leaf replay-start-time {
if-feature "replay";
type yang:date-and-time;
config false;
description
"Used to trigger the 'replay' feature for a dynamic
subscription, where event records that are selected
need to be at or after the specified starting time. If
'replay-start-time' is not present, this is not a replay
subscription and event record push should start
immediately. It is never valid to specify start times
that are later than or equal to the current time.";
}
}
}
uses update-qos;
}
grouping subscription-policy {
description
"This grouping describes the full set of policy information
concerning both dynamic and configured subscriptions, with the
exclusion of both receivers and networking information
specific to the publisher, such as what interface should be
used to transmit notification messages.";
uses subscription-policy-dynamic;
leaf transport {
if-feature "configured";
type transport;
description
"For a configured subscription, this leaf specifies the
transport used to deliver messages destined for all
receivers of that subscription.";
}
leaf encoding {
when 'not(../transport) or derived-from(../transport,
"sn:configurable-encoding")';
type encoding;
description
"The type of encoding for notification messages. For a
dynamic subscription, if not included as part of an
'establish-subscription' RPC, the encoding will be populated
with the encoding used by that RPC. For a configured
subscription, if not explicitly configured, the encoding
will be the default encoding for an underlying transport.";
}
leaf purpose {
if-feature "configured";
type string;
description
"Open text allowing a configuring entity to embed the
originator or other specifics of this subscription.";
}
}
/*
* RPCs
*/
rpc establish-subscription {
description
"This RPC allows a subscriber to create (and possibly
negotiate) a subscription on its own behalf. If successful,
the subscription remains in effect for the duration of the
subscriber's association with the publisher or until the
subscription is terminated. If an error occurs or the
publisher cannot meet the terms of a subscription, an RPC
error is returned, and the subscription is not created.
In that case, the RPC reply's 'error-info' MAY include
suggested parameter settings that would have a higher
likelihood of succeeding in a subsequent
'establish-subscription' request.";
input {
uses subscription-policy-dynamic;
leaf encoding {
type encoding;
description
"The type of encoding for the subscribed data. If not
included as part of the RPC, the encoding MUST be set by
the publisher to be the encoding used by this RPC.";
}
}
output {
leaf id {
type subscription-id;
mandatory true;
description
"Identifier used for this subscription.";
}
leaf replay-start-time-revision {
if-feature "replay";
type yang:date-and-time;
description
"If a replay has been requested, this object represents
the earliest time covered by the event buffer for the
requested event stream. The value of this object is the
'replay-log-aged-time' if it exists. Otherwise, it is
the 'replay-log-creation-time'. All buffered event
records after this time will be replayed to a receiver.
This object will only be sent if the starting time has
been revised to be later than the time requested by the
subscriber.";
}
}
}
rc:yang-data establish-subscription-stream-error-info {
container establish-subscription-stream-error-info {
description
"If any 'establish-subscription' RPC parameters are
unsupportable against the event stream, a subscription
is not created and the RPC error response MUST indicate the
reason why the subscription failed to be created. This
yang-data MAY be inserted as structured data in a
subscription's RPC error response to indicate the reason for
the failure. This yang-data MUST be inserted if hints are
to be provided back to the subscriber.";
leaf reason {
type identityref {
base establish-subscription-error;
}
description
"Indicates the reason why the subscription has failed to
be created to a targeted event stream.";
}
leaf filter-failure-hint {
type string;
description
"Information describing where and/or why a provided
filter was unsupportable for a subscription. The
syntax and semantics of this hint are
implementation specific.";
}
}
}
rpc modify-subscription {
description
"This RPC allows a subscriber to modify a dynamic
subscription's parameters. If successful, the changed
subscription parameters remain in effect for the duration of
the subscription, until the subscription is again modified, or
until the subscription is terminated. In the case of an error
or an inability to meet the modified parameters, the
subscription is not modified and the original subscription
parameters remain in effect. In that case, the RPC error MAY
include 'error-info' suggested parameter hints that would have
a high likelihood of succeeding in a subsequent
'modify-subscription' request. A successful
'modify-subscription' will return a suspended subscription to
the 'active' state.";
input {
leaf id {
type subscription-id;
mandatory true;
description
"Identifier to use for this subscription.";
}
uses subscription-policy-modifiable;
}
}
rc:yang-data modify-subscription-stream-error-info {
container modify-subscription-stream-error-info {
description
"This yang-data MAY be provided as part of a subscription's
RPC error response when there is a failure of a
'modify-subscription' RPC that has been made against an
event stream. This yang-data MUST be used if hints are to
be provided back to the subscriber.";
leaf reason {
type identityref {
base modify-subscription-error;
}
description
"Information in a 'modify-subscription' RPC error response
that indicates the reason why the subscription to an event
stream has failed to be modified.";
}
leaf filter-failure-hint {
type string;
description
"Information describing where and/or why a provided
filter was unsupportable for a subscription. The syntax
and semantics of this hint are
implementation specific.";
}
}
}
rpc delete-subscription { description "This RPC allows a subscriber to delete a subscription that was previously created by that same subscriber using the 'establish-subscription' RPC.
rpc delete-subscription {description "このRPCにより、サブスクライバーは、 'establish-subscription' RPCを使用して、同じサブスクライバーによって以前に作成されたサブスクリプションを削除できます。
If an error occurs, the server replies with an 'rpc-error'
where the 'error-info' field MAY contain a
'delete-subscription-error-info' structure.";
input {
leaf id {
type subscription-id;
mandatory true;
description
"Identifier of the subscription that is to be deleted.
Only subscriptions that were created using
'establish-subscription' from the same origin as this RPC
can be deleted via this RPC.";
}
}
}
rpc kill-subscription {
nacm:default-deny-all;
description
"This RPC allows an operator to delete a dynamic subscription
without restrictions on the originating subscriber or
underlying transport session.
If an error occurs, the server replies with an 'rpc-error'
where the 'error-info' field MAY contain a
'delete-subscription-error-info' structure.";
input {
leaf id {
type subscription-id;
mandatory true;
description
"Identifier of the subscription that is to be deleted.
Only subscriptions that were created using
'establish-subscription' can be deleted via this RPC.";
}
}
}
｝
rc:yang-data delete-subscription-error-info {
container delete-subscription-error-info {
description
"If a 'delete-subscription' RPC or a 'kill-subscription' RPC
fails, the subscription is not deleted and the RPC error
response MUST indicate the reason for this failure. This
yang-data MAY be inserted as structured data in a
subscription's RPC error response to indicate the reason
for the failure.";
leaf reason {
type identityref {
base delete-subscription-error;
}
mandatory true;
description
"Indicates the reason why the subscription has failed to be
deleted.";
}
}
}
/*
* NOTIFICATIONS
*/
notification replay-completed {
sn:subscription-state-notification;
if-feature "replay";
description
"This notification is sent to indicate that all of the replay
notifications have been sent.";
leaf id {
type subscription-id;
mandatory true;
description
"This references the affected subscription.";
}
}
notification subscription-completed {
sn:subscription-state-notification;
if-feature "configured";
description
"This notification is sent to indicate that a subscription has
finished passing event records, as the 'stop-time' has been
reached.";
leaf id {
type subscription-id;
mandatory true;
description
"This references the gracefully completed subscription.";
}
}
notification subscription-modified {
sn:subscription-state-notification;
description
"This notification indicates that a subscription has been
modified. Notification messages sent from this point on will
conform to the modified terms of the subscription. For
completeness, this subscription state change notification
includes both modified and unmodified aspects of a
subscription.";
leaf id {
type subscription-id;
mandatory true;
description
"This references the affected subscription.";
}
uses subscription-policy {
refine "target/stream/stream-filter/within-subscription" {
description
"Filter applied to the subscription. If the
'stream-filter-name' is populated, the filter in the
subscription came from the 'filters' container.
Otherwise, it is populated in-line as part of the
subscription.";
}
}
}
notification subscription-resumed {
sn:subscription-state-notification;
description
"This notification indicates that a subscription that had
previously been suspended has resumed. Notifications will
once again be sent. In addition, a 'subscription-resumed'
indicates that no modification of parameters has occurred
since the last time event records have been sent.";
leaf id {
type subscription-id;
mandatory true;
description
"This references the affected subscription.";
}
}
notification subscription-started {
sn:subscription-state-notification;
if-feature "configured";
description
"This notification indicates that a subscription has started
and notifications will now be sent.";
leaf id {
type subscription-id;
mandatory true;
description
"This references the affected subscription.";
}
uses subscription-policy {
refine "target/stream/replay-start-time" {
description
"Indicates the time that a replay is using for the
streaming of buffered event records. This will be
populated with the most recent of the following:
the event time of the previous event record sent to a
receiver, the 'replay-log-creation-time', the
'replay-log-aged-time', or the most recent publisher
boot time.";
}
refine "target/stream/stream-filter/within-subscription" {
description
"Filter applied to the subscription. If the
'stream-filter-name' is populated, the filter in the
subscription came from the 'filters' container.
Otherwise, it is populated in-line as part of the
subscription.";
}
augment "target/stream" {
description
"This augmentation adds additional parameters specific to a
'subscription-started' notification.";
leaf replay-previous-event-time {
when '../replay-start-time';
if-feature "replay";
type yang:date-and-time;
description
"If there is at least one event in the replay buffer
prior to 'replay-start-time', this gives the time of
the event generated immediately prior to the
'replay-start-time'.
If a receiver previously received event records for
this configured subscription, it can compare this time
to the last event record previously received. If the
two are not the same (perhaps due to a reboot), then a
dynamic replay can be initiated to acquire any missing
event records.";
}
}
}
}
notification subscription-suspended {
sn:subscription-state-notification;
description
"This notification indicates that a suspension of the
subscription by the publisher has occurred. No further
notifications will be sent until the subscription resumes.
This notification shall only be sent to receivers of a
subscription; it does not constitute a general-purpose
notification.";
leaf id {
type subscription-id;
mandatory true;
description
"This references the affected subscription.";
}
leaf reason {
type identityref {
base subscription-suspended-reason;
}
mandatory true;
description
"Identifies the condition that resulted in the suspension.";
}
}
notification subscription-terminated {
sn:subscription-state-notification;
description
"This notification indicates that a subscription has been
terminated.";
leaf id {
type subscription-id;
mandatory true;
description
"This references the affected subscription.";
}
leaf reason {
type identityref {
base subscription-terminated-reason;
}
mandatory true;
description
"Identifies the condition that resulted in the termination.";
}
}
/*
* DATA NODES
*/
container streams {
config false;
description
"Contains information on the built-in event streams provided by
the publisher.";
list stream {
key "name";
description
"Identifies the built-in event streams that are supported by
the publisher.";
leaf name {
type string;
description
"A handle for a system-provided event stream made up of a
sequential set of event records, each of which is
characterized by its own domain and semantics.";
}
leaf description {
type string;
description
"A description of the event stream, including such
information as the type of event records that are
available in this event stream.";
}
leaf replay-support {
if-feature "replay";
type empty;
description
"Indicates that event record replay is available on this
event stream.";
}
leaf replay-log-creation-time {
when '../replay-support';
if-feature "replay";
type yang:date-and-time;
mandatory true;
description
"The timestamp of the creation of the log used to support
the replay function on this event stream. This time
might be earlier than the earliest available information
contained in the log. This object is updated if the log
resets for some reason.";
}
leaf replay-log-aged-time {
when '../replay-support';
if-feature "replay";
type yang:date-and-time;
description
"The timestamp associated with the last event record that
has been aged out of the log. This timestamp identifies
how far back in history this replay log extends, if it
doesn't extend back to the 'replay-log-creation-time'.
This object MUST be present if replay is supported and any
event records have been aged out of the log.";
}
}
}
container filters {
description
"Contains a list of configurable filters that can be applied to
subscriptions. This facilitates the reuse of complex filters
once defined.";
list stream-filter {
key "name";
description
"A list of preconfigured filters that can be applied to
subscriptions.";
leaf name {
type string;
description
"A name to differentiate between filters.";
}
uses stream-filter-elements;
}
}
container subscriptions {
description
"Contains the list of currently active subscriptions, i.e.,
subscriptions that are currently in effect, used for
subscription management and monitoring purposes. This
includes subscriptions that have been set up via
RPC primitives as well as subscriptions that have been
established via configuration.";
list subscription {
key "id";
description
"The identity and specific parameters of a subscription.
Subscriptions in this list can be created using a control
channel or RPC or can be established through configuration.
If the 'kill-subscription' RPC or configuration operations
are used to delete a subscription, a
'subscription-terminated' message is sent to any active or
suspended receivers.";
leaf id {
type subscription-id;
description
"Identifier of a subscription; unique in a given
publisher.";
}
uses subscription-policy {
refine "target/stream/stream" {
description
"Indicates the event stream to be considered for this
subscription. If an event stream has been removed
and can no longer be referenced by an active
subscription, send a 'subscription-terminated'
notification with 'stream-unavailable' as the reason.
If a configured subscription refers to a nonexistent
event stream, move that subscription to the
'invalid' state.";
}
refine "transport" {
description
"For a configured subscription, this leaf specifies the
transport used to deliver messages destined for all
receivers of that subscription. This object is
mandatory for subscriptions in the configuration
datastore. This object (1) is not mandatory for dynamic
subscriptions in the operational state datastore and
(2) should not be present for other types of dynamic
subscriptions.";
}
augment "target/stream" {
description
"Enables objects to be added to a configured stream
subscription.";
leaf configured-replay {
if-feature "configured";
if-feature "replay";
type empty;
description
"The presence of this leaf indicates that replay for
the configured subscription should start at the
earliest time in the event log or at the publisher
boot time, whichever is later.";
}
}
}
choice notification-message-origin {
if-feature "configured";
description
"Identifies the egress interface on the publisher
from which notification messages are to be sent.";
case interface-originated {
description
"When notification messages are to egress a specific,
designated interface on the publisher.";
leaf source-interface {
if-feature "interface-designation";
type if:interface-ref;
description
"References the interface for notification messages.";
}
}
case address-originated {
description
"When notification messages are to depart from a
publisher using a specific originating address and/or
routing context information.";
leaf source-vrf {
if-feature "supports-vrf";
type leafref {
path "/ni:network-instances/ni:network-instance/ni:name";
}
description
"VRF from which notification messages should egress a
publisher.";
}
leaf source-address {
type inet:ip-address-no-zone;
description
"The source address for the notification messages.
If a source VRF exists but this object doesn't, a
publisher's default address for that VRF must
be used.";
}
}
}
leaf configured-subscription-state {
if-feature "configured";
type enumeration {
enum valid {
value 1;
description
"The subscription is supportable with its current
parameters.";
}
enum invalid {
value 2;
description
"The subscription as a whole is unsupportable with its
current parameters.";
}
enum concluded {
value 3;
description
"A subscription is inactive, as it has hit a
stop time. It no longer has receivers in the
'active' or 'suspended' state, but the subscription
has not yet been removed from configuration.";
}
}
config false;
description
"The presence of this leaf indicates that the subscription
originated from configuration, not through a control
channel or RPC. The value indicates the state of the
subscription as established by the publisher.";
}
container receivers {
description
"Set of receivers in a subscription.";
list receiver {
key "name";
min-elements 1;
description
"A host intended as a recipient for the notification
messages of a subscription. For configured
subscriptions, transport-specific network parameters
(or a leafref to those parameters) may be augmented to a
specific receiver in this list.";
leaf name {
type string;
description
"Identifies a unique receiver for a subscription.";
}
leaf sent-event-records {
type yang:zero-based-counter64;
config false;
description
"The number of event records sent to the receiver. The
count is initialized when a dynamic subscription is
established or when a configured receiver
transitions to the 'valid' state.";
}
leaf excluded-event-records {
type yang:zero-based-counter64;
config false;
description
"The number of event records explicitly removed via
either an event stream filter or an access control
filter so that they are not passed to a receiver.
This count is set to zero each time
'sent-event-records' is initialized.";
}
leaf state {
type enumeration {
enum active {
value 1;
description
"The receiver is currently being sent any
applicable notification messages for the
subscription.";
}
enum suspended {
value 2;
description
"The receiver state is 'suspended', so the
publisher is currently unable to provide
notification messages for the subscription.";
}
enum connecting {
value 3;
if-feature "configured";
description
"A subscription has been configured, but a
'subscription-started' subscription state change
notification needs to be successfully received
before notification messages are sent.
If the 'reset' action is invoked for a receiver of
an active configured subscription, the state
must be moved to 'connecting'.";
}
enum disconnected {
value 4;
if-feature "configured";
description
"A subscription has failed to send a
'subscription-started' state change to the
receiver. Additional connection attempts are not
currently being made.";
}
}
config false;
mandatory true;
description
"Specifies the state of a subscription from the
perspective of a particular receiver. With this
information, it is possible to determine whether a
publisher is currently generating notification
messages intended for that receiver.";
}
action reset {
if-feature "configured";
description
"Allows the reset of this configured subscription's
receiver to the 'connecting' state. This enables the
connection process to be reinitiated.";
output {
leaf time {
type yang:date-and-time;
mandatory true;
description
"Time at which a publisher returned the receiver to
the 'connecting' state.";
}
}
}
}
}
}
}
}
<CODE ENDS>
IANA has registered one URI in the "ns" subregistry of the "IETF XML Registry" [RFC3688] maintained at <https://www.iana.org/assignments/ xml-registry>. The following registration has been made per the format in [RFC3688]:
IANAは、<https://www.iana.org/assignments/ xml-registry>で管理される「IETF XMLレジストリ」[RFC3688]の「ns」サブレジストリに1つのURIを登録しました。 [RFC3688]の形式に従って、次の登録が行われました。
URI: urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications Registrant Contact: The NETCONF WG of the IETF. XML: N/A; the requested URI is an XML namespace.
URI：urn：ietf：params：xml：ns：yang：ietf-subscribed-notifications登録者の連絡先：IETFのNETCONF WG。 XML：なし。要求されたURIはXML名前空間です。
IANA has registered one YANG module in the "YANG Module Names" registry [RFC6020] maintained at <https://www.iana.org/assignments/ yang-parameters>. The following registration has been made per the format in [RFC6020]:
IANAは、<https://www.iana.org/assignments/ yang-parameters>で管理されている「YANG Module Names」レジストリ[RFC6020]に1つのYANGモジュールを登録しました。 [RFC6020]の形式に従って、次の登録が行われました。
Name: ietf-subscribed-notifications
Namespace: urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications
Prefix: sn
Reference: RFC 8639
To support deployments that include both configured and dynamic subscriptions, it is recommended that the subscription "id" domain be split into static and dynamic halves. This will eliminate the possibility of collisions if the configured subscriptions attempt to set a "subscription-id" that might have already been dynamically allocated. A best practice is to use the lower half of the "id" object's integer space when that "id" is assigned by an external entity (such as with a configured subscription). This leaves the upper half of the subscription integer space available to be dynamically assigned by the publisher.
構成済みサブスクリプションと動的サブスクリプションの両方を含む展開をサポートするには、サブスクリプションの「id」ドメインを静的と動的の半分に分割することをお勧めします。これにより、構成済みのサブスクリプションが、すでに動的に割り当てられている可能性のある「サブスクリプションID」を設定しようとした場合の衝突の可能性がなくなります。ベストプラクティスは、「id」オブジェクトの整数スペースの下半分を、その「id」が外部エンティティ（割り当てられたサブスクリプションなど）によって割り当てられている場合に使用することです。これにより、サブスクリプションの整数スペースの上半分がパブリッシャーによって動的に割り当てられるようになります。
If a subscription is unable to marshal a series of filtered event records into transmittable notification messages, the receiver should be suspended with the reason "unsupportable-volume".
サブスクリプションが一連のフィルターされたイベントレコードを送信可能な通知メッセージにマーシャリングできない場合、レシーバーは「unsupportable-volume」という理由で一時停止する必要があります。
For configured subscriptions, operations are performed against the set of receivers using the subscription "id" as a handle for that set. But for streaming updates, subscription state change notifications are local to a receiver. In the case of this specification, receivers do not get any information from the publisher about the existence of other receivers. But if a network operator wants to let the receivers correlate results, it is useful to use the subscription "id" across the receivers to allow that correlation. Note that due to the possibility of different access control permissions per receiver, each receiver may actually get a different set of event records.
構成されたサブスクリプションの場合、そのセットのハンドルとしてサブスクリプション「id」を使用して、レシーバーのセットに対して操作が実行されます。ただし、ストリーミング更新の場合、サブスクリプション状態変更通知はレシーバーに対してローカルです。この仕様の場合、レシーバーは他のレシーバーの存在についてパブリッシャーから情報を取得しません。ただし、ネットワークオペレーターが受信者に結果を関連付けさせたい場合は、受信者全体でサブスクリプション "id"を使用してその関連付けを許可すると便利です。受信者ごとに異なるアクセス制御パーミッションの可能性があるため、各受信者は実際には異なるイベントレコードのセットを取得する場合があることに注意してください。
For configured replay subscriptions, the receiver is protected from duplicated events being pushed after a publisher is rebooted. However, it is possible that a receiver might want to acquire event records that failed to be delivered just prior to the reboot. Delivering these event records can be accomplished by leveraging the <eventTime> [RFC5277] from the last event record received prior to the receipt of a "subscription-started" subscription state change notification. With this <eventTime> and the "replay-start-time" from the "subscription-started" notification, an independent dynamic subscription can be established that retrieves any event records that may have been generated but not sent to the receiver.
構成された再生サブスクリプションの場合、レシーバーは、パブリッシャーの再起動後にプッシュされる重複イベントから保護されます。ただし、再起動の直前に配信に失敗したイベントレコードを受信者が取得したい場合があります。これらのイベントレコードの配信は、「サブスクリプション開始」サブスクリプション状態変更通知を受信する前に受信した最後のイベントレコードの<eventTime> [RFC5277]を利用することで実現できます。この<eventTime>と、「subscription-started」通知からの「replay-start-time」を使用して、生成されたが受信側に送信されていない可能性のあるイベントレコードを取得する独立した動的サブスクリプションを確立できます。
This section provides requirements for any subscribed notification transport supporting the solution presented in this document.
このセクションでは、このドキュメントに記載されているソリューションをサポートするサブスクライブされた通知トランスポートの要件を示します。
The transport selected by the subscriber to reach the publisher MUST be able to support multiple "establish-subscription" requests made in the same transport session.
パブリッシャーに到達するためにサブスクライバーによって選択されたトランスポートは、同じトランスポートセッションで行われた複数の "establish-subscription"リクエストをサポートできなければなりません（MUST）。
For both configured and dynamic subscriptions, the publisher MUST authenticate a receiver via some transport-level mechanism before sending any event records that the receiver is authorized to see. In addition, the receiver MUST authenticate the publisher at the transport level. The result is mutual authentication between the two.
構成済みサブスクリプションと動的サブスクリプションの両方について、パブリッシャーは、レシーバーが見ることを許可されているイベントレコードを送信する前に、トランスポートレベルのメカニズムを介してレシーバーを認証する必要があります。さらに、レシーバーはトランスポートレベルでパブリッシャーを認証する必要があります。結果は、2つの間の相互認証です。
A secure transport is highly recommended. Beyond this, the publisher MUST ensure that the receiver has sufficient authorization to perform the function it is requesting against the specific subset of content involved.
安全なトランスポートを強くお勧めします。これを超えて、パブリッシャーは、受信者が関係するコンテンツの特定のサブセットに対して要求している機能を実行するための十分な権限を持っていることを確認する必要があります。
A specification for a transport built upon this document may or may not choose to require the use of the same logical channel for the RPCs and the event records. However, the event records and the subscription state change notifications MUST be sent on the same transport session to ensure properly ordered delivery.
このドキュメントに基づいて構築されたトランスポートの仕様では、RPCとイベントレコードに同じ論理チャネルを使用することを要求する場合としない場合があります。ただし、イベントレコードとサブスクリプション状態変更通知は、適切に順序付けられた配信を保証するために、同じトランスポートセッションで送信する必要があります。
A specification for a transport MUST identify any encodings that are supported. If a configured subscription's transport allows different encodings, the specification MUST identify the default encoding.
トランスポートの仕様は、サポートされているエンコーディングを識別しなければなりません（MUST）。構成されたサブスクリプションのトランスポートが異なるエンコーディングを許可する場合、仕様はデフォルトのエンコーディングを識別しなければなりません（MUST）。
A subscriber that includes a "dscp" leaf in an "establish-subscription" request will need to understand and consider what the corresponding DSCP value represents in the domain of the publisher.
「establish-subscription」リクエストに「dscp」リーフを含めるサブスクライバーは、対応するDSCP値がパブリッシャーのドメインで何を表しているかを理解し、考慮する必要があります。
Additional transport requirements will be dictated by the choice of transport used with a subscription. For an example of such requirements, see [RFC8640].
追加のトランスポート要件は、サブスクリプションで使用されるトランスポートの選択によって決まります。このような要件の例については、[RFC8640]を参照してください。
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 [RFC5246].
このドキュメントで指定されているYANGモジュールは、NETCONF [RFC6241]やRESTCONF [RFC8040]などのネットワーク管理プロトコルを介してアクセスするように設計されたデータのスキーマを定義します。最下層のNETCONF層はセキュアなトランスポート層であり、実装に必須のセキュアなトランスポートはセキュアシェル（SSH）[RFC6242]です。最も低いRESTCONF層はHTTPSであり、実装に必須のセキュアなトランスポートはTLS [RFC5246]です。
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プロトコル操作およびコンテンツの事前構成されたサブセットに制限する手段を提供します。
With configured subscriptions, one or more publishers could be used to overwhelm a receiver. To counter this, notification messages SHOULD NOT be sent to any receiver that does not support this specification. Receivers that do not want notification messages need only terminate or refuse any transport sessions from the publisher.
サブスクリプションを構成すると、1つ以上のパブリッシャーを使用して、レシーバーを圧倒することができます。これに対抗するために、この仕様をサポートしていない受信者には通知メッセージを送信すべきではありません（SHOULD NOT）。通知メッセージを必要としない受信者は、パブリッシャーからのトランスポートセッションを終了または拒否するだけで済みます。
When a receiver of a configured subscription gets a new "subscription-started" message for a known subscription where it is already consuming events, it may indicate that an attacker has done something that has momentarily disrupted receiver connectivity. To acquire events lost during this interval, the receiver SHOULD retrieve any event records generated since the last event record was received. This can be accomplished by establishing a separate dynamic replay subscription with the same filtering criteria with the publisher, assuming that the publisher supports the "replay" feature.
構成済みのサブスクリプションの受信者が既知のサブスクリプションの新しい「サブスクリプション開始」メッセージを受け取り、既にイベントを消費している場合、それは攻撃者がレシーバーの接続を一時的に中断させたことを示している可能性があります。この間隔中に失われたイベントを取得するために、受信者は最後のイベントレコードが受信されてから生成されたイベントレコードを取得する必要があります（SHOULD）。これは、パブリッシャーが「リプレイ」機能をサポートしていることを前提として、パブリッシャーと同じフィルタリング基準で個別の動的リプレイサブスクリプションを確立することで実現できます。
For dynamic subscriptions, implementations need to protect against malicious or buggy subscribers that may send a large number of "establish-subscription" requests and thereby use up system resources. To cover this possibility, operators SHOULD monitor for such cases and, if discovered, take remedial action to limit the resources used, such as suspending or terminating a subset of the subscriptions or, if the underlying transport is session based, terminating the underlying transport session.
動的サブスクリプションの場合、実装は、多数の「確立サブスクリプション」リクエストを送信してシステムリソースを使い果たす可能性がある悪意のある、またはバグのあるサブスクライバーから保護する必要があります。この可能性をカバーするために、オペレーターはそのような場合を監視し、発見された場合は、サブスクリプションのサブセットの一時停止または終了、または基礎となるトランスポートがセッションベースの場合は基礎となるトランスポートセッションの終了など、使用するリソースを制限する是正措置をとる必要があります。
The replay mechanisms described in Sections 2.4.2.1 and 2.5.6 provide access to historical event records. By design, the access control model that protects these records could enable subscribers to view data to which they were not authorized at the time of collection.
セクション2.4.2.1および2.5.6で説明されている再生メカニズムは、履歴イベントレコードへのアクセスを提供します。設計上、これらのレコードを保護するアクセス制御モデルにより、サブスクライバーは、収集時に許可されていなかったデータを表示できます。
Using DNS names for configured subscription's receiver "name" lookups can cause situations where the name resolves differently than expected on the publisher, so the recipient would be different than expected.
構成済みサブスクリプションの受信者の「名前」ルックアップにDNS名を使用すると、名前がパブリッシャーで予期したものとは異なる方法で解決されるため、受信者が予期したものとは異なる場合があります。
An attacker that can cause the publisher to use an incorrect time can induce message replay by setting the time in the past and can introduce a risk of message loss by setting the time in the future.
攻撃者がパブリッシャーに誤った時間を使用させると、過去の時間を設定することによりメッセージの再生を誘発し、将来の時間を設定することによりメッセージ損失のリスクをもたらす可能性があります。
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) 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など）を行うと、ネットワーク操作に悪影響を与える可能性があります。これらは、サブツリーとデータノード、およびそれらの機密性/脆弱性です。
Container: "/filters"
コンテナ：「/ filters」
o "stream-subtree-filter": Updating a filter could increase the computational complexity of all referencing subscriptions.
o "stream-subtree-filter"：フィルターを更新すると、すべての参照サブスクリプションの計算が複雑になる可能性があります。
o "stream-xpath-filter": Updating a filter could increase the computational complexity of all referencing subscriptions.
o "stream-xpath-filter"：フィルターを更新すると、すべての参照サブスクリプションの計算が複雑になる可能性があります。
Container: "/subscriptions"
コンテナ：「/ subscriptions」
The following considerations are only relevant for configuration operations made upon configured subscriptions:
以下の考慮事項は、構成済みサブスクリプションに対して行われる構成操作にのみ関連します。
o "configured-replay": Can be used to send a large number of event records to a receiver.
o 「configured-replay」：多数のイベントレコードをレシーバーに送信するために使用できます。
o "dependency": Can be used to force important traffic to be queued behind updates that are not as important.
o "dependency": Can be used to force important traffic to be queued behind updates that are not as important.
o "dscp": If unvalidated, can result in the sending of traffic with a higher-priority marking than warranted.
o 「dscp」：検証されていない場合、保証よりも優先度の高いマーキングでトラフィックが送信される可能性があります。
o "id": Can overwrite an existing subscription, perhaps one configured by another entity.
o "id"：既存のサブスクリプションを上書きできます。別のエンティティによって構成されている可能性があります。
o "name": Adding a new key entry can be used to attempt to send traffic to an unwilling receiver.
o "name": Adding a new key entry can be used to attempt to send traffic to an unwilling receiver.
o "replay-start-time": Can be used to push very large logs, wasting resources.
o "replay-start-time"：非常に大きなログをプッシュしてリソースを浪費するために使用できます。
o "source-address": The configured address might not be able to reach a desired receiver.
o "source-address"：設定されたアドレスが目的の受信者に到達できない可能性があります。
o "source-interface": The configured interface might not be able to reach a desired receiver.
o 「source-interface」：構成されたインターフェースが目的のレシーバーに到達できない可能性があります。
o "source-vrf": Can place a subscription in a virtual network where receivers are not entitled to view the subscribed content.
o 「source-vrf」：受信者がサブスクライブしたコンテンツを表示する資格がない仮想ネットワークにサブスクリプションを配置できます。
o "stop-time": Could be used to terminate content at an inopportune time.
o 「stop-time」：不適切な時間にコンテンツを終了するために使用できます。
o "stream": Could set a subscription to an event stream that does not contain content permitted for the targeted receivers.
o 「ストリーム」：ターゲットレシーバーに許可されたコンテンツを含まないイベントストリームへのサブスクリプションを設定できます。
o "stream-filter-name": Could be set to a filter that is not relevant to the event stream.
o "stream-filter-name"：イベントストリームに関連しないフィルターに設定できます。
o "stream-subtree-filter": A complex filter can increase the computational resources for this subscription.
o 「stream-subtree-filter」：複雑なフィルターは、このサブスクリプションの計算リソースを増やすことができます。
o "stream-xpath-filter": A complex filter can increase the computational resources for this subscription.
o 「stream-xpath-filter」：複雑なフィルターは、このサブスクリプションの計算リソースを増やすことができます。
o "weighting": Allocating a large weight can overwhelm the dequeuing of other subscriptions.
o 「重み付け」：大きな重みを割り当てると、他のサブスクリプションのデキューを圧倒する可能性があります。
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、または通知を介して）。これらは、サブツリーとデータノード、およびそれらの機密性/脆弱性です。
Container: "/streams"
コンテナ：「/ streams」
o "name": If access control is not properly configured, can expose system internals to those who should not have access to this information.
o "name"：アクセス制御が適切に構成されていない場合、この情報にアクセスしてはならないユーザーにシステム内部を公開する可能性があります。
o "replay-support": If access control is not properly configured, can expose logs to those who should not have access.
o "replay-support"：アクセス制御が適切に構成されていない場合、アクセスを許可しないユーザーにログを公開する可能性があります。
Container: "/subscriptions"
コンテナ：「/ subscriptions」
o "excluded-event-records": This leaf can provide information about filtered event records. A network operator should have the proper permissions to know about such filtering. However, exposing the count of excluded events to a receiver could leak information about the presence of access control filters that might be in place for that receiver.
o "excluded-event-records"：このリーフは、フィルタリングされたイベントレコードに関する情報を提供できます。ネットワークオペレータは、このようなフィルタリングについて知るための適切な権限を持っている必要があります。ただし、除外されたイベントのカウントをレシーバーに公開すると、そのレシーバーに設定されている可能性のあるアクセス制御フィルターの存在に関する情報が漏洩する可能性があります。
o "subscription": Different operational teams might have a desire to set varying subsets of subscriptions. Access control should be designed to permit read access to just the allowed set.
o "subscription": Different operational teams might have a desire to set varying subsets of subscriptions. Access control should be designed to permit read access to just the allowed set.
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操作は、一部のネットワーク環境では機密または脆弱であると見なされる場合があります。したがって、これらの操作へのアクセスを制御することが重要です。これらは操作とその感度/脆弱性です：
RPC: all
RPC：すべて
o If a malicious or buggy subscriber sends an unexpectedly large number of RPCs, the result might be an excessive use of system resources on the publisher just to determine that these subscriptions should be declined. In such a situation, subscription interactions MAY be terminated by terminating the transport session.
o 悪意のある、またはバグのあるサブスクライバーが予想外に多数のRPCを送信すると、これらのサブスクリプションを拒否する必要があると判断するためだけに、パブリッシャーのシステムリソースが過度に使用される可能性があります。そのような状況では、サブスクリプションの相互作用は、トランスポートセッションを終了することによって終了する場合があります。
RPC: "delete-subscription"
RPC：「サブスクリプションの削除」
o No special considerations.
o 特別な考慮事項はありません。
RPC: "establish-subscription"
RPC: "establish-subscription"
o Subscriptions could overload a publisher's resources. For this reason, publishers MUST ensure that they have sufficient resources to fulfill this request; otherwise, they MUST reject the request.
o サブスクリプションは、パブリッシャーのリソースを過負荷にする可能性があります。このため、パブリッシャーは、この要求を満たす十分なリソースがあることを確認する必要があります。それ以外の場合は、要求を拒否する必要があります。
RPC: "kill-subscription"
RPC： "kill-subscription"
o The "kill-subscription" RPC MUST be secured so that only connections with administrative rights are able to invoke this RPC.
o 「kill-subscription」RPCは、管理者権限を持つ接続のみがこのRPCを呼び出すことができるように保護する必要があります。
RPC: "modify-subscription"
RPC：「サブスクリプションの変更」
o Subscriptions could overload a publisher's resources. For this reason, publishers MUST ensure that they have sufficient resources to fulfill this request; otherwise, they MUST reject the request.
o サブスクリプションは、パブリッシャーのリソースを過負荷にする可能性があります。このため、パブリッシャーは、この要求を満たす十分なリソースがあることを確認する必要があります。それ以外の場合は、要求を拒否する必要があります。
[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>。
[RFC2474] Nichols, K., Blake, S., Baker, F., and D. Black, "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers", RFC 2474, DOI 10.17487/RFC2474, December 1998, <https://www.rfc-editor.org/info/rfc2474>.
[RFC2474] Nichols、K.、Blake、S.、Baker、F。、およびD. Black、「IPv4およびIPv6ヘッダーのDiffServフィールド（DSフィールド）の定義」、RFC 2474、DOI 10.17487 / RFC2474、 1998年12月、<https://www.rfc-editor.org/info/rfc2474>。
[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。、「The IETF XML Registry」、BCP 81、RFC 3688、DOI 10.17487 / RFC3688、2004年1月、<https://www.rfc-editor.org/info/rfc3688>。
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security (TLS) Protocol Version 1.2", RFC 5246, DOI 10.17487/RFC5246, August 2008, <https://www.rfc-editor.org/info/rfc5246>.
[RFC5246] Dierks、T。およびE. Rescorla、「The Transport Layer Security（TLS）Protocol Version 1.2」、RFC 5246、DOI 10.17487 / RFC5246、2008年8月、<https://www.rfc-editor.org/info / rfc5246>。
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, <https://www.rfc-editor.org/info/rfc5277>.
[RFC5277] Chisholm、S。およびH. Trevino、「NETCONFイベント通知」、RFC 5277、DOI 10.17487 / RFC5277、2008年7月、<https://www.rfc-editor.org/info/rfc5277>。
[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 - 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>.
[RFC6241] Enns、R。、編、Bjorklund、M。、編、Schoenwaelder、J。、編、A。Bierman、編、「Network Configuration Protocol（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。、「Using the NETCONF Protocol over Secure Shell（SSH）」、RFC 6242、DOI 10.17487 / RFC6242、2011年6月、<https://www.rfc-editor.org/info/rfc6242>。
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-editor.org/info/rfc6991>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-editor.org/info/rfc6991>.
[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>.
[RFC7950] Bjorklund、M。、編、「The YANG 1.1 Data Modeling Language」、RFC 7950、DOI 10.17487 / RFC7950、2016年8月、<https://www.rfc-editor.org/info/rfc7950>。
[RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", RFC 7951, DOI 10.17487/RFC7951, August 2016, <https://www.rfc-editor.org/info/rfc7951>.
[RFC7951] Lhotka、L。、「YANGでモデル化されたデータのJSONエンコーディング」、RFC 7951、DOI 10.17487 / RFC7951、2016年8月、<https://www.rfc-editor.org/info/rfc7951>。
[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、「Network Configuration Access Control Model」、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、「Network Management Datastore Architecture（NMDA）」、RFC 8342、DOI 10.17487 / RFC8342、2018年3月、< https://www.rfc-editor.org/info/rfc8342>。
[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>.
[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>。
[RFC8529] Berger, L., Hopps, C., Lindem, A., Bogdanovic, D., and X. Liu, "YANG Data Model for Network Instances", RFC 8529, DOI 10.17487/RFC8529, March 2019, <https://www.rfc-editor.org/info/rfc8529>.
[RFC8529] Berger、L.、Hopps、C.、Lindem、A.、Bogdanovic、D。、およびX. Liu、「ネットワークインスタンスのYANGデータモデル」、RFC 8529、DOI 10.17487 / RFC8529、2019年3月、<https ：//www.rfc-editor.org/info/rfc8529>。
[W3C.REC-xml-20081126] Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", World Wide Web Consortium Recommendation REC-xml-20081126, November 2008, <https://www.w3.org/TR/2008/REC-xml-20081126>.
[W3C.REC-xml-20081126] Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", World Wide Web Consortium Recommendation REC-xml-20081126, November 2008, <https://www.w3.org/TR/2008/REC-xml-20081126>.
[XPATH] Clark, J. and S. DeRose, "XML Path Language (XPath) Version 1.0", November 1999, <https://www.w3.org/TR/1999/REC-xpath-19991116>.
[XPATH] Clark、J.およびS. DeRose、「XML Path Language（XPath）Version 1.0」、1999年11月、<https://www.w3.org/TR/1999/REC-xpath-19991116>。
[RESTCONF-Notif] Voit, E., Rahman, R., Nilsen-Nygaard, E., Clemm, A., and A. Bierman, "Dynamic subscription to YANG Events and Datastores over RESTCONF", Work in Progress, draft-ietf-netconf-restconf-notif-15, June 2019.
[RESTCONF-Notif] Voit、E.、Rahman、R.、Nilsen-Nygaard、E.、Clemm、A。、およびA. Bierman、「RESTCONFを介したYANGイベントおよびデータストアへの動的サブスクリプション」、Work in Progress、下書き- ietf-netconf-restconf-notif-15、2019年6月。
[RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049, October 2013, <https://www.rfc-editor.org/info/rfc7049>.
[RFC7049] Bormann、C。およびP. Hoffman、「簡潔なバイナリオブジェクト表現（CBOR）」、RFC 7049、DOI 10.17487 / RFC7049、2013年10月、<https://www.rfc-editor.org/info/rfc7049> 。
[RFC7540] Belshe, M., Peon, R., and M. Thomson, Ed., "Hypertext Transfer Protocol Version 2 (HTTP/2)", RFC 7540, DOI 10.17487/RFC7540, May 2015, <https://www.rfc-editor.org/info/rfc7540>.
[RFC7540] Belshe, M., Peon, R., and M. Thomson, Ed., "Hypertext Transfer Protocol Version 2 (HTTP/2)", RFC 7540, DOI 10.17487/RFC7540, May 2015, <https://www.rfc-editor.org/info/rfc7540>.
[RFC7923] Voit, E., Clemm, A., and A. Gonzalez Prieto, "Requirements for Subscription to YANG Datastores", RFC 7923, DOI 10.17487/RFC7923, June 2016, <https://www.rfc-editor.org/info/rfc7923>.
[RFC7923] Voit、E.、Clemm、A。、およびA. Gonzalez Prieto、「YANG Datastoresへのサブスクリプションの要件」、RFC 7923、DOI 10.17487 / RFC7923、2016年6月、<https：//www.rfc-editor。 org / info / rfc7923>。
[RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", RFC 8071, DOI 10.17487/RFC8071, February 2017, <https://www.rfc-editor.org/info/rfc8071>.
[RFC8071] Watsen、K。、「NETCONF Call Home and RESTCONF Call Home」、RFC 8071、DOI 10.17487 / RFC8071、2017年2月、<https://www.rfc-editor.org/info/rfc8071>。
[RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", STD 90, RFC 8259, DOI 10.17487/RFC8259, December 2017, <https://www.rfc-editor.org/info/rfc8259>.
[RFC8259]ブレイ、T。、編、「JavaScript Object Notation（JSON）データ交換フォーマット」、STD 90、RFC 8259、DOI 10.17487 / RFC8259、2017年12月、<https://www.rfc-editor.org / info / rfc8259>。
[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、編、「YANGツリー図」、BCP 215、RFC 8340、DOI 10.17487 / RFC8340、2018年3月、<https://www.rfc-editor.org/info/ rfc8340>。
[RFC8640] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, E., and A. Tripathy, "Dynamic Subscription to YANG Events and Datastores over NETCONF", RFC 8640, DOI 10.17487/RFC8640, September 2019, <https://www.rfc-editor.org/info/rfc8640>.
[RFC8640] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, E., and A. Tripathy, "Dynamic Subscription to YANG Events and Datastores over NETCONF", RFC 8640, DOI 10.17487/RFC8640, September 2019, <https://www.rfc-editor.org/info/rfc8640>.
[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、「データストア更新のためのYANG通知のサブスクリプション」、RFC 8641、DOI 10.17487 / RFC8641、2019年9月、<https://www.rfc-editor.org/info/rfc8641> 。
This appendix provides a non-normative example of how the YANG module defined in Section 4 may be enhanced to incorporate the configuration parameters needed to support the transport connectivity process. This example is not intended to be a complete transport model. In this example, connectivity via an imaginary transport type of "foo" is explored. For more on the overall objectives behind configuring transport connectivity for a configured subscription, see Section 2.5.7.
この付録では、セクション4で定義されたYANGモジュールを拡張して、トランスポート接続プロセスをサポートするために必要な構成パラメーターを組み込む方法の非規範的な例を示します。この例は、完全なトランスポートモデルを意図したものではありません。この例では、架空の転送タイプ「foo」を介した接続が調査されます。構成済みサブスクリプションのトランスポート接続の構成の背後にある全体的な目的の詳細については、セクション2.5.7を参照してください。
The YANG module example defined in this appendix contains two main elements. First is a transport identity "foo". This transport identity allows a configuration agent to define "foo" as the selected type of transport for a subscription. Second is a YANG case augmentation "foo", which is made to the "/subscriptions/subscription/receivers/receiver" node of Section 4. In this augmentation are the transport configuration parameters "address" and "port", which are necessary to make the connection to the receiver.
この付録で定義されているYANGモジュールの例には、2つの主要な要素が含まれています。最初は、トランスポートID「foo」です。このトランスポートIDにより、構成エージェントは、サブスクリプション用に選択されたトランスポートタイプとして「foo」を定義できます。 2番目は、YANGケースの拡張 "foo"です。これは、セクション4の "/ subscriptions / subscription / receivers / receiver"ノードに対して行われます。この拡張では、トランスポート構成パラメーター "address"および "port"が必要です。受信機に接続します。
module example-foo-subscribed-notifications {
yang-version 1.1;
namespace
"urn:example:foo-subscribed-notifications";
prefix fsn;
接頭辞fsn;
import ietf-subscribed-notifications {
prefix sn;
}
import ietf-inet-types {
prefix inet;
}
description "Defines 'foo' as a supported type of configured transport for subscribed event notifications.";
説明「サブスクライブされたイベント通知用にサポートされている構成済みトランスポートのタイプとして「foo」を定義します。」;
identity foo {
base sn:transport;
description
"Transport type 'foo' is available for use as a configured
subscription's transport protocol for subscribed
notifications.";
}
augment
"/sn:subscriptions/sn:subscription/sn:receivers/sn:receiver" {
when 'derived-from(../../../transport, "fsn:foo")';
description
"This augmentation makes transport parameters specific to 'foo'
available for a receiver.";
leaf address {
type inet:host;
mandatory true;
description
"Specifies the address to use for messages destined for a
receiver.";
}
leaf port {
type inet:port-number;
mandatory true;
description
"Specifies the port number to use for messages destined for a
receiver.";
}
}
}
Figure 21: Example Transport Augmentation for the Fictitious Protocol "foo"
Figure 21: Example Transport Augmentation for the Fictitious Protocol "foo"
This example YANG module for transport "foo" will not be seen in a real-world deployment. For a real-world deployment supporting an actual transport technology, a similar YANG module must be defined.
トランスポート "foo"のこのYANGモジュールの例は、実際のデプロイメントでは表示されません。実際のトランスポートテクノロジーをサポートする実際のデプロイメントでは、同様のYANGモジュールを定義する必要があります。
Acknowledgments
Acknowledgments
For their valuable comments, discussions, and feedback, we wish to acknowledge Andy Bierman, Tim Jenkins, Martin Bjorklund, Kent Watsen, Balazs Lengyel, Robert Wilton, Sharon Chisholm, Hector Trevino, Susan Hares, Michael Scharf, and Guangying Zheng.
彼らの貴重なコメント、ディスカッション、フィードバックについて、アンディビアマン、ティムジェンキンス、マーティンビョークランド、ケントワッセン、バラズレンゲル、ロバートウィルトン、シャロンチスホルム、ヘクタートレビノ、スーザンヘアーズ、マイケルシャーフ、グアンインジェンに感謝します。
Authors' Addresses
Authors' Addresses
Eric Voit Cisco Systems
Eric Voit Cisco Systems
Email: evoit@cisco.com
Alexander Clemm Futurewei
アレクサンダークレムフューチャーウェイ
Email: ludwig@clemm.org
Alberto Gonzalez Prieto Microsoft
アルベルトゴンザレスプリエトマイクロソフト
Email: alberto.gonzalez@microsoft.com
Einar Nilsen-Nygaard Cisco Systems
Einar Nilsen-Nygaard Cisco Systems
Email: einarnn@cisco.com
Ambika Prasad Tripathy Cisco Systems
Ambika Prasad Tripathy Cisco Systems
Email: ambtripa@cisco.com