snmp-set-oid-output-format.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.snmp-set-oid-output-format" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>snmp_set_oid_output_format</refname>
  <refpurpose>
   Set the OID output format
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>snmp_set_oid_output_format</methodname>
   <methodparam><type>int</type><parameter>format</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>snmp_set_oid_output_format</function> sets the output format
   to be full or numeric.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <table>
       <title>OID .1.3.6.1.2.1.1.3.0 representation for various <parameter>format</parameter> values</title>
        <tgroup cols="2">
         <tbody>
          <row><entry><constant>SNMP_OID_OUTPUT_FULL</constant></entry><entry>.iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.sysUpTimeInstance</entry></row>
          <row><entry><constant>SNMP_OID_OUTPUT_NUMERIC</constant></entry><entry>.1.3.6.1.2.1.1.3.0</entry> </row>
          <row><entry><constant>SNMP_OID_OUTPUT_MODULE</constant></entry><entry>DISMAN-EVENT-MIB::sysUpTimeInstance</entry></row>
          <row><entry><constant>SNMP_OID_OUTPUT_SUFFIX</constant></entry><entry>sysUpTimeInstance</entry></row>
          <row><entry><constant>SNMP_OID_OUTPUT_UCD</constant></entry><entry>system.sysUpTime.sysUpTimeInstance</entry></row>
          <row><entry><constant>SNMP_OID_OUTPUT_NONE</constant></entry><entry>Undefined</entry></row>
         </tbody>
        </tgroup>
       </table> 
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &return.type.true;
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>snmprealwalk</function></title>
    <programlisting role="php">
<![CDATA[
<?php

 snmp_read_mib("/usr/share/mibs/netsnmp/NET-SNMP-TC");

 // default or SNMP_OID_OUTPUT_MODULE
 print_r( snmprealwalk('localhost', 'public', 'RFC1213-MIB::sysObjectID') );

 snmp_set_oid_output_format(SNMP_OID_OUTPUT_NUMERIC);
 print_r( snmprealwalk('localhost', 'public', 'RFC1213-MIB::sysObjectID') );

 snmp_set_oid_output_format(SNMP_OID_OUTPUT_FULL);
 print_r( snmprealwalk('localhost', 'public', 'RFC1213-MIB::sysObjectID') );
?>
]]>
    </programlisting>
    
    <para>
     The above would output:
<![CDATA[
 Array
 (
    [RFC1213-MIB::sysObjectID.0] => OID: NET-SNMP-TC::linux
 )
 Array
 (
    [.1.3.6.1.2.1.1.2.0] => OID: .1.3.6.1.4.1.8072.3.2.10
 )
 Array
 (
    [.iso.org.dod.internet.mgmt.mib-2.system.sysObjectID.0] => OID: .iso.org.dod.internet.private.enterprises.netSnmp.netSnmpEnumerations.netSnmpAgentOIDs.linux
 )
]]>
    </para>
   </example>
  </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
-->