Guidelines for Authors and Reviewers of IPFIX Information Elements
draft-ietf-ipfix-ie-doctors-01

The information below is for an old version of the document
Document Type Active Internet-Draft (ipfix WG)
Last updated 2012-02-10 (latest revision 2011-11-21)
Replaces draft-trammell-ipfix-ie-doctors
Stream IETF
Intended RFC status (None)
Formats plain text pdf html
Stream WG state WG Document
Document shepherd None
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
IPFIX Working Group                                          B. Trammell
Internet-Draft                                                ETH Zurich
Intended status: BCP                                           B. Claise
Expires: August 13, 2012                             Cisco Systems, Inc.
                                                       February 10, 2012

   Guidelines for Authors and Reviewers of IPFIX Information Elements
                   draft-ietf-ipfix-ie-doctors-01.txt

Abstract

   This document provides guidelines for the definition of IPFIX
   Information Elements for addition to the IANA IPFIX Information
   Element registry, in order to extend the applicability of the IPFIX
   protocol to new operations and management areas.

Status of this Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on August 13, 2012.

Copyright Notice

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

   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.

Trammell & Claise        Expires August 13, 2012                [Page 1]
Internet-Draft              IPFIX IE-DOCTORS               February 2012

Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
     1.1.  Intended Audience and Usage  . . . . . . . . . . . . . . .  3
     1.2.  Overview of relevant IPFIX documents . . . . . . . . . . .  4
   2.  Terminology  . . . . . . . . . . . . . . . . . . . . . . . . .  4
   3.  How to apply IPFIX . . . . . . . . . . . . . . . . . . . . . .  5
   4.  Defining new Information Elements  . . . . . . . . . . . . . .  6
     4.1.  Information Element naming . . . . . . . . . . . . . . . .  7
     4.2.  Information Element data types . . . . . . . . . . . . . .  7
     4.3.  Information Element numbering  . . . . . . . . . . . . . .  8
     4.4.  Ancillary Information Element properties . . . . . . . . .  9
     4.5.  Internal structure in Information Elements . . . . . . . .  9
     4.6.  Information Element multiplicity . . . . . . . . . . . . . 10
     4.7.  Enumerated Values and Subregistries  . . . . . . . . . . . 11
     4.8.  Reversibility as per RFC 5103  . . . . . . . . . . . . . . 11
     4.9.  Promotion of Enterprise-Specific Information Elements  . . 11
     4.10. Avoiding Bad Ideas in Information Element Design . . . . . 12
   5.  The Information Element Lifecycle  . . . . . . . . . . . . . . 13
     5.1.  The IE-DOCTORS process . . . . . . . . . . . . . . . . . . 13
     5.2.  Revising Information Elements  . . . . . . . . . . . . . . 14
     5.3.  Deprecating Information Elements . . . . . . . . . . . . . 15
     5.4.  Versioning the entire IANA Registry  . . . . . . . . . . . 16
   6.  When not to define new Information Elements  . . . . . . . . . 16
     6.1.  Maximizing reuse of existing Information Elements  . . . . 16
     6.2.  Applying enterprise-specific Information Elements  . . . . 18
   7.  Information Element Definition Checklist . . . . . . . . . . . 18
   8.  Applying IPFIX to non-Flow Applications  . . . . . . . . . . . 21
   9.  Writing Internet-Drafts for IPFIX Applications . . . . . . . . 22
     9.1.  Example Information Element Definition . . . . . . . . . . 22
     9.2.  Defining Recommended Templates . . . . . . . . . . . . . . 23
   10. A Textual Format for Specifying Information Elements and
       Templates  . . . . . . . . . . . . . . . . . . . . . . . . . . 24
     10.1. Information Element Specifiers . . . . . . . . . . . . . . 24
     10.2. Specifying Templates . . . . . . . . . . . . . . . . . . . 26
     10.3. Specifying IPFIX Structured Data . . . . . . . . . . . . . 27
   11. Security Considerations  . . . . . . . . . . . . . . . . . . . 27
Show full document text