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
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.
このドキュメントの現在の状態、任意の正誤表、そしてどのようにフィードバックを提供するための情報が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.
著作権（C）2011 IETF信託とドキュメントの作成者として特定の人物。全著作権所有。
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トラストの法律の規定に従うものとします。彼らは、この文書に関してあなたの権利と制限を説明するように、慎重にこれらの文書を確認してください。コードコンポーネントは、トラスト法規定のセクションで説明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].
この文書のキーワード "MUST"、 "MUST NOT"、 "REQUIRED"、、、、 "べきではない" "べきである" "ないもの" "ものとし"、 "推奨"、 "MAY"、および "OPTIONAL" はあります[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: The shorthand notation for the with-defaults capability identifier.
： - デフォルト値を持つ：を有する、デフォルト機能識別子のための簡略表記。
The following terms are defined in [RFC6241]:
以下の用語は[RFC6241]で定義されています。
o client
またはクライアント
o datastore
Oデータストア
o operation
運用O
o server
Oサーバ
The following term is defined in [RFC6020]:
以下の用語は[RFC6020]で定義されています。
o data node
お だた ので
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.操作を作成し、削除します。<編集-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,
この文書では、サーバのデフォルトの処理動作を識別するために、NETCONFプロトコル機能、デフォルトのデータを識別するためのXML [W3C.REC-XMLSCHEMA-0から20041028]属性を定義します
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クライアントは、デフォルトのデータがサーバーから返されるかどうかを制御することを可能にする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.
「報告-すべて」を基本モードを使用するサーバーは、デフォルトのデータもスキーマのデフォルトのデータであることをすべてのデータノードを考慮していません。
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.
データは、「レポートすべてを」基本モードを使用して、サーバから取得し、< - デフォルトで>パラメータが存在しないである場合、全てのデータノードを報告しなければなりません。
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で指定されている「報告-すべて」に等しい値を持つパラメータ、<-デフォルト値を持ちます>。
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.
サーバーは、すべてのデータノードが存在するために考慮しなければならないとしても、スキーマのデフォルト値を含むもの。 「データが存在する」というエラー・タグで失敗しなければなりませんそのスキーマのデフォルト値が含まれているデータノードの有効な「作成」操作属性。データノードはすぐにデフォルト値を持つサーバーに置き換えられていても、成功しなければならない、そのスキーマのデフォルト値が含まれているデータノードの有効な「削除」操作属性。
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.
「報告-すべて」を基本モードを使用するサーバーは、<-デフォルトで>検索モードは関係ありませんデフォルトのノードの概念がないので、「報告-すべてのタグ付き」。基本モードの検索操作では省略されているノードがないことから、任意のタグ付けされたノードがあってはなりません。 「デフォルト」属性は任意のコンフィギュレーション・データ内に存在する場合、サーバは「未知の属性」エラータグと<RPCエラー>応答を返さなければなりません。
A server that uses the 'trim' basic mode MUST consider any data node set to its schema default value to be default data.
基本モードを「トリム」を使用するサーバーは、そのスキーマのデフォルト値に設定されているデータノードは、デフォルトのデータであることを考慮しなければなりません。
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.
データが「トリム」の基本的なモードを使用して、サーバーから取得し、<-デフォルトで>パラメータが存在しないされている場合、彼らはスキーマのデフォルト値が含まれている場合、データノードが報告されてはなりません。スキーマのデフォルト値を含む非コンフィギュレーション・データ・ノードが報告されてはなりません。
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節で指定されているように、「トリム」に等しい値を持つパラメータ<-デフォルトで>サポートしなければなりません。
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エラー>応答を返さなければなりません。
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構成データストアに保存されてはならないが、それは、成功しなければなりません。これは、データノードを削除し、デフォルトのデータとして扱うのと同じ効果があります。
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.
サーバは<と、デフォルト設定>パラメータのための「報告-すべてをタグ付き」の値をサポートしている場合は、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.
データが「明示的な」基本モードを使用して、サーバーから取得し、<-デフォルトで>パラメータが存在しないされている場合、明示的にクライアントによって設定された場合は、データノードは、彼らは、スキーマのデフォルト値が含まれている場合でも、報告しなければなりません。スキーマのデフォルト値を含む非コンフィギュレーション・データ・ノードは報告しなければなりません。
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で指定されるように、「明示的な」と等しい値を持つパラメータ<-デフォルトで>サポートしなければなりません。
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.
サーバーは、明示的に存在するデータを設定されているすべてのデータノードを検討します。有効なはそのスキーマのデフォルト値にクライアントによって設定されたデータノードのための操作属性がエラータグ「を、存在するデータ」で失敗しなければなりません「作成します」。成功しなければなりません、そのスキーマのデフォルト値にサーバによって設定されたデータノードの有効な「作成」操作属性。そのスキーマのデフォルト値にクライアントによって設定されたデータノードの有効な「削除」操作属性が成功しなければなりません。 「データ・行方不明」エラータグで失敗しなければなりませんそのスキーマのデフォルト値にサーバによって設定されたデータノードの有効な「削除」操作属性。
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.
サーバはその中で「報告-すべてのタグ付き」検索モードをサポートしている場合：で、デフォルトの機能は、「デフォルト」属性が設定入力で受け入れなければなりません。すべてのNETCONF <編集設定>または<コピー-config>のパラメータが有効である場合、サーバは返すように要求としてタグ付けされたデータノード（「true」または「1」にセットすなわち、「デフォルト」属性）を扱いますそのノードがデータをデフォルトに。この要求は、要求されたNETCONF操作のコンテキスト内で有効である場合には、データノードが削除され、デフォルト値に戻ります。 NETCONFメッセージ内のデータノードは、スキーマのデフォルト値に等しくなければならない。この場合、の値を含まなければなりません。そうでない場合、サーバは「無効値」というエラー・タグと<RPCエラー>応答を返さなければなりません。
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.
この文書は、デフォルトのデータの検索がサーバーによって処理される方法を制御するために、特定の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.
この仕様を実装し、サーバはそれがサポートするデフォルトのハンドリングモードのいずれかの列挙を含むパラメータ<-デフォルトで>受け入れなければなりません。 <-デフォルト値を持つ>パラメータは、このセクションで定義された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.
データは、「レポートすべてを」に等しいパラメータ<-デフォルト値を持つ>で取得された場合、全てのデータノードは、サーバによってデフォルトデータであると考えられ、任意のデータノードを含め、報告されなければなりません。
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.
データが「トリム」に等しいパラメータ<-デフォルト値を持つ>で取得されたとき、彼らはスキーマのデフォルト値が含まれている場合、データノードが報告されてはなりません。スキーマのデフォルト値を含む非コンフィギュレーション・データ・ノードが報告されてはなりません。
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.
データは、「明示的」に等しいパラメータ<-デフォルト値を持つ>で取得された場合、そのスキーマのデフォルト値にクライアントによって設定されたデータノードは、報告されなければなりません。スキーマのデフォルト値にサーバによって設定されるだろう概念データノードが報告されてはなりません。スキーマのデフォルト値を含む非コンフィギュレーション・データ・ノードは報告しなければなりません。
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.
基本モードのほかに、「報告-すべて」を基本モードの特殊なバリアントは、「レポート・オール・タグ付け」と呼ば使用可能です。デフォルト機能「報告-すべてのタグ付き」オプションが含まれています。中「はサポート」パラメータがあれば、このモードはサーバでサポートしなければなりません。この機能の詳細をエンコードするための第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.
「レポート - すべてのタグ付き」をサポートしているサーバーは、<編集-config>のへの構成入力内の「デフォルト」のXML属性または<コピー-config>の操作を受け入れなければなりません。 「デフォルト」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.
：と-のデフォルト機能はデフォルトハンドリングの基本的なモードはサーバによってサポートされているかを示します。また、追加のデフォルトの検索モードをサポートしている可能性があります。これらの検索モードは、NETCONFクライアントは、デフォルトのデータがサーバーから返されているかどうかを制御することができます。 （状態データのデフォルト値の使用量が少ない一般的であることを認めている間）機能の両方の構成と状態データに影響を与えます。デフォルトのデータの送信は別に、個々の操作のために制御されています。
A NETCONF server implementing the :with-defaults capability:
デフォルトの機能：実装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モジュールをサポートする必要があります。
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
URN：IETF：のparams：NETCONF：機能：と-デフォルト：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.
識別子は、別のパラメータを持っているかもしれません：「もサポート」。このパラメータは、パラメータの値がサポートされる1つの以上のモードのコンマ区切りのリストである項5にサーバが<-デフォルトで>のために受け入れる（基本モードの列挙に加えて）は、追加の列挙値パラメータを示しますモードのほかに「基本モード」パラメータで示されています。可能なモードは、「レポート-すべてを」、「レポート - すべてのタグ付き」、第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も、[RFC6020]で指定された規則に従ってYANGモジュール能力URIをアドバタイズする必要があり、このモジュールを実装するサーバでYANGモジュールのYANGモジュール能力URIとは別であることに留意されたいです。
Examples:
例：
urn:ietf:params:netconf:capability:with-defaults:1.0?basic-mode=explicit
URN：IETF：のparams：NETCONF：機能：と-デフォルト：？1.0基本的なモード=明示
urn:ietf:params:netconf:capability:with-defaults:1.0?basic-mode=explicit&also-supported=report-all,report-all-tagged
URN：IETF：のparams：NETCONF：機能：？ - デフォルト値を持つ：1.0基本的なモード=明示的な＆は=は、レポートのすべて、レポート - すべてのタグもサポート
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.
新しい<で、デフォルト> XML要素は<GET>、<GET-config>の、そして<コピー-config>の操作のための入力に追加されます。 <-デフォルトで>要素が存在する場合は、デフォルトのデータの報告を制御します。サーバーが指定された検索モードをサポートしている場合、サーバーは、この要素の値に応じてメッセージNETCONF <RPC-返信>にデフォルトのデータを返さなければなりません。
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.
要素は、第5節では、IETF-NETCONF-と-defaults.yangモジュールではなく、<GET>、<GET-config>のためのXML名前空間、および<コピー設定用の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.
、と-デフォルト設定機能：と、デフォルトの要素の許容値は、サーバがサポートしている中に示した値に制限されている特定のサーバについては、第5の許容値に「は、デフォルト・タイプ」のtypedefから取られ「基本モード」と「もサポート」のパラメータインチ
If an unsupported value is used, the NETCONF server MUST return an <rpc-error> response with an 'invalid-value' error-tag.
サポートされていない値が使用されている場合、NETCONFサーバ「は無効値」エラータグと<RPCエラー>応答を返さなければなりません。
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.
<-デフォルトで>要素が存在しない場合によって示されるように、サーバーは、その基本モードの動作に従わなければならない：機能の識別子の「基本モード」パラメータデフォルトで、4.3節で定義されています。
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>の操作は<フィルター>パラメータを使用して、別のフィルタリングメカニズムをサポートします。 <フィルタ>パラメータが処理される前に、デフォルトのフィルタリングを概念的に行われます。例えば、< - デフォルトで>パラメータは、「レポート全て」、その後<フィルター>パラメータは、概念的に、すべてのデータノードとすべてのデフォルトのデータに適用されるに等しい場合。
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.
<コピー-config>の操作だけに影響される操作の対象は、<URL>パラメータで指定されている場合は、パラメータ<-デフォルト値を持ちます>。ターゲットはNETCONF設定データストア（すなわち、ランニング、候補者、または起動）である場合、< - デフォルトで>パラメータは影響を及ぼしません。 NETCONFの設定データストアにデータをコピーする際、サーバは、その基本的なモードを使用する必要があります。 <で、デフォルト値>パラメータは、この場合に存在する場合、それは静かに、サーバによって無視されなければなりません。
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節の影響<コピー-config>の操作で定義されています。 「デフォルト」属性が存在し、「真」または「1」に設定されている場合、サーバは（すなわち、コンフィギュレーション・データストアから削除）デフォルト値にそのノードを返すように要求として、新しいデータノードを扱わなければなりません。 NETCONFメッセージ内のデータノードは、スキーマのデフォルト値に等しくなければならない。この場合、の値を含まなければなりません。そうでない場合、サーバは「無効値」というエラー・タグと<RPCエラー>応答を返さなければなりません。
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.
<編集-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エラー>応答を返さなければなりません。
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節の影響<編集-config>の操作で定義されています。 「デフォルト」属性が存在し、「真」または「1」に設定されている場合、サーバは（すなわち、コンフィギュレーション・データストアから削除）デフォルト値にそのノードを返すように要求として、新しいデータノードを扱わなければなりません。 NETCONFメッセージ内のデータノードは、スキーマのデフォルト値に等しくなければならない。この場合、の値を含まなければなりません。そうでない場合、サーバは「無効値」というエラー・タグと<RPCエラー>応答を返さなければなりません。
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エラー>応答を返さなければなりません。例えば、「作成」、次に作成要求（例えば、現在のデータ・ノードが存在していなければならない）、それ自身の上で有効である必要があり、効果的な操作です。効果的な動作を決定するための手順は、[RFC6241]で定義されています。それは、<編集設定>要求内で、「デフォルト動作」パラメータおよび/またはデータ・ノードまたはその祖先ノードのいずれかの中に存在する任意の操作属性から導出されます。
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-設定>、および<コピー設定>操作へと、デフォルト元素の添加を定義します。 YANG言語は[RFC6020]で定義されています。上記の操作は、[RFC6241]にYANGに定義されています。サポートしているすべてのNETCONFサーバ：と-のデフォルト機能は、このYANGモジュールを実装しなければなりません。
<CODE BEGINS> file="ietf-netconf-with-defaults@2011-06-01.yang"
ファイル= "ietf-netconf-with-defaults@2011-06-01.yang" <CODEが開始されます>
module ietf-netconf-with-defaults {
モジュールIETF-NETCONF-WITH-デフォルト{
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults";
名前空間 "URN：IETF：のparams：XML：NS：ヤン：IETF-NETCONF-と、デフォルトは";
prefix ncwd;
接頭辞ncwd;
import ietf-netconf { prefix nc; }
IETF-NETCONF {プレフィックスNCをインポートします。 }
organization "IETF NETCONF (Network Configuration Protocol) Working Group";
組織「IETF NETCONF（ネットワーク構成プロトコル）ワーキンググループ」。
contact "WG Web: <http://tools.ietf.org/wg/netconf/>
「連絡WGのWeb：<http://tools.ietf.org/wg/netconf/>
WG List: <netconf@ietf.org>
WGメール：<netconf@ietf.org>
WG Chair: Bert Wijnen <bertietf@bwijnen.net>
WG座長：バート・ワイン<bertietf@bwijnen.net>
WG Chair: Mehmet Ersue <mehmet.ersue@nsn.com>
WG座長：メフメットErsue <mehmet.ersue@nsn.com>
Editor: Andy Bierman <andy.bierman@brocade.com>
編集者：アンディBierman <andy.bierman@brocade.com>
Editor: Balazs Lengyel <balazs.lengyel@ericsson.com>";
エディタ：バラージュポーランド<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.
著作権（C）2011 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 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).
、に基づき許可されており、中に含まれるライセンス条項に従う、簡体BSDライセンスは、IETFドキュメントに関連IETFトラストの法律規定（のセクション4.Cに記載されている変更の有無にかかわらず、ソースおよびバイナリ形式での再配布および使用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.";
で、デフォルトパラメータグルーピング{説明は「NETCONF検索操作におけるデフォルトの制御のためのパラメータ<-デフォルトで>が含まれています。」;
leaf with-defaults {
description
"The explicit defaults processing mode requested.";
reference
"RFC 6243; Section 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; }
デフォルトパラメータを使用しています。 }
// 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; }
デフォルトパラメータを使用しています。 }
// 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; }
デフォルトパラメータを使用しています。 }
}
｝
<CODE ENDS>
<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の許容字句表現：ブールデータ型が文字列「0」であり、偽の概念と文字列「1」のための「偽」と「真」真の概念について。実装は、字句表現の両方のスタイルをサポートしなければなりません。
<CODE BEGINS> file="defaults.xsd"
<CODEが始まる>ファイル= "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">
<？xml version = "1.0" エンコード= "UTF-8"？> <XS：スキーマのxmlns：XSの= "http://www.w3.org/2001/XMLSchema" のxmlns = "壷：IETF：のparams：XML ：NS：NETCONF：デフォルト：1.0" のtargetNamespace = "壷：IETF：のparams：XML：NS：NETCONF：デフォルト：1.0" のelementFormDefault = "資格" attributeFormDefault = "修飾されていない" XML：LANG = "EN">
<xs:annotation> <xs:documentation> This schema defines the syntax for the 'default' attribute described within this document. </xs:documentation> </xs:annotation>
<XS：注釈> <XS：ドキュメント>このスキーマは、この文書の中で説明「デフォルト」属性の構文を定義します。 </ XS：ドキュメンテーション> </ XS：注釈>
<!-- 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：属性名= "デフォルト" タイプ= "XS：ブール" デフォルト= "false" に> <XS：注釈> <XS：ドキュメント>この属性は、データノードは、によって表されるかどうかを示しますこの属性を含むXML要素は、既定のデータとサーバーによって考えられています。 「真」または「1」に設定した場合、データノードは、デフォルトのデータです。 「偽の」または「0」の場合、データノードは、データをデフォルトされていません。 </ XS：ドキュメンテーション> </ XS：注釈> </ XS：属性>
</xs:schema>
</ XS：スキーマ>
<CODE ENDS>
<CODEはENDS>
This document registers the following capability identifier URN in the 'Network Configuration Protocol (NETCONF) Capability URNs' registry:
この文書では、「ネットワーク構成プロトコル（NETCONF）能力壺」レジストリに次の機能識別子URNを登録します。
urn:ietf:params:netconf:capability:with-defaults:1.0
URN：IETF：のparams：NETCONF：機能：と-デフォルト：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：NETCONF：デフォルト：1.0
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults
URI：URN：IETF：のparams：XML：NS：ヤン：IETF-NETCONF-と、デフォルト
Registrant Contact: The NETCONF WG of the IETF.
登録者連絡先：IETFのNETCONF WG。
XML: N/A, the requested URIs are XML namespaces.
XML：N / A、要求されたURIは、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-と、デフォルト
prefix: ncwd
接頭辞：ncwd
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults
名前空間：URN：IETF：のparams：XML：NS：ヤン：IETF-NETCONF-と、デフォルト
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.
「は、デフォルトは」機能は、クライアントがNETCONFデータストアからデフォルトのデータの検索を制御できます。 [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.
このドキュメントへの重要なインプットを提供するためのマーティンBjorklund、シャロン・チザム、フィル・シェーファー、ユルゲンSchoenwaelder、ケントWatsen、Washamファン、およびNETCONF WGの多くの他のメンバーに感謝します。
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2119]ブラドナーの、S.、 "要件レベルを示すためにRFCsにおける使用のためのキーワード"、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]エンス、R.、編、Bjorklund、M.、編、Schoenwaelder、J.、編、及びA. Bierman、編、 "ネットワーク構成プロトコル（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]ブレイ、T.、パオリ、J.、Sperberg-マックィーン、C.、MALER、E.、およびF. Yergeau、 "拡張マークアップ言語（XML）1.0（第5版）"、 World Wide Web Consortium（W3C）の勧告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]フォールサイド、D.とP. Walmsley、 "XMLスキーマパート0：入門第二版"、World Wide Web Consortium（W3C）の勧告REC-XMLSCHEMA-0から20041028、2004年10月、<のhttp： //www.w3.org/TR/2004/REC-xmlschema-0-20041028>。
Appendix A. Usage Examples
付録A.使用例
A.1. Example YANG Module
A.1。例YANGモジュール
The following YANG module defines an example interfaces table to demonstrate how the <with-defaults> parameter behaves for a specific data model.
以下YANGモジュールは、< - デフォルト値を持つ>パラメータは特定のデータ・モデルにどのように動作するかを示すために、例えばインタフェーステーブルを定義します。
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項に定義された機能、-デフォルトでこのモジュールは、IANAに登録されてはならない、とのコードではないと考えられます成分。それは意図的に非常に簡潔で、そしていくつかの記述文を含んでいます。
module example {
モジュールの例{
namespace "http://example.com/ns/interfaces";
名前空間「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"; } }
長さは「1 ..マックス」。 }}
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;
}
}
}
}
A.2. Example Data Set
A.2。例データセット
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>
<MTU> 1500 </ MTU> <状態> </状態> </インターフェイス> </インターフェイス> </ 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 |
+--------------+--------------+--------------+
A.3. Protocol Operation Examples
A.3。プロトコルの動作例
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.
クライアントは、パラメータ<-デフォルトで>で濾過「インターフェース」オブジェクト内の全てのデータノードを取得しています。
A.3.1. <with-defaults> = 'report-all'
A.3.1。 <と、デフォルト値> =「レポート、すべての」
The behavior of the <with-defaults> parameter handling for the value 'report-all' is demonstrated in this example.
値「レポートのすべての」の取扱い<と、デフォルト設定>パラメータの動作は、この例で示されています。
<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メッセージID = "101" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：1.0"> <GET> <フィルタタイプ= "サブツリー"> <インターフェースのxmlnsは= "HTTP：//例.COM / NS /インターフェース "/> </フィルタ> <と、デフォルトのxmlns =" URN：IETF：paramsは：XML：NS：陽：IETF-NETCONF-WITH-デフォルト ">レポートすべての</と、デフォルト> </ GET> </ RPC>
<rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <data>
<RPC返信メッセージID = "101" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：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> </rpc-reply>
<インターフェイスのxmlns = "http://example.com/ns/interfaces"> <インターフェース> <名前>はeth0 </名前> <MTU> 8192 </ MTU> <状態>まで</ステータス> </インターフェイス> <インターフェイス> <名前> eth1の</名前> <MTU> 1500 </ MTU> <状態>まで</状態> </インターフェイス> <インターフェイス> <名前>のeth2 </名前> <MTU> 9000 </ MTU> <ステータス>感じていないので、良い</ステータス> </インターフェイス> <インターフェイス> <名前> ETH3 </名前> <MTU> 1500 </ MTU> <状態>目覚め</ステータス> </インターフェイス> </インタフェース> </データ> </ RPC返信>
A.3.2. <with-defaults> = 'report-all-tagged'
A.3.2。 <で、デフォルト値> =「報告書は、すべてのタグ付き」
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'.
「-すべてのタグ付きのレポート」の値のために取り扱い、<と、デフォルト設定>パラメータの動作は、この例で示されています。 「タグ付け」データノードは、「真」または「1」に設定し「デフォルト」のXML属性を、含む要素です。
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>
<RPCメッセージID = "102" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：1.0"> <GET> <フィルタタイプ= "サブツリー"> <インターフェースのxmlnsは= "HTTP：//例.COM / NS /インターフェース "/> </フィルタ>
<with-defaults xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"> report-all-tagged </with-defaults> </get> </rpc>
<と、デフォルトのxmlns = "壷：IETF：のparams：XML：NS：ヤン：IETF-NETCONF-と、デフォルトで">レポート - すべてのタグ<で、デフォルトは/> </取得> </ 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>
<RPC返信メッセージID = "102" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：1.0" のxmlns：WD = "URN：IETF：paramsは：XML：NS：NETCONF：デフォルト：1.0 "> <データ> <インターフェースのxmlns =" http://example.com/ns/interfaces "> <インターフェース> <名前>はeth0 </名前> <MTU> 8192 </ MTU> <状態WD：=デフォルト" 真">まで</状態> </インターフェイス> <インターフェイス> <名前> eth1の</名前> <MTU WD：デフォルト=" 真 "> 1500 </ MTU> <ステータスWD：デフォルト=" アップ>「真</状態> </インターフェイス> <インターフェイス> <名前>のeth2 </名前> <MTU> 9000 </ MTU> <状態> </ステータス> </インターフェイス> <インターフェイス> <名前> ETH3 </名あまり良く感じていません> <MTU WD：デフォルト= "真"> 1500 </ MTU> <状態> </状態> </インターフェイス> </インターフェイス> </データ> </ RPC-応答を目覚め>
A.3.3. <with-defaults> = 'trim'
A.3.3。 <と、デフォルト値> =「トリム」
The behavior of the <with-defaults> parameter handling for the value 'trim' is demonstrated in this example.
「トリム」値のために取り扱い、<と、デフォルト設定>パラメータの動作は、この例で示されています。
<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
<RPCメッセージID = "103" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：1.0"> <GET> <フィルタタイプ= "サブツリー"> <インターフェースのxmlnsは= "HTTP：//例.COM / NS /インターフェース "/> </フィルタ> <と、デフォルト
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"> trim </with-defaults> </get> </rpc>
xmlns = "壷：IETF：のparams：XML：NS：ヤン：IETF-NETCONF-と、デフォルト値"> </と、デフォルト> </ 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>
<RPC返信メッセージID = "103" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：1.0"> <データ> <インターフェースのxmlns = "http://example.com/ns/interfaces 「> <インターフェース> <名前>はeth0 </名前> <MTU> 8192 </ MTU> </インターフェイス> <インターフェース> <名前> eth1の</名前> </インターフェイス> <インターフェース> <名前>のeth2 </名前> <MTU> 9000 </ MTU> <状態>あまり良く感じていない</ステータス> </インターフェイス> <インターフェイス> <名前> ETH3 </名前> <状態> </ステータス> </インターフェイス> </目覚めインターフェイス> </データ> </ RPC返信>
A.3.4. <with-defaults> = 'explicit'
A.3.4。 <-デフォルト値を持つ> = '明示的な'
The behavior of the <with-defaults> parameter handling for the value 'explicit' is demonstrated in this example.
値に対して処理<有する-デフォルト>パラメータの挙動は、「明示的な」この例で実証されています。
<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メッセージID = "104" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：1.0"> <GET> <フィルタタイプ= "サブツリー"> <インターフェースのxmlnsは= "HTTP：//例.COM / NS /インターフェース "/> </フィルタ> <と、デフォルトのxmlns =" URN：IETF：paramsは：XML：NS：陽：IETF-NETCONF-WITH-デフォルト "> </と、デフォルト> </明示取得> </ 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>
<RPC返信メッセージID = "104" のxmlns = "URN：IETF：paramsは：XML：NS：NETCONF：塩基：1.0"> <データ> <インターフェースのxmlns = "http://example.com/ns/interfaces 「> <インターフェース> <名前>はeth0 </名前> <MTU> 8192 </ MTU> <状態>まで</ステータス>まで</インターフェイス> <インターフェイス> <名前> eth1の</名前> <状態> </状態> </インターフェイス> <インターフェイス> <名前>のeth2 </名前> <MTU> 9000 </ MTU> <状態> </ステータス> </インターフェイス> <インターフェイス> <名前> ETH3 </名あまり良く感じていません> <MTU> 1500 </ MTU> <状態> </状態> </インターフェイス> </インターフェイス> </データ> </ RPC-応答を目覚め>
Authors' Addresses
著者のアドレス
Andy Bierman Brocade
アンディBiermanブロケード
EMail: andy.bierman@brocade.com
メールアドレス：andy.bierman@brocade.com
Balazs Lengyel Ericsson Budapest, Hungary
ブダペスト、ハンガリー、ポーランドエリクソンバラージュ
EMail: balazs.lengyel@ericsson.com
メールアドレス：balazs.lengyel@ericsson.com