php-doc-en/reference/snmp/functions/snmp-read-mib.xml
2011-08-16 11:38:58 +00:00

94 lines
2.3 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.snmp-read-mib" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>snmp_read_mib</refname>
<refpurpose>
Reads and parses a MIB file into the active MIB tree
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>snmp_read_mib</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
This function is used to load additional, e.g. vendor specific, MIBs so that
human readable OIDs like VENDOR-MIB::foo.1 instead of error prone numeric OIDs
can be used.
</para>
<para>
The order in which the MIBs are loaded does matter as the underlying Net-SNMP
libary will print warnings if referenced objects cannot be resolved.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem><para>The filename of the <acronym>MIB</acronym>.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Using <function>snmp_read_mib</function></title>
<programlisting role="php">
<![CDATA[
<?php
print_r( snmprealwalk('localhost', 'public', '.1.3.6.1.2.1.2.3.4.5') );
snmp_read_mib('./FOO-BAR-MIB.txt');
print_r( snmprealwalk('localhost', 'public', 'FOO-BAR-MIB::someTable' );
?>
]]>
</programlisting>
</example>
</para>
<para>
The above example is made up but the results would look like:
<![CDATA[
Array
(
[iso.3.6.1.2.1.2.3.4.5.0] => Gauge32: 6
)
Array
(
[FOO-BAR-MIB::someTable.0] => Gauge32: 6
)
]]>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->