[要約] RFC 6243は、NETCONFプロトコルにおけるデフォルト設定の機能を定義しています。このRFCの目的は、クライアントがデフォルト設定を取得し、変更するための機能を提供することです。
Internet Engineering Task Force (IETF) A. Bierman
Request for Comments: 6243 Brocade
Category: Standards Track B. Lengyel
ISSN: 2070-1721 Ericsson
June 2011
With-defaults Capability for NETCONF
NetConfのデフォルト機能付き
Abstract
概要
The Network Configuration Protocol (NETCONF) defines ways to read and edit configuration data from a NETCONF server. In some cases, part of this data may not be set by the NETCONF client, but rather a default value known to the server is used instead. In many situations the NETCONF client has a priori knowledge about default data, so the NETCONF server does not need to save it in a NETCONF configuration datastore or send it to the client in a retrieval operation reply. In other situations the NETCONF client will need this data from the server. Not all server implementations treat this default data the same way. This document defines a capability-based extension to the NETCONF protocol that allows the NETCONF client to identify how defaults are processed by the server, and also defines new mechanisms for client control of server processing of default data.
ネットワーク構成プロトコル（NetConf）は、NetConfサーバーから構成データを読み取り、編集する方法を定義します。場合によっては、このデータの一部はNetConfクライアントによって設定されるのではなく、代わりにサーバーに知られているデフォルト値が使用されます。多くの状況では、NetConfクライアントはデフォルトデータに関する先験的な知識を持っているため、NetConfサーバーはNetConf構成データストアに保存したり、検索操作の返信でクライアントに送信したりする必要はありません。他の状況では、NetConfクライアントはサーバーからこのデータが必要になります。すべてのサーバーの実装がこのデフォルトデータを同じように扱うわけではありません。このドキュメントでは、NetConfクライアントがデフォルトの処理方法を識別できるようにするNetConfプロトコルへの機能ベースの拡張機能を定義し、デフォルトデータのサーバー処理のクライアント制御のための新しいメカニズムを定義します。
Status of This Memo
本文書の位置付け
This is an Internet Standards Track document.
これは、インターネット標準トラックドキュメントです。
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 5741.
このドキュメントは、インターネットエンジニアリングタスクフォース（IETF）の製品です。IETFコミュニティのコンセンサスを表しています。公開レビューを受けており、インターネットエンジニアリングステアリンググループ（IESG）からの出版が承認されています。インターネット標準の詳細については、RFC 5741のセクション2で入手できます。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc6243.
このドキュメントの現在のステータス、任意のERRATA、およびそのフィードバックを提供する方法に関する情報は、http：//www.rfc-editor.org/info/rfc6243で取得できます。
Copyright Notice
著作権表示
Copyright (c) 2011 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright（c）2011 IETF Trustおよび文書著者として特定された人。全著作権所有。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
このドキュメントは、BCP 78およびIETFドキュメント（http://trustee.ietf.org/license-info）に関連するIETF Trustの法的規定の対象となります。この文書に関するあなたの権利と制限を説明するので、これらの文書を注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、セクション4.Eで説明されている法的規定のセクション4.Eで説明されており、単純化されたBSDライセンスで説明されているように保証なしで提供される簡略化されたBSDライセンステキストを含める必要があります。
Table of Contents
目次
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Default-Handling Behavior . . . . . . . . . . . . . . . . 5
1.3. Client Controlled Retrieval of Default Data . . . . . . . 5
2. Default-Handling Basic Modes . . . . . . . . . . . . . . . . . 6
2.1. 'report-all' Basic Mode . . . . . . . . . . . . . . . . . 6
2.1.1. 'report-all' Basic Mode Retrieval . . . . . . . . . . 6
2.1.2. 'report-all' <with-defaults> Retrieval . . . . . . . . 6
2.1.3. 'report-all' <edit-config> and <copy-config>
Behavior . . . . . . . . . . . . . . . . . . . . . . . 6
2.2. 'trim' Basic Mode . . . . . . . . . . . . . . . . . . . . 7
2.2.1. 'trim' Basic Mode Retrieval . . . . . . . . . . . . . 7
2.2.2. 'trim' <with-defaults> Retrieval . . . . . . . . . . . 7
2.2.3. 'trim' <edit-config> and <copy-config> Behavior . . . 7
2.3. 'explicit' Basic Mode . . . . . . . . . . . . . . . . . . 8
2.3.1. 'explicit' Basic Mode Retrieval . . . . . . . . . . . 8
2.3.2. 'explicit' <with-defaults> Retrieval . . . . . . . . . 8
2.3.3. 'explicit' <edit-config> and <copy-config> Behavior . 8
3. Retrieval of Default Data . . . . . . . . . . . . . . . . . . 9
3.1. 'report-all' Retrieval Mode . . . . . . . . . . . . . . . 9
3.2. 'trim' Retrieval Mode . . . . . . . . . . . . . . . . . . 9
3.3. 'explicit' Retrieval Mode . . . . . . . . . . . . . . . . 9
3.4. 'report-all-tagged' Retrieval Mode . . . . . . . . . . . . 9
4. With-defaults Capability . . . . . . . . . . . . . . . . . . . 10
4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.2. Dependencies . . . . . . . . . . . . . . . . . . . . . . . 10
4.3. Capability Identifier . . . . . . . . . . . . . . . . . . 10
4.4. New Operations . . . . . . . . . . . . . . . . . . . . . . 11
4.5. Modifications to Existing Operations . . . . . . . . . . . 11
4.5.1. <get>, <get-config>, and <copy-config> Operations . . 11
4.5.2. <edit-config> Operation . . . . . . . . . . . . . . . 12
4.5.3. Other Operations . . . . . . . . . . . . . . . . . . . 13
4.6. Interactions with Other Capabilities . . . . . . . . . . . 13
5. YANG Module for the <with-defaults> Parameter . . . . . . . . 13
6. XSD for the 'default' Attribute . . . . . . . . . . . . . . . 17
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18
8. Security Considerations . . . . . . . . . . . . . . . . . . . 18
9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 19
10. Normative References . . . . . . . . . . . . . . . . . . . . . 19
Appendix A. Usage Examples . . . . . . . . . . . . . . . . . . . 20
A.1. Example YANG Module . . . . . . . . . . . . . . . . . . . 20
A.2. Example Data Set . . . . . . . . . . . . . . . . . . . . . 21
A.3. Protocol Operation Examples . . . . . . . . . . . . . . . 22
A.3.1. <with-defaults> = 'report-all' . . . . . . . . . . . . 22
A.3.2. <with-defaults> = 'report-all-tagged' . . . . . . . . 23
A.3.3. <with-defaults> = 'trim' . . . . . . . . . . . . . . . 24
A.3.4. <with-defaults> = 'explicit' . . . . . . . . . . . . . 25
The NETCONF protocol [RFC6241] defines ways to read configuration and state data from a NETCONF server. Part of the configuration data may not be set by the NETCONF client, but rather by a default value from the data model. In many situations the NETCONF client has a priori knowledge about default data, so the NETCONF server does not need to send it to the client. A priori knowledge can be obtained, e.g., from a document formally describing the data models supported by the NETCONF server.
NetConfプロトコル[RFC6241]は、NetConfサーバーから構成と状態データを読み取る方法を定義します。構成データの一部は、NetConfクライアントによってはなく、データモデルのデフォルト値によって設定される場合があります。多くの状況では、NetConfクライアントにはデフォルトデータに関する先験的な知識があるため、NetConfサーバーはクライアントに送信する必要はありません。たとえば、NetConfサーバーによってサポートされているデータモデルを正式に説明するドキュメントから、先験的な知識を取得できます。
It can be important for a client to know exactly how a server implementation will handle default data. There are subtle differences in some protocol operations where the default-handling behavior of the server will affect the outcome of the operation.
クライアントがサーバーの実装がデフォルトデータをどのように処理するかを正確に知ることが重要です。一部のプロトコル操作には、サーバーのデフォルトの処理動作が操作の結果に影響する微妙な違いがあります。
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
「必須」、「そうしない」、「必須」、「必要」、「しない」、「そうしない」、「そうではない」、「そうでない」、「推奨」、「5月」、および「オプション」は、[RFC2119]に記載されているように解釈される。
Data model schema: A document or set of documents describing the data models supported by the NETCONF server.
データモデルスキーマ：NetConfサーバーによってサポートされているデータモデルを説明するドキュメントまたはドキュメントのセット。
Management application: A computer program running outside the NETCONF server that configures or supervises the NETCONF server. A management application can reach the device, e.g., via NETCONF, command line interface (CLI), or the Simple Network Management Protocol (SNMP).
管理アプリケーション：NetConfサーバーを構成または監督するNetConfサーバーの外で実行されるコンピュータープログラム。管理アプリケーションは、たとえば、NetConf、コマンドラインインターフェイス（CLI）、または単純なネットワーク管理プロトコル（SNMP）を介してデバイスに到達できます。
Schema default data: Data specified in the data model schema as default, that is, set or used by the device whenever the NETCONF client or other management application/user does not provide a specific value for the relevant data node. Schema default data may or may not be stored as part of a configuration datastore, depending on the basic mode used by a particular server.
スキーマデフォルトデータ：データモデルスキーマでデフォルトとして指定されたデータ、つまり、NetConfクライアントまたはその他の管理アプリケーション/ユーザーが関連するデータノードに特定の値を提供しない場合は、デバイスによって設定または使用されます。スキーマのデフォルトデータは、特定のサーバーで使用される基本モードに応じて、構成データストアの一部として保存される場合とできない場合があります。
Default data: Conceptual data containing a default value. Default data is not kept in a datastore. Not all servers use the same criteria to decide if a data node is actually instantiated in a datastore. If a data node is not present in a datastore, and a schema default definition is in use by the server instead, then it is considered to be a default data node.
デフォルトデータ：デフォルト値を含む概念データ。デフォルトデータはデータストアに保持されません。すべてのサーバーが同じ基準を使用して、データノードが実際にデータストアにインスタンス化されているかどうかを決定するわけではありません。データストアにデータノードが存在しない場合、代わりにサーバーがスキーマデフォルトの定義が使用されている場合、デフォルトのデータノードと見なされます。
Default value: A default value is a value for a data node instance that is conceptually in use by the server, when the data node instance does not exist.
デフォルト値：デフォルト値は、データノードインスタンスが存在しない場合、サーバーが概念的に使用しているデータノードインスタンスの値です。
Explicitly set data: Data that is set to any value by a NETCONF client or other management application by the way of an explicit management operation, including any data model schema default value. Any value set by the NETCONF server that is not the schema defined default value is also considered explicitly set data.
明示的に設定されたデータ：データモデルスキーマのデフォルト値を含む明示的な管理操作により、NetConfクライアントまたはその他の管理アプリケーションによって任意の価値に設定されたデータ。スキーマではないNetConfサーバーによって設定された任意の値は、定義されたデフォルト値も明示的に設定されたデータと見なされます。
<with-defaults> retrieval: Refers to a protocol operation that includes the <with-default> parameter to control the handling of default data.
<With-Defaults>取得：デフォルトデータの処理を制御するための<with-default>パラメーターを含むプロトコル操作を指します。
:with-defaults: The shorthand notation for the with-defaults capability identifier.
：with-defaults：with-defaults機能識別子の速記表記。
The following terms are defined in [RFC6241]:
次の用語は[RFC6241]で定義されています。
o client
o クライアント
o datastore
o データストア
o operation
o 手術
o server
o サーバ
The following term is defined in [RFC6020]:
次の用語は[RFC6020]で定義されています。
o data node
o データノード
The default-handling behavior used by a server will impact NETCONF protocol operations in two ways:
サーバーが使用するデフォルトの処理動作は、2つの方法でNetConfプロトコル操作に影響を与えます。
1. Data retrieval: A server is normally allowed to exclude data nodes that it considers to contain the default value. The actual nodes omitted depend on the default-handling behavior used by the server.
1. データ取得：サーバーは通常、デフォルト値を含むと考えるデータノードを除外することが許可されています。省略された実際のノードは、サーバーが使用するデフォルトの処理動作によって異なります。
2. Create and delete operations: The <edit-config> 'operation' attribute can be used to create and/or delete specific data nodes. These operations depend on whether or not the target node currently exists. The server's default-handling behavior will determine whether or not the requested node currently exists in the configuration datastore.
2. 操作の作成と削除：<edit-config>「操作」属性を使用して、特定のデータノードを作成および/または削除できます。これらの操作は、ターゲットノードが現在存在するかどうかに依存します。サーバーのデフォルトの処理動作により、要求されたノードが現在構成データストアに存在するかどうかが判断されます。
A networking device may have a large number of default values. Often the default values are specifically defined with a reasonable value, documented and well-known, so that the management user does not need to handle them. For these reasons, it is quite common for networking devices to suppress the output of parameters having the default value.
ネットワークデバイスには、多数のデフォルト値がある場合があります。多くの場合、デフォルト値は、管理ユーザーがそれらを処理する必要がないように、文書化された、妥当な値で特別に定義されています。これらの理由から、ネットワークデバイスがデフォルト値を持つパラメーターの出力を抑制することは非常に一般的です。
However, there are use-cases when a NETCONF client will need the default data from the server:
ただし、NetConfクライアントがサーバーからデフォルトデータを必要とする場合、ユースケースがあります。
o The management application often needs a single, definitive, and complete set of configuration values that determine how the networking device works.
o 多くの場合、管理アプリケーションには、ネットワークデバイスの仕組みを決定する単一の決定的な完全な構成値セットが必要です。
o Documentation about default values can be unreliable or unavailable.
o デフォルト値に関するドキュメントは、信頼できないか、利用できない場合があります。
o Some management applications might not have the capabilities to correctly parse and interpret formal data models.
o 一部の管理アプリケーションには、正式なデータモデルを正しく解析および解釈する機能がない場合があります。
o Human users might want to understand the received data without consultation of the documentation.
o 人間のユーザーは、ドキュメントを相談せずに受信したデータを理解したい場合があります。
In all these cases, the NETCONF client will need a mechanism to retrieve default data from a NETCONF server.
これらすべての場合、NetConfクライアントは、NetConfサーバーからデフォルトデータを取得するメカニズムが必要です。
This document defines a NETCONF protocol capability to identify the server's default-handling behavior, an XML [W3C.REC-xmlschema-0-20041028] attribute to identify default data, and a YANG module extension to the NETCONF protocol that allows the NETCONF client to control whether default data is returned by the server.
このドキュメントでは、サーバーのデフォルト処理動作を識別するNetConfプロトコル機能、XML [W3C.REC-XMLSCHEMA-0-20041028]属性を識別するためのデフォルトデータ、およびNetConfクライアントがNetConfクライアントを可能にするNetConfプロトコルのYangモジュール拡張機能を定義しています。デフォルトデータがサーバーによって返されるかどうかを制御します。
Not all server implementations treat default data in the same way. Instead of forcing a single implementation strategy, this document allows a server to advertise a particular style of default-handling, and the client can adjust accordingly. Client implementations are expected to be powerful enough to support all three of the server basic default-handling modes.
すべてのサーバーの実装がデフォルトデータを同じように扱うわけではありません。このドキュメントにより、単一の実装戦略を強制する代わりに、サーバーが特定のスタイルのデフォルト処理を宣伝することができ、クライアントはそれに応じて調整できます。クライアントの実装は、3つのサーバーの基本的なデフォルト処理モードすべてをサポートするのに十分な強力であると予想されます。
NETCONF servers report default data in different ways. This document specifies three standard default-handling basic modes that a server implementer may choose from:
NetConfサーバーは、デフォルトデータをさまざまな方法で報告します。このドキュメントは、サーバー実装者が選択できる3つの標準デフォルトハンドリング基本モードを指定します。
o report-all
o レポート - すべて
o trim
o トリム
o explicit
o 明示的
A server MUST select one of the three basic modes defined in this section for handling default data.
サーバーは、デフォルトデータを処理するために、このセクションで定義されている3つの基本モードのいずれかを選択する必要があります。
A server that uses the 'report-all' basic mode does not consider any data node to be default data, even schema default data.
「レポートALL」基本モードを使用するサーバーでは、データノードはデフォルトデータであるとは見なさず、デフォルトデータもスキーマです。
When data is retrieved from a server using the 'report-all' basic mode, and the <with-defaults> parameter is not present, all data nodes MUST be reported.
「レポートすべて」の基本モードを使用してサーバーからデータが取得され、<with-defaults>パラメーターが存在しない場合、すべてのデータノードを報告する必要があります。
If the 'report-all' basic mode is used by the server, then the server MUST support the <with-defaults> parameter with a value equal to 'report-all', as specified in Section 3.1.
「レポート」基本モードがサーバーによって使用されている場合、セクション3.1で指定されているように、サーバーは「レポートオール」に等しい値で<with-defaults>パラメーターをサポートする必要があります。
The server MUST consider every data node to exist, even those containing a schema default value. A valid 'create' operation attribute for a data node that contains its schema default value MUST fail with a 'data-exists' error-tag. A valid 'delete' operation attribute for a data node that contains its schema default value MUST succeed, even though the data node is immediately replaced by the server with the default value.
サーバーは、スキーマデフォルト値を含むものでも、すべてのデータノードが存在することを考慮する必要があります。スキーマのデフォルト値を含むデータノードの有効な「作成」操作属性は、「data-exists」エラータグで失敗する必要があります。データノードがデフォルト値でサーバーにすぐに置き換えられる場合でも、スキーマデフォルト値を含むデータノードの有効な「削除」操作属性は成功する必要があります。
A server that uses the 'report-all' basic mode has no concept of a default node, so the 'report-all-tagged' <with-defaults> retrieval mode is not relevant. There will never be any tagged nodes, since there are no nodes that are omitted in a basic-mode retrieval operation. If the 'default' attribute is present in any configuration data, the server MUST return an <rpc-error> response with an 'unknown-attribute' error-tag.
「レポートすべて」基本モードを使用するサーバーには、デフォルトノードの概念がないため、「レポート」<with-defaults>取得モードは関連しません。基本モード検索操作で省略されているノードがないため、タグ付きノードはありません。「デフォルト」属性が任意の構成データに存在する場合、サーバーは「未知のアトリブ」エラータグで<RPC-Error>応答を返す必要があります。
A server that uses the 'trim' basic mode MUST consider any data node set to its schema default value to be default data.
「TRIM」基本モードを使用するサーバーは、スキーマデフォルト値に設定されたデータノードをデフォルトデータにする必要があります。
When data is retrieved from a server using the 'trim' basic mode, and the <with-defaults> parameter is not present, data nodes MUST NOT be reported if they contain the schema default value. Non-configuration data nodes containing the schema default value MUST NOT be reported.
「トリム」基本モードを使用してサーバーからデータが取得され、<with-defaults>パラメーターが存在しない場合、スキーマデフォルト値が含まれている場合、データノードを報告しないでください。スキーマのデフォルト値を含む非構成データノードを報告する必要はありません。
If the 'trim' basic mode is used by the server, then the server MUST support the <with-defaults> parameter with a value equal to 'trim', as specified in Section 3.2.
「トリム」基本モードがサーバーによって使用される場合、サーバーはセクション3.2で指定されているように、「トリム」に等しい値で<with-defaults>パラメーターをサポートする必要があります。
The server MUST consider any data node that does not contain its schema default value to exist. A valid 'create' operation attribute for a data node that has a schema default value defined MUST succeed. A valid 'delete' operation attribute for a missing data node that has a schema default value MUST fail. The server MUST return an <rpc-error> response with a 'data-missing' error-tag.
サーバーは、存在するスキーマデフォルト値を含まないデータノードを考慮する必要があります。スキーマデフォルト値が定義されているデータノードの有効な「作成」操作属性は、成功する必要があります。スキーマのデフォルト値を持つ欠損データノードの有効な「削除」操作属性が失敗する必要があります。サーバーは、「データミッシング」エラータグで<RPC-Error>応答を返す必要があります。
If a client sets a data node to its schema default value, using any valid operation, it MUST succeed, although the data node MUST NOT be saved in the NETCONF configuration datastore. This has the same effect as removing the data node and treating it as default data.
クライアントがデータノードをスキーマデフォルト値に設定して有効な操作を使用して設定した場合、成功する必要がありますが、データノードはNetConf Configuration DataStoreに保存する必要はありません。これは、データノードを削除してデフォルトデータとして扱うのと同じ効果があります。
If the server supports the 'report-all-tagged' value for the <with-defaults> parameter, then the 'default' attribute MUST be accepted in configuration input, as described in Section 4.5.1 and Section 4.5.2.
サーバーが<with-defaults>パラメーターの「レポート」値をサポートする場合、セクション4.5.1およびセクション4.5.2で説明されているように、「デフォルト」属性を構成入力で受け入れる必要があります。
A server that uses the 'explicit' basic mode MUST consider any data node that is not explicitly set data to be default data.
「明示的な」基本モードを使用するサーバーは、明示的にデータをデフォルトデータに設定していないデータノードを考慮する必要があります。
When data is retrieved from a server using the 'explicit' basic mode, and the <with-defaults> parameter is not present, data nodes MUST be reported if explicitly set by the client, even if they contain the schema default value. Non-configuration data nodes containing the schema default value MUST be reported.
「明示的な」基本モードを使用してサーバーからデータが取得され、<with-defaults>パラメーターが存在しない場合、スキーマのデフォルト値が含まれていても、クライアントによって明示的に設定されている場合はデータノードを報告する必要があります。スキーマのデフォルト値を含む非構成データノードを報告する必要があります。
If the 'explicit' basic mode is used by the server, the server MUST support the <with-defaults> parameter with a value equal to 'explicit', as specified in Section 3.3.
「明示的な」基本モードがサーバーによって使用される場合、サーバーはセクション3.3で指定されているように、「明示的」に等しい値で<with-defaults>パラメーターをサポートする必要があります。
The server considers any data node that is explicitly set data to exist. A valid 'create' operation attribute for a data node that has been set by a client to its schema default value MUST fail with a 'data-exists' error-tag. A valid 'create' operation attribute for a data node that has been set by the server to its schema default value MUST succeed. A valid 'delete' operation attribute for a data node that has been set by a client to its schema default value MUST succeed. A valid 'delete' operation attribute for a data node that has been set by the server to its schema default value MUST fail with a 'data-missing' error-tag.
サーバーは、データを明示的に設定したデータノードを明示的に設定していると考慮します。クライアントがスキーマに設定したデータノードの有効な「作成」操作属性は、「data-exists」エラータグで失敗する必要があります。サーバーによってスキーマに設定されたデータノードの有効な「作成」操作属性は、デフォルト値を成功させる必要があります。クライアントがスキーマのデフォルト値に設定したデータノードの有効な「削除」操作属性は、成功する必要があります。サーバーによってスキーマに設定されたデータノードの有効な「削除」操作属性は、「データミッシング」エラータグで失敗する必要があります。
If the server supports the 'report-all-tagged' retrieval mode in its :with-defaults capability, then the 'default' attribute MUST be accepted in configuration input. If all NETCONF <edit-config> or <copy-config> parameters are valid, then the server will treat a tagged data node (i.e., the 'default' attribute set to 'true' or '1') as a request to return that node to default data. If this request is valid within the context of the requested NETCONF operation, then the data node is removed and returned to its default value. The data node within the NETCONF message MUST contain a value in this case, which MUST be equal to the schema default value. If not, the server MUST return an <rpc-error> response with an 'invalid-value' error-tag.
サーバーが次の「レポート - タグ付き」検索モードをサポートする場合、Defaults機能を使用すると、「デフォルト」属性を構成入力で受け入れる必要があります。すべてのnetconf <edit-config>または<copy-config>パラメーターが有効な場合、サーバーはタグ付きデータノード（つまり、「デフォルト」属性が「true」または「1」に設定されています）を扱います。そのノードからデフォルトデータ。この要求が要求されたNetConf操作のコンテキスト内で有効な場合、データノードが削除され、デフォルト値に返されます。NetConfメッセージ内のデータノードには、この場合に値が含まれている必要があります。これは、スキーマのデフォルト値に等しくなければなりません。そうでない場合、サーバーは「無効な価値」エラータグで<RPC-Error>応答を返す必要があります。
This document defines a new parameter, called <with-defaults>, which can be added to specific NETCONF operation request messages to control how retrieval of default data is treated by the server.
このドキュメントでは、<with-defaults>と呼ばれる新しいパラメーターを定義します。これは、特定のNetConf操作要求メッセージに追加でき、デフォルトデータの取得がサーバーによってどのように扱われるかを制御できます。
A server that implements this specification MUST accept the <with-defaults> parameter containing the enumeration for any of the default-handling modes it supports. The <with-defaults> parameter contains one of the four enumerations defined in this section.
この仕様を実装するサーバーは、サポートするデフォルトの処理モードの列挙を含む<with-defaults>パラメーターを受け入れる必要があります。<with-defaults>パラメーターには、このセクションで定義されている4つの列挙のいずれかが含まれています。
When data is retrieved with a <with-defaults> parameter equal to 'report-all', all data nodes MUST be reported, including any data nodes considered to be default data by the server.
データが「レポートオール」に等しい<with-defaults>パラメーターで取得される場合、サーバーによってデフォルトデータと見なされるデータノードを含むすべてのデータノードを報告する必要があります。
When data is retrieved with a <with-defaults> parameter equal to 'trim', data nodes MUST NOT be reported if they contain the schema default value. Non-configuration data nodes containing the schema default value MUST NOT be reported.
<with-defaults>パラメーターが「トリム」に等しい<with-defaults>パラメーターでデータが取得された場合、スキーマのデフォルト値が含まれている場合、データノードを報告しないでください。スキーマのデフォルト値を含む非構成データノードを報告する必要はありません。
When data is retrieved with a <with-defaults> parameter equal to 'explicit', a data node that was set by a client to its schema default value MUST be reported. A conceptual data node that would be set by the server to the schema default value MUST NOT be reported. Non-configuration data nodes containing the schema default value MUST be reported.
<with-defaults>パラメーターが「明示的」に等しい<with-defaults>パラメーターでデータが取得される場合、クライアントによってスキーマのデフォルト値に設定されたデータノードを報告する必要があります。サーバーによってスキーマのデフォルト値に設定される概念データノードを報告してはなりません。スキーマのデフォルト値を含む非構成データノードを報告する必要があります。
In addition to the basic modes, a special variant of the 'report-all' basic mode is available called 'report-all-tagged'. This mode MUST be supported on a server if the 'also-supported' parameter in the :with-defaults capability contains the 'report-all-tagged' option. Refer to Section 4 for encoding details for this capability.
基本モードに加えて、「レポートオール」基本モードの特別なバリアントが「レポートオールタグ付き」と呼ばれます。：with-defaults機能に「レポート」オプションが含まれている場合、このモードはサーバーでサポートする必要があります。この機能の詳細については、セクション4を参照してください。
In this mode the server returns all data nodes, just like the 'report-all' mode, except a data node that is considered by the server to contain default data will include an XML attribute to indicate this condition. This is useful for an application to determine which nodes are considered to contain default data by the server, within a single retrieval operation.
このモードでは、サーバーがデフォルトのデータを含むと考慮されるデータノードがこの条件を示すためにXML属性が含まれることを除いて、「レポートオール」モードと同じように、サーバーはすべてのデータノードを返します。これは、単一の検索操作内で、サーバーによってデフォルトデータが含まれると見なされるノードを決定するアプリケーションにとって有用です。
A server that supports 'report-all-tagged' MUST also accept the 'default' XML attribute within configuration input to the <edit-config> or <copy-config> operations. Refer to Section 6 for XML encoding details of the 'default' XML attribute.
「すべてタグ付き」をサポートするサーバーは、<edit-config>または<copy-config>操作への構成入力内の「デフォルト」XML属性を受け入れる必要があります。「デフォルト」XML属性の詳細をエンコードするXMLのセクション6を参照してください。
The :with-defaults capability indicates which default-handling basic mode is supported by the server. It may also indicate support for additional defaults retrieval modes. These retrieval modes allow a NETCONF client to control whether default data is returned by the server. The capability affects both configuration and state data (while acknowledging that the usage of default values for state data is less prevalent). Sending of default data is controlled for each individual operation separately.
：with-defaults機能は、サーバーによってどのデフォルト処理基本モードがサポートされているかを示します。また、追加のデフォルト検索モードのサポートを示している場合があります。これらの検索モードにより、NetConfクライアントは、デフォルトデータがサーバーによって返されるかどうかを制御できます。機能は、構成データと状態データの両方に影響します（状態データのデフォルト値の使用があまり一般的ではないことを認めながら）。デフォルトデータの送信は、個々の操作ごとに個別に制御されます。
A NETCONF server implementing the :with-defaults capability:
：with-defaults機能を実装するNetConfサーバー：
o MUST indicate its basic mode behavior by including the 'basic-mode' parameter in the capability URI, as defined in Section 4.3.
o セクション4.3で定義されているように、機能URIに「基本モード」パラメーターを含めることにより、基本モードの動作を示す必要があります。
o MUST support the YANG module defined in Section 5 for the default-handling mode indicated by the 'basic-mode' parameter.
o 「基本モード」パラメーターで示されるデフォルトの処理モードのセクション5で定義されているYangモジュールをサポートする必要があります。
o SHOULD support the YANG module in Section 5 for the default-handling mode identified by the 'report-all' or 'report-all-tagged' enumeration value.
o セクション5のYangモジュールをサポートする必要があります。「レポートAll」または「レポート」列挙値によって識別されるデフォルトの処理モードです。
o If the 'report-all-tagged' default-handling mode is supported, then the 'default' attribute MUST be supported.
o 「レポート」デフォルトの取り扱いモードがサポートされている場合、「デフォルト」属性をサポートする必要があります。
o MAY support the YANG module in Section 5 for additional default-handling modes.
o 追加のデフォルトハンドリングモードについては、セクション5のYangモジュールをサポートできます。
None.
なし。
urn:ietf:params:netconf:capability:with-defaults:1.0
The identifier MUST have a parameter: "basic-mode". This indicates how the server will treat default data, as defined in Section 2. The allowed values of this parameter are 'report-all', 'trim', and 'explicit', as defined in Section 2.
識別子にはパラメーター「基本モード」が必要です。これは、セクション2で定義されているように、サーバーがデフォルトデータをどのように扱うかを示します。このパラメーターの許可された値は、セクション2で定義されているように、「レポート」、「トリム」、「明示的」です。
The identifier MAY have another parameter: "also-supported". This parameter indicates which additional enumeration values (besides the basic-mode enumeration) the server will accept for the <with-defaults> parameter in Section 5. The value of the parameter is a comma-separated list of one or more modes that are supported besides the mode indicated in the 'basic-mode' parameter. Possible modes are 'report-all', 'report-all-tagged', 'trim', and 'explicit', as defined in Section 3.
識別子には別のパラメーターがある場合があります：「サポート」もあります。このパラメーターは、サーバーがセクション5の<with-defaults>パラメーターを受け入れる追加の列挙値（基本モード列挙以外）を示します。「基本モード」パラメーターに示されているモードに加えて。可能なモードは、セクション3で定義されているように、「レポートオール」、「レポート」、「トリム」、「トリム」、「明示的」です。
Note that this protocol capability URI is separate from the YANG module capability URI for the YANG module in Section 5. A server that implements this module MUST also advertise a YANG module capability URI according to the rules specified in [RFC6020].
このプロトコル機能URIは、セクション5のYangモジュールのYangモジュール機能URIとは別にあることに注意してください。このモジュールを実装するサーバーは、[RFC6020]で指定されたルールに従ってYangモジュール機能URIを宣伝する必要があります。
Examples:
例：
urn:ietf:params:netconf:capability:with-defaults:1.0?basic-
mode=explicit
urn:ietf:params:netconf:capability:with-defaults:1.0?basic-
mode=explicit&also-supported=report-all,report-all-tagged
None.
なし。
A new <with-defaults> XML element is added to the input for the <get>, <get-config>, and <copy-config> operations. If the <with-defaults> element is present, it controls the reporting of default data. The server MUST return default data in the NETCONF <rpc-reply> messages according to the value of this element, if the server supports the specified retrieval mode.
<get>、<get-config>、および<copy-config>操作の入力に新しい<with-defaults> xml要素が追加されます。<with-defaults>要素が存在する場合、デフォルトデータのレポートを制御します。サーバーが指定された検索モードをサポートする場合、サーバーはこの要素の値に従ってNetConf <RPC-Reply>メッセージのデフォルトデータを返す必要があります。
This parameter only controls these specified retrieval operations, and does not impact any other operations or the non-volatile storage of configuration data.
このパラメーターは、これらの指定された検索操作のみを制御し、他の操作または構成データの不揮発性ストレージに影響しません。
The <with-defaults> element is defined in the XML namespace for the ietf-netconf-with-defaults.yang module in Section 5, not the XML namespace for the <get>, <get-config>, and <copy-config> operations.
<with-defaults>要素は、<get>、<get-config>、および<copy-configのxml名空間ではなく、セクション5のyangモジュールのietf-netconf with-defaults.yangモジュールのxml名空間で定義されています。>操作。
Allowed values of the with-defaults element are taken from the 'with-defaults-type' typedef in Section 5. The allowed values for a particular server are restricted to the values that the server indicates it supports within the :with-defaults capability, in the 'basic-mode' and 'also-supported' parameters.
with-defaults要素の許可された値は、セクション5の「with-defaults-type」typedefから取得されます。特定のサーバーの許容値は、サーバーが次のようにサポートする値に制限されています。「基本モード」および「サポートされている」パラメーター。
If an unsupported value is used, the NETCONF server MUST return an <rpc-error> response with an 'invalid-value' error-tag.
サポートされていない値が使用される場合、NetConfサーバーは「無効な価値」エラータグで<RPC-Error>応答を返す必要があります。
If the <with-defaults> element is not present, the server MUST follow its basic mode behavior as indicated by the :with-defaults capability identifier's 'basic-mode' parameter, defined in Section 4.3.
<with-defaults>要素が存在しない場合、サーバーは次のように基本モードの動作に従う必要があります。
The <get> and <get-config> operations support a separate filtering mechanism, using the <filter> parameter. The defaults filtering is conceptually done before the <filter> parameter is processed. For example, if the <with-defaults> parameter is equal to 'report-all', then the <filter> parameter is conceptually applied to all data nodes and all default data.
<get>および<get-config>操作は、<filter>パラメーターを使用して、個別のフィルタリングメカニズムをサポートしています。デフォルトのフィルタリングは、<filter>パラメーターが処理される前に概念的に行われます。たとえば、<with-defaults>パラメーターが「レポートすべて」に等しい場合、<filter>パラメーターはすべてのデータノードとすべてのデフォルトデータに概念的に適用されます。
The <copy-config> operation is only affected by the <with-defaults> parameter if the target of the operation is specified with the <url> parameter. If the target is a NETCONF configuration datastore (i.e., running, candidate, or startup), the <with-defaults> parameter has no effect. The server MUST use its basic mode when copying data to a NETCONF configuration datastore. If the <with-defaults> parameter is present in this case, it MUST be silently ignored by the server.
<copy-config>操作は、操作のターゲットが<url>パラメーターで指定されている場合にのみ<defaults>パラメーターの影響を受けます。ターゲットがNetConf構成データストア（つまり、実行、候補、または起動）である場合、<with-defaults>パラメーターは効果がありません。データをNetConf構成データストアにコピーするときは、サーバーは基本モードを使用する必要があります。この場合、<with-defaults>パラメーターが存在する場合、サーバーによって静かに無視する必要があります。
If the server supports the 'report-all-tagged' mode, then the 'default' attribute defined in Section 6 also impacts the <copy-config> operation. If the 'default' attribute is present and set to 'true' or '1', then the server MUST treat the new data node as a request to return that node to its default value (i.e., remove it from the configuration datastore). The data node within the NETCONF message MUST contain a value in this case, which MUST be equal to the schema default value. If not, the server MUST return an <rpc-error> response with an 'invalid-value' error-tag.
サーバーが「レポートオールタグ付き」モードをサポートする場合、セクション6で定義されている「デフォルト」属性も<Copy-Config>操作に影響します。「デフォルト」属性が存在し、「true」または「1」に設定されている場合、サーバーは新しいデータノードをデフォルト値に返すリクエストとして扱う必要があります（つまり、構成データストアから削除）。NetConfメッセージ内のデータノードには、この場合に値が含まれている必要があります。これは、スキーマのデフォルト値に等しくなければなりません。そうでない場合、サーバーは「無効な価値」エラータグで<RPC-Error>応答を返す必要があります。
The <edit-config> operation has several editing modes. The 'create' and 'delete' editing operations are affected by the default-handling basic mode. The other enumeration values for the NETCONF operation attribute are not affected.
<edit-config>操作には、いくつかの編集モードがあります。「作成」および「削除」編集操作は、デフォルトの処理基本モードの影響を受けます。NetConf操作属性の他の列挙値は影響を受けません。
If the operation attribute contains the value 'create', and the data node already exists in the target configuration datastore, then the server MUST return an <rpc-error> response with an 'invalid-value' error-tag.
操作属性に値「作成」が含まれ、データノードがターゲット構成データストアに既に存在する場合、サーバーは「無効な値」エラータグで<RPC-Error>応答を返す必要があります。
If the client sets a data node to its schema default value, the server MUST accept the request if it is valid. The server MUST keep or discard the new value based on its default-handling basic mode. For the 'trim' basic mode, all schema default values are discarded; otherwise, a client-provided schema default value is saved in a NETCONF configuration datastore.
クライアントがデータノードをスキーマのデフォルト値に設定する場合、サーバーが有効な場合、サーバーはリクエストを受け入れる必要があります。サーバーは、デフォルトの処理基本モードに基づいて新しい値を保持または廃棄する必要があります。「トリム」基本モードの場合、すべてのスキーマデフォルト値が破棄されます。それ以外の場合、クライアントが提供するスキーマのデフォルト値は、NetConf構成データストアに保存されます。
If the server supports the 'report-all-tagged' mode, then the 'default' attribute defined in Section 6 also impacts the <edit-config> operation. If the 'default' attribute is present and set to 'true' or '1', then the server MUST treat the new data node as a request to return that node to its default value (i.e., remove it from the configuration datastore). The data node within the NETCONF message MUST contain a value in this case, which MUST be equal to the schema default value. If not, the server MUST return an <rpc-error> response with an 'invalid-value' error-tag.
サーバーが「レポートオールタグ付き」モードをサポートする場合、セクション6で定義されている「デフォルト」属性も<edit-config>操作に影響します。「デフォルト」属性が存在し、「true」または「1」に設定されている場合、サーバーは新しいデータノードをデフォルト値に返すリクエストとして扱う必要があります（つまり、構成データストアから削除）。NetConfメッセージ内のデータノードには、この場合に値が含まれている必要があります。これは、スキーマのデフォルト値に等しくなければなりません。そうでない場合、サーバーは「無効な価値」エラータグで<RPC-Error>応答を返す必要があります。
If the 'default' attribute is present, then the effective operation for the target data node MUST be 'create', 'merge', or 'replace'. If not, then the server MUST return an <rpc-error> response with an 'invalid-value' error-tag. For example, if 'create' is the effective operation, then the create request must be valid on its own (e.g., current data node MUST NOT exist). The procedure for determining the effective operation is defined in [RFC6241]. It is derived from the 'default-operation' parameter and/or any operation attributes that are present in the data node or any of its ancestor nodes, within the <edit-config> request.
「デフォルト」属性が存在する場合、ターゲットデータノードの有効操作は「作成」、「マージ」、または「交換」でなければなりません。そうでない場合は、サーバーは「無効な価値」エラータグで<RPC-Error>応答を返す必要があります。たとえば、「create」が効果的な操作である場合、作成要求は独自に有効でなければなりません（たとえば、現在のデータノードは存在してはなりません）。有効操作を決定する手順は、[RFC6241]で定義されています。これは、<edit-config>リクエスト内で、データノードまたはその先祖ノードに存在する「デフォルトオペレーション」パラメーターおよび/または任意の操作属性から導き出されます。
Other operations that return configuration data SHOULD also handle default data according to the rules set in this document, and explicitly state this in their documentation. If this is not specified in the document defining the respective operation, the default-handling rules described herein do not affect these operations.
構成データを返す他の操作は、このドキュメントに設定されたルールに従ってデフォルトデータを処理し、ドキュメントにこれを明示的に述べている必要があります。これがそれぞれの操作を定義するドキュメントで指定されていない場合、ここで説明するデフォルトの処理ルールはこれらの操作に影響しません。
None.
なし。
The following YANG module defines the addition of the with-defaults element to the <get>, <get-config>, and <copy-config> operations. The YANG language is defined in [RFC6020]. The above operations are defined in YANG in [RFC6241]. Every NETCONF server that supports the :with-defaults capability MUST implement this YANG module.
次のYangモジュールは、<get>、<get-config>、および<copy-config>操作にwith-defaults要素を追加することを定義しています。Yang言語は[RFC6020]で定義されています。上記の操作は、[RFC6241]のYangで定義されています。：with-defaults機能をサポートするすべてのNetConfサーバーは、このYangモジュールを実装する必要があります。
<CODE BEGINS> file="ietf-netconf-with-defaults@2011-06-01.yang"
module ietf-netconf-with-defaults {
モジュールietf-netconf with-defaults {
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults";
prefix ncwd;
プレフィックスNCWD;
import ietf-netconf { prefix nc; }
organization "IETF NETCONF (Network Configuration Protocol) Working Group";
組織「IETF NetConf（ネットワーク構成プロトコル）ワーキンググループ」;
contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <netconf@ietf.org>
WG Chair: Bert Wijnen
<bertietf@bwijnen.net>
WG Chair: Mehmet Ersue
<mehmet.ersue@nsn.com>
Editor: Andy Bierman
<andy.bierman@brocade.com>
Editor: Balazs Lengyel
<balazs.lengyel@ericsson.com>";
description "This module defines an extension to the NETCONF protocol that allows the NETCONF client to control how default values are handled by the server in particular NETCONF operations.
説明 "このモジュールは、NetConfクライアントが特にNetConf操作のサーバーによってデフォルト値の処理方法を制御できるようにするNetConfプロトコルの拡張機能を定義します。
Copyright (c) 2011 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright（c）2011 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 (http://trustee.ietf.org/license-info).
変更とバイナリ形式での再配布と使用は、変更の有無にかかわらず、IETF Trustの法的規定（IETFドキュメントに関する法的規定）のセクション4.Cに記載されている簡略化されたBSDライセンスに基づいて許可されており、ライセンス条件に従います。http://trustee.ietf.org/license-info）。
This version of this YANG module is part of RFC 6243; see the RFC itself for full legal notices.";
このYangモジュールのこのバージョンは、RFC 6243の一部です。完全な法的通知については、RFC自体を参照してください。」;
revision 2011-06-01 {
description
"Initial version.";
reference
"RFC 6243: With-defaults Capability for NETCONF";
}
typedef with-defaults-mode {
description
"Possible modes to report default data.";
reference
"RFC 6243; Section 3.";
type enumeration {
enum report-all {
description
"All default data is reported.";
reference
"RFC 6243; Section 3.1";
}
enum report-all-tagged {
description
"All default data is reported.
Any nodes considered to be default data
will contain a 'default' XML attribute,
set to 'true' or '1'.";
reference
"RFC 6243; Section 3.4";
}
enum trim {
description
"Values are not reported if they contain the default.";
reference
"RFC 6243; Section 3.2";
}
enum explicit {
description
"Report values that contain the definition of
explicitly set data.";
reference
"RFC 6243; Section 3.3";
}
}
}
grouping with-defaults-parameters { description "Contains the <with-defaults> parameter for control of defaults in NETCONF retrieval operations.";
DEFAULTS-PARAMETERSを使用したグループ{説明 "NetConf検索操作のデフォルトの制御のための<with-defaults>パラメーターが含まれています。";
leaf with-defaults { description "The explicit defaults processing mode requested."; reference "RFC 6243; Section 4.5.1";
葉のある葉{説明 "明示的なデフォルトの処理モードが要求されました。";参照「RFC 6243;セクション4.5.1 ";
type with-defaults-mode;
}
}
// extending the get-config operation
augment /nc:get-config/nc:input {
description
"Adds the <with-defaults> parameter to the
input of the NETCONF <get-config> operation.";
reference
"RFC 6243; Section 4.5.1";
uses with-defaults-parameters; }
Defaults-Parametersを使用して使用します。}
// extending the get operation
augment /nc:get/nc:input {
description
"Adds the <with-defaults> parameter to
the input of the NETCONF <get> operation.";
reference
"RFC 6243; Section 4.5.1";
uses with-defaults-parameters; }
Defaults-Parametersを使用して使用します。}
// extending the copy-config operation
augment /nc:copy-config/nc:input {
description
"Adds the <with-defaults> parameter to
the input of the NETCONF <copy-config> operation.";
reference
"RFC 6243; Section 4.5.1";
uses with-defaults-parameters; }
Defaults-Parametersを使用して使用します。}
}
}
<CODE ENDS>
<コードエンド>
The following XML Schema document [W3C.REC-xml-20081126] defines the 'default' attribute, described within this document. This XSD is only relevant if the server supports the 'report-all-tagged' defaults retrieval mode.
次のXMLスキーマドキュメント[W3C.REC-XML-20081126]は、このドキュメント内で説明されている「デフォルト」属性を定義します。このXSDは、サーバーが「レポート」デフォルトの取得モードをサポートしている場合にのみ関連します。
The 'default' attribute uses the XSD data type 'boolean'. In accordance with Section 3.2.2.1 of XML Schema Part 2: Datatypes, the allowable lexical representations for the xs:boolean datatype are the strings "0" and "false" for the concept of false and the strings "1" and "true" for the concept of true. Implementations MUST support both styles of lexical representation.
「デフォルト」属性は、XSDデータ型「ブールン」を使用します。XMLスキーマパート2のセクション3.2.2.1に従って、データ型、XSの許容される語彙表現：ブールのデータ型は、偽と文字列「1」と「真」の概念の文字列「0」と「false」です。真の概念のために。実装は、両方のスタイルの語彙表現をサポートする必要があります。
<CODE BEGINS> file="defaults.xsd"
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="urn:ietf:params:xml:ns:netconf:default:1.0"
targetNamespace="urn:ietf:params:xml:ns:netconf:default:1.0"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
xml:lang="en">
<xs:annotation>
<xs:documentation>
This schema defines the syntax for the 'default' attribute
described within this document.
</xs:documentation>
</xs:annotation>
<!--
default attribute
-->
<xs:attribute name="default" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>
This attribute indicates whether the data node represented
by the XML element containing this attribute is considered
by the server to be default data. If set to 'true' or '1', then
the data node is default data. If 'false' or '0', then the
data node is not default data.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:schema>
<CODE ENDS>
<コードエンド>
This document registers the following capability identifier URN in the 'Network Configuration Protocol (NETCONF) Capability URNs' registry:
このドキュメントは、「ネットワーク構成プロトコル（NetConf）機能URNSのレジストリで次の機能識別子URNを登録します。
urn:ietf:params:netconf:capability:with-defaults:1.0
This document registers two XML namespace URNs in the 'IETF XML registry', following the format defined in [RFC3688].
このドキュメントは、[RFC3688]で定義されている形式に従って、「IETF XMLレジストリ」の2つのXMLネームスペースURNを登録します。
URI: urn:ietf:params:xml:ns:netconf:default:1.0
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults
Registrant Contact: The NETCONF WG of the IETF.
登録者の連絡先：IETFのNetConf WG。
XML: N/A, the requested URIs are XML namespaces.
XML：n/a、要求されたurisはXMLネームスペースです。
This document registers one module name in the 'YANG Module Names' registry, defined in [RFC6020] .
このドキュメントは、[RFC6020]で定義されている「Yangモジュール名」レジストリに1つのモジュール名を登録します。
name: ietf-netconf-with-defaults
名前：ietf-netconf with-defaults
prefix: ncwd
プレフィックス：ncwd
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults
RFC: 6243
RFC：6243
This document defines an extension to existing NETCONF protocol operations. It does not introduce any new or increased security risks into the management system.
このドキュメントは、既存のNetConfプロトコル操作の拡張機能を定義します。管理システムに新たなまたは増加したセキュリティリスクを導入することはありません。
The 'with-defaults' capability gives clients control over the retrieval of default data from a NETCONF datastore. The security consideration of [RFC6241] applies to this document as well.
「with-defaults」機能により、クライアントはNetConf DataStoreからのデフォルトデータの取得を制御できます。[RFC6241]のセキュリティに関する考慮事項は、このドキュメントにも適用されます。
Thanks to Martin Bjorklund, Sharon Chisholm, Phil Shafer, Juergen Schoenwaelder, Kent Watsen, Washam Fan, and many other members of the NETCONF WG for providing important input to this document.
Martin Bjorklund、Sharon Chisholm、Phil Shafer、Juergen Schoenwaelder、Kent Watsen、Washam Fan、およびNetconf WGの他の多くのメンバーに感謝します。
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2119] Bradner、S。、「要件レベルを示すためにRFCで使用するためのキーワード」、BCP 14、RFC 2119、1997年3月。
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004.
[RFC3688] Mealling、M。、「IETF XMLレジストリ」、BCP 81、RFC 3688、2004年1月。
[RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, October 2010.
[RFC6020] Bjorklund、M。、「Yang-ネットワーク構成プロトコル（NetConf）のデータモデリング言語」、RFC 6020、2010年10月。
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, June 2011.
[RFC6241] Enns、R.、ed。、Bjorklund、M.、ed。、Schoenwaelder、J.、ed。、およびA. Bierman、ed。、「Network Configuration Protocol（NetConf）」、RFC 6241、2011年6月。
[W3C.REC-xml-20081126] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", World Wide Web Consortium Recommendation REC-xml-20081126, November 2008, <http://www.w3.org/TR/2008/REC-xml-20081126>.
[W3C.REC-XML-20081126] Bray、T.、Paoli、J.、Sperberg-Mcqueen、C.、Maler、E.、およびF. Yergeau、「拡張可能なマークアップ言語（XML）1.0（第5版）」、World Wide Web Consortiumの推奨REC-XML-20081126、2008年11月、<http://www.w3.org/tr/2008/REC-XML-20081126>。
[W3C.REC-xmlschema-0-20041028] Fallside, D. and P. Walmsley, "XML Schema Part 0: Primer Second Edition", World Wide Web Consortium Recommendation REC-xmlschema-0-20041028, October 2004, <http://www.w3.org/TR/2004/REC-xmlschema-0-20041028>.
[W3C.REC-XMLSCHEMA-0-20041028] FALLSIDE、D。およびP. Walmsley、「XML Schema Part 0：Primer Second Edition」、World Wide Webコンソーシアムの推奨REC-XMLSCHEMA-0-20041028、2004年10月、<http：//www.w3.org/tr/2004/rec-xmlschema-0-20041028>。
The following YANG module defines an example interfaces table to demonstrate how the <with-defaults> parameter behaves for a specific data model.
次のYangモジュールは、特定のデータモデルに対して<with-defaults>パラメーターがどのように動作するかを示すために、インターフェイスの例を定義します。
Note that this is not a real module, and implementation of this module is not required for conformance to the :with-defaults capability, defined in Section 4. This module is not to be registered with IANA, and is not considered to be a code component. It is intentionally very terse, and includes few descriptive statements.
これは実際のモジュールではなく、このモジュールの実装は次のように適合するために必要ではありません：セクション4で定義されているデフォルトを使用する機能を備えていることに注意してください。成分。意図的に非常に簡潔であり、記述的な記述はほとんど含まれていません。
module example {
モジュールの例{
namespace "http://example.com/ns/interfaces";
namespace "http://example.com/ns/interfaces";
prefix exam;
プレフィックス試験;
typedef status-type {
description "Interface status";
type enumeration {
enum ok;
enum 'waking up';
enum 'not feeling so good';
enum 'better check it out';
enum 'better call for help';
}
default ok;
}
container interfaces { description "Example interfaces group";
コンテナインターフェイス{説明 "例インターフェイスグループ";
list interface { description "Example interface entry"; key name;
リストインターフェイス{説明 "例インターフェイスエントリ";キー名;
leaf name {
description
"The administrative name of the interface.
This is an identifier that is only unique
within the scope of this list, and only
within a specific server.";
type string {
length "1 .. max";
}
}
leaf mtu {
description
"The maximum transmission unit (MTU) value assigned to
this interface.";
type uint32;
default 1500;
}
leaf status {
description
"The current status of this interface.";
type status-type;
config false;
}
}
}
}
The following data element shows the conceptual contents of the example server for the protocol operation examples in the next section. This includes all the configuration data nodes, non-configuration data nodes, and default leafs.
次のデータ要素は、次のセクションのプロトコル操作例のサンプルサーバーの概念的な内容を示しています。これには、すべての構成データノード、非構成データノード、デフォルトの葉が含まれます。
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<status>up</status>
</interface>
<interface>
<name>eth1</name>
<mtu>1500</mtu>
<status>up</status>
</interface>
<interface>
<name>eth2</name>
<mtu>9000</mtu>
<status>not feeling so good</status>
</interface>
<interface>
<name>eth3</name>
<mtu>1500</mtu>
<status>waking up</status>
</interface>
</interfaces>
</data>
In this example, the 'mtu' field for each interface entry is set in the following manner:
この例では、各インターフェイスエントリの「MTU」フィールドが次の方法で設定されています。
+--------------+--------------+--------------+
| name | set by | mtu |
+--------------+--------------+--------------+
| eth0 | client | 8192 |
| eth1 | server | 1500 |
| eth2 | client | 9000 |
| eth3 | client | 1500 |
+--------------+--------------+--------------+
The following examples show some <get> operations using the 'with-defaults' element. The data model used for these examples is defined in Appendix A.1.
次の例は、「デフォルト付き」要素を使用したいくつかの<get>操作を示しています。これらの例で使用されるデータモデルは、付録A.1に定義されています。
The client is retrieving all the data nodes within the 'interfaces' object, filtered with the <with-defaults> parameter.
クライアントは、<with-defaults>パラメーターでフィルタリングされた「インターフェイス」オブジェクト内のすべてのデータノードを取得しています。
The behavior of the <with-defaults> parameter handling for the value 'report-all' is demonstrated in this example.
この例では、<with-defaults> value 'Report-all'のパラメーター処理の動作を示しています。
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/>
</filter>
<with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
report-all
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<status>up</status>
</interface>
<interface>
<name>eth1</name>
<mtu>1500</mtu>
<status>up</status>
</interface>
<interface>
<name>eth2</name>
<mtu>9000</mtu>
<status>not feeling so good</status>
</interface>
<interface>
<name>eth3</name>
<mtu>1500</mtu>
<status>waking up</status>
</interface>
</interfaces>
</data>
</rpc-reply>
The behavior of the <with-defaults> parameter handling for the value 'report-all-tagged' is demonstrated in this example. A 'tagged' data node is an element that contains the 'default' XML attribute, set to 'true' or '1'.
この例では、<with-defaults> value 'Report-all-Tagged'のパラメーター処理の動作を示しています。「タグ付き」データノードは、「デフォルト」XML属性を含む要素で、「true」または「1」に設定されています。
The actual data nodes tagged by the server depend on the default-handling basic mode used by the server. Only the data nodes that are considered to be default data will be tagged.
サーバーによってタグ付けされた実際のデータノードは、サーバーが使用するデフォルトの処理基本モードによって異なります。デフォルトデータと見なされるデータノードのみがタグ付けされます。
In this example, the server's basic mode is equal to 'trim', so all data nodes that would contain the schema default value are tagged. If the server's basic mode is 'explicit', then only data nodes that are not explicitly set data are tagged. If the server's basic mode is 'report-all', then no data nodes are tagged.
この例では、サーバーの基本モードは「トリム」に等しくなるため、スキーマのデフォルト値を含むすべてのデータノードにタグが付けられています。サーバーの基本モードが「明示的」の場合、明示的に設定されていないデータノードのみがタグ付けされます。サーバーの基本モードが「レポートすべて」の場合、データノードはタグ付けされていません。
<rpc message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/>
</filter>
<with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
report-all-tagged
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:wd="urn:ietf:params:xml:ns:netconf:default:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<status wd:default="true">up</status>
</interface>
<interface>
<name>eth1</name>
<mtu wd:default="true">1500</mtu>
<status wd:default="true">up</status>
</interface>
<interface>
<name>eth2</name>
<mtu>9000</mtu>
<status>not feeling so good</status>
</interface>
<interface>
<name>eth3</name>
<mtu wd:default="true">1500</mtu>
<status>waking up</status>
</interface>
</interfaces>
</data>
</rpc-reply>
The behavior of the <with-defaults> parameter handling for the value 'trim' is demonstrated in this example.
この例では、値「トリム」の<with-defaults>パラメーター処理の動作が示されています。
<rpc message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/>
</filter>
<with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
trim
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
</interface>
<interface>
<name>eth1</name>
</interface>
<interface>
<name>eth2</name>
<mtu>9000</mtu>
<status>not feeling so good</status>
</interface>
<interface>
<name>eth3</name>
<status>waking up</status>
</interface>
</interfaces>
</data>
</rpc-reply>
The behavior of the <with-defaults> parameter handling for the value 'explicit' is demonstrated in this example.
この例では、値「明示的」の<with-defaults>パラメーター処理の動作が示されています。
<rpc message-id="104"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/>
</filter>
<with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
explicit
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="104"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<status>up</status>
</interface>
<interface>
<name>eth1</name>
<status>up</status>
</interface>
<interface>
<name>eth2</name>
<mtu>9000</mtu>
<status>not feeling so good</status>
</interface>
<interface>
<name>eth3</name>
<mtu>1500</mtu>
<status>waking up</status>
</interface>
</interfaces>
</data>
</rpc-reply>
Authors' Addresses
著者のアドレス
Andy Bierman Brocade
アンディ・ビアマン・ブロケード
EMail: andy.bierman@brocade.com
Balazs Lengyel Ericsson Budapest, Hungary
Balazs Lengyel Ericsson Budapest、ハンガリー
EMail: balazs.lengyel@ericsson.com