RFC 5612 INFORMATIONAL MANAGEMENT · DOCUMENTATION

Enterprise Number for Documentation Use

A reserved enterprise number, 32473, for use in examples so nobody borrows a real company's number.

On rfc-editor.org ↗
PUBLISHED
August 2009
AUTHORS
P. Eronen, D. Harrington
STREAM
IETF
DOCUMENTATION ENTERPRISE NUMBER
32473
ENTERPRISE OID PREFIX
1.3.6.1.4.1.
DOI
10.17487/RFC5612

RFC text

Contents
Original text · RFC Editor View on rfc-editor.org ↗
Network Working Group                                          P. Eronen
Request for Comments: 5612                                         Nokia
Category: Informational                                    D. Harrington
                                               Huawei Technologies (USA)
                                                             August 2009


                Enterprise Number for Documentation Use

Abstract

   This document describes an Enterprise Number (also known as SMI
   Network Management Private Enterprise Code) for use in documentation.

Status of This Memo

   This memo provides information for the Internet community.  It does
   not specify an Internet standard of any kind.  Distribution of this
   memo is unlimited.

Copyright Notice

   Copyright (c) 2009 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 in effect on the date of
   publication of this document (http://trustee.ietf.org/license-info).
   Please review these documents carefully, as they describe your rights
   and restrictions with respect to this document.

1.  Introduction

   RFC 1065 [RFC1065] (later superceded by [RFC1155] and [RFC2578])
   created a subtree (arc) of object identifiers (OIDs) for identifying
   management objects that are defined unilaterally by a single party,
   such as an enterprise.  The subtree for a particular enterprise
   consists of the prefix "1.3.6.1.4.1.", followed by the Enterprise
   Number assigned for that enterprise.

   Enterprise Numbers are allocated by IANA, and are also known as
   "Private Enterprise Numbers", "Enterprise Codes", and "SMI (Structure
   of Management Information) Network Management Private Enterprise
   Codes".  See the "Private Enterprise Number Application Form"
   [Application] for more information on how to request an Enterprise
   Number from IANA, and [Numbers] for the list of currently assigned
   numbers.

   Enterprise Numbers have also been used for many other purposes than
   OIDs in various protocols; for example:

   o  "STRUCTURED-DATA" identifiers in Syslog [RFC5424]
   o  "Vendor-Specific" RADIUS attributes [RFC2865]
   o  Mobile IPv4 vendor/organization-specific extensions [RFC3115]
   o  User-defined error information in RSVP [RFC5284]
   o  Vendor options in DHCPv4 [RFC3925]
   o  Enterprise-specific information elements in the IP Flow
      Information Export (IPFIX) protocol [RFC5101]

   Documents related to these protocols may include examples that
   contain Enterprise Numbers.  To reduce the likelihood of conflict and
   confusion, this document specifies an Enterprise Number for use in
   examples in RFCs, books, documentation, and the like.

   This Enterprise Number is not intended to be implemented.  It is not
   expected that any implementation would send it, or that any
   implementation would treat it specially when receiving it.

2.  Enterprise Number for Documentation Use

   The Enterprise Number 32473 has been allocated for use in examples in
   RFCs, books, documentation, and the like.

3.  IANA Considerations

   IANA has updated the registration for Enterprise Number 32473 to
   point to this RFC.

4.  Security Considerations

   Allocating an enterprise number for documentation use does not have
   any direct impact on security.

5.  Acknowledgments

   The need for an Enterprise Number for documentation use was
   identified by Rainer Gerhards for the examples in [RFC5424].  The
   authors would also like to thank Michelle Cotton for her help, and
   Alfred Hoenes for his comments.  This document borrows text from
   [RFC5398] and ideas from [RFC4735].

6.  References

6.1.  Normative References

   [Numbers]  IANA, "Private Enterprise Numbers",
              <http://www.iana.org/assignments/enterprise-numbers>,
              2009.

6.2.  Informative References

   [Application]
              IANA, "Protocol Registration Forms",
              http://www.iana.org/protocols/apply/.

   [RFC1065]  Rose, M. and K. McCloghrie, "Structure and identification
              of management information for TCP/IP-based internets", RFC
              1065, August 1988.

   [RFC1155]  Rose, M. and K. McCloghrie, "Structure and identification
              of management information for TCP/IP-based internets", STD
              16, RFC 1155, May 1990.

   [RFC2578]  McCloghrie, K., Perkins, D., and J. Schoenwaelder,
              "Structure of Management Information Version 2 (SMIv2)",
              STD 58, RFC 2578, April 1999.

   [RFC2865]  Rigney, C., Willens, S., Rubens, A., and W. Simpson,
              "Remote Authentication Dial In User Service (RADIUS)", RFC
              2865, June 2000.

   [RFC3115]  Dommety, G. and K. Leung, "Mobile IP Vendor/
              Organization-Specific Extensions", RFC 3115, April 2001.

   [RFC3925]  Littlefield, J., "Vendor-Identifying Vendor Options for
              Dynamic Host Configuration Protocol version 4 (DHCPv4)",
              RFC 3925, October 2004.

   [RFC4735]  Taylor, T., "Example Media Types for Use in
              Documentation", RFC 4735, October 2006.

   [RFC5101]  Claise, B., "Specification of the IP Flow Information
              Export (IPFIX) Protocol for the Exchange of IP Traffic
              Flow Information", RFC 5101, January 2008.

   [RFC5284]  Swallow, G. and A. Farrel, "User-Defined Errors for RSVP",
              RFC 5284, August 2008.

   [RFC5398]  Huston, G., "Autonomous System (AS) Number Reservation for
              Documentation Use", RFC 5398, December 2008.

   [RFC5424]  Gerhards, R., "The Syslog Protocol", RFC 5424, March 2009.

Authors' Addresses

   Pasi Eronen
   Nokia Research Center
   P.O. Box 407
   FIN-00045 Nokia Group
   Finland

   EMail: pasi.eronen@nokia.com


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

   EMail: dharrington@huawei.com

AI ELI5

On this page
PROBLEMExamples in RFCs and books that need an Enterprise Number had no safe value to use, risking conflict and confusion with a real organization.
MECHANISMThe RFC sets aside Enterprise Number 32473 for use in examples in RFCs, books, documentation, and the like.
WHY IT MATTERSWriters can use 32473 in examples; it is not intended to be implemented or treated specially by any implementation.

§1Enterprise Numbers

RFC 1065 created a subtree of object identifiers (OIDs) for management objects defined by a single party, such as an enterprise. The subtree for an enterprise is the prefix 1.3.6.1.4.1. followed by the Enterprise Number assigned to it. IANA allocates these numbers.

The numbers are also used in other protocols, for example STRUCTURED-DATA identifiers in Syslog, vendor-specific RADIUS attributes, vendor options in DHCPv4, and enterprise-specific information elements in IPFIX. Documents about these protocols may contain examples that include an Enterprise Number.

Every company gets its own number, like a house number on a street, so its network settings do not mix with anyone else's.

§2The Documentation Number

To reduce the likelihood of conflict and confusion, the RFC allocates Enterprise Number 32473 for use in examples in RFCs, books, documentation, and the like.

This number is not intended to be implemented. No implementation is expected to send it or to treat it specially when receiving it.

The number 32473 is the pretend house number you put in examples. Real programs never need to use it.

§3IANA and Security

IANA has updated the registration for Enterprise Number 32473 to point to this RFC. The RFC says the allocation has no direct impact on security.

The number list now says 32473 is the pretend one, and using it does not make anything less safe.

§4References