cvs: phpdoc /en/reference/snmp/functions snmp-get-quick-print.xml snmp-get-valueretrieval.xml snmp-read-mib.xml snmp-set-enum-print.xml
snmp-set-oid-numeric-print.xml snmp-set-quick-print.xml snmp-set-valueretrieval.xml snmpget.xml snmpgetnext.xml snmprealwalk.xml snmpset.xml
snmpwalk.xml snmpwalkoid.xml
| From: | Mehdi Achour | Date: | Sun, 07 Jan 2007 01:04:21 +0000 |
| Subject: | cvs: phpdoc /en/reference/snmp/functions snmp-get-quick-print.xml snmp-get-valueretrieval.xml snmp-read-mib.xml snmp-set-enum-print.xml snmp-set-oid-numeric-print.xml snmp-set-quick-print.xml snmp-set-valueretrieval.xml snmpget.xml snmpgetnext.xml snmprealwalk.xml snmpset.xml snmpwalk.xml snmpwalkoid.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969374691@lists.php.net to get a copy of this message | ||
didou Sun Jan 7 01:04:21 2007 UTC
Modified files:
/phpdoc/en/reference/snmp/functions snmp-get-quick-print.xml
snmp-get-valueretrieval.xml
snmp-read-mib.xml
snmp-set-enum-print.xml
snmp-set-oid-numeric-print.xml
snmp-set-quick-print.xml
snmp-set-valueretrieval.xml
snmpget.xml snmpgetnext.xml
snmprealwalk.xml snmpset.xml
snmpwalk.xml snmpwalkoid.xml
Log:
Convert to new doc style
# Use cvs -wbB to ignore WS changes
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml:1.3 phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml:1.3 Wed Jul 16 01:10:08 2003 +++ phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml Sun Jan 7 01:04:21 2007 @@ -1,50 +1,69 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmp-get-quick-print"> - <refnamediv> - <refname>snmp_get_quick_print</refname> - <refpurpose> - Fetches the current value of the UCD library's quick_print setting - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>snmp_get_quick_print</methodname> - <void/> - </methodsynopsis> - <para> - Returns the current value stored in the UCD Library for quick_print. - quick_print is off by default. - <example> - <title><function>snmp_get_quick_print</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.4 $ --> +<refentry id="function.snmp-get-quick-print"> + <refnamediv> + <refname>snmp_get_quick_print</refname> + <refpurpose> + Fetches the current value of the UCD library's quick_print setting + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>snmp_get_quick_print</methodname> + <void/> + </methodsynopsis> + <para> + Returns the current value stored in the UCD Library for quick_print. + quick_print is off by default. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if quick_print is on, &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>snmp_get_quick_print</function> example</title> + <programlisting role="php"> <![CDATA[ <?php - $quickprint = snmp_get_quick_print(); +$quickprint = snmp_get_quick_print(); ?> ]]> - </programlisting> - </example> - </para> - <para> - Above function call would return &false; if - quick_print is off, and &true; if quick_print - is on. - </para> - <para> - <function>snmp_get_quick_print</function> is only available when using - the UCD SNMP library. This function is not available when using the - Windows SNMP library. - </para> - <para> - See also - <function>snmp_set_quick_print</function> for a full description - of what quick_print does. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + <function>snmp_get_quick_print</function> is only available when using + the UCD SNMP library. This function is not available when using the + Windows SNMP library. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>snmp_set_quick_print</function> for a full description + of what quick_print does.</member> + </simplelist> + </para> + </refsect1> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml diff -u phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml:1.1 phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmp-get-valueretrieval"> <refnamediv> <refname>snmp_get_valueretrieval</refname> @@ -7,8 +7,8 @@ Return the method how the SNMP values will be returned </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>snmp_get_valueretrieval</methodname> <void/> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-read-mib.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-read-mib.xml diff -u phpdoc/en/reference/snmp/functions/snmp-read-mib.xml:1.3 phpdoc/en/reference/snmp/functions/snmp-read-mib.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmp-read-mib.xml:1.3 Fri Jun 24 09:11:46 2005 +++ phpdoc/en/reference/snmp/functions/snmp-read-mib.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.snmp-read-mib"> <refnamediv> <refname>snmp_read_mib</refname> @@ -7,8 +7,8 @@ Reads and parses a MIB file into the active MIB tree </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>snmp_read_mib</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml:1.1 phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmp-set-enum-print"> <refnamediv> <refname>snmp_set_enum_print</refname> @@ -7,8 +7,8 @@ Return all values that are enums with their enum value instead of the raw integer </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>snmp_set_enum_print</methodname> <methodparam><type>int</type><parameter>enum_print</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml:1.1 phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmp-set-oid-numeric-print"> <refnamediv> <refname>snmp_set_oid_numeric_print</refname> @@ -7,8 +7,8 @@ Return all objects including their respective object id within the specified one </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>snmp_set_oid_numeric_print</methodname> <methodparam><type>int</type><parameter>oid_numeric_print</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml:1.4 phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml:1.5 --- phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml:1.4 Mon Dec 15 16:53:45 2003 +++ phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml Sun Jan 7 01:04:21 2007 @@ -1,72 +1,103 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmp-set-quick-print"> - <refnamediv> - <refname>snmp_set_quick_print</refname> - <refpurpose>Set the value of quick_print within the UCD SNMP library - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>snmp_set_quick_print</methodname> - <methodparam><type>bool</type><parameter>quick_print</parameter></methodparam> - </methodsynopsis> - - <para> - Sets the value of quick_print within the UCD SNMP library. When this - is set (1), the SNMP library will return 'quick printed' values. This - means that just the value will be printed. When quick_print is not - enabled (default) the UCD SNMP library prints extra information - including the type of the value (i.e. IpAddress or OID). Additionally, - if quick_print is not enabled, the library prints additional hex values - for all strings of three characters or less. - </para> - - <para> - Setting quick_print is often used when using the information returned - rather then displaying it. - - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.5 $ --> +<refentry id="function.snmp-set-quick-print"> + <refnamediv> + <refname>snmp_set_quick_print</refname> + <refpurpose>Set the value of quick_print within the UCD SNMP library + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>void</type><methodname>snmp_set_quick_print</methodname> + <methodparam><type>bool</type><parameter>quick_print</parameter></methodparam> + </methodsynopsis> + + <para> + Sets the value of quick_print within the UCD SNMP library. When this + is set (1), the SNMP library will return 'quick printed' values. This + means that just the value will be printed. When quick_print is not + enabled (default) the UCD SNMP library prints extra information + including the type of the value (i.e. IpAddress or OID). Additionally, + if quick_print is not enabled, the library prints additional hex values + for all strings of three characters or less. + </para> + <para> + By default the UCD SNMP library returns verbose values, quick_print is + used to return only the value. + </para> + <para> + Currently strings are still returned with extra quotes, this will be + corrected in a later release. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>quick_print</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + Setting quick_print is often used when using the information returned + rather then displaying it. + </para> + <para> + <example> + <title>Using <function>snmp_set_quick_print</function></title> + <programlisting role="php"> <![CDATA[ <?php snmp_set_quick_print(0); $a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1"); -echo "$a< br />\n"; +echo "$a\n"; snmp_set_quick_print(1); $a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1"); -echo "$a<br />\n"; +echo "$a\n"; ?> ]]> - </programlisting> - </informalexample> - </para> - - <para> - The first value printed might be: 'Timeticks: (0) 0:00:00.00', whereas - with quick_print enabled, just '0:00:00.00' would be printed. - </para> - - <para> - By default the UCD SNMP library returns verbose values, quick_print is - used to return only the value. - </para> - - <para> - Currently strings are still returned with extra quotes, this will be - corrected in a later release. - </para> - - <para> - <function>snmp_set_quick_print</function> is only available when using - the UCD SNMP library. This function is not available when using - the Windows SNMP library. - </para> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +'Timeticks: (0) 0:00:00.00' +'0:00:00.00' +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + <function>snmp_get_quick_print</function> is only available when using + the UCD SNMP library. This function is not available when using the + Windows SNMP library. + </para> + </note> + </refsect1> - </refsect1> - </refentry> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml:1.2 phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml:1.3 --- phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml:1.2 Fri Jun 24 13:24:34 2005 +++ phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.snmp-set-valueretrieval"> <refnamediv> <refname>snmp_set_valueretrieval</refname> @@ -7,8 +7,8 @@ Specify the method how the SNMP values will be returned </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>snmp_set_valueretrieval</methodname> <methodparam><type>int</type><parameter>method</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpget.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpget.xml diff -u phpdoc/en/reference/snmp/functions/snmpget.xml:1.3 phpdoc/en/reference/snmp/functions/snmpget.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmpget.xml:1.3 Wed Jul 16 17:21:14 2003 +++ phpdoc/en/reference/snmp/functions/snmpget.xml Sun Jan 7 01:04:21 2007 @@ -1,48 +1,99 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpget"> - <refnamediv> - <refname>snmpget</refname> - <refpurpose>Fetch an SNMP object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>snmpget</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Returns SNMP object value on success and &false; on error. - </para> - - <para> - The <function>snmpget</function> function is used to read the - value of an SNMP object specified by the - <parameter>object_id</parameter>. SNMP agent is specified by the - <parameter>hostname</parameter> and the read community is - specified by the <parameter>community</parameter> parameter. - </para> - - <para> - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.4 $ --> +<refentry id="function.snmpget"> + <refnamediv> + <refname>snmpget</refname> + <refpurpose>Fetch an SNMP object</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>snmpget</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + <para> + The <function>snmpget</function> function is used to read the + value of an SNMP object specified by the + <parameter>object_id</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + The SNMP object. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns SNMP object value on success or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Using <function>snmpget</function></title> + <programlisting role="php"> <![CDATA[ <?php $syscontact = snmpget("127.0.0.1", "public", "system.SysContact.0"); ?> ]]> - </programlisting> - </informalexample> - </para> + </programlisting> + </example> + </para> + </refsect1> - </refsect1> - </refentry> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpgetnext.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpgetnext.xml diff -u phpdoc/en/reference/snmp/functions/snmpgetnext.xml:1.1 phpdoc/en/reference/snmp/functions/snmpgetnext.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmpgetnext.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmpgetnext.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmpgetnext"> <refnamediv> <refname>snmpgetnext</refname> @@ -7,8 +7,8 @@ Fetch a SNMP object </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>snmpgetnext</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmprealwalk.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmprealwalk.xml diff -u phpdoc/en/reference/snmp/functions/snmprealwalk.xml:1.3 phpdoc/en/reference/snmp/functions/snmprealwalk.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmprealwalk.xml:1.3 Sun Jun 30 16:08:48 2002 +++ phpdoc/en/reference/snmp/functions/snmprealwalk.xml Sun Jan 7 01:04:21 2007 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.20 --> - <refentry id='function.snmprealwalk'> - <refnamediv> - <refname>snmprealwalk</refname> - <refpurpose> - Return all objects including their respective object ID within the specified one - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>snmprealwalk</methodname> - <methodparam><type>string</type><parameter>host</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id='function.snmprealwalk'> + <refnamediv> + <refname>snmprealwalk</refname> + <refpurpose> + Return all objects including their respective object ID within the specified one + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>snmprealwalk</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + &warn.undocumented.func; + + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpset.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpset.xml diff -u phpdoc/en/reference/snmp/functions/snmpset.xml:1.2 phpdoc/en/reference/snmp/functions/snmpset.xml:1.3 --- phpdoc/en/reference/snmp/functions/snmpset.xml:1.2 Wed Apr 17 06:44:04 2002 +++ phpdoc/en/reference/snmp/functions/snmpset.xml Sun Jan 7 01:04:21 2007 @@ -1,39 +1,98 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpset"> - <refnamediv> - <refname>snmpset</refname> - <refpurpose>Set an SNMP object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>snmpset</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam><type>string</type><parameter>type</parameter></methodparam> - <methodparam><type>mixed</type><parameter>value</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Sets the specified SNMP object value, returning &true; on success - and &false; on error. - </para> - - <para> - The <function>snmpset</function> function is used - to set the value of an SNMP object specified by the - <parameter>object_id</parameter>. SNMP agent is specified by the - <parameter>hostname</parameter> and the read community is specified - by the <parameter>community</parameter> parameter. - </para> +<!-- $Revision: 1.3 $ --> +<refentry id="function.snmpset"> + <refnamediv> + <refname>snmpset</refname> + <refpurpose>Set an SNMP object</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>snmpset</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> - </refsect1> - </refentry> + <para> + <function>snmpset</function> is used to set the value of an SNMP object + specified by the <parameter>object_id</parameter>. + </para> + + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + The SNMP object. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpwalk.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpwalk.xml diff -u phpdoc/en/reference/snmp/functions/snmpwalk.xml:1.5 phpdoc/en/reference/snmp/functions/snmpwalk.xml:1.6 --- phpdoc/en/reference/snmp/functions/snmpwalk.xml:1.5 Fri Jul 1 13:07:49 2005 +++ phpdoc/en/reference/snmp/functions/snmpwalk.xml Sun Jan 7 01:04:21 2007 @@ -1,69 +1,114 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpwalk"> - <refnamediv> - <refname>snmpwalk</refname> - <refpurpose>Fetch all the SNMP objects from an agent</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>snmpwalk</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Returns an array of SNMP object values starting from the - <parameter>object_id</parameter> as root and &false; on error. - </para> - - <para> - <function>snmpwalk</function> function is used to read all the - values from an SNMP agent specified by the - <parameter>hostname</parameter>. <parameter>Community</parameter> - specifies the read community for that agent. A &null; - <parameter>object_id</parameter> is taken as the root of the SNMP - objects tree and all objects under that tree are returned as an - array. If <parameter>object_id</parameter> is specified, all the - SNMP objects below that <parameter>object_id</parameter> are - returned. - - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.snmpwalk"> + <refnamediv> + <refname>snmpwalk</refname> + <refpurpose>Fetch all the SNMP objects from an agent</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>snmpwalk</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + <para> + <function>snmpwalk</function> function is used to read all the values from + an SNMP agent specified by the <parameter>hostname</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + If &null;, <parameter>object_id</parameter> is taken as the root of + the SNMP objects tree and all objects under that tree are returned as + an array. + </para> + <para> + If <parameter>object_id</parameter> is specified, all the SNMP objects + below that <parameter>object_id</parameter> are returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of SNMP object values starting from the + <parameter>object_id</parameter> as root or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>snmpwalk</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php $a = snmpwalk("127.0.0.1", "public", ""); -?> -]]> - </programlisting> - </informalexample> - </para> - - <para> - Above function call would return all the SNMP objects from the - SNMP agent running on localhost. One can step through the values - with a loop - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php foreach ($a as $val) { echo "$val\n"; } + ?> ]]> - </programlisting> - </informalexample> - </para> + </programlisting> + </example> + </para> + <para> + Above function call would return all the SNMP objects from the + SNMP agent running on localhost. One can step through the values + with a loop + </para> + </refsect1> - </refsect1> - </refentry> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpwalkoid.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpwalkoid.xml diff -u phpdoc/en/reference/snmp/functions/snmpwalkoid.xml:1.5 phpdoc/en/reference/snmp/functions/snmpwalkoid.xml:1.6 --- phpdoc/en/reference/snmp/functions/snmpwalkoid.xml:1.5 Tue Aug 3 17:25:34 2004 +++ phpdoc/en/reference/snmp/functions/snmpwalkoid.xml Sun Jan 7 01:04:21 2007 @@ -1,77 +1,121 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpwalkoid"> - <refnamediv> - <refname>snmpwalkoid</refname> - <refpurpose>Query for a tree of information about a network entity - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>snmpwalkoid</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Returns an associative array with object ids and their respective - object value starting from the <parameter>object_id</parameter> - as root and &false; on error. - </para> - - <para> - <function>snmpwalkoid</function> function is used to read all - object ids and their respective values from an SNMP agent - specified by the <parameter>hostname</parameter>. Community specifies the read - <parameter>community</parameter> for that agent. A &null; - <parameter>object_id</parameter> is taken as the root of the SNMP - objects tree and all objects under that tree are returned as an - array. If <parameter>object_id</parameter> is specified, all the - SNMP objects below that <parameter>object_id</parameter> are - returned. - </para> - - <para> - The existence of <function>snmpwalkoid</function> and - <function>snmpwalk</function> has historical reasons. Both - functions are provided for backward compatibility. - - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.snmpwalkoid"> + <refnamediv> + <refname>snmpwalkoid</refname> + <refpurpose>Query for a tree of information about a network entity + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>snmpwalkoid</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + <para> + <function>snmpwalkoid</function> function is used to read all object ids + and their respective values from an SNMP agent specified by + <parameter>hostname</parameter>. + </para> + + <para> + The existence of <function>snmpwalkoid</function> and + <function>snmpwalk</function> has historical reasons. Both + functions are provided for backward compatibility. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + If &null;, <parameter>object_id</parameter> is taken as the root of + the SNMP objects tree and all objects under that tree are returned as + an array. + </para> + <para> + If <parameter>object_id</parameter> is specified, all the SNMP objects + below that <parameter>object_id</parameter> are returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with object ids and their respective + object value starting from the <parameter>object_id</parameter> + as root or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>snmpwalkoid</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php $a = snmpwalkoid("127.0.0.1", "public", ""); -?> -]]> - </programlisting> - </informalexample> - </para> - - <para> - Above function call would return all the SNMP objects from the - SNMP agent running on localhost. One can step through the values - with a loop - - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php for (reset($a); $i = key($a); next($a)) { echo "$i: $a[$i]<br />\n"; } ?> ]]> - </programlisting> - </informalexample> - </para> + </programlisting> + </example> + </para> + <para> + Above function call would return all the SNMP objects from the + SNMP agent running on localhost. One can step through the values + with a loop + </para> + </refsect1> - </refsect1> - </refentry> +</refentry> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml:1.3 phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml:1.3 Wed Jul 16 01:10:08 2003 +++ phpdoc/en/reference/snmp/functions/snmp-get-quick-print.xml Sun Jan 7 01:04:21 2007 @@ -1,50 +1,69 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmp-get-quick-print"> - <refnamediv> - <refname>snmp_get_quick_print</refname> - <refpurpose> - Fetches the current value of the UCD library's quick_print setting - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>snmp_get_quick_print</methodname> - <void/> - </methodsynopsis> - <para> - Returns the current value stored in the UCD Library for quick_print. - quick_print is off by default. - <example> - <title><function>snmp_get_quick_print</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.4 $ --> +<refentry id="function.snmp-get-quick-print"> + <refnamediv> + <refname>snmp_get_quick_print</refname> + <refpurpose> + Fetches the current value of the UCD library's quick_print setting + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>snmp_get_quick_print</methodname> + <void/> + </methodsynopsis> + <para> + Returns the current value stored in the UCD Library for quick_print. + quick_print is off by default. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if quick_print is on, &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>snmp_get_quick_print</function> example</title> + <programlisting role="php"> <![CDATA[ <?php - $quickprint = snmp_get_quick_print(); +$quickprint = snmp_get_quick_print(); ?> ]]> - </programlisting> - </example> - </para> - <para> - Above function call would return &false; if - quick_print is off, and &true; if quick_print - is on. - </para> - <para> - <function>snmp_get_quick_print</function> is only available when using - the UCD SNMP library. This function is not available when using the - Windows SNMP library. - </para> - <para> - See also - <function>snmp_set_quick_print</function> for a full description - of what quick_print does. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + <function>snmp_get_quick_print</function> is only available when using + the UCD SNMP library. This function is not available when using the + Windows SNMP library. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>snmp_set_quick_print</function> for a full description + of what quick_print does.</member> + </simplelist> + </para> + </refsect1> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml diff -u phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml:1.1 phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmp-get-valueretrieval.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmp-get-valueretrieval"> <refnamediv> <refname>snmp_get_valueretrieval</refname> @@ -7,8 +7,8 @@ Return the method how the SNMP values will be returned </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>snmp_get_valueretrieval</methodname> <void/> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-read-mib.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-read-mib.xml diff -u phpdoc/en/reference/snmp/functions/snmp-read-mib.xml:1.3 phpdoc/en/reference/snmp/functions/snmp-read-mib.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmp-read-mib.xml:1.3 Fri Jun 24 09:11:46 2005 +++ phpdoc/en/reference/snmp/functions/snmp-read-mib.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.snmp-read-mib"> <refnamediv> <refname>snmp_read_mib</refname> @@ -7,8 +7,8 @@ Reads and parses a MIB file into the active MIB tree </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>snmp_read_mib</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml:1.1 phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmp-set-enum-print.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmp-set-enum-print"> <refnamediv> <refname>snmp_set_enum_print</refname> @@ -7,8 +7,8 @@ Return all values that are enums with their enum value instead of the raw integer </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>snmp_set_enum_print</methodname> <methodparam><type>int</type><parameter>enum_print</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml:1.1 phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmp-set-oid-numeric-print.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmp-set-oid-numeric-print"> <refnamediv> <refname>snmp_set_oid_numeric_print</refname> @@ -7,8 +7,8 @@ Return all objects including their respective object id within the specified one </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>snmp_set_oid_numeric_print</methodname> <methodparam><type>int</type><parameter>oid_numeric_print</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml:1.4 phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml:1.5 --- phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml:1.4 Mon Dec 15 16:53:45 2003 +++ phpdoc/en/reference/snmp/functions/snmp-set-quick-print.xml Sun Jan 7 01:04:21 2007 @@ -1,72 +1,103 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmp-set-quick-print"> - <refnamediv> - <refname>snmp_set_quick_print</refname> - <refpurpose>Set the value of quick_print within the UCD SNMP library - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>snmp_set_quick_print</methodname> - <methodparam><type>bool</type><parameter>quick_print</parameter></methodparam> - </methodsynopsis> - - <para> - Sets the value of quick_print within the UCD SNMP library. When this - is set (1), the SNMP library will return 'quick printed' values. This - means that just the value will be printed. When quick_print is not - enabled (default) the UCD SNMP library prints extra information - including the type of the value (i.e. IpAddress or OID). Additionally, - if quick_print is not enabled, the library prints additional hex values - for all strings of three characters or less. - </para> - - <para> - Setting quick_print is often used when using the information returned - rather then displaying it. - - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.5 $ --> +<refentry id="function.snmp-set-quick-print"> + <refnamediv> + <refname>snmp_set_quick_print</refname> + <refpurpose>Set the value of quick_print within the UCD SNMP library + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>void</type><methodname>snmp_set_quick_print</methodname> + <methodparam><type>bool</type><parameter>quick_print</parameter></methodparam> + </methodsynopsis> + + <para> + Sets the value of quick_print within the UCD SNMP library. When this + is set (1), the SNMP library will return 'quick printed' values. This + means that just the value will be printed. When quick_print is not + enabled (default) the UCD SNMP library prints extra information + including the type of the value (i.e. IpAddress or OID). Additionally, + if quick_print is not enabled, the library prints additional hex values + for all strings of three characters or less. + </para> + <para> + By default the UCD SNMP library returns verbose values, quick_print is + used to return only the value. + </para> + <para> + Currently strings are still returned with extra quotes, this will be + corrected in a later release. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>quick_print</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + Setting quick_print is often used when using the information returned + rather then displaying it. + </para> + <para> + <example> + <title>Using <function>snmp_set_quick_print</function></title> + <programlisting role="php"> <![CDATA[ <?php snmp_set_quick_print(0); $a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1"); -echo "$a< br />\n"; +echo "$a\n"; snmp_set_quick_print(1); $a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1"); -echo "$a<br />\n"; +echo "$a\n"; ?> ]]> - </programlisting> - </informalexample> - </para> - - <para> - The first value printed might be: 'Timeticks: (0) 0:00:00.00', whereas - with quick_print enabled, just '0:00:00.00' would be printed. - </para> - - <para> - By default the UCD SNMP library returns verbose values, quick_print is - used to return only the value. - </para> - - <para> - Currently strings are still returned with extra quotes, this will be - corrected in a later release. - </para> - - <para> - <function>snmp_set_quick_print</function> is only available when using - the UCD SNMP library. This function is not available when using - the Windows SNMP library. - </para> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +'Timeticks: (0) 0:00:00.00' +'0:00:00.00' +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + <function>snmp_get_quick_print</function> is only available when using + the UCD SNMP library. This function is not available when using the + Windows SNMP library. + </para> + </note> + </refsect1> - </refsect1> - </refentry> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml diff -u phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml:1.2 phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml:1.3 --- phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml:1.2 Fri Jun 24 13:24:34 2005 +++ phpdoc/en/reference/snmp/functions/snmp-set-valueretrieval.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.snmp-set-valueretrieval"> <refnamediv> <refname>snmp_set_valueretrieval</refname> @@ -7,8 +7,8 @@ Specify the method how the SNMP values will be returned </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>snmp_set_valueretrieval</methodname> <methodparam><type>int</type><parameter>method</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpget.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpget.xml diff -u phpdoc/en/reference/snmp/functions/snmpget.xml:1.3 phpdoc/en/reference/snmp/functions/snmpget.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmpget.xml:1.3 Wed Jul 16 17:21:14 2003 +++ phpdoc/en/reference/snmp/functions/snmpget.xml Sun Jan 7 01:04:21 2007 @@ -1,48 +1,99 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpget"> - <refnamediv> - <refname>snmpget</refname> - <refpurpose>Fetch an SNMP object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>snmpget</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Returns SNMP object value on success and &false; on error. - </para> - - <para> - The <function>snmpget</function> function is used to read the - value of an SNMP object specified by the - <parameter>object_id</parameter>. SNMP agent is specified by the - <parameter>hostname</parameter> and the read community is - specified by the <parameter>community</parameter> parameter. - </para> - - <para> - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.4 $ --> +<refentry id="function.snmpget"> + <refnamediv> + <refname>snmpget</refname> + <refpurpose>Fetch an SNMP object</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>snmpget</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + <para> + The <function>snmpget</function> function is used to read the + value of an SNMP object specified by the + <parameter>object_id</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + The SNMP object. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns SNMP object value on success or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Using <function>snmpget</function></title> + <programlisting role="php"> <![CDATA[ <?php $syscontact = snmpget("127.0.0.1", "public", "system.SysContact.0"); ?> ]]> - </programlisting> - </informalexample> - </para> + </programlisting> + </example> + </para> + </refsect1> - </refsect1> - </refentry> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpgetnext.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpgetnext.xml diff -u phpdoc/en/reference/snmp/functions/snmpgetnext.xml:1.1 phpdoc/en/reference/snmp/functions/snmpgetnext.xml:1.2 --- phpdoc/en/reference/snmp/functions/snmpgetnext.xml:1.1 Sun May 2 19:35:35 2004 +++ phpdoc/en/reference/snmp/functions/snmpgetnext.xml Sun Jan 7 01:04:21 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.snmpgetnext"> <refnamediv> <refname>snmpgetnext</refname> @@ -7,8 +7,8 @@ Fetch a SNMP object </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>snmpgetnext</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmprealwalk.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmprealwalk.xml diff -u phpdoc/en/reference/snmp/functions/snmprealwalk.xml:1.3 phpdoc/en/reference/snmp/functions/snmprealwalk.xml:1.4 --- phpdoc/en/reference/snmp/functions/snmprealwalk.xml:1.3 Sun Jun 30 16:08:48 2002 +++ phpdoc/en/reference/snmp/functions/snmprealwalk.xml Sun Jan 7 01:04:21 2007 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.20 --> - <refentry id='function.snmprealwalk'> - <refnamediv> - <refname>snmprealwalk</refname> - <refpurpose> - Return all objects including their respective object ID within the specified one - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>snmprealwalk</methodname> - <methodparam><type>string</type><parameter>host</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id='function.snmprealwalk'> + <refnamediv> + <refname>snmprealwalk</refname> + <refpurpose> + Return all objects including their respective object ID within the specified one + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>snmprealwalk</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + &warn.undocumented.func; + + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpset.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpset.xml diff -u phpdoc/en/reference/snmp/functions/snmpset.xml:1.2 phpdoc/en/reference/snmp/functions/snmpset.xml:1.3 --- phpdoc/en/reference/snmp/functions/snmpset.xml:1.2 Wed Apr 17 06:44:04 2002 +++ phpdoc/en/reference/snmp/functions/snmpset.xml Sun Jan 7 01:04:21 2007 @@ -1,39 +1,98 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpset"> - <refnamediv> - <refname>snmpset</refname> - <refpurpose>Set an SNMP object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>snmpset</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam><type>string</type><parameter>type</parameter></methodparam> - <methodparam><type>mixed</type><parameter>value</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Sets the specified SNMP object value, returning &true; on success - and &false; on error. - </para> - - <para> - The <function>snmpset</function> function is used - to set the value of an SNMP object specified by the - <parameter>object_id</parameter>. SNMP agent is specified by the - <parameter>hostname</parameter> and the read community is specified - by the <parameter>community</parameter> parameter. - </para> +<!-- $Revision: 1.3 $ --> +<refentry id="function.snmpset"> + <refnamediv> + <refname>snmpset</refname> + <refpurpose>Set an SNMP object</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>snmpset</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> - </refsect1> - </refentry> + <para> + <function>snmpset</function> is used to set the value of an SNMP object + specified by the <parameter>object_id</parameter>. + </para> + + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + The SNMP object. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpwalk.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpwalk.xml diff -u phpdoc/en/reference/snmp/functions/snmpwalk.xml:1.5 phpdoc/en/reference/snmp/functions/snmpwalk.xml:1.6 --- phpdoc/en/reference/snmp/functions/snmpwalk.xml:1.5 Fri Jul 1 13:07:49 2005 +++ phpdoc/en/reference/snmp/functions/snmpwalk.xml Sun Jan 7 01:04:21 2007 @@ -1,69 +1,114 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpwalk"> - <refnamediv> - <refname>snmpwalk</refname> - <refpurpose>Fetch all the SNMP objects from an agent</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>snmpwalk</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Returns an array of SNMP object values starting from the - <parameter>object_id</parameter> as root and &false; on error. - </para> - - <para> - <function>snmpwalk</function> function is used to read all the - values from an SNMP agent specified by the - <parameter>hostname</parameter>. <parameter>Community</parameter> - specifies the read community for that agent. A &null; - <parameter>object_id</parameter> is taken as the root of the SNMP - objects tree and all objects under that tree are returned as an - array. If <parameter>object_id</parameter> is specified, all the - SNMP objects below that <parameter>object_id</parameter> are - returned. - - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.snmpwalk"> + <refnamediv> + <refname>snmpwalk</refname> + <refpurpose>Fetch all the SNMP objects from an agent</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>snmpwalk</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + <para> + <function>snmpwalk</function> function is used to read all the values from + an SNMP agent specified by the <parameter>hostname</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + If &null;, <parameter>object_id</parameter> is taken as the root of + the SNMP objects tree and all objects under that tree are returned as + an array. + </para> + <para> + If <parameter>object_id</parameter> is specified, all the SNMP objects + below that <parameter>object_id</parameter> are returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of SNMP object values starting from the + <parameter>object_id</parameter> as root or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>snmpwalk</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php $a = snmpwalk("127.0.0.1", "public", ""); -?> -]]> - </programlisting> - </informalexample> - </para> - - <para> - Above function call would return all the SNMP objects from the - SNMP agent running on localhost. One can step through the values - with a loop - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php foreach ($a as $val) { echo "$val\n"; } + ?> ]]> - </programlisting> - </informalexample> - </para> + </programlisting> + </example> + </para> + <para> + Above function call would return all the SNMP objects from the + SNMP agent running on localhost. One can step through the values + with a loop + </para> + </refsect1> - </refsect1> - </refentry> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/snmp/functions/snmpwalkoid.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/snmp/functions/snmpwalkoid.xml diff -u phpdoc/en/reference/snmp/functions/snmpwalkoid.xml:1.5 phpdoc/en/reference/snmp/functions/snmpwalkoid.xml:1.6 --- phpdoc/en/reference/snmp/functions/snmpwalkoid.xml:1.5 Tue Aug 3 17:25:34 2004 +++ phpdoc/en/reference/snmp/functions/snmpwalkoid.xml Sun Jan 7 01:04:21 2007 @@ -1,77 +1,121 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 --> - <refentry id="function.snmpwalkoid"> - <refnamediv> - <refname>snmpwalkoid</refname> - <refpurpose>Query for a tree of information about a network entity - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>snmpwalkoid</methodname> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>community</parameter></methodparam> - <methodparam><type>string</type><parameter>object_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> - </methodsynopsis> - - <para> - Returns an associative array with object ids and their respective - object value starting from the <parameter>object_id</parameter> - as root and &false; on error. - </para> - - <para> - <function>snmpwalkoid</function> function is used to read all - object ids and their respective values from an SNMP agent - specified by the <parameter>hostname</parameter>. Community specifies the read - <parameter>community</parameter> for that agent. A &null; - <parameter>object_id</parameter> is taken as the root of the SNMP - objects tree and all objects under that tree are returned as an - array. If <parameter>object_id</parameter> is specified, all the - SNMP objects below that <parameter>object_id</parameter> are - returned. - </para> - - <para> - The existence of <function>snmpwalkoid</function> and - <function>snmpwalk</function> has historical reasons. Both - functions are provided for backward compatibility. - - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.snmpwalkoid"> + <refnamediv> + <refname>snmpwalkoid</refname> + <refpurpose>Query for a tree of information about a network entity + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>snmpwalkoid</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> + + <para> + <function>snmpwalkoid</function> function is used to read all object ids + and their respective values from an SNMP agent specified by + <parameter>hostname</parameter>. + </para> + + <para> + The existence of <function>snmpwalkoid</function> and + <function>snmpwalk</function> has historical reasons. Both + functions are provided for backward compatibility. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + The SNMP agent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>community</parameter></term> + <listitem> + <para> + The read community. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>object_id</parameter></term> + <listitem> + <para> + If &null;, <parameter>object_id</parameter> is taken as the root of + the SNMP objects tree and all objects under that tree are returned as + an array. + </para> + <para> + If <parameter>object_id</parameter> is specified, all the SNMP objects + below that <parameter>object_id</parameter> are returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retries</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with object ids and their respective + object value starting from the <parameter>object_id</parameter> + as root or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>snmpwalkoid</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php $a = snmpwalkoid("127.0.0.1", "public", ""); -?> -]]> - </programlisting> - </informalexample> - </para> - - <para> - Above function call would return all the SNMP objects from the - SNMP agent running on localhost. One can step through the values - with a loop - - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php for (reset($a); $i = key($a); next($a)) { echo "$i: $a[$i]<br />\n"; } ?> ]]> - </programlisting> - </informalexample> - </para> + </programlisting> + </example> + </para> + <para> + Above function call would return all the SNMP objects from the + SNMP agent running on localhost. One can step through the values + with a loop + </para> + </refsect1> - </refsect1> - </refentry> +</refentry> <!-- Keep this comment at the end of the file Local variables: