RFC 5249 - Templates for Internet-Drafts Containing MIB Modules 日本語訳

URL : https://tools.ietf.org/html/rfc5249
タイトル : RFC 5249 - MIBモジュールを含むインターネットドラフトのテンプレート
翻訳編集 : 自動生成

Network Working Group                                 D. Harrington, Ed.
Request for Comments: 5249                     Huawei Technologies (USA)
BCP: 139                                                       July 2008
Category: Best Current Practice

          Templates for Internet-Drafts Containing MIB Modules

Status of This Memo

このメモのステータス

This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Distribution of this memo is unlimited.

このドキュメントはインターネットコミュニティのためのインターネットBest Current Practicesを指定し、改善のための議論と提案を要求します。このメモの配布は無制限です。

Abstract

抽象

This memo references three annotated templates for IETF documents that contain the definition of MIB modules. It is intended to reduce the work of the editors of such documents, making these documents more uniform and easier to read and review, thus furthering the quality of such documents and expediting their publication.

このメモはMIBモジュールの定義が含まれているIETF文書のための3つの注釈付きのテンプレートを参照します。このような文書の品質を進めるとその公表を迅速、これらの文書は、より均一で読み、レビューしやすくなって、そのような文書の編集者の仕事を減少させることを意図しています。

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . 2
   2.  Overview  . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
   3.  Security Considerations . . . . . . . . . . . . . . . . . . . . 3
   4.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . . . 3
   5.  Normative References  . . . . . . . . . . . . . . . . . . . . . 3

1. Introduction

1. はじめに

This memo references three annotated templates for IETF documents that contain the definition of MIB modules. It is intended to reduce the work of the editors of such documents, making these more uniform and easier to read and review, thus furthering the quality of such documents and expediting their publication.

このメモはMIBモジュールの定義が含まれているIETF文書のための3つの注釈付きのテンプレートを参照します。このような文書の品質を進めるとその公表を迅速、読み、確認するには、これらのより均一かつ容易に行うこと、そのような文書の編集者の仕事を減少させることを意図しています。

2. Overview

2.概要

The MIB Doctors directorate has produced three templates specifically aimed at Internet-Drafts containing MIB modules. The templates are available at the IETF Tools web site, listed as "Templates for MIB Documents".

MIB医師の理事は、具体的にはMIBモジュールを含むインターネットドラフトに向けた3つのテンプレートを作成しました。テンプレートには、「MIBドキュメントのテンプレート」として記載されているIETFツールWebサイトにてご利用いただけます。

o The first is an XML template for editors that use XML2RFC. Some advice echoing guidelines from RFC 4181 is embedded in comments.

O最初はXML2RFCを使用する編集者のためのXMLテンプレートがあります。 RFC 4181からのガイドラインをエコーいくつかのアドバイスは、コメント中に埋め込まれています。

o A second template is a text template for MIB documents with advice embedded in the document.

O 2番目のテンプレートは、文書内に埋め込まれたアドバイスとMIBドキュメントのテキストテンプレートです。

o A third template is a plain text template with no advice included.

第三テンプレートoをなし助言とプレーンテキストのテンプレートが含まれています。

The templates were developed to make IETF documents that contain MIB modules more consistent. This makes it easier for a MIB Doctor and other IETF participants to review the document. There are a number of MUSTs in the templates, especially in the advice; these usually refer to IESG requirements for Internet-Drafts, and MIB Doctors are likely to check for these requirements.

テンプレートはMIBモジュールは、より一貫性の含まれているIETF文書を作るために開発されました。これはMIB医師と他のIETFの参加者が文書をレビューすることが容易になります。テンプレート内のマストの数は特にアドバイスにあります。これらは通常、インターネットドラフトのためのIESG要件を参照して、MIB医師は、これらの要件をチェックする可能性があります。

The templates contain boilerplates that are required for IETF MIB module documents. It has been common practice for editors to use existing MIB module documents as templates. This approach has problems because boilerplates and other required elements change over time. The templates referenced by this document will be made available on the IETF Tools web site, and occasionally updated to reflect the latest requirements. The most up-to-date revisions of the templates are available at http://www.tools.ietf.org.

テンプレートは、IETF MIBモジュールドキュメントのために必要とされるボイラープレートが含まれています。これは、テンプレートとして既存のMIBモジュールのドキュメントを使用するには、編集者のために一般的でした。ボイラープレートおよび他の必要な要素は、時間の経過とともに変化するので、このアプローチには問題があります。このドキュメントで参照されるテンプレートは、IETFツールWebサイト上で利用可能、そして時折、最新の要件を反映するように更新されます。テンプレートの最新の改正はhttp://www.tools.ietf.orgでご利用いただけます。

The templates contain sections that describe the purpose and organization of the MIB module, and the relationship between this MIB module and other MIB modules. This makes it easier for MIB Doctors to understand the MIB module, which speeds the review process.

テンプレートには、目的や組織MIBモジュールの、このMIBモジュールと他のMIBモジュール間の関係を説明するセクションが含まれています。これは、それが簡単にMIB医師がレビュープロセスを高速化MIBモジュールを、理解できるようになります。

Editors should read RFC 4181 "Guidelines for Authors and Reviewers of MIB Documents" [RFC4181], which describes best current practices for MIB module document editing.

編集者はMIBモジュールの文書編集のために最良の現在のプラクティスについて説明[RFC4181]「ガイドライン著者と査読MIBのドキュメントのための」RFC 4181を、お読みください。

The document templates do not include a template for the MIB module itself. Tools to validate MIB modules typically require that the MIB module be separated from the surrounding document. The MIB Doctors feel that the simplest approach is to develop the MIB module outside the document that contains the surrounding text, and then include the MIB module into the surrounding document written using the templates.

文書テンプレートはMIBモジュール自体のテンプレートが含まれていません。 MIBモジュールを検証するためのツールは、典型的には、MIBモジュールは、周囲のドキュメントから分離されることを必要とします。 MIB医師は、最も簡単な方法は、周囲のテキストを含む文書の外にMIBモジュールを開発して、テンプレートを使用して書かれた周囲の文書にMIBモジュールを含めることであると感じています。

3. Security Considerations

3.セキュリティの考慮事項

This memo recommends templates for editing; it has no direct impact on network security. The templates include boilerplates and associated advice for writing the Security Considerations section of an Internet-Draft that documents a MIB module.

このメモは、編集用のテンプレートをお勧めします。それは、ネットワークセキュリティに直接的な影響を及ぼしません。テンプレートは、ボイラープレートおよびMIBモジュールを文書化するインターネットドラフトのSecurity Considerations部を記述するための関連したアドバイスが含まれています。

4. Contributors

4.協力者

These templates are based on contributions from the MIB Doctors, especially Juergen Schoenwaelder, Dave Perkins, C.M. Heard, and Randy Presuhn.

これらのテンプレートは、MIB医師、特にユルゲンSchoenwaelder、デーヴパーキンス、C.M。からの貢献に基づいています聞いて、ランディPresuhn。

5. Normative References

5.引用規格

[RFC4181] Heard, C., "Guidelines for Authors and Reviewers of MIB Documents", BCP 111, RFC 4181, September 2005.

[RFC4181]聞いた、C.、 "MIBドキュメントの著者と査読のためのガイドライン"、BCP 111、RFC 4181、2005年9月。

Author's Address

著者のアドレス

David Harrington (editor) Huawei Technologies (USA) 1700 Alma Drive, Suite 100 Plano, TX 75075 USA

デヴィッド・ハリントン（エディタ）華為技術（USA）1700アルマドライブ、スイート100プラノ、TX 75075 USA

Phone: +1 603 436 8634 EMail: dharrington@huawei.com

電話：+1 603 436 8634 Eメール：dharrington@huawei.com

Full Copyright Statement

完全な著作権声明

著作権（C）IETFトラスト（2008）。

This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.

この文書では、BCP 78に含まれる権利と許可と制限の適用を受けており、その中の記載を除いて、作者は彼らのすべての権利を保有します。

This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

この文書とここに含まれている情報は、基礎とCONTRIBUTOR「そのまま」、ORGANIZATION HE / SHEが表すまたはインターネットSOCIETY、（もしあれば）を後援し、IETF TRUST ANDインターネットエンジニアリングタスクフォース放棄ALLに設けられています。保証は、明示または黙示、この情報の利用および特定目的に対する権利または商品性または適合性の黙示の保証を侵害しない任意の保証がこれらに限定されません。

Intellectual Property

知的財産

The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.

IETFは、本書またはそのような権限下で、ライセンスがたりないかもしれない程度に記載された技術の実装や使用に関係すると主張される可能性があります任意の知的財産権やその他の権利の有効性または範囲に関していかなる位置を取りません利用可能です。またそれは、それがどのような権利を確認する独自の取り組みを行ったことを示すものでもありません。 RFC文書の権利に関する手続きの情報は、BCP 78およびBCP 79に記載されています。

Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.

IPRの開示のコピーが利用できるようにIETF事務局とライセンスの保証に行われた、または本仕様の実装者または利用者がそのような所有権の使用のための一般的なライセンスまたは許可を取得するために作られた試みの結果を得ることができますhttp://www.ietf.org/iprのIETFのオンラインIPRリポジトリから。

The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.

IETFは、その注意にこの標準を実装するために必要とされる技術をカバーすることができる任意の著作権、特許または特許出願、またはその他の所有権を持ってすべての利害関係者を招待します。 ietf-ipr@ietf.orgのIETFに情報を記述してください。