Subversion Repositories oidinfo_new_design

Rev

Rev 3 | Rev 20 | Go to most recent revision | Show entire file | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 3 Rev 15
Line 45... Line 45...
45
                                                <li><a href="#29">What are the duties of a Registration Authority?</a></li>
45
                                                <li><a href="#29">What are the duties of a Registration Authority?</a></li>
46
                                                <li><a href="#size-limitations">Are there size limitations for OID encoding?</a></li>
46
                                                <li><a href="#size-limitations">Are there size limitations for OID encoding?</a></li>
47
                                                <li><a href="#31">Are there binary encoders/decoders for OIDs?</a></li>
47
                                                <li><a href="#31">Are there binary encoders/decoders for OIDs?</a></li>
48
                                                <li><a href="#cookies">Does this web site use cookies?</a></li>
48
                                                <li><a href="#cookies">Does this web site use cookies?</a></li>
49
                                                <li><a href="#33">How does this web site protect users' privacy?</a></li>
49
                                                <li><a href="#33">How does this web site protect users' privacy?</a></li>
-
 
50
                                                <li><a href="#guidelines">What are the guidelines to adequately describe an OID in this OID repository?</a></li>
50
                                        </ol><br></td>
51
                                        </ol><br></td>
51
                        </tr>
52
                        </tr>
52
                </table>
53
                </table>
53
        </div>
54
        </div>
54
        <div id="table_answers_in_faq">
55
        <div id="table_answers_in_faq">
Line 189... Line 190...
189
                                                                so any OID described in this OID repository has to be officially allocated
190
                                                                so any OID described in this OID repository has to be officially allocated
190
                                                                by the Registration Authority of its parent OID. There are at least
191
                                                                by the Registration Authority of its parent OID. There are at least
191
                                                                4 ways of adding a new OID description to the repository: <br>a. Enter the OID value in the box under "Add a description for the
192
                                                                4 ways of adding a new OID description to the repository: <br>a. Enter the OID value in the box under "Add a description for the
192
                                                                following OID to the database" on the <a href="index.htm">main page</a> and
193
                                                                following OID to the database" on the <a href="index.htm">main page</a> and
193
                                                                click on the "Create" button; a new page will then be displayed with
194
                                                                click on the "Create" button; a new page will then be displayed with
194
                                                                some boxes to fill. You can also enter the OID in the following box:<br><form method="post" action="/cgi-bin/manage" enctype="multipart/form-data">
195
                                                                some boxes to fill (see <a href="#guidelines">guidelines for describing an OID</a>). You can also enter the OID in the following box:<br><form method="post" action="/cgi-bin/manage" enctype="multipart/form-data">
195
                                                                        <input type="hidden" name="a" value="create">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong>{</strong>
196
                                                                        <input type="hidden" name="a" value="create">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong>{</strong>
196
                                                                        <input type="text" name="oid" size="30" value=""><strong>}</strong>
197
                                                                        <input type="text" name="oid" size="30" value=""><strong>}</strong>
197
                                                                        <input type="submit" name="submit" value="Create"></form>
198
                                                                        <input type="submit" name="submit" value="Create"></form>
198
                                                                b. Go to the parent OID of the OID that you want to add (i.e. the
199
                                                                b. Go to the parent OID of the OID that you want to add (i.e. the
199
                                                                OID at the immediate upper level in the OID tree) and click on the
200
                                                                OID at the immediate upper level in the OID tree) and click on the
200
                                                                "Create a child OID" link on the top right-hand side of the page;
201
                                                                "Create a child OID" link on the top right-hand side of the page;
201
                                                                a new page will then be displayed with some boxes to fill.<br>c. Go to an OID at the same level as the OID that you want to add
202
                                                                a new page will then be displayed with some boxes to fill (see <a href="#guidelines">guidelines for describing an OID</a>).<br>c. Go to an OID at the same level as the OID that you want to add
202
                                                                (a.k.a. sibling OID) and click on the "Create a sibling OID" link
203
                                                                (a.k.a. sibling OID) and click on the "Create a sibling OID" link
203
                                                                on the top right-hand side of the page; a new page will then be displayed
204
                                                                on the top right-hand side of the page; a new page will then be displayed
204
                                                                with some boxes to fill.<br>d. If you have a lot of OID descriptions to add, it is more convenient
205
                                                                with some boxes to fill (see <a href="#guidelines">guidelines for describing an OID</a>).<br>d. If you have a lot of OID descriptions to add, it is more convenient
205
                                                                to describe them in an XML document that conforms to our <a href="oid.xsd">XML
206
                                                                to describe them in an XML document that conforms to our <a href="oid.xsd">XML
206
                                                                        Schema for OIDs</a> and <a href="submit.htm">submit</a> this document
207
                                                                        Schema for OIDs</a> and <a href="submit.htm">submit</a> this document
207
                                                                through the web interface. <br><em>
208
                                                                through the web interface. <br><em>
208
                                                                        Note: In all 4 cases, the person (if any) you mention as <a href="#registration-authorities">registrant</a>
209
                                                                        Note: In all 4 cases, the person (if any) you mention as <a href="#registration-authorities">registrant</a>
209
                                                                        for the OID, and the person (if known) who is the <a href="#registration-authorities">registrant</a>
210
                                                                        for the OID, and the person (if known) who is the <a href="#registration-authorities">registrant</a>
Line 322... Line 323...
322
                                                        <div class="question">
323
                                                        <div class="question">
323
                                                                How many OIDs are currently described in this repository?<a name="9"></a>
324
                                                                How many OIDs are currently described in this repository?<a name="9"></a>
324
                                                                <a href="#top"><img src="images/page_top_fleche.png" width="27" height="17" border="0"></a>
325
                                                                <a href="#top"><img src="images/page_top_fleche.png" width="27" height="17" border="0"></a>
325
                                                        </div>
326
                                                        </div>
326
                                                        <div class="answer">
327
                                                        <div class="answer">
327
                                                                There are more than 950 000 OID descriptions stored in our repository
328
                                                                There are close to 2 billion OID descriptions stored in this repository
328
                                                                (see <a href="/cgi-bin/display?a=count_nodes">exact number</a>). The
329
                                                                (see <a href="/cgi-bin/display?a=count_nodes">exact number</a>). The
329
                                                                repository is well alive and updated as often as necessary; <a href="/cgi-bin/display?a=count_nodes">statistics</a>
330
                                                                repository is well alive and updated as often as necessary; <a href="/cgi-bin/display?a=count_nodes">statistics</a>
330
                                                                are available about the number of OIDs added to the repository (or
331
                                                                are available about the number of OIDs added to the repository (or
331
                                                                updated) over the past 12 months. A (non-exhaustive) list of standards
332
                                                                updated) over the past 12 months. A (non-exhaustive) list of standards
332
                                                                (and other documents that define OIDs) which have been captured in
333
                                                                (and other documents that define OIDs) which have been captured in
Line 471... Line 472...
471
                                                                good idea is probably to look at <a href="country_oids.htm#agreements">how
472
                                                                good idea is probably to look at <a href="country_oids.htm#agreements">how
472
                                                                        other countries have organized subsequent arcs beneath their country
473
                                                                        other countries have organized subsequent arcs beneath their country
473
                                                                        arc</a> as well as reading the ITU handbook on &quot;<a href="http://www.itu.int/pub/T-HDB-LNG.4-2010"><em>
474
                                                                        arc</a> as well as reading the ITU handbook on &quot;<a href="http://www.itu.int/pub/T-HDB-LNG.4-2010"><em>
474
                                                                                Object
475
                                                                                Object
475
                                                                                identifiers (OIDs) and their registration authorities
476
                                                                                identifiers (OIDs) and their registration authorities
476
                                                                        </em></a>&quot;.<br><br></div>
477
                                                                        </em></a>&quot;. You can also take benefit from the
-
 
478
                                                                        <a href="#guidelines">guidelines to adequately describe an OID in this OID repository</a>.<br><br></div>
477
                                                </li>
479
                                                </li>
478
                                                <li>
480
                                                <li>
479
                                                        <div class="question">
481
                                                        <div class="question">
480
                                                                What is the Internet OID?<a name="13"></a>
482
                                                                What is the Internet OID?<a name="13"></a>
481
                                                                <a href="#top"><img src="images/page_top_fleche.png" width="27" height="17" border="0"></a>
483
                                                                <a href="#top"><img src="images/page_top_fleche.png" width="27" height="17" border="0"></a>
Line 604... Line 606...
604
                                                                The <a href="display-example.htm">description page</a> for each OID
606
                                                                The <a href="display-example.htm">description page</a> for each OID
605
                                                                offers the ability to:
607
                                                                offers the ability to:
606
                                                                <ul type="disc">
608
                                                                <ul type="disc">
607
                                                                        <li>
609
                                                                        <li>
608
                                                                                have a synthetic <a href="/cgi-bin/display?tree=">graphical
610
                                                                                have a synthetic <a href="/cgi-bin/display?tree=">graphical
609
                                                                                        view</a> of the tree (click on the<img src="images/pm.gif" width="19" height="18">and<img src="images/mm.gif" width="19" height="18">icons to
611
                                                                                        view</a> of the tree (click on the<img src="images/pm.gif" width="19" height="18" alt="Unfolding the subtree">and<img src="images/mm.gif" width="19" height="18" alt="Folding the subtree">icons to
610
                                                                                fold and unfold arcs);
612
                                                                                fold and unfold arcs);
611
                                                                        </li>
613
                                                                        </li>
612
                                                                        <li>display the description of another OID (the &quot;Go&quot; button);</li>
614
                                                                        <li>display the description of another OID (the &quot;Go&quot; button);</li>
613
                                                                        <li>
615
                                                                        <li>
614
                                                                                use the &quot;remote control&quot; to display the description
616
                                                                                use the &quot;remote control&quot; to display the description
Line 721... Line 723...
721
                                                                According to clause 8.2 f of <a href="http://www.itu.int/rec/T-REC-X.660/en">Recommendation
723
                                                                According to clause 8.2 f of <a href="http://www.itu.int/rec/T-REC-X.660/en">Recommendation
722
                                                                        ITU-T X.660 | ISO/IEC 9834-1</a>, the registration record for an OID
724
                                                                        ITU-T X.660 | ISO/IEC 9834-1</a>, the registration record for an OID
723
                                                                shall include at least:<br>a) the definition of the object (when the registration authority of
725
                                                                shall include at least:<br>a) the definition of the object (when the registration authority of
724
                                                                the parent OID performs a technical role, it checks that the objet
726
                                                                the parent OID performs a technical role, it checks that the objet
725
                                                                can be registered under the parent OID);<br>b) when applicable, the identifier (beginning with a lowercase letter)
727
                                                                can be registered under the parent OID);<br>b) when applicable, the identifier (beginning with a lowercase letter)
726
                                                                assigned to the object (in addition to the unique number);<br>b) the name and contact information of the organization that proposed
728
                                                                assigned to the object (in addition to the unique number);<br>c) the name and contact information of the organization that proposed
727
                                                                the entry (usually it is the &quot;<a href="#registration-authorities">First
729
                                                                the entry (usually it is the &quot;<a href="#registration-authorities">First
728
                                                                        registration authority</a>&quot; for the requested OID);<br>c) the dates of submission/registration.<br><br></div>
730
                                                                        registration authority</a>&quot; for the requested OID);<br>d) the dates of submission/registration.<br><br></div>
729
                                                </li>
731
                                                </li>
730
                                                <li>
732
                                                <li>
731
                                                        <div class="question">
733
                                                        <div class="question">
732
                                                                Is there a particular OID that can be used for documenting
734
                                                                Is there a particular OID that can be used for documenting
733
                                                                examples of object identifiers?<a name="22"></a><a name="example"></a>
735
                                                                examples of object identifiers?<a name="22"></a><a name="example"></a>
Line 781... Line 783...
781
                                                        </div>
783
                                                        </div>
782
                                                        <div class="answer">
784
                                                        <div class="answer">
783
                                                                The constraints are gathered in sections 4.6.5, 4.6.6, and Appendix
785
                                                                The constraints are gathered in sections 4.6.5, 4.6.6, and Appendix
784
                                                                D of IETF <a href="https://datatracker.ietf.org/doc/html/rfc4181">RFC 4181</a>
786
                                                                D of IETF <a href="https://datatracker.ietf.org/doc/html/rfc4181">RFC 4181</a>
785
                                                                (updated by <a href="https://datatracker.ietf.org/doc/html/rfc4841">RFC 4841</a>)
787
                                                                (updated by <a href="https://datatracker.ietf.org/doc/html/rfc4841">RFC 4841</a>)
786
                                                                which makes references to <a href="https://datatracker.ietf.org/doc/html/rfc2578">RFC
788
                                                                which makes references to IETF <a href="https://datatracker.ietf.org/doc/html/rfc2578">RFC
787
                                                                        2578</a>, sections 3.5, 3.6, 5.6, 7.10, and <a href="https://datatracker.ietf.org/doc/html/rfc3416">RFC
789
                                                                        2578</a>, sections 3.5, 3.6, 5.6, 7.10, and <a href="https://datatracker.ietf.org/doc/html/rfc3416">RFC
788
                                                                        3416</a>, section 4.1.<br>
790
                                                                        3416</a>, section 4.1.<br>
789
                                                                - According to <a href="https://datatracker.ietf.org/doc/html/rfc2578">RFC 2578</a>, section 3.5, all OIDs are limited to 128 child OIDs and each OID has a maximum (integer) value of 2<sup>32</sup>-1 (<code>4294967295</code>).<br>
791
                                                                - According to IETF <a href="https://datatracker.ietf.org/doc/html/rfc2578">RFC 2578</a>, section 3.5, all OIDs are limited to 128 child OIDs and each OID has a maximum (integer) value of 2<sup>32</sup>-1 (<code>4294967295</code>).<br>
790
                                                                - The last arc of an OID assigned to any object (be it table, row, column, or scalar) must not be equal to 0.<br>- In some cases, a final arc 0 is used to translate between SNMPv1 and SNMPv2 notification parameters as explained in <a href="https://datatracker.ietf.org/doc/html/rfc2576">RFC 2576</a>, section 3.<br>One example of a MIB module whose OID assignments follow the recommended scheme is the <code>POWER-ETHERNET-MIB</code> defined in <a href="https://datatracker.ietf.org/doc/html/rfc3621">RFC 3621</a>.<br>MIBs use a notation like "<code>.2.999</code>" where the leading dot shows that this OID is absolute while "<code>2.999</code>" might be considered as a relative OID by some tools which would then add a root OID in front of it.<br><br></div>
792
                                                                - The last arc of an OID assigned to any object (be it table, row, column, or scalar) must not be equal to 0.<br>- In some cases, a final arc 0 is used to translate between SNMPv1 and SNMPv2 notification parameters as explained in IETF <a href="https://datatracker.ietf.org/doc/html/rfc2576">RFC 2576</a>, section 3.<br>One example of a MIB module whose OID assignments follow the recommended scheme is the <code>POWER-ETHERNET-MIB</code> defined in <a href="https://datatracker.ietf.org/doc/html/rfc3621">RFC 3621</a>.<br>MIBs use a notation like "<code>.2.999</code>" where the leading dot shows that this OID is absolute while "<code>2.999</code>" might be considered as a relative OID by some tools which would then add a root OID in front of it.<br><br></div>
791
                                                </li>
793
                                                </li>
792
                                                <li>
794
                                                <li>
793
                                                        <div class="question">
795
                                                        <div class="question">
794
                                                                Is there a way to look up an OID in the OID repository from my web browser?<a name="25"></a><a name="lookup"></a>
796
                                                                Is there a way to look up an OID in the OID repository from my web browser?<a name="25"></a><a name="lookup"></a>
795
                                                                <a href="#top"><img src="images/page_top_fleche.png" width="27" height="17" border="0"></a>
797
                                                                <a href="#top"><img src="images/page_top_fleche.png" width="27" height="17" border="0"></a>
Line 1012... Line 1014...
1012
                                                                only be used by the OID repository administrator to explain or undo
1014
                                                                only be used by the OID repository administrator to explain or undo
1013
                                                                changes if needed.<br>For any other question related to data protection or to request the
1015
                                                                changes if needed.<br>For any other question related to data protection or to request the
1014
                                                                rectification or erasure of your personal data, you can <a href="/helper">contact
1016
                                                                rectification or erasure of your personal data, you can <a href="/helper">contact
1015
                                                                        the webmaster</a>. Repetitive, disproportionate or impracticable requests
1017
                                                                        the webmaster</a>. Repetitive, disproportionate or impracticable requests
1016
                                                                may be rejected.
1018
                                                                may be rejected.
-
 
1019
                                                        <br><br></div>
-
 
1020
                                                </li>
-
 
1021
 
-
 
1022
 
-
 
1023
 
-
 
1024
                                                <li>
-
 
1025
                                                        <div class="question">
-
 
1026
                                                                What are the guidelines to adequately describe an OID in this OID repository?<a name="34"></a><a name="guidelines"></a>
-
 
1027
                                                                <a href="#top"><img src="images/page_top_fleche.png" width="27" height="17" border="0"></a>
-
 
1028
                                                        </div>
-
 
1029
                                                        <div class="answer">
-
 
1030
                                                                The following rules are followed by the OID repository administrator to validate OID descriptions:
-
 
1031
                                                        <ul>
-
 
1032
                                                                <li>The description shall be as short as possible (usually, not more than one line) and focus on <em>what</em> (i.e., which object) is identified by the OID. The description shall not be a sentence (with a verb). Consequently, the description does not end up with a full stop "." (except when the full stop is part of an abbreviation). See also the <a href="#syntax-rules">syntax rules</a>.</li>
-
 
1033
                                                                <li>The description should be easily understandable by any user of the OID repository. Substantives should not be put one after the other without inserting small words like "for", "of", etc. This helps understanding the description and avoids ambiguities when translating to other languages.</li>
-
 
1034
                                                                <li>Useless expressions like "OID for", "OID identifying", "Root OID for", "Top arc for", "Arc for", "This OID describes", "This arc describes", etc., are forbidden.</li>
-
 
1035
                                                                <li>Words are not capitalized (contrarily to what is usually done for paper or book titles in English) except for an abbreviation or acronym which is put between parentheses after the expression that defines it (with each letter of the abbreviation being capitalized in its definition), e.g., Meaning of My Abbreviation (MMA).</li>
-
 
1036
                                                                <li>Any text (e.g., how it is used, how child OIDs are allocated, etc.) which is not related to <em>what</em> is identified by the OID shall be moved to the "Information" part. Any text which can be assimilated to a publicity or a company description shall be avoided (a URL can be associated to the company name).</li>
-
 
1037
                                                        </ul>
1017
                                                        </div>
1038
                                                </div>
1018
                                                </li>
1039
                                                </li>
-
 
1040
 
-
 
1041
 
1019
                                        </ol>
1042
                                        </ol>
1020
 
1043
 
1021
                                </td>
1044
                                </td>
1022
                        </tr>
1045
                        </tr>
1023
                </table>
1046
                </table>