[要約] RFC 8819は、YANGモジュールにタグを付けるための標準を定義しています。このRFCの目的は、YANGモジュールを識別し、検索可能にすることです。YANGモジュールの管理や利用を効率化するための仕組みを提供しています。
Internet Engineering Task Force (IETF) C. Hopps
Request for Comments: 8819 L. Berger
Updates: 8407 LabN Consulting, L.L.C.
Category: Standards Track D. Bogdanovic
ISSN: 2070-1721 Volta Networks
January 2021
YANG Module Tags
ヤンモジュールタグ
Abstract
概要
This document provides for the association of tags with YANG modules. The expectation is for such tags to be used to help classify and organize modules. A method for defining, reading, and writing modules tags is provided. Tags may be registered and assigned during module definition, assigned by implementations, or dynamically defined and set by users. This document also provides guidance to future model writers; as such, this document updates RFC 8407.
この文書は、タグとYangモジュールの関連付けを提供します。期待は、そのようなタグを使用してモジュールを分類して整理するのに役立ちます。モジュールタグを定義、読み取り、書き込みするための方法が提供される。タグは、実装によって割り当てられている、またはユーザーによって動的に定義され設定されたモジュール定義中に登録され割り当てられます。この文書はまた、将来のモデル作家へのガイダンスを提供します。そのため、この文書はRFC 8407を更新します。
Status of This Memo
本文書の状態
This is an Internet Standards Track document.
これはインターネット規格のトラック文書です。
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.
この文書は、インターネットエンジニアリングタスクフォース（IETF）の製品です。IETFコミュニティのコンセンサスを表します。それは公開レビューを受け、インターネットエンジニアリングステアリンググループ（IESG）による出版の承認を受けました。インターネット規格に関する詳細情報は、RFC 7841のセクション2で利用できます。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc8819.
この文書の現在のステータス、任意のエラータ、およびフィードバックを提供する方法は、https://www.rfc-editor.org/info/frfc8819で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2021 IETF Trust and the persons identified as the document authors. All rights reserved.
著作権（C）2021 IETF信頼と文書著者として識別された人。全著作権所有。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
このドキュメントは、このドキュメントの発行日に有効なBCP 78およびIETFドキュメントに関連するIETFトラストの法的規定（https://trustee.ietf.org/license-info）の対象となります。 これらのドキュメントは、このドキュメントに関するお客様の権利と制限について説明しているため、注意深く確認してください。 このドキュメントから抽出されたコードコンポーネントには、Trust LegalProvisionsのセクション4.eで説明されているSimplifiedBSD Licenseテキストが含まれている必要があり、Simplified BSDLicenseで説明されているように保証なしで提供されます。
Table of Contents
目次
1. Introduction
1.1. Some Possible Use Cases for YANG Module Tags
1.2. Conventions Used in This Document
2. Tag Values
2.1. IETF Tags
2.2. Vendor Tags
2.3. User Tags
2.4. Reserved Tags
3. Tag Management
3.1. Module Definition Tagging
3.2. Implementation Tagging
3.3. User Tagging
4. Tags Module Structure
4.1. Tags Module Tree
4.2. YANG Module
5. Other Classifications
6. Guidelines to Model Writers
6.1. Define Standard Tags
7. IANA Considerations
7.1. YANG Module Tag Prefixes Registry
7.2. IETF YANG Module Tags Registry
7.3. Updates to the IETF XML Registry
7.4. Updates to the YANG Module Names Registry
8. Security Considerations
9. References
9.1. Normative References
9.2. Informative References
Appendix A. Examples
Appendix B. Non-NMDA State Module
Acknowledgements
Authors' Addresses
The use of tags for classification and organization is fairly ubiquitous not only within IETF protocols but in the internet itself (e.g., "#hashtags"). One benefit of using tags for organization over a rigid structure is that it is more flexible and can more easily adapt over time as technologies evolve. Tags can be usefully registered, but they can also serve as a non-registered mechanism available for users to define themselves. This document provides a mechanism to define tags and associate them with YANG modules in a flexible manner. In particular, tags may be registered as well as assigned during module definition, assigned by implementations, or dynamically defined and set by users.
分類および組織のためのタグの使用は、IETFプロトコル内ではなく、インターネット自体（例えば、「#HashTAGS」）内ではかなり普及しています。剛性構造を超えて組織化するためのタグを使用することの1つの利点は、それがより柔軟であり、技術が進化するにつれて経時的に適応することができるということです。タグは有用に登録することができますが、ユーザーが自分自身を定義するための登録されていないメカニズムとしても機能します。このドキュメントはタグを定義し、それらを柔軟な方法でyangモジュールと関連付けるためのメカニズムを提供します。特に、タグは、実装によって割り当てられた、または動的に定義されてユーザによって設定されたモジュール定義中に割り当てられているだけでなく、登録されてもよい。
This document defines a YANG module [RFC7950] that provides a list of module entries to allow for adding or removing tags as well as viewing the set of tags associated with a module.
このドキュメントは、タグを追加または削除するためのモジュールエントリのリストとモジュールに関連付けられているタグのセットを表示できるようにするYANGモジュール[RFC7950]を定義します。
This document defines an extension statement to indicate tags that SHOULD be added by the module implementation automatically (i.e., outside of configuration).
この文書は、モジュール実装によって自動的に追加されるべきタグを示すための拡張ステートメントを定義します（すなわち、構成外）。
This document also defines an IANA registry for tag prefixes as well as a set of globally assigned tags.
このドキュメントはまた、タグプレフィックスのIANAレジストリと、一連のグローバルに割り当てられたタグを定義しています。
Section 6 provides guidelines for authors of YANG data models.
セクション6はYangデータモデルの著者のためのガイドラインを提供します。
This document updates [RFC8407].
この文書は更新[RFC8407]を更新します。
The YANG data model in this document conforms to the Network Management Datastore Architecture (NMDA) defined in [RFC8342].
このドキュメントのYANGデータモデルは、[RFC8342]で定義されているネットワーク管理データストアアーキテクチャ（NMDA）に準拠しています。
During this document's development, there were requests for example uses of module tags. The following are a few example use cases for tags. This list is certainly not exhaustive.
このドキュメントの開発中に、例えばモジュールタグの使用要求がありました。以下はタグの使用例の例です。このリストは確かに網羅的ではありません。
One example use of tags would be to help filter different discrete categories of YANG modules supported by a device. For example, if modules are suitably tagged, then an XPath query can be used to list all of the vendor modules supported by a device.
タグの使用例は、デバイスによってサポートされているさまざまな個別のカテゴリのYangモジュールをフィルタリングするのを助けることです。たとえば、モジュールが適切にタグ付けされている場合は、デバイスでサポートされているすべてのベンダーモジュールをリストするためにXPathクエリを使用できます。
Tags can also be used to help coordination when multiple, semi-independent clients are interacting with the same devices. For example, one management client could mark that some modules should not be used because they have not been verified to behave correctly, so that other management clients avoid querying the data associated with those modules.
タグは、複数の半依存したクライアントが同じデバイスと対話しているときに調整を助けるためにも使用できます。たとえば、1つの管理クライアントは、他の管理クライアントがそれらのモジュールに関連付けられているデータに照会されないように、一部のモジュールを使用しないでください。
Tag classification is useful for users searching module repositories (e.g., YANG catalog). A query restricted to the 'ietf:routing' module tag could be used to return only the IETF YANG modules associated with routing. Without tags, a user would need to know the name of all the IETF routing protocol YANG modules.
タグ分類は、モジュールリポジトリを検索するユーザー（例えば、Yang Catalog）に役立ちます。'IETF：ルーティング'モジュールタグに制限されているクエリを使用して、ルーティングに関連付けられているIETF YANGモジュールのみを返すことができます。タグがないと、ユーザーはすべてのIETFルーティングプロトコルヤンモジュールの名前を知る必要があります。
Future management protocol extensions could allow for filtering queries of configuration or operational state on a server based on tags (for example, return all operational state related to system management).
将来の管理プロトコル拡張機能は、タグに基づいてサーバ上で構成または運用状態の照会をフィルタリングすることができる（たとえば、システム管理に関連するすべての運用状態を返す）。
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
この文書のキーワード "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", および "OPTIONAL" はBCP 14 [RFC2119] [RFC8174]で説明されているように、すべて大文字の場合にのみ解釈されます。
All tags SHOULD begin with a prefix indicating who owns their definition. An IANA registry (Section 7.1) is used to support registering tag prefixes. Currently, three prefixes are defined. No further structure is imposed by this document on the value following the registered prefix, and the value can contain any YANG type 'string' characters except carriage returns, newlines, and tabs.
すべてのタグは、誰が自分の定義を所有しているかを示すプレフィックスで始まります。IANAレジストリ（セクション7.1）は、タグプレフィックスの登録をサポートするために使用されます。現在、3つのプレフィックスが定義されています。登録されたプレフィックスに続く値にこの文書によってそれ以上の構造は課されず、キャリッジリターン、改行、タブ以外のyang type '文字列'文字を含むことができます。
Again, except for the conflict-avoiding prefix, this document is purposefully not specifying any structure on (i.e., restricting) the tag values. The intent is to avoid arbitrarily restricting the values that designers, implementers, and users can use. As a result of this choice, designers, implementers, and users are free to add or not add any structure they may require to their own tag values.
繰り返しますが、競合回避の接頭辞を除いて、この文書は意図的に、タグ値を任意の構造を特定していない（すなわち制限）。意図は、デザイナー、実装者、およびユーザーが使用できる値を任意に制限することを避けることです。この選択の結果として、デザイナー、実装者、およびユーザーは、自分のタグ値に必要な構造を追加または追加することはできません。
An IETF tag is a tag that has the prefix "ietf:". All IETF tags are registered with IANA in a registry defined later in this document (Section 7.2).
IETFタグは、「IETF：」という接頭辞を持つタグです。すべてのIETFタグは、このドキュメントで後で定義されたレジストリにIANAに登録されています（セクション7.2）。
A vendor tag is a tag that has the prefix "vendor:". These tags are defined by the vendor that implements the module and are not registered; however, it is RECOMMENDED that the vendor include extra identification in the tag to avoid collisions, such as using the enterprise or organization name following the "vendor:" prefix (e.g., vendor:example.com:vendor-defined-classifier).
ベンダータグは、プレフィックス "ベンダー："を持つタグです。これらのタグは、モジュールを実装して登録されていないベンダーによって定義されています。ただし、「ベンダー：」プレフィックスに続く企業名または組織名を使用するなどの衝突を回避するために、ベンダーに追加の識別を含めることをお勧めします。
A user tag is any tag that has the prefix "user:". These tags are defined by the user/administrator and are not meant to be registered. Users are not required to use the "user:" prefix; however, doing so is RECOMMENDED as it helps avoid collisions.
ユーザータグは、プレフィックス "user："を持つタグです。これらのタグは、ユーザー/管理者によって定義されており、登録されることを意味していません。ユーザーは "user："プレフィックスを使用する必要はありません。ただし、衝突を回避するのに役立つので、そうすることをお勧めします。
Any tag not starting with the prefix "ietf:", "vendor:", or "user:" is reserved for future use. These tag values are not invalid but simply reserved in the context of specifications (e.g., RFCs).
prefix "itetf："、 "vendor："、または "user："で始まっていないタグは、将来の使用のために予約されています。これらのタグ値は無効ではありませんが、仕様のコンテキストでは単に予約されています（たとえば、RFC）。
Tags can become associated with a module in a number of ways. Tags may be defined and associated at module design time, at implementation time, or via user administrative control. As the main consumer of tags are users, users may also remove any tag, no matter how the tag became associated with a module.
タグは、モジュールに関連してさまざまな方法で関連付けることができます。タグは、実装時に、またはユーザ管理制御を介して、モジュール設計時刻、またはモジュール設計時刻に関連付けられてもよい。タグの主な消費者がユーザーであるため、タグがモジュールにどのように関連付けられたかにかかわらず、ユーザーはタグを削除することもできます。
A module definition MAY indicate a set of tags to be added by the module implementer. These design-time tags are indicated using the module-tag extension statement.
モジュール定義は、モジュール実装者によって追加されるタグのセットを示すことができる。これらの設計時タグは、module-tag拡張ステートメントを使用して示されています。
If the module is defined in an IETF Standards Track document, the tags MUST be IETF tags (Section 2.1). Thus, new modules can drive the addition of new IETF tags to the IANA registry defined in Section 7.2, and the IANA registry can serve as a check against duplication.
モジュールがIETF標準トラック文書で定義されている場合、タグはIETFタグでなければなりません（セクション2.1）。したがって、新しいモジュールは、セクション7.2で定義されているIANAレジストリに新しいIETFタグを追加することができ、IANAレジストリは複製に対するチェックとして機能します。
An implementation MAY include additional tags associated with a module. These tags SHOULD be IETF tags (i.e., registered) or vendor-specific tags.
実装は、モジュールに関連付けられている追加のタグを含み得る。これらのタグは、IETFタグ（すなわち、登録）またはベンダ固有のタグである必要があります。
Tags of any kind, with or without a prefix, can be assigned and removed by the user using normal configuration mechanisms. In order to remove a tag from the operational datastore, the user adds a matching "masked-tag" entry for a given module.
プレフィックスの有無にかかわらず、通常の設定メカニズムを使用してユーザーが割り当てて削除することができます。オペレーショナルデータストアからタグを削除するために、ユーザーは特定のモジュールに対して一致する「マスクタグ」エントリを追加します。
The tree associated with the "ietf-module-tags" module follows. The meaning of the symbols can be found in [RFC8340].
"ietf-module-tags"モジュールに関連付けられているツリーは続きます。シンボルの意味は[RFC8340]にあります。
module: ietf-module-tags
+--rw module-tags
+--rw module* [name]
+--rw name yang:yang-identifier
+--rw tag* tag
+--rw masked-tag* tag
Figure 1: YANG Module Tags Tree Diagram
図1：ヤンモジュールタグツリー図
<CODE BEGINS> file "ietf-module-tags@2021-01-04.yang"
module ietf-module-tags {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-module-tags";
prefix tags;
import ietf-yang-types {
prefix yang;
}
organization
"IETF NetMod Working Group (NetMod)";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org>
Author: Christian Hopps
<mailto:chopps@chopps.org>
Author: Lou Berger
<mailto:lberger@labn.net>
Author: Dean Bogdanovic
<mailto:ivandean@gmail.com>";
description "This module describes a mechanism associating tags with YANG modules. Tags may be IANA assigned or privately defined.
説明 "このモジュールは、タグをYangモジュールと関連付けるメカニズムを説明しています。タグは、IANAが割り当てられているか、または個人的に定義されている可能性があります。
Copyright (c) 2021 IETF Trust and the persons identified as authors of the code. All rights reserved.
著作権（c）2021 IETF信頼とコードの著者として識別された人。全著作権所有。
Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info).
修正の有無にかかわらず、ソースおよびバイナリ形式での再配布と使用は、IETF文書に関連するIETF信託の法的規定のセクション4.Cに記載されている単純化されたBSDライセンスに従い、身に付けられたライセンス条項に従って許可されています（https://trustee.ietf.org/License-info）。
This version of this YANG module is part of RFC 8819 (https://www.rfc-editor.org/info/rfc8819); see the RFC itself for full legal notices.
このYangモジュールのこのバージョンはRFC 8819（https://www.rfc-editor.org/info/rfc8819）の一部です。完全な法的通知のためにRFC自体を参照してください。
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here.";
キーワードは「必須」、「必須」、「shall」、「shall '、'は '、'は '、'推奨 '、'推奨されていない '、' may '、'任意のものではありません。'この文書では、ここに示すように、BCP 14（RFC 2119）（RFC 8174）（RFC 8174）に記載されているように解釈されるべきです。
revision 2021-01-04 {
description
"Initial revision.";
reference
"RFC 8819: YANG Module Tags";
}
typedef tag {
type string {
length "1..max";
pattern '[\S ]+';
}
description
"A tag is a type of 'string' value that does not include
carriage return, newline, or tab characters. It SHOULD begin
with a registered prefix; however, tags without a registered
prefix SHOULD NOT be treated as invalid.";
}
extension module-tag {
argument tag;
description
"The argument 'tag' is of type 'tag'. This extension statement
is used by module authors to indicate the tags that SHOULD be
added automatically by the system. As such, the origin of the
value for the predefined tags should be set to 'system'
[RFC8342].";
}
container module-tags {
description
"Contains the list of modules and their associated tags.";
list module {
key "name";
description
"A list of modules and their associated tags.";
leaf name {
type yang:yang-identifier;
mandatory true;
description
"The YANG module name.";
}
leaf-list tag {
type tag;
description
"Tags associated with the module. See the IANA 'YANG
Module Tag Prefixes' registry for reserved prefixes and
the IANA 'IETF YANG Module Tags' registry for IETF tags.
The 'operational' state [RFC8342] view of this list is constructed using the following steps:
このリストの「演算」状態[RFC8342]ビューは、次の手順で構築されています。
1) System tags (i.e., tags of 'system' origin) are added.
2) User-configured tags (i.e., tags of 'intended' origin)
are added.
3) Any tag that is equal to a masked-tag is removed.";
}
leaf-list masked-tag {
type tag;
description
"The list of tags that should not be associated with this
module. The user can remove (mask) tags from the
operational state datastore [RFC8342] by adding them to
this list. It is not an error to add tags to this list
that are not associated with the module, but they have no
operational effect.";
}
}
}
}
<CODE ENDS>
Figure 2: Module Tags Module
図2：モジュールタグモジュール
It is worth noting that a different YANG module classification document exists [RFC8199]. That document only classifies modules in a logical manner and does not define tagging or any other mechanisms. It divides YANG modules into two categories (service or element) and then into one of three origins: standard, vendor, or user. It does provide a good way to discuss and identify modules in general. This document defines IETF tags to support the classification style described in [RFC8199].
異なるヤンモジュール分類文書が存在することが存在する価値がある[RFC8199]。その文書は、モジュールを論理的に分類し、タグ付けまたは他のメカニズムを定義しません。Yangモジュールを2つのカテゴリ（サービスまたは要素）に分割し、次に標準、ベンダー、またはユーザーの3つの起源のうちの1つに分割します。それは一般的にモジュールを議論し識別するための良い方法を提供します。このドキュメントは[RFC8199]で説明されている分類スタイルをサポートするためのIETFタグを定義しています。
This section updates [RFC8407].
このセクションは[RFC8407]を更新します。
A module MAY indicate, using module-tag extension statements, a set of tags that are to be automatically associated with it (i.e., not added through configuration).
モジュールは、module-tag拡張ステートメントを使用して、自動的に関連付けられているタグのセット（すなわち、設定によっては追加されていない）を示すことができる。
module example-module {
namespace "https://example.com/yang/example";
prefix "ex";
//...
import module-tags { prefix tags; }
tags:module-tag "ietf:some-new-tag";
tags:module-tag "ietf:some-other-tag";
// ...
}
The module writer can use existing standard tags or use new tags defined in the model definition, as appropriate. For IETF standardized modules, new tags MUST be assigned in the IANA registry defined below, see Section 7.2.
モジュールライターは既存の標準タグを使用することも、必要に応じてモデル定義で定義されている新しいタグを使用できます。IETF標準化されたモジュールの場合、新しいタグを以下に定義したIANAレジストリに割り当てる必要があります。セクション7.2を参照してください。
IANA has created the "YANG Module Tag Prefixes" subregistry in the "YANG Module Tags" registry.
IANAは「YANG MODULE TAG」レジストリに「YANG MODULE TAGプレフィックス」サブレジストを作成しました。
This registry allocates tag prefixes. All YANG module tags SHOULD begin with one of the prefixes in this registry.
このレジストリはタグのプレフィックスを割り当てます。すべてのYANGモジュールタグは、このレジストリ内のプレフィックスの1つで始める必要があります。
Prefix entries in this registry should be short strings consisting of lowercase ASCII alpha-numeric characters and a final ":" character.
このレジストリ内のプレフィックスエントリは、小文字のASCIIアルファ数字と最後の "："文字で構成される短い文字列です。
The allocation policy for this registry is Specification Required [RFC8126]. The Reference and Assignee values should be sufficient to identify and contact the organization that has been allocated the prefix.
このレジストリの割り当てポリシーは指定されました[RFC8126]。参照および担当者の値は、接頭辞を割り当てられている組織を識別して連絡するのに十分です。
The initial values for this registry are as follows.
このレジストリの初期値は次のとおりです。
+=========+========================+===========+==========+
| Prefix | Description | Reference | Assignee |
+=========+========================+===========+==========+
| ietf: | IETF tags allocated in | RFC 8819 | IETF |
| | the IANA "IETF YANG | | |
| | Module Tags" registry. | | |
+---------+------------------------+-----------+----------+
| vendor: | Non-registered tags | RFC 8819 | IETF |
| | allocated by the | | |
| | module implementer. | | |
+---------+------------------------+-----------+----------+
| user: | Non-registered tags | RFC 8819 | IETF |
| | allocated by and for | | |
| | the user. | | |
+---------+------------------------+-----------+----------+
Table 1
表1
Other standards development organizations (SDOs) wishing to allocate their own set of tags should allocate a prefix from this registry.
自分のタグのセットを割り当てることを望む他の標準開発組織（SDO）は、このレジストリからプレフィックスを割り当てる必要があります。
IANA has created the "IETF YANG Module Tags" subregistry within the "YANG Module Tags" registry . This registry appears below the "YANG Module Tag Prefixes" registry.
IANAは、「YANG MODULE TAG」レジストリ内に「IETF YANGモジュールタグ」サブレイストを作成しました。このレジストリは、「yang moduleタグの接頭辞」レジストリの下に表示されます。
This registry allocates tags that have the registered prefix "ietf:". New values should be well considered and not achievable through a combination of already existing IETF tags. IANA assigned tags must conform to Net-Unicode as defined in [RFC5198], and they shall not need normalization.
このレジストリは、登録されているプレフィックス "itetf："を持つタグを割り当てます。新しい値は、既存のIETFタグの組み合わせを通じて、新しい値がよく考慮されるべきであり、達成できません。割り当てられたタグは、[RFC5198]で定義されているようにNet-Unicodeに準拠しており、それらは正規化を必要としません。
The allocation policy for this registry is IETF Review [RFC8126].
このレジストリの割り当てポリシーはIETFレビュー[RFC8126]です。
The initial values for this registry are as follows.
このレジストリの初期値は次のとおりです。
+============================+=======================+===========+
| Tag | Description | Reference |
+============================+=======================+===========+
| ietf:network-element-class | Network element as | [RFC8199] |
| | defined in [RFC8199]. | |
+----------------------------+-----------------------+-----------+
| ietf:network-service-class | Network service as | [RFC8199] |
| | defined in [RFC8199]. | |
+----------------------------+-----------------------+-----------+
| ietf:sdo-defined-class | Module is defined by | [RFC8199] |
| | a standards | |
| | organization. | |
+----------------------------+-----------------------+-----------+
| ietf:vendor-defined-class | Module is defined by | [RFC8199] |
| | a vendor. | |
+----------------------------+-----------------------+-----------+
| ietf:user-defined-class | Module is defined by | [RFC8199] |
| | the user. | |
+----------------------------+-----------------------+-----------+
| ietf:hardware | Relates to hardware | RFC 8819 |
| | (e.g., inventory). | |
+----------------------------+-----------------------+-----------+
| ietf:software | Relates to software | RFC 8819 |
| | (e.g., installed OS). | |
+----------------------------+-----------------------+-----------+
| ietf:protocol | Represents a protocol | RFC 8819 |
| | (often combined with | |
| | another tag to | |
| | refine). | |
+----------------------------+-----------------------+-----------+
| ietf:qos | Relates to quality of | RFC 8819 |
| | service. | |
+----------------------------+-----------------------+-----------+
| ietf:network-service-app | Relates to a network | RFC 8819 |
| | service application | |
| | (e.g., an NTP server, | |
| | DNS server, DHCP | |
| | server, etc.). | |
+----------------------------+-----------------------+-----------+
| ietf:system-management | Relates to system | RFC 8819 |
| | management (e.g., a | |
| | system management | |
| | protocol such as | |
| | syslog, TACAC+, SNMP, | |
| | NETCONF, etc.). | |
+----------------------------+-----------------------+-----------+
| ietf:oam | Relates to | RFC 8819 |
| | Operations, | |
| | Administration, and | |
| | Maintenance (e.g., | |
| | BFD). | |
+----------------------------+-----------------------+-----------+
| ietf:routing | Relates to routing. | RFC 8819 |
+----------------------------+-----------------------+-----------+
| ietf:security | Related to security. | RFC 8819 |
+----------------------------+-----------------------+-----------+
| ietf:signaling | Relates to control- | RFC 8819 |
| | plane signaling. | |
+----------------------------+-----------------------+-----------+
| ietf:link-management | Relates to link | RFC 8819 |
| | management. | |
+----------------------------+-----------------------+-----------+
Table 2
表2.
This document registers a URI in the "IETF XML Registry" [RFC3688]. Following the format in [RFC3688], the following registrations have been made:
このドキュメントは「IETF XMLレジストリ」[RFC3688]にURIを登録します。[RFC3688]の形式に従って、次の登録が行われました。
URI: urn:ietf:params:xml:ns:yang:ietf-module-tags Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace.
URI：URN：IETF：PARAMS：XML：NS：yang：ietf-module-tags登録者連絡先：IESG。XML：n / a;要求されたURIはXMLネームスペースです。
URI: urn:ietf:params:xml:ns:yang:ietf-module-tags-state Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace.
URI：URN：IETF：PARAMS：XML：NS：YANG：yeetf-module-tags-state登録者連絡先：IESG。XML：n / a;要求されたURIはXMLネームスペースです。
This document registers two YANG modules in the "YANG Module Names" registry [RFC6020]. Following the format in [RFC6020], the following registrations have been made:
このドキュメントでは、「Yang Module Names」レジストリ[RFC6020]に2つのYANGモジュールを登録します。[RFC6020]の形式に従って、次の登録が行われました。
name: ietf-module-tags
namespace: urn:ietf:params:xml:ns:yang:ietf-module-tags
prefix: tags
reference: RFC 8819
name: ietf-module-tags-state
namespace: urn:ietf:params:xml:ns:yang:ietf-module-tags-state
prefix: tags-s
reference: RFC 8819
The YANG module defined in this memo is designed to be accessed via the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the secure transport layer and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242].
このメモに定義されているYangモジュールは、NetConfプロトコル[RFC6241]を介してアクセスするように設計されています。最低のNetConfレイヤはセキュアトランスポート層で、必須のSecure TransportはSecure Shell（SSH）[RFC6242]です。
This document adds the ability to associate tag metadata with YANG modules. This document does not define any actions based on these associations, and none are yet defined; therefore, it does not by itself introduce any new security considerations directly.
この文書は、タグメタデータをYANGモジュールに関連付ける機能を追加します。この文書は、これらの関連付けに基づくアクションを定義していないため、まだ定義されていません。したがって、それ自体では新しいセキュリティ上の考慮事項を直接導入することはありません。
Users of the tag metadata may define various actions to be taken based on the tag metadata. These actions and their definitions are outside the scope of this document. Users will need to consider the security implications of any actions they choose to define, including the potential for a tag to get 'masked' by another user.
タグメタデータのユーザは、タグメタデータに基づいて撮影されるさまざまなアクションを定義することができます。これらの行動とその定義はこの文書の範囲外です。ユーザーは、タグが「マスクされている」を別のユーザーに入手する可能性を含め、定義することを選択する任意の行動のセキュリティの影響を検討する必要があります。
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>.
[RFC2119] BRADNER、S、「RFCSで使用するためのキーワード」、BCP 14、RFC 2119、DOI 10.17487 / RFC2119、1997年3月、<https：//www.rfc-editor.org/info/RFC2119>。
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, <https://www.rfc-editor.org/info/rfc7950>.
[RFC7950] Bjorklund、M.、ED。、「Yang 1.1データモデリング言語」、RFC 7950、DOI 10.17487 / RFC7950、2016年8月、<https://www.rfc-editor.org/info/rfc7950>。
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 8126, DOI 10.17487/RFC8126, June 2017, <https://www.rfc-editor.org/info/rfc8126>.
[RFC8126]綿、M.、Leiba、B.およびT.Narten、「RFCSのIANAに関する考察のためのガイドライン」、BCP 26、RFC 8126、DOI 10.17487 / RFC8126、2017年6月、<HTTPS：// WWW.rfc-editor.org / info / rfc8126>。
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8174] Leiba、B、「RFC 2119キーワードの大文字の曖昧さ」、BCP 14、RFC 8174、DOI 10.17487 / RFC8174、2017年5月、<https：//www.rfc-editor.org/info/RFC8174>。
[RFC8199] Bogdanovic, D., Claise, B., and C. Moberg, "YANG Module Classification", RFC 8199, DOI 10.17487/RFC8199, July 2017, <https://www.rfc-editor.org/info/rfc8199>.
[RFC8199] Bogdanovic、D.、Claise、B.、およびC. Moberg、 "Yang Module Classification"、RFC 8199、DOI 10.17487 / RFC8199、2017年7月、<https：//www.rfc-editor.org/info/RFC8199>。
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, <https://www.rfc-editor.org/info/rfc8342>.
[RFC8342] Bjorklund、M.、Schoenwaelder、J.、Shafer、P.、Watsen、K.、R. Wilton、「ネットワーク管理データストアアーキテクチャ（NMDA）」、RFC 8342、DOI 10.17487 / RFC8342、2018年3月、<https://www.rfc-editor.org/info/rfc8342>。
[RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models", BCP 216, RFC 8407, DOI 10.17487/RFC8407, October 2018, <https://www.rfc-editor.org/info/rfc8407>.
[RFC8407] Bierman、A。、「ヤンデータモデルを含む文書の査読者のためのガイドライン」、BCP 216、RFC 8407、DOI 10.17487 / RFC8407、2018年10月、<https：//www.rfc-editor.org/info/ RFC8407>。
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, <https://www.rfc-editor.org/info/rfc3688>.
[RFC3688] Mealling、M.、 "The IETF XMLレジストリ"、BCP 81、RFC 3688、DOI 10.17487 / RFC3688、2004年1月、<https：//www.rfc-editor.org/info/rfc3688>。
[RFC5198] Klensin, J. and M. Padlipsky, "Unicode Format for Network Interchange", RFC 5198, DOI 10.17487/RFC5198, March 2008, <https://www.rfc-editor.org/info/rfc5198>.
[RFC5198] Klensin、J.およびM. Pidlipsky、「ネットワークインターチェンジのためのUnicode Format」、RFC 5198、DOI 10.17487 / RFC5198、2008年3月、<https：//www.rfc-editor.org/info/rfc5198>。
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, <https://www.rfc-editor.org/info/rfc6020>.
[RFC6020] Bjorklund、M.、Ed。、「Yang - ネットワーク構成プロトコルのデータモデリング言語（NetConf）」、RFC 6020、DOI 10.17487 / RFC6020、2010年10月、<https：//www.rfc-編集者。org / info / rfc6020>。
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, <https://www.rfc-editor.org/info/rfc6241>.
[RFC6241]、R.Bjorklund、M.、Ed。、Schoenwaelder、J.、Ed。、およびA. Bierman、ED。、「ネットワーク構成プロトコル（NetConf）」、RFC 6241、DOI 10.17487 /RFC6241、2011年6月、<https://www.rfc-editor.org/info/rfc6241>。
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, <https://www.rfc-editor.org/info/rfc6242>.
[RFC6242] Wasserman、M.、「Secure Shell（SSH）のNetConfプロトコル（SSH）の使用（SSH）、RFC 6242、DOI 10.17487 / RFC6242、2011年6月、<https://www.rfc-editor.org/info/rfc6242>。
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, <https://www.rfc-editor.org/info/rfc8340>.
[RFC8340] Bjorklund、M.およびL. Berger、Ed。、「Yang Tree Diagress」、BCP 215、RFC 8340、DOI 10.17487 / RFC8340、2018年3月、<https：//www.rfc-editor.org/info/RFC8340>。
The following is a fictional NETCONF example result from a query of the module tags list. For the sake of brevity, only a few module results are shown.
以下は、モジュールタグリストのクエリからのFictional NetConfの例の結果です。簡潔にするために、いくつかのモジュール結果のみが示されています。
<ns0:data xmlns:ns0="urn:ietf:params:xml:ns:netconf:base:1.0">
<t:module-tags
xmlns:t="urn:ietf:params:xml:ns:yang:ietf-module-tags">
<t:module>
<t:name>ietf-bfd</t:name>
<t:tag>ietf:network-element-class</t:tag>
<t:tag>ietf:oam</t:tag>
<t:tag>ietf:protocol</t:tag>
<t:tag>ietf:sdo-defined-class</t:tag>
</t:module>
<t:module>
<t:name>ietf-isis</t:name>
<t:tag>ietf:network-element-class</t:tag>
<t:tag>ietf:protocol</t:tag>
<t:tag>ietf:sdo-defined-class</t:tag>
<t:tag>ietf:routing</t:tag>
</t:module>
<t:module>
<t:name>ietf-ssh-server</t:name>
<t:tag>ietf:network-element-class</t:tag>
<t:tag>ietf:protocol</t:tag>
<t:tag>ietf:sdo-defined-class</t:tag>
<t:tag>ietf:system-management</t:tag>
</t:module>
</t:module-tags>
</ns0:data>
Figure 3: Example NETCONF Query Output
図3：NetConfクエリ出力の例
As per [RFC8407], the following is a non-NMDA module to support viewing the operational state for non-NMDA compliant servers.
[RFC8407]に従って、NMDA以外の準拠サーバーの操作状態の表示をサポートするための非NMDAモジュールです。
<CODE BEGINS> file "ietf-module-tags-state@2021-01-04.yang"
module ietf-module-tags-state {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-module-tags-state";
prefix tags-s;
import ietf-yang-types {
prefix yang;
}
import ietf-module-tags {
prefix tags;
}
organization
"IETF NetMod Working Group (NetMod)";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org>
Author: Christian Hopps
<mailto:chopps@chopps.org>
Author: Lou Berger
<mailto:lberger@labn.net>
Author: Dean Bogdanovic
<mailto:ivandean@gmail.com>";
description "This module describes a mechanism associating tags with YANG modules. Tags may be IANA assigned or privately defined.
説明 "このモジュールは、タグをYangモジュールと関連付けるメカニズムを説明しています。タグは、IANAが割り当てられているか、または個人的に定義されている可能性があります。
This is a temporary non-NMDA module that is for use by implementations that don't yet support NMDA.
これは、まだNMDAをサポートしていない実装で使用するための一時的なNMDAモジュールです。
Copyright (c) 2021 IETF Trust and the persons identified as authors of the code. All rights reserved.
著作権（c）2021 IETF信頼とコードの著者として識別された人。全著作権所有。
Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info).
修正の有無にかかわらず、ソースおよびバイナリ形式での再配布と使用は、IETF文書に関連するIETF信託の法的規定のセクション4.Cに記載されている単純化されたBSDライセンスに従い、身に付けられたライセンス条項に従って許可されています（https://trustee.ietf.org/License-info）。
This version of this YANG module is part of RFC 8819
(https://www.rfc-editor.org/info/rfc8819); see the RFC itself
for full legal notices.";
revision 2021-01-04 {
description
"Initial revision.";
reference
"RFC 8819: YANG Module Tags";
}
container module-tags-state {
config false;
status deprecated;
description
"Contains the list of modules and their associated tags.";
list module {
key "name";
status deprecated;
description
"A list of modules and their associated tags.";
leaf name {
type yang:yang-identifier;
mandatory true;
status deprecated;
description
"The YANG module name.";
}
leaf-list tag {
type tags:tag;
status deprecated;
description
"Tags associated with the module. See the IANA 'YANG
Module Tag Prefixes' registry for reserved prefixes and
the IANA 'IETF YANG Module Tags' registry for IETF tags.
The contents of this list is constructed using the following steps:
このリストの内容は、次の手順で構築されています。
1) System tags (i.e., tags of added by the system) are
added.
2) User-configured tags (i.e., tags added by
configuration) are added.
3) Any tag that is equal to a masked-tag present in the
corresponding ietf-module-tags:module-tags:module-tag leaf
list for this module is removed.";
}
}
}
}
<CODE ENDS>
Figure 4: Non-NMDA Module Tags State Module
図4：NMDA非NMDAモジュールタグ状態モジュール
Acknowledgements
謝辞
Special thanks to Robert Wilton for his help improving the introduction and providing the example use cases, as well as generating the non-NMDA module.
Robert Wiltonのおかげで、紹介を改善し、ユースケースの例を提供するだけでなく、非NMDAモジュールを生成しています。
Authors' Addresses
著者の住所
Christian Hopps LabN Consulting, L.L.C.
クリスチャンHopps Labn Consulting、L.L.c。
Email: chopps@chopps.org
Lou Berger LabN Consulting, L.L.C.
Lou Berger Labn Consulting、L.C.
Email: lberger@labn.net
Dean Bogdanovic Volta Networks
Dean Bogdanovic Voltaネットワーク
Email: ivandean@gmail.com