[要約] RFC 9144は、ネットワーク管理データストアアーキテクチャ(NMDA)のデータストアを比較し、その目的は、異なるデータストア間での一貫性と効率性を向上させることです。この文書は、ネットワーク設定、運用、監視の文脈での利用が想定されています。

Internet Engineering Task Force (IETF)                          A. Clemm
Request for Comments: 9144                                         Y. Qu
Category: Standards Track                                      Futurewei
ISSN: 2070-1721                                              J. Tantsura
                                                               Microsoft
                                                              A. Bierman
                                                               YumaWorks
                                                           December 2021
        

Comparison of Network Management Datastore Architecture (NMDA) Datastores

ネットワーク管理データストアアーキテクチャ(NMDA)データストアの比較

Abstract

概要

This document defines a Remote Procedure Call (RPC) operation to compare management datastores that comply with the Network Management Datastore Architecture (NMDA).

この文書は、ネットワーク管理データストアアーキテクチャ(NMDA)に準拠した管理データストアを比較するためのリモートプロシージャコール(RPC)操作を定義します。

Status of This Memo

本文書の位置付け

This is an Internet Standards Track document.

これはインターネット規格のトラック文書です。

This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.

この文書はインターネットエンジニアリングタスクフォース(IETF)の製品です。IETFコミュニティのコンセンサスを表します。それはパブリックレビューを受け、インターネットエンジニアリングステアリンググループ(IESG)による出版の承認を受けました。インターネット規格に関する詳細情報は、RFC 7841のセクション2で利用できます。

Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc9144.

この文書の現在のステータス、任意のエラータ、およびフィードバックを提供する方法は、https://www.rfc-editor.org/info/frfc9144で入手できます。

Copyright Notice

著作権表示

Copyright (c) 2021 IETF Trust and the persons identified as the document authors. All rights reserved.

Copyright(C)2021 IETFの信頼と文書著者として識別された人。全著作権所有。

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.

この文書は、この文書の公開日に有効なIETF文書(https://trustee.ietf.org/License-Info)に関するBCP 78およびIETF信頼の法的規定の対象となります。この文書に関してあなたの権利と制限を説明するので、これらの文書をよくレビューしてください。この文書から抽出されたコードコンポーネントには、信託法定規定のセクション4。

Table of Contents

目次

   1.  Introduction
   2.  Key Words
   3.  Data Model Overview
   4.  YANG Data Model
   5.  Example
   6.  Performance Considerations
   7.  IANA Considerations
     7.1.  Update to the IETF XML Registry
     7.2.  Update to the YANG Module Names Registry
   8.  Security Considerations
   9.  References
     9.1.  Normative References
     9.2.  Informative References
   Appendix A.  Possible Future Extensions
   Acknowledgments
   Authors' Addresses
        
1. Introduction
1. はじめに

The revised NMDA [RFC8342] introduces a set of new datastores that each hold YANG-defined data [RFC7950] and represent a different "viewpoint" on the data that is maintained by a server. New YANG datastores that are introduced include <intended>, which contains validated configuration data that a client application intends to be in effect, and <operational>, which contains operational state data (such as statistics) as well as configuration data that is actually in effect.

改訂NMDA [RFC8342]は、Yang定義データ[RFC7950]を保持し、サーバーによって維持されているデータに異なる「視点」を表す新しいデータストアのセットを紹介します。紹介された新しいYANGデータストアには、<意図した>が含まれています。これは、クライアントアプリケーションが有効になっていることを検証した構成データと、<統計情報)(統計など)と実際にある構成データを含む<操作>に含まれています。効果。

NMDA introduces, in effect, a concept of "lifecycle" for management data, distinguishing between data that is part of a configuration that was supplied by a user, configuration data that has actually been successfully applied and that is part of the operational state, and the overall operational state that includes applied configuration data as well as status and statistics.

NMDAは、管理データの「ライフサイクル」の概念を紹介し、ユーザによって供給された構成の一部であるデータを区別し、実際に適用された構成データと運用状態の一部である。適用された構成データとステータスと統計を含む全体的な運用状態。

As a result, data from the same management model can be reflected in multiple datastores. Clients need to specify the target datastore to be specific about which viewpoint of the data they want to access. For example, a client application can differentiate whether they are interested in the configuration that is supplied to a server and is supposed to be in effect or the configuration that has been applied and is actually in effect on the server.

その結果、同じ管理モデルからのデータを複数のデータストアに反映させることができます。クライアントは、アクセスしたいデータのどの視点を特定するように特定のデータストアを指定する必要があります。たとえば、クライアントアプリケーションは、サーバーに提供されている構成に関心があるかどうかを差別化することができ、実際には適用されている構成または実際にサーバーに有効になっていると想定されます。

Due to the fact that data can propagate from one datastore to another, it is possible for differences between datastores to occur. Some of this is entirely expected, as there may be a time lag between when a configuration is given to the device and reflected in <intended> until when it actually takes effect and is reflected in <operational>. However, there may be cases when a configuration item that was to be applied may not actually take effect at all or needs an unusually long time to do so. This can be the case due to certain conditions not being met, certain parts of the configuration not propagating because they are considered inactive, resource dependencies not being resolved, or even implementation errors in corner conditions.

データが1つのデータストアから別のデータストアに伝播できるという事実により、データストア間の違いが発生する可能性があります。このうちのいくつかは完全に期待されているので、構成が装置に与えられ、<意図>に反映されるまでの間の時間遅れがあるかもしれず、<操作>に反映されるまでの間の時間遅れがあるかもしれない。ただし、適用されるべき構成項目が実際には全く有効になっていない場合や、そうするのに異常に長い時間がかかる場合がある場合があります。これは、METが満たされていない状態で、構成の特定の部分が、非アクティブ、リソースの依存関係が解決されていないため、またはコーナー状態の実装エラーでさえも、構成の特定の部分が発生する可能性があります。

When the configuration that is in effect is different from the configuration that was applied, many issues can result. It becomes more difficult to operate the network properly due to limited visibility of the actual operational status, which makes it more difficult to analyze and understand what is going on in the network. Services may be negatively affected (for example, degrading or breaking a customer service), and network resources may be misallocated.

有効な構成が適用された構成と異なる場合、多くの問題が発生する可能性があります。実際の運用状況の可視性が限られているため、ネットワークを正しく操作することはより困難になり、ネットワーク内で何が起こっているのかを分析して理解することがより困難になります。サービスが悪影響を受ける可能性があります(たとえば、顧客サービスを劣化または破壊する)、ネットワークリソースが誤って割り当てられている可能性があります。

Applications can potentially analyze any differences between two datastores by retrieving the contents from both datastores and comparing them. However, in many cases, this will be both costly and extremely wasteful.

アプリケーションは、データストアの両方からコンテンツを検索してそれらを比較することによって、2つのデータストア間の違いを潜在的に分析することができます。しかし、多くの場合、これは費用がかかり、非常に無駄になります。

This document introduces a YANG data model that defines RPCs intended to be used in conjunction with NETCONF [RFC6241] or RESTCONF [RFC8040]. These RPCs allow a client to request a server to compare two NMDA datastores and report any differences.

この文書では、NetConf [RFC6241]またはRESTCONF [RFC8040]と組み合わせて使用しようとしているRPCを定義するYANGデータモデルを紹介します。これらのRPCは、クライアントがサーバーに2つのNMDAデータストアを比較し、違いを報告するように要求できます。

2. Key Words
2. キーワード

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

この文書のキーワード "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", および "OPTIONAL" はBCP 14 [RFC2119] [RFC8174]で説明されているように、すべて大文字の場合にのみ解釈されます。

3. Data Model Overview
3. データモデルの概要

The core of the solution is a new management operation, <compare>, that compares the data tree contents of two datastores. The operation checks whether there are any differences in values or in data nodes that are contained in either datastore and returns any differences as output. The output is returned in the format specified in YANG Patch [RFC8072].

ソリューションのコアは、2つのデータストアのデータツリーの内容を比較する新しい管理操作、<比較>です。この操作は、データストアに含まれる値またはデータノードに違いがあるかどうかを確認し、出力として違いを返します。出力はYang Patch [RFC8072]で指定された形式で返されます。

The YANG data model defines the <compare> operation as a new RPC. The operation takes the following input parameters:

Yangデータモデルは、<compare>演算を新しいRPCとして定義します。操作は次の入力パラメータを取ります。

source: The source identifies the datastore to serve as the reference for the comparison -- for example, <intended>.

ソース:ソースは、比較のための参照として役立つデータストアを識別します - たとえば<United>です。

target: The target identifies the datastore to compare against the source -- for example, <operational>.

ターゲット:ターゲットは、ソースと比較するデータストアを識別します - たとえば、<演算>。

filter-spec: This is a choice between different filter constructs to identify the parts of the datastore to be retrieved. It acts as a node selector that specifies which data nodes are within the scope of the comparison and which nodes are outside the scope. This allows a comparison operation to be applied only to a specific part of the datastore that is of interest, such as a particular subtree. Note that the filter does not allow expressions that match against data node values, since this may incur implementation difficulties and is not required for normal use cases.

filter-spec:検索するデータストアの部分を識別するための異なるフィルタ構築物の間の選択です。どのデータノードが比較の範囲内であり、どのノードがスコープの外側にあるかを指定するノードセレクタとして機能します。これにより、比較動作を、特定のサブツリーなどの関心のあるデータストアの特定の部分にのみ適用することができます。フィルタは、データノード値と一致する式を許可しないため、実装の問題が発生し、通常の使用例には必要ありません。

all: When set, this parameter indicates that all differences should be included, including differences pertaining to schema nodes that exist in only one of the datastores. When this parameter is not included, a prefiltering step is automatically applied to exclude data from the comparison that does not pertain to both datastores: if the same schema node is not present in both datastores, then all instances of that schema node and all its descendants are excluded from the comparison. This allows client applications to focus on the differences that constitute true mismatches of instance data without needing to specify more complex filter constructs.

すべて:設定すると、このパラメータは、1つのデータストアにのみ存在するスキーマノードに関連する違いを含めて、すべての違いを含める必要があることを示します。このパラメータが含まれていない場合は、両方のデータストアに関連しない比較からデータを除外するようにプレフィルタ処理ステップが自動的に適用されます。比較から除外されています。これにより、クライアントアプリケーションは、より複雑なフィルタ構成要素を指定する必要なしに、インスタンスデータの真の不一致を構成する違いに集中することができます。

report-origin: When set, this parameter indicates that origin metadata should be included as part of RPC output. When this parameter is omitted, origin metadata in comparisons that involve <operational> is by default omitted. Note that origin metadata only applies to <operational>; it is therefore also omitted in comparisons that do not involve <operational> regardless of whether or not the parameter is set.

Report-Origin:設定すると、このパラメータは、OriginメタデータをRPC出力の一部として含める必要があることを示します。このパラメータを省略した場合、<演算>を含む比較の原点メタデータはデフォルトでは省略されます。起点メタデータは<演算>にのみ適用されます。したがって、パラメータが設定されているかどうかにかかわらず、<演算>を含まない比較も省略されます。

The operation provides the following output parameter:

操作は次の出力パラメータを提供します。

differences: This parameter contains the list of differences. Those differences are encoded per the YANG Patch data model defined in [RFC8072]. When a datastore node in the source of the comparison is not present in the target of the comparison, this can be indicated either as a "delete" or as a "remove" in the patch as there is no differentiation between those operations for the purposes of the comparison. The YANG Patch data model is augmented to indicate the value of source datastore nodes in addition to the patch itself that would need to be applied to the source to produce the target. When the target datastore is <operational> and the input parameter "report-origin" is set, origin metadata is included as part of the patch. Including origin metadata can help explain the cause of a difference in some cases -- for example, when a data node is part of <intended> but the origin of the same data node in <operational> is reported as "system".

違い:このパラメータには違いのリストが含まれています。これらの違いは、[RFC8072]で定義されているYANGパッチデータモデルごとにエンコードされています。比較のターゲット内のデータストアノードが比較の対象に存在しない場合、これは「削除」として、またはその目的のための区別の間に差別化がないため、パッチ内の「削除」として示すことができます。比較のYANGパッチデータモデルは、ターゲットを生成するためにソースに適用される必要があるパッチ自体に加えて、ソースデータストアノードの値を示すように拡張されます。ターゲットデータストアが<Operational>と入力パラメータ "Report-Origin"が設定されている場合、原点メタデータはパッチの一部として含まれています。原点メタデータを含めることは、場合によっては違いの原因を説明するのに役立ちます。たとえば、データノードが<United>の一部であるが<演算>の同じデータノードの原点は「システム」として報告されている。

The data model is defined in the ietf-nmda-compare YANG module. Its structure is shown in the following figure. The notation syntax follows [RFC8340].

データモデルは、IETF-NMDA比較YANGモジュールで定義されています。その構造を次の図に示します。表記の構文は[RFC8340]に続きます。

   module: ietf-nmda-compare
     rpcs:
       +---x compare
          +---w input
          |  +---w source            identityref
          |  +---w target            identityref
          |  +---w all?              empty
          |  +---w report-origin?    empty
          |  +---w (filter-spec)?
          |     +--:(subtree-filter)
          |     |  +---w subtree-filter?
          |     +--:(xpath-filter)
          |        +---w xpath-filter?     yang:xpath1.0 {nc:xpath}?
          +--ro output
             +--ro (compare-response)?
                +--:(no-matches)
                |  +--ro no-matches?    empty
                +--:(differences)
                   +--ro differences
                      +--ro yang-patch
                         +--ro patch-id    string
                         +--ro comment?    string
                         +--ro edit* [edit-id]
                            +--ro edit-id         string
                            +--ro operation       enumeration
                            +--ro target          target-resource-offset
                            +--ro point?          target-resource-offset
                            +--ro where?          enumeration
                            +--ro value?
                            +--ro source-value?
        

Figure 1: Structure of ietf-nmda-compare

図1:IETF-NMDA比較の構造

4. YANG Data Model
4. Yangデータモデル

This YANG module includes references to [RFC6991], [RFC8342], [RFC8072], and [RFC6241].

このYangモジュールには、[RFC6991]、[RFC8342]、[RFC8072]、[RFC6241]への参照が含まれています。

   <CODE BEGINS> file "ietf-nmda-compare@2021-12-10.yang"
   module ietf-nmda-compare {
     yang-version 1.1;
     namespace "urn:ietf:params:xml:ns:yang:ietf-nmda-compare";
     prefix cmp;
        
     import ietf-yang-types {
       prefix yang;
       reference
         "RFC 6991: Common YANG Data Types";
     }
     import ietf-datastores {
       prefix ds;
       reference
         "RFC 8342: Network Management Datastore
          Architecture (NMDA)";
     }
     import ietf-yang-patch {
       prefix ypatch;
       reference
         "RFC 8072: YANG Patch Media Type";
     }
     import ietf-netconf {
       prefix nc;
       reference
         "RFC 6241: Network Configuration Protocol (NETCONF)";
     }
        
     organization
       "IETF NETMOD (Network Modeling) Working Group";
     contact
       "WG Web:   <https://datatracker.ietf.org/wg/netmod/>
        WG List:  <mailto:netmod@ietf.org>
        
        Author: Alexander Clemm
                <mailto:ludwig@clemm.org>
        
        Author: Yingzhen Qu
                <mailto:yqu@futurewei.com>
        
        Author: Jeff Tantsura
                <mailto:jefftant.ietf@gmail.com>
        

Author: Andy Bierman <mailto:andy@yumaworks.com>"; description "The YANG data model defines a new operation, <compare>, that can be used to compare NMDA datastores.

著者:Andy Bierman <mailto:andy@yumaworks.com> ";説明" Yangデータモデルは、NMDAデータストアを比較するために使用できる新しい操作を定義します。

Copyright (c) 2021 IETF Trust and the persons identified as authors of the code. All rights reserved.

Copyright(C)2021 IETF信頼とコードの著者として識別された人。全著作権所有。

Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info).

修正の有無にかかわらず、ソースおよびバイナリ形式での再配布と使用は、IETF信託の法定条項の第4章に記載されている改訂されたBSDライセンスに準拠しており、これに含まれるライセンス条項に従って許可されています。https://trustee.ietf.org/License-info)。

This version of this YANG module is part of RFC 9144; see the RFC itself for full legal notices.";

このYangモジュールのこのバージョンはRFC 9144の一部です。完全な法的通知のためのRFC自体を参照してください。」

     revision 2021-12-10 {
       description
         "Initial revision.";
       reference
         "RFC 9144: Comparison of Network Management Datastore
          Architecture (NMDA) Datastores";
     }
        
     /* RPC */
        
     rpc compare {
       description
         "NMDA datastore compare operation.";
       input {
         leaf source {
           type identityref {
             base ds:datastore;
           }
           mandatory true;
           description
             "The source datastore to be compared.";
         }
         leaf target {
           type identityref {
             base ds:datastore;
           }
           mandatory true;
           description
             "The target datastore to be compared.";
         }
         leaf all {
           type empty;
           description
             "When this leaf is provided, all data nodes are compared,
              whether their schema node pertains to both datastores or
              not.  When this leaf is omitted, a prefiltering step is
              automatically applied that excludes data nodes from the
              comparison that can occur in only one datastore but not
              the other.  Specifically, if one of the datastores
              (source or target) contains only configuration data and
              the other datastore is <operational>, data nodes for
              the config that is false are excluded from the
              comparison.";
         }
         leaf report-origin {
           type empty;
           description
             "When this leaf is provided, origin metadata is
              included as part of RPC output.  When this leaf is
              omitted, origin metadata in comparisons that involve
              <operational> is by default omitted.";
         }
         choice filter-spec {
           description
             "Identifies the portions of the datastores to be
                  compared.";
           anydata subtree-filter {
             description
               "This parameter identifies the portions of the
                target datastore to retrieve.";
             reference
               "RFC 6241, Section 6.";
           }
           leaf xpath-filter {
             if-feature "nc:xpath";
             type yang:xpath1.0;
             description
               "This parameter contains an XPath expression
                identifying the portions of the target
                datastore to retrieve.";
             reference
               "RFC 6991: Common YANG Data Types";
           }
         }
       }
       output {
         choice compare-response {
           description
             "Comparison results.";
           leaf no-matches {
             type empty;
             description
               "This leaf indicates that the filter did not match
                anything and nothing was compared.";
           }
           container differences {
             description
               "The list of differences, encoded per RFC 8072 with an
                augmentation to include source values where applicable.
                When a datastore node in the source is not present in
                the target, this can be indicated either as a 'delete'
                or as a 'remove' as there is no difference between
                them for the purposes of the comparison.";
             uses ypatch:yang-patch {
               augment "yang-patch/edit" {
                 description
                   "Provides the value of the source of the patch,
                    respectively of the source of the comparison, in
                    addition to the target value, where applicable.";
                 anydata source-value {
                   when "../operation = 'delete'"
                      + "or ../operation = 'merge'"
                      + "or ../operation = 'move'"
                      + "or ../operation = 'replace'"
                      + "or ../operation = 'remove'";
                   description
                     "The anydata 'value' is only used for 'delete',
                      'move', 'merge', 'replace', and 'remove'
                      operations.";
                 }
                 reference
                   "RFC 8072: YANG Patch Media Type";
               }
             }
           }
         }
       }
     }
   }
   <CODE ENDS>
        
5. Example
5. 例

The following example compares the difference between <operational> and <intended> for a subtree under "interfaces". The subtree contains a subset of objects that are defined in a YANG data model for the management of interfaces defined in [RFC8343]. For the purposes of understanding the subsequent example, the following excerpt of the data model whose instantiation is the basis of the comparison is provided:

次の例では、「インタフェース」の下のサブツリーの<演算>と<対象>の差を比較します。サブツリーには、[RFC8343]で定義されているインターフェイスの管理のためのYANGデータモデルで定義されているオブジェクトのサブセットが含まれています。その後の例を理解する目的で、インスタンス化が比較の基礎であるデータモデルの以下の抜粋が提供されています。

   container interfaces {
     description
       "Interface parameters.";
     list interface {
       key "name";
       leaf name {
         type string;
         description
           "The name of the interface.";
       }
       leaf description {
         type string;
         description
           "A textual description of the interface.";
       }
       leaf enabled {
         type boolean;
         default "true";
         description
           "This leaf contains the configured, desired state of the
            interface.";
       }
     }
   }
        

The contents of <intended> and <operational> datastores in XML [W3C.REC-xml-20081126]:

XML [W3C.REC-XML-20081126]の<意図>および<操作>データストアの内容:

   <!--INTENDED-->
   <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
     <interface>
       <name>eth0</name>
       <enabled>false</enabled>
       <description>ip interface</description>
     </interface>
   </interfaces>
        
   <!--OPERATIONAL-->
   <interfaces
       xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"
       xmlns:or="urn:ietf:params:xml:ns:yang:ietf-origin">
     <interface or:origin="or:learned">
       <name>eth0</name>
       <enabled>true</enabled>
     </interface>
   </interfaces>
        

<operational> does not contain an instance for leaf "description" that is contained in <intended>. Another leaf, "enabled", has different values in the two datastores, being "true" in <operational> and "false" in <intended>. A third leaf, "name", is the same in both cases. The origin of the leaf instances in <operational> is "learned", which may help explain the discrepancies.

<Operational>は、<United>に含まれているリーフ「説明」のインスタンスを含まない。もう1つのリーフ、「有効」は、2つのデータストア内の異なる値を持ち、<操作>で「TRUE」、<UNETED>の「FALSE」です。3番目の葉、「名前」は、どちらの場合も同じです。<Operational>のリーフインスタンスの起源は「学習」されています。これは矛盾を説明するのに役立ちます。

RPC request to compare <operational> (source of the comparison) with <intended> (target of the comparison):

RPC <PROSTIAL>(比較源)を<Unity>(比較のターゲット)を比較するように要求します。

   <rpc message-id="101"
       xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
     <compare xmlns="urn:ietf:params:xml:ns:yang:ietf-nmda-compare"
         xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
       <source>ds:operational</source>
       <target>ds:intended</target>
       <report-origin/>
       <xpath-filter
           xmlns:if="urn:ietf:params:xml:ns:yang:ietf-interfaces">
         /if:interfaces
       </xpath-filter>
     </compare>
   </rpc>
        

RPC reply when a difference is detected:

rpcの返信が検出されたときに返信

   <rpc-reply
        xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
        message-id="101">
     <differences
        xmlns="urn:ietf:params:xml:ns:yang:ietf-nmda-compare"
        xmlns:or="urn:ietf:params:xml:ns:yang:ietf-origin">
       <yang-patch>
         <patch-id>interface status</patch-id>
         <comment>
           diff between operational (source) and intended (target)
         </comment>
         <edit>
           <edit-id>1</edit-id>
           <operation>replace</operation>
           <target>/ietf-interfaces:interface=eth0/enabled</target>
           <value>
             <if:enabled>false</if:enabled>
           </value>
           <source-value>
              <if:enabled or:origin="or:learned">true</if:enabled>
           </source-value>
         </edit>
         <edit>
           <edit-id>2</edit-id>
           <operation>create</operation>
           <target>/ietf-interfaces:interface=eth0/description</target>
           <value>
             <if:description>ip interface</if:description>
           </value>
         </edit>
       </yang-patch>
     </differences>
   </rpc-reply>
        

The same request in RESTCONF (using JSON format [RFC7951]):

RESTCONFでの同じ要求(JSON形式[RFC7951]を使用):

   POST /restconf/operations/ietf-nmda-compare:compare HTTP/1.1
   Host: example.com
   Content-Type: application/yang-data+json
   Accept: application/yang-data+json
        
   { "ietf-nmda-compare:input" : {
      "source" : "ietf-datastores:operational",
      "target" : "ietf-datastores:intended",
      "report-origin" : null,
      "xpath-filter" : "/ietf-interfaces:interfaces"
      }
   }
        

The same response in RESTCONF (using JSON format):

RESTCONF(JSON形式の使用)での同じ応答

   HTTP/1.1 200 OK
   Date: Thu, 24 Jan 2019 20:56:30 GMT
   Server: example-server
   Content-Type: application/yang-data+json
        
   { "ietf-nmda-compare:output" : {
       "differences" : {
         "ietf-yang-patch:yang-patch" : {
           "patch-id" : "interface status",
           "comment" : "diff between intended (source) and operational",
           "edit" : [
             {
               "edit-id" : "1",
               "operation" : "replace",
               "target" : "/ietf-interfaces:interface=eth0/enabled",
               "value" : {
                  "ietf-interfaces:interface/enabled" : "false"
               },
               "source-value" : {
                  "ietf-interfaces:interface/enabled" : "true",
                  "@ietf-interfaces:interface/enabled" : {
                    "ietf-origin:origin" : "ietf-origin:learned"
                  }
                }
             },
             {
               "edit-id" : "2",
               "operation" : "create",
               "target" : "/ietf-interfaces:interface=eth0/description",
               "value" : {
                 "ietf-interface:interface/description" : "ip interface"
               }
             }
           ]
         }
       }
     }
   }
        
6. Performance Considerations
6. パフォーマンスに関する考慮事項

The <compare> operation can be computationally expensive. While responsible client applications are expected to use the operation responsibly and sparingly only when warranted, implementations need to be aware of the fact that excessive invocation of this operation will burden system resources and need to ensure that system performance will not be adversely impacted. One possibility for an implementation to mitigate against this is to limit the number of requests that are served to a client, or to any number of clients, in any one time interval, by rejecting requests made at a higher frequency than the implementation can reasonably sustain.

<compare>操作は計算的に高価になることができます。責任あるクライアントアプリケーションは、保証されたときにのみ担当の操作を使用することが期待されていますが、この操作の過度の呼び出しがシステムリソースに負担をかけ、システム性能が悪影響を受けないようにする必要があるという事実を認識する必要があります。これに対して軽減するための実装が軽減される可能性は、クライアントにサービスを提供する要求の数を制限することです。。

While useful, tools such as YANG data models that allow for the monitoring of server resources, system performance, and statistics about RPCs and RPC rates are outside the scope of this document. When defined, any such model should be general in nature and not limited to the RPC operation defined in this document.

便利ながら、サーバーリソースの監視、システムパフォーマンス、およびRPCとRPCレートの統計を監視することを可能にするYANGデータモデルなどのツールは、この文書の範囲外です。定義されている場合、そのようなモデルは本質的に一般的であり、この文書で定義されているRPC操作に限定されません。

7. IANA Considerations
7. IANAの考慮事項
7.1. Update to the IETF XML Registry
7.1. IETF XMLレジストリに更新されます

IANA has registered the following URI in the "IETF XML Registry" [RFC3688]:

IANAは「IETF XMLレジストリ」で次のURIを登録しました[RFC3688]

URI: urn:ietf:params:xml:ns:yang:ietf-nmda-compare Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace.

URI:URN:IETF:PARAMS:XML:NS:YANG:IETF-NMDA比較登録者連絡先:IESG。XML:n / a;要求されたURIはXMLネームスペースです。

7.2. Update to the YANG Module Names Registry
7.2. YANGモジュール名レジストリに更新します

IANA has registered the following YANG module in the "YANG Module Names" registry [RFC6020]:

IANAは、「ヤンモジュール名」レジストリに次のYangモジュールを登録しています[RFC6020]:

   name:  ietf-nmda-compare
   namespace:  urn:ietf:params:xml:ns:yang:ietf-nmda-compare
   prefix:  cmp
   reference:  RFC 9144
        
8. Security Considerations
8. セキュリティに関する考慮事項

The YANG module specified in this document defines a schema for data that is designed to be accessed via network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446].

このドキュメントで指定されているYANGモジュールは、NetConf [RFC6241]またはRESTCONF [RFC8040]などのネットワーク管理プロトコルを介してアクセスするように設計されているデータのスキーマを定義しています。最低のNETCONFレイヤーはセキュアトランスポート層であり、必須のセキュアトランスポートはSecure Shell(SSH)[RFC6242]です。最低のRETCONFレイヤーはhttpsで、必須のセキュアトランスポートはTLS [RFC8446]です。

The Network Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.

ネットワーク構成アクセス制御モデル(NACM)[RFC8341]は、特定のNETCONFまたはRESTCONFユーザへのアクセスを利用可能なすべてのNetConfまたはRESTCONFプロトコル操作およびコンテンツの事前設定されたサブセットに制限する手段を提供します。

NACM specifies access for the server in its entirety, and the same access rules apply to all datastores. Any subtrees to which a requestor does not have read access are silently skipped and not included in the comparison.

NACMはその全体がその全体のアクセスを指定し、同じアクセス規則がすべてのデータストアに適用されます。リクエスタが読み取りアクセス権がないサブツリーは静かにスキップされ、比較に含まれていません。

The RPC operation defined in this YANG module, <compare>, may be considered sensitive or vulnerable in some network environments. It is thus important to control access to this operation. This is the sensitivity/vulnerability of RPC operation <compare>:

このYANGモジュールで定義されているRPC動作は、<Compare>がいくつかのネットワーク環境では敏感または脆弱と見なすことができます。したがって、この操作へのアクセスを制御することが重要です。これはRPC操作の感度/脆弱性です。

Comparing datastores for differences requires a certain amount of processing resources at the server. An attacker could attempt to attack a server by making a high volume of comparison requests. Server implementations can guard against such scenarios in several ways. For one, they can implement the NACM in order to require proper authorization for requests to be made. Second, server implementations can limit the number of requests that they serve to a client in any one time interval, rejecting requests made at a higher frequency than the implementation can reasonably sustain.

違いについてデータストアを比較するには、サーバーで一定量の処理リソースが必要です。攻撃者は、大量の比較要求をすることによってサーバーを攻撃しようとする可能性があります。サーバーの実装は、いくつかの方法でそのようなシナリオを防ぐことができます。1つは、要求を行うために適切な承認を必要とするためにNACMを実装することができます。第2に、サーバ実装は、それらが任意の1回の間隔でそれらがクライアントに役立つ要求の数を制限することができ、実装よりも高い頻度で行われた拒否要求は合理的に維持することができる。

9. References
9. 参考文献
9.1. Normative References
9.1. 引用文献

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>.

[RFC2119] BRADNER、S、「RFCで使用するためのキーワード」、BCP 14、RFC 2119、DOI 10.17487 / RFC2119、1997年3月、<https://www.rfc-editor.org/info/RFC2119>。

[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, <https://www.rfc-editor.org/info/rfc3688>.

[RFC3688] Mealling、M.、 "IETF XML Registry"、BCP 81、RFC 3688、DOI 10.17487 / RFC3688、2004年1月、<https://www.rfc-editor.org/info/rfc3688>。

[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, <https://www.rfc-editor.org/info/rfc6020>.

[RFC6020] Bjorklund、M.、Ed。、 "Yang - ネットワーク構成プロトコルのデータモデリング言語(NetConf)"、RFC 6020、DOI 10.17487 / RFC6020、2010年10月、<https://www.rfc-編集者。org / info / rfc6020>。

[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, <https://www.rfc-editor.org/info/rfc6241>.

[RFC6241] ENNS、R.、ED。、Bjorklund、M.、Ed。、Schoenwaelder、J.、Ed。、およびA. Bierman、ED。、「ネットワーク構成プロトコル(NetConf)」、RFC 6241、DOI 10.17487 /RFC6241、2011年6月、<https://www.rfc-editor.org/info/rfc6241>。

[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, <https://www.rfc-editor.org/info/rfc6242>.

[RFC6242] Wasserman、M.、「Secure Shell(SSH)を介したNetConfプロトコルの使用」、RFC 6242、DOI 10.17487 / RFC6242、2011年6月、<https://www.rfc-editor.org/info/rfc6242>。

[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。、「共通ヤンデータ型」、RFC 6991、DOI 10.17487 / RFC6991、2013年7月、<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.、Ed。、「Yang 1.1データモデリング言語」、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>。

[RFC8072] Bierman, A., Bjorklund, M., and K. Watsen, "YANG Patch Media Type", RFC 8072, DOI 10.17487/RFC8072, February 2017, <https://www.rfc-editor.org/info/rfc8072>.

[RFC8072] Bierman、A.、Bjorklund、M.、K。Watsen、「Yang Patch Media Type」、RFC 8072、DOI 10.17487 / RFC8072、2017年2月、<https://www.rfc-editor.org/info/ RFC8072>。

[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>。

[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, <https://www.rfc-editor.org/info/rfc8340>.

[RFC8340] Bjorklund、M.およびL. Berger、Ed。、「Yang Tree Diagress」、BCP 215、RFC 8340、DOI 10.17487 / RFC8340、2018年3月、<https://www.rfc-editor.org/info/RFC8340>。

[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, <https://www.rfc-editor.org/info/rfc8341>.

[RFC8341] Bierman、A.およびM.Bjorklund、「ネットワーク構成アクセス制御モデル」、STD 91、RFC 8341、DOI 10.17487 / RFC8341、2018年3月、<https://www.rfc-editor.org/info/rfc8341>。

[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, <https://www.rfc-editor.org/info/rfc8342>.

[RFC8342] Bjorklund、M.、Schoenwaelder、J.、Shafer、P.、Watsen、K.、およびR.Wilton、「ネットワーク管理データストアアーキテクチャ(NMDA)」、RFC 8342、DOI 10.17487 / RFC8342、2018年3月、<https://www.rfc-editor.org/info/rfc8342>。

[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, <https://www.rfc-editor.org/info/rfc8446>.

[RFC8446] RESCORLA、E。、「トランスポート層セキュリティ(TLS)プロトコルバージョン1.3」、RFC 8446、DOI 10.17487 / RFC8446、<https://www.rfc-editor.org/info/rfc8446>。

[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.、およびF. Yergeau、「Extensible Markup Language(XML)1.0(第5版)」World Wide Web Consortium勧告Rec-XML-20081126、2008年11月、<https://www.w3.org/tr/2008/Rec-xml-20081126>。

9.2. Informative References
9.2. 参考引用

[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.、「インタフェース管理のためのヤンデータモデル」、RFC 8343、DOI 10.17487 / RFC8343、2018年3月、<https://www.rfc-editor.org/info/rfc8343>。

Appendix A. Possible Future Extensions
付録A.可能な将来の拡張機能

It is conceivable to extend the <compare> operation with a number of possible additional features in the future.

将来的には、<比較>操作を多くの可能な追加の機能で拡張することが考えられます。

Specifically, it is possible to define an extension with an optional feature for dampening. This will allow clients to specify a minimum time period for which a difference must persist for it to be reported. This will enable clients to distinguish between differences that are only fleeting from ones that are not and that may represent a real operational issue and inconsistency within the device.

具体的には、減衰のための任意の機能を備えた拡張を定義することが可能である。これにより、クライアントは、違いが報告されるために持続しなければならない最小期間を指定することができます。これにより、クライアントは、そうでないものからのみの違いを区別することができ、それがデバイス内の実際の運用上の問題と矛盾を表す可能性がある。

For this purpose, an additional input parameter can be added to specify the dampening period. Only differences that pertain for at least the dampening time are reported. A value of 0 or omission of the parameter indicates no dampening. Reporting of differences MAY correspondingly be delayed by the dampening period from the time the request is received.

この目的のために、減衰期間を指定するために追加の入力パラメータを追加することができます。少なくとも減衰時間に関連する違いのみが報告されています。パラメータが0または省略された値は減衰しないことを示す。差異の報告は、要求が受信された時から減衰期間によってそれに対応して遅延され得る。

To implement this feature, a server implementation might run a comparison when the RPC is first invoked and temporarily store the result. Subsequently, it could wait until after the end of the dampening period to check whether the same differences are still observed. The differences that still persist are then returned.

この機能を実装するには、RPCが最初に呼び出されて結果を一時的に保存すると、サーバーの実装が比較を実行する可能性があります。続いて、湿し止め期間の終了後まで待つことができ、同じ差がまだ観察されているかどうかを確認することができます。その後、まだ持続した違いが返されます。

Acknowledgments

謝辞

We thank Rob Wilton, Martin Bjorklund, Mahesh Jethanandani, Lou Berger, Kent Watsen, Phil Shafer, Ladislav Lhotka, Tim Carey, and Reshad Rahman for their valuable feedback and suggestions.

Rob Wilton、Martin Bjorklund、Mahesh Jethanandani、Lou Berger、Kent Watsen、Phil Shafer、Ladislav Lhotka、Tim Carey、Reshad Rahman、貴重なフィードバックと提案をお願いします。

Authors' Addresses

著者の住所

Alexander Clemm Futurewei 2330 Central Expressway Santa Clara, CA 95050 United States of America

Alexander Clemm FutureWei 2330 Central Expresswayサンタクララ、CA 95050アメリカ合衆国

   Email: ludwig@clemm.org
        

Yingzhen Qu Futurewei 2330 Central Expressway Santa Clara, CA 95050 United States of America

Yingzhen Queutterwei 2330 Central Expresswayサンタクララ、CA 95050アメリカ合衆国

   Email: yqu@futurewei.com
        

Jeff Tantsura Microsoft

Jeff Tantsura Microsoft.

   Email: jefftant.ietf@gmail.com
        

Andy Bierman YumaWorks

Andy Bierman Yumaworks

   Email: andy@yumaworks.com