[DOC-CVS] [doc-en] master: snmp: fix XML to remove useless wrapping para tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-26T15:34:34Z
Commit: https://github.com/php/doc-en/commit/017ddc051b8136cc9116b57ce51f655fe681bb82
Raw diff: https://github.com/php/doc-en/commit/017ddc051b8136cc9116b57ce51f655fe681bb82.diff
snmp: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/snmp/functions/snmp-get-quick-print.xml
M reference/snmp/functions/snmp-get-valueretrieval.xml
M reference/snmp/functions/snmp-read-mib.xml
M reference/snmp/functions/snmp-set-enum-print.xml
M reference/snmp/functions/snmp-set-oid-numeric-print.xml
M reference/snmp/functions/snmp-set-oid-output-format.xml
M reference/snmp/functions/snmp-set-quick-print.xml
M reference/snmp/functions/snmp-set-valueretrieval.xml
M reference/snmp/functions/snmp2-get.xml
M reference/snmp/functions/snmp2-getnext.xml
M reference/snmp/functions/snmp2-real-walk.xml
M reference/snmp/functions/snmp2-set.xml
M reference/snmp/functions/snmp2-walk.xml
M reference/snmp/functions/snmp3-get.xml
M reference/snmp/functions/snmp3-getnext.xml
M reference/snmp/functions/snmp3-real-walk.xml
M reference/snmp/functions/snmp3-walk.xml
M reference/snmp/functions/snmpget.xml
M reference/snmp/functions/snmpgetnext.xml
M reference/snmp/functions/snmprealwalk.xml
M reference/snmp/functions/snmpset.xml
M reference/snmp/functions/snmpwalk.xml
M reference/snmp/functions/snmpwalkoid.xml
M reference/snmp/snmp/get.xml
M reference/snmp/snmp/getnext.xml
M reference/snmp/snmp/set.xml
Diff:
diff --git a/reference/snmp/functions/snmp-get-quick-print.xml b/reference/snmp/functions/snmp-get-quick-print.xml
index d945e422af5e..233cd8866003 100644
--- a/reference/snmp/functions/snmp-get-quick-print.xml
+++ b/reference/snmp/functions/snmp-get-quick-print.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-get-quick-print" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmp-get-quick-print">
<refnamediv>
<refname>snmp_get_quick_print</refname>
<refpurpose>
@@ -14,7 +14,7 @@
<void/>
</methodsynopsis>
<para>
- Returns the current value stored in the NET-SNMP Library for quick_print.
+ Returns the current value stored in the NET-SNMP Library for quick_print.
quick_print is off by default.
</para>
</refsect1>
@@ -33,32 +33,27 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>snmp_get_quick_print</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>snmp_get_quick_print</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$quickprint = snmp_get_quick_print();
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</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>
+ <simplelist>
+ <member><function>snmp_set_quick_print</function> for a full description
+ of what quick_print does.</member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/snmp/functions/snmp-get-valueretrieval.xml b/reference/snmp/functions/snmp-get-valueretrieval.xml
index 920edeab49f5..04d1d26820a0 100644
--- a/reference/snmp/functions/snmp-get-valueretrieval.xml
+++ b/reference/snmp/functions/snmp-get-valueretrieval.xml
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-get-valueretrieval" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp-get-valueretrieval">
<refnamediv>
<refname>snmp_get_valueretrieval</refname>
<refpurpose>
Return the method how the SNMP values will be returned
</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -21,7 +21,7 @@
&reftitle.parameters;
&no.function.parameters;
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -30,13 +30,12 @@
possible SNMP_VALUE_OBJECT set.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp_get_valueretrieval</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp_get_valueretrieval</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$ret = snmpget('localhost', 'public', 'IF-MIB::ifName.1');
@@ -47,25 +46,21 @@
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member>
- <function>snmp_set_valueretrieval</function>
- </member>
- <member><xref linkend="snmp.constants" /></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member>
+ <function>snmp_set_valueretrieval</function>
+ </member>
+ <member><xref linkend="snmp.constants"/></member>
+ </simplelist>
</refsect1>
-
-</refentry>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -86,4 +81,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/snmp/functions/snmp-read-mib.xml b/reference/snmp/functions/snmp-read-mib.xml
index 4b5735a54ca4..a31b3247d9ce 100644
--- a/reference/snmp/functions/snmp-read-mib.xml
+++ b/reference/snmp/functions/snmp-read-mib.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-read-mib" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmp-read-mib">
<refnamediv>
<refname>snmp_read_mib</refname>
<refpurpose>
@@ -13,7 +13,7 @@
<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 <literal>VENDOR-MIB::foo.1</literal> instead of error prone numeric OIDs
@@ -23,19 +23,17 @@
The order in which the MIBs are loaded does matter as the underlying Net-SNMP
library 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>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem><para>The filename of the <acronym>MIB</acronym>.</para></listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,27 +42,25 @@
&return.success;
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp_read_mib</function></title>
- <programlisting role="php">
+ <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>
+ </programlisting>
+ </example>
<para>
The above example is made up but the results would look like:
-<![CDATA[
+<![CDATA[
Array
(
[iso.3.6.1.2.1.2.3.4.5.0] => Gauge32: 6
@@ -76,9 +72,8 @@ Array
]]>
</para>
</refsect1>
-
-</refentry>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/snmp/functions/snmp-set-enum-print.xml b/reference/snmp/functions/snmp-set-enum-print.xml
index 3b07c4641611..87e001f29847 100644
--- a/reference/snmp/functions/snmp-set-enum-print.xml
+++ b/reference/snmp/functions/snmp-set-enum-print.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-set-enum-print" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmp-set-enum-print">
<refnamediv>
<refname>snmp_set_enum_print</refname>
<refpurpose>
@@ -15,10 +15,10 @@
</methodsynopsis>
<para>
This function toggles if snmpwalk/snmpget etc. should automatically lookup enum values
- in the MIB and return them together with their human readable string.
+ in the MIB and return them together with their human readable string.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -42,29 +42,26 @@
<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>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &return.type.true;
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp_set_enum_print</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp_set_enum_print</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
snmp_set_enum_print(0);
@@ -73,18 +70,17 @@
echo snmpget('localhost', 'public', 'IF-MIB::ifOperStatus.3') . "\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
The above would return
-<![CDATA[
+<![CDATA[
INTEGER: up(1)
INTEGER: 1
]]>
</para>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp-set-oid-numeric-print.xml b/reference/snmp/functions/snmp-set-oid-numeric-print.xml
index 6bf3d18d2545..b200c8ebecfc 100644
--- a/reference/snmp/functions/snmp-set-oid-numeric-print.xml
+++ b/reference/snmp/functions/snmp-set-oid-numeric-print.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-set-oid-numeric-print" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmp-set-oid-numeric-print">
<refnamediv>
<refname>snmp_set_oid_numeric_print</refname>
<refpurpose>&Alias; <function>snmp_set_oid_output_format</function></refpurpose>
@@ -15,13 +15,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp_set_oid_output_format</function></member>
- </simplelist>
- </para>
- </refsect1>
-
+ <simplelist>
+ <member><function>snmp_set_oid_output_format</function></member>
+ </simplelist>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp-set-oid-output-format.xml b/reference/snmp/functions/snmp-set-oid-output-format.xml
index 4e7b4b4a4fa1..935af3b9fa04 100644
--- a/reference/snmp/functions/snmp-set-oid-output-format.xml
+++ b/reference/snmp/functions/snmp-set-oid-output-format.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-set-oid-output-format" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmp-set-oid-output-format">
<refnamediv>
<refname>snmp_set_oid_output_format</refname>
<refpurpose>
@@ -18,31 +18,29 @@
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>
+ <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>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,29 +52,26 @@
<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>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &return.type.true;
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmprealwalk</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmprealwalk</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -92,10 +87,10 @@
print_r( snmprealwalk('localhost', 'public', 'RFC1213-MIB::sysObjectID') );
?>
]]>
- </programlisting>
-
- <para>
- The above would output:
+ </programlisting>
+
+ <para>
+ The above would output:
<![CDATA[
Array
(
@@ -110,12 +105,11 @@
[.iso.org.dod.internet.mgmt.mib-2.system.sysObjectID.0] => OID: .iso.org.dod.internet.private.enterprises.netSnmp.netSnmpEnumerations.netSnmpAgentOIDs.linux
)
]]>
- </para>
- </example>
- </para>
+ </para>
+ </example>
</refsect1>
-
-
+
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp-set-quick-print.xml b/reference/snmp/functions/snmp-set-quick-print.xml
index 26e6c3e032fe..b16779875bed 100644
--- a/reference/snmp/functions/snmp-set-quick-print.xml
+++ b/reference/snmp/functions/snmp-set-quick-print.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-set-quick-print" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmp-set-quick-print">
<refnamediv>
<refname>snmp_set_quick_print</refname>
<refpurpose>Set the value of <parameter>enable</parameter> within the NET-<acronym>SNMP</acronym> library
@@ -18,8 +18,8 @@
is set (1), the <acronym>SNMP</acronym> library will return 'quick printed' values. This
means that just the value will be printed. When <parameter>enable</parameter> is not
enabled (default) the NET-<acronym>SNMP</acronym> 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
+ 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>
@@ -34,17 +34,15 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>enable</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>enable</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -56,21 +54,19 @@
<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>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &return.type.true;
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
@@ -79,10 +75,9 @@
Setting quick_print is often used when using the information returned
rather than displaying it.
</para>
- <para>
- <example>
- <title>Using <function>snmp_set_quick_print</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp_set_quick_print</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
snmp_set_quick_print(0);
@@ -93,25 +88,22 @@ $a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1");
echo "$a\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
'Timeticks: (0) 0:00:00.00'
'0:00:00.00'
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp_get_quick_print</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp_get_quick_print</function></member>
+ </simplelist>
</refsect1>
</refentry>
diff --git a/reference/snmp/functions/snmp-set-valueretrieval.xml b/reference/snmp/functions/snmp-set-valueretrieval.xml
index 58eb30b7f272..162610568777 100644
--- a/reference/snmp/functions/snmp-set-valueretrieval.xml
+++ b/reference/snmp/functions/snmp-set-valueretrieval.xml
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp-set-valueretrieval" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmp-set-valueretrieval">
<refnamediv>
<refname>snmp_set_valueretrieval</refname>
<refpurpose>
Specify the method how the SNMP values will be returned
</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -15,44 +15,42 @@
<methodparam><type>int</type><parameter>method</parameter></methodparam>
</methodsynopsis>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>method</parameter>
- </term>
- <listitem>
- <table>
- <title>types</title>
- <tgroup cols="2">
- <tbody>
- <row>
- <entry>SNMP_VALUE_LIBRARY</entry>
- <entry>The return values will be as returned by the Net-SNMP library.</entry>
- </row>
- <row>
- <entry>SNMP_VALUE_PLAIN</entry>
- <entry>The return values will be the plain value without the SNMP type information.</entry>
- </row>
- <row>
- <entry>SNMP_VALUE_OBJECT</entry>
- <entry>
- The return values will be objects with the properties <literal>value</literal> and <literal>type</literal>, where the latter
- is one of the <constant>SNMP_OCTET_STR</constant>, <constant>SNMP_COUNTER</constant> etc. constants. The
- way <literal>value</literal> is returned is based on which one of constants
- <constant>SNMP_VALUE_LIBRARY</constant>, <constant>SNMP_VALUE_PLAIN</constant> is set.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>method</parameter>
+ </term>
+ <listitem>
+ <table>
+ <title>types</title>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>SNMP_VALUE_LIBRARY</entry>
+ <entry>The return values will be as returned by the Net-SNMP library.</entry>
+ </row>
+ <row>
+ <entry>SNMP_VALUE_PLAIN</entry>
+ <entry>The return values will be the plain value without the SNMP type information.</entry>
+ </row>
+ <row>
+ <entry>SNMP_VALUE_OBJECT</entry>
+ <entry>
+ The return values will be objects with the properties <literal>value</literal> and <literal>type</literal>, where the latter
+ is one of the <constant>SNMP_OCTET_STR</constant>, <constant>SNMP_COUNTER</constant> etc. constants. The
+ way <literal>value</literal> is returned is based on which one of constants
+ <constant>SNMP_VALUE_LIBRARY</constant>, <constant>SNMP_VALUE_PLAIN</constant> is set.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -64,31 +62,28 @@
<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>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &return.type.true;
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using
- <function>snmp_set_valueretrieval</function>
- </title>
- <programlisting role="php">
+ <example>
+ <title>Using
+ <function>snmp_set_valueretrieval</function>
+ </title>
+ <programlisting role="php">
<![CDATA[
<?php
snmp_set_valueretrieval(SNMP_VALUE_LIBRARY);
@@ -125,23 +120,20 @@
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member>
- <function>snmp_get_valueretrieval</function>
- </member>
- <member><xref linkend="snmp.constants"/></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member>
+ <function>snmp_get_valueretrieval</function>
+ </member>
+ <member><xref linkend="snmp.constants"/></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp2-get.xml b/reference/snmp/functions/snmp2-get.xml
index 54bac07d99c9..acc03a8ae259 100644
--- a/reference/snmp/functions/snmp2-get.xml
+++ b/reference/snmp/functions/snmp2-get.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp2-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-get">
<refnamediv>
<refname>snmp2_get</refname>
<refpurpose>Fetch an <acronym>SNMP</acronym> object</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,7 +22,7 @@
<parameter>object_id</parameter>.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -68,39 +68,35 @@
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <acronym>SNMP</acronym> object value on success or &false; on error.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp2_get</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp2_get</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$syscontact = snmp2_get("127.0.0.1", "public", "system.SysContact.0");
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp2_set</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp2_set</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp2-getnext.xml b/reference/snmp/functions/snmp2-getnext.xml
index 1f497591e2ce..85b0d92a68e0 100644
--- a/reference/snmp/functions/snmp2-getnext.xml
+++ b/reference/snmp/functions/snmp2-getnext.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp2-getnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-getnext">
<refnamediv>
<refname>snmp2_getnext</refname>
<refpurpose>Fetch the <acronym>SNMP</acronym> object which follows the given object id</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,7 +22,7 @@
<parameter>object_id</parameter>.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -68,8 +68,8 @@
</varlistentry>
</variablelist>
</refsect1>
-
-
+
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -77,33 +77,29 @@
In case of an error, an E_WARNING message is shown.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp2_get_next</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp2_get_next</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$nameOfSecondInterface = snmp2_get_next('localhost', 'public', 'IF-MIB::ifName.1');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp2_get</function></member>
- <member><function>snmp2_walk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp2_get</function></member>
+ <member><function>snmp2_walk</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp2-real-walk.xml b/reference/snmp/functions/snmp2-real-walk.xml
index 26ac49c3c311..df34bb471c53 100644
--- a/reference/snmp/functions/snmp2-real-walk.xml
+++ b/reference/snmp/functions/snmp2-real-walk.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp2-real-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-real-walk">
<refnamediv>
<refname>snmp2_real_walk</refname>
<refpurpose>Return all objects including their respective object ID within the specified one</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,7 +22,7 @@
and return not only their values but also their object ids.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -68,8 +68,8 @@
</varlistentry>
</variablelist>
</refsect1>
-
-
+
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -77,22 +77,21 @@
In case of an error, an E_WARNING message is shown.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp2_real_walk</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp2_real_walk</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
print_r(snmp2_real_walk("localhost", "public", "IF-MIB::ifName"));
?>
]]>
- </programlisting>
-
- <para>
- The above will output something like:
+ </programlisting>
+
+ <para>
+ The above will output something like:
<![CDATA[
Array
(
@@ -103,20 +102,17 @@
[IF-MIB::ifName.5] => STRING: sixxs
)
]]>
- </para>
- </example>
- </para>
+ </para>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp2_walk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp2_walk</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp2-set.xml b/reference/snmp/functions/snmp2-set.xml
index 854104bf2143..6b10b16538ad 100644
--- a/reference/snmp/functions/snmp2-set.xml
+++ b/reference/snmp/functions/snmp2-set.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp2-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-set">
<refnamediv>
<refname>snmp2_set</refname>
<refpurpose>Set the value of an <acronym>SNMP</acronym> object</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,9 +22,9 @@
<function>snmp2_set</function> is used to set the value of an <acronym>SNMP</acronym> object
specified by the <parameter>object_id</parameter>.
</para>
-
+
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -87,7 +87,7 @@
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -98,9 +98,9 @@
If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
</para>
</refsect1>
-
-
-
+
+
+
<refsect1 role="examples">
&reftitle.examples;
<example>
@@ -126,16 +126,14 @@
</programlisting>
</example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp2_get</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp2_get</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp2-walk.xml b/reference/snmp/functions/snmp2-walk.xml
index e4f8b185de8e..fd42d8ed01cc 100644
--- a/reference/snmp/functions/snmp2-walk.xml
+++ b/reference/snmp/functions/snmp2-walk.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp2-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-walk">
<refnamediv>
<refname>snmp2_walk</refname>
<refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -21,7 +21,7 @@
an <acronym>SNMP</acronym> agent specified by the <parameter>hostname</parameter>.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -73,7 +73,7 @@
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -81,13 +81,12 @@
<parameter>object_id</parameter> as root or &false; on error.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>snmp2_walk</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>snmp2_walk</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$a = snmp2_walk("127.0.0.1", "public", "");
@@ -98,25 +97,22 @@ foreach ($a as $val) {
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
Above function call would return all the <acronym>SNMP</acronym> objects from the
<acronym>SNMP</acronym> agent running on localhost. One can step through the values
with a loop
</para>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp2_real_walk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp2_real_walk</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp3-get.xml b/reference/snmp/functions/snmp3-get.xml
index 9252c3adf68d..06a99fec21d1 100644
--- a/reference/snmp/functions/snmp3-get.xml
+++ b/reference/snmp/functions/snmp3-get.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp3-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-get">
<refnamediv>
<refname>snmp3_get</refname>
<refpurpose>Fetch an <acronym>SNMP</acronym> object</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -27,7 +27,7 @@
<parameter>object_id</parameter>.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -114,64 +114,58 @@
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <acronym>SNMP</acronym> object value on success or &false; on error.
</para>
</refsect1>
-
+
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>8.1.0</entry>
- <entry>
- The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
- and <literal>"SHA512"</literal> when supported by libnetsnmp.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.1.0</entry>
+ <entry>
+ The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
+ and <literal>"SHA512"</literal> when supported by libnetsnmp.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp3_get</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp3_get</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$nameOfSecondInterface = snmp3_get('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName.2');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp3_set</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp3_set</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp3-getnext.xml b/reference/snmp/functions/snmp3-getnext.xml
index 7f38614e4bc9..4d1aca71d428 100644
--- a/reference/snmp/functions/snmp3-getnext.xml
+++ b/reference/snmp/functions/snmp3-getnext.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp3-getnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-getnext">
<refnamediv>
<refname>snmp3_getnext</refname>
<refpurpose>Fetch the <acronym>SNMP</acronym> object which follows the given object id</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -27,7 +27,7 @@
<parameter>object_id</parameter>.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -115,7 +115,7 @@
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -123,58 +123,52 @@
In case of an error, an E_WARNING message is shown.
</para>
</refsect1>
-
+
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>8.1.0</entry>
- <entry>
- The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
- and <literal>"SHA512"</literal> when supported by libnetsnmp.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.1.0</entry>
+ <entry>
+ The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
+ and <literal>"SHA512"</literal> when supported by libnetsnmp.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmp3_getnext</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmp3_getnext</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$nameOfSecondInterface = snmp3_getnext('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName.1');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp3_get</function></member>
- <member><function>snmp3_walk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp3_get</function></member>
+ <member><function>snmp3_walk</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp3-real-walk.xml b/reference/snmp/functions/snmp3-real-walk.xml
index 5e0702fdbee7..7cf640c3f2df 100644
--- a/reference/snmp/functions/snmp3-real-walk.xml
+++ b/reference/snmp/functions/snmp3-real-walk.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp3-real-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-real-walk">
<refnamediv>
<refname>snmp3_real_walk</refname>
<refpurpose>Return all objects including their respective object ID within the specified one</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -30,7 +30,7 @@
and return not only their values but also their object ids.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -138,7 +138,7 @@
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -147,49 +147,46 @@
In case of an error, an E_WARNING message is shown.
</para>
</refsect1>
-
+
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>8.1.0</entry>
- <entry>
- The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
- and <literal>"SHA512"</literal> when supported by libnetsnmp.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.1.0</entry>
+ <entry>
+ The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
+ and <literal>"SHA512"</literal> when supported by libnetsnmp.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using
- <function>snmp3_real_walk</function>
- </title>
- <programlisting role="php">
+ <example>
+ <title>Using
+ <function>snmp3_real_walk</function>
+ </title>
+ <programlisting role="php">
<![CDATA[
<?php
var_export(snmp3_real_walk('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName'));
?>
]]>
- </programlisting>
-
- <para>
- The above will output something like:
+ </programlisting>
+
+ <para>
+ The above will output something like:
<![CDATA[
array (
'IF-MIB::ifName.1' => 'STRING: lo',
@@ -199,22 +196,19 @@ array (
'IF-MIB::ifName.5' => 'STRING: sixxs',
)
]]>
- </para>
- </example>
- </para>
+ </para>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member>
- <function>snmpwalk</function>
- </member>
- </simplelist>
- </para>
+ <simplelist>
+ <member>
+ <function>snmpwalk</function>
+ </member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmp3-walk.xml b/reference/snmp/functions/snmp3-walk.xml
index 1e95efd5a9cc..9cfc2e5b2a44 100644
--- a/reference/snmp/functions/snmp3-walk.xml
+++ b/reference/snmp/functions/snmp3-walk.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmp3-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-walk">
<refnamediv>
<refname>snmp3_walk</refname>
<refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -23,13 +23,13 @@
</methodsynopsis>
<para>
<function>snmp3_walk</function> function is used to read all the values from
- an <acronym>SNMP</acronym> agent specified by the <parameter>hostname</parameter>.
+ an <acronym>SNMP</acronym> agent specified by the <parameter>hostname</parameter>.
</para>
<para>
Even if the security level does not use an auth or priv protocol/password valid values have to be specified.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
@@ -96,7 +96,7 @@
<para>
If &null;, <parameter>object_id</parameter> is taken as the root of
the <acronym>SNMP</acronym> objects tree and all objects under that tree are returned as
- an array.
+ an array.
</para>
<para>
If <parameter>object_id</parameter> is specified, all the <acronym>SNMP</acronym> objects
@@ -122,7 +122,7 @@
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -130,52 +130,48 @@
<parameter>object_id</parameter> as root or &false; on error.
</para>
</refsect1>
-
-
+
+
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>8.1.0</entry>
- <entry>
- The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
- and <literal>"SHA512"</literal> when supported by libnetsnmp.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.1.0</entry>
+ <entry>
+ The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
+ and <literal>"SHA512"</literal> when supported by libnetsnmp.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>snmp3_walk</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>snmp3_walk</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$ret = snmp3_walk('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName');
var_export($ret);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
Above function call would return all the <acronym>SNMP</acronym> objects from the
<acronym>SNMP</acronym> agent running on localhost:
-<![CDATA[
+<![CDATA[
array (
0 => 'STRING: lo',
1 => 'STRING: eth0',
@@ -189,13 +185,11 @@ array (
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmp3_real_walk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmp3_real_walk</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmpget.xml b/reference/snmp/functions/snmpget.xml
index 79063cd884b7..5b93dd25d3cd 100644
--- a/reference/snmp/functions/snmpget.xml
+++ b/reference/snmp/functions/snmpget.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmpget" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmpget">
<refnamediv>
<refname>snmpget</refname>
<refpurpose>Fetch an <acronym>SNMP</acronym> object</refpurpose>
@@ -25,50 +25,48 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>hostname</parameter></term>
- <listitem>
- <para>
- The <acronym>SNMP</acronym> 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 <acronym>SNMP</acronym> object.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timeout</parameter></term>
- <listitem>
- <para>
- The number of microseconds until the first timeout.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>retries</parameter></term>
- <listitem>
- <para>
- The number of times to retry if timeouts occur.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>hostname</parameter></term>
+ <listitem>
+ <para>
+ The <acronym>SNMP</acronym> 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 <acronym>SNMP</acronym> object.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem>
+ <para>
+ The number of microseconds until the first timeout.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>retries</parameter></term>
+ <listitem>
+ <para>
+ The number of times to retry if timeouts occur.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -80,29 +78,25 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmpget</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmpget</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$syscontact = snmpget("127.0.0.1", "public", "system.SysContact.0");
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmpset</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmpset</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmpgetnext.xml b/reference/snmp/functions/snmpgetnext.xml
index 979c17261704..8bfe0ff6c961 100644
--- a/reference/snmp/functions/snmpgetnext.xml
+++ b/reference/snmp/functions/snmpgetnext.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmpgetnext" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmpgetnext">
<refnamediv>
<refname>snmpgetnext</refname>
<refpurpose>
@@ -17,42 +17,40 @@
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
-
+
<para>
The <function>snmpgetnext</function> function is used to read the
- value of the <acronym>SNMP</acronym> object that follows the specified
+ value of the <acronym>SNMP</acronym> object that follows the specified
<parameter>object_id</parameter>.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>hostname</parameter></term>
- <listitem><para>The hostname of the <acronym>SNMP</acronym> agent (server).</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 <acronym>SNMP</acronym> object id which precedes the wanted one.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timeout</parameter></term>
- <listitem><para>The number of microseconds until the first timeout.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>retries</parameter></term>
- <listitem><para>The number of times to retry if timeouts occur.</para></listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>hostname</parameter></term>
+ <listitem><para>The hostname of the <acronym>SNMP</acronym> agent (server).</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 <acronym>SNMP</acronym> object id which precedes the wanted one.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem><para>The number of microseconds until the first timeout.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>retries</parameter></term>
+ <listitem><para>The number of times to retry if timeouts occur.</para></listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -60,33 +58,29 @@
In case of an error, an E_WARNING message is shown.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmpgetnext</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmpgetnext</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$nameOfSecondInterface = snmpgetnetxt('localhost', 'public', 'IF-MIB::ifName.1');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmpget</function></member>
- <member><function>snmpwalk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmpget</function></member>
+ <member><function>snmpwalk</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmprealwalk.xml b/reference/snmp/functions/snmprealwalk.xml
index 540abe580260..6531d8087cb8 100644
--- a/reference/snmp/functions/snmprealwalk.xml
+++ b/reference/snmp/functions/snmprealwalk.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmprealwalk" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmprealwalk">
<refnamediv>
<refname>snmprealwalk</refname>
<refpurpose>
@@ -21,37 +21,35 @@
The <function>snmprealwalk</function> function is used to traverse over a number
of <acronym>SNMP</acronym> objects starting from <parameter>object_id</parameter>
and return not only their values but also their object ids.
- </para>
+ </para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>hostname</parameter></term>
- <listitem><para>The hostname of the <acronym>SNMP</acronym> agent (server).</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 <acronym>SNMP</acronym> object id which precedes the wanted one.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timeout</parameter></term>
- <listitem><para>The number of microseconds until the first timeout.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>retries</parameter></term>
- <listitem><para>The number of times to retry if timeouts occur.</para></listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>hostname</parameter></term>
+ <listitem><para>The hostname of the <acronym>SNMP</acronym> agent (server).</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 <acronym>SNMP</acronym> object id which precedes the wanted one.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem><para>The number of microseconds until the first timeout.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>retries</parameter></term>
+ <listitem><para>The number of times to retry if timeouts occur.</para></listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -59,23 +57,22 @@
In case of an error, an E_WARNING message is shown.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Using <function>snmprealwalk</function></title>
- <programlisting role="php">
+ <example>
+ <title>Using <function>snmprealwalk</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
print_r(snmprealwalk("localhost", "public", "IF-MIB::ifName"));
?>
]]>
- </programlisting>
-
- <para>
- The above will output something like:
-<![CDATA[
+ </programlisting>
+
+ <para>
+ The above will output something like:
+<![CDATA[
Array
(
[IF-MIB::ifName.1] => STRING: lo
@@ -85,18 +82,15 @@
[IF-MIB::ifName.5] => STRING: sixxs
)
]]>
- </para>
- </example>
- </para>
+ </para>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmpwalk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmpwalk</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/snmp/functions/snmpset.xml b/reference/snmp/functions/snmpset.xml
index 246239a69a8c..c53c4bd79cfb 100644
--- a/reference/snmp/functions/snmpset.xml
+++ b/reference/snmp/functions/snmpset.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmpset" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmpset">
<refnamediv>
<refname>snmpset</refname>
<refpurpose>Set the value of an <acronym>SNMP</acronym> object</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -18,79 +18,77 @@
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
-
+
<para>
<function>snmpset</function> is used to set the value of an <acronym>SNMP</acronym> 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 hostname of the <acronym>SNMP</acronym> agent (server).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>community</parameter></term>
- <listitem>
- <para>
- The write community.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>object_id</parameter></term>
- <listitem>
- <para>
- The <acronym>SNMP</acronym> object id.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>type</parameter></term>
- <listitem>
- &snmp.set.type.values;
- &snmp.set.type.values.asn.mapping;
- &snmp.set.type.values.equal.note;
- &snmp.set.type.values.bitset.note;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- The new value.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timeout</parameter></term>
- <listitem>
- <para>
- The number of microseconds until the first timeout.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>retries</parameter></term>
- <listitem>
- <para>
- The number of times to retry if timeouts occur.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>hostname</parameter></term>
+ <listitem>
+ <para>
+ The hostname of the <acronym>SNMP</acronym> agent (server).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>community</parameter></term>
+ <listitem>
+ <para>
+ The write community.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>object_id</parameter></term>
+ <listitem>
+ <para>
+ The <acronym>SNMP</acronym> object id.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>type</parameter></term>
+ <listitem>
+ &snmp.set.type.values;
+ &snmp.set.type.values.asn.mapping;
+ &snmp.set.type.values.equal.note;
+ &snmp.set.type.values.bitset.note;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ The new value.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem>
+ <para>
+ The number of microseconds until the first timeout.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>retries</parameter></term>
+ <listitem>
+ <para>
+ The number of times to retry if timeouts occur.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -101,7 +99,7 @@
If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
<example>
@@ -127,16 +125,14 @@
</programlisting>
</example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmpget</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmpget</function></member>
+ </simplelist>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/snmp/functions/snmpwalk.xml b/reference/snmp/functions/snmpwalk.xml
index 023770b6e177..e8b75c0ca24e 100644
--- a/reference/snmp/functions/snmpwalk.xml
+++ b/reference/snmp/functions/snmpwalk.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmpwalk" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmpwalk">
<refnamediv>
<refname>snmpwalk</refname>
<refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose>
@@ -18,60 +18,58 @@
<para>
<function>snmpwalk</function> function is used to read all the values from
- an <acronym>SNMP</acronym> agent specified by the <parameter>hostname</parameter>.
+ an <acronym>SNMP</acronym> 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 (server).
- </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 <acronym>SNMP</acronym> objects tree and all objects under that tree are returned as
- an array.
- </para>
- <para>
- If <parameter>object_id</parameter> is specified, all the <acronym>SNMP</acronym> objects
- below that <parameter>object_id</parameter> are returned.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timeout</parameter></term>
- <listitem>
- <para>
- The number of microseconds until the first timeout.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>retries</parameter></term>
- <listitem>
- <para>The number of times to retry if timeouts occur.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>hostname</parameter></term>
+ <listitem>
+ <para>
+ The SNMP agent (server).
+ </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 <acronym>SNMP</acronym> objects tree and all objects under that tree are returned as
+ an array.
+ </para>
+ <para>
+ If <parameter>object_id</parameter> is specified, all the <acronym>SNMP</acronym> objects
+ below that <parameter>object_id</parameter> are returned.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem>
+ <para>
+ The number of microseconds until the first timeout.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>retries</parameter></term>
+ <listitem>
+ <para>The number of times to retry if timeouts occur.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -84,13 +82,12 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>snmpwalk</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>snmpwalk</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
-$a = snmpwalk("127.0.0.1", "public", "");
+$a = snmpwalk("127.0.0.1", "public", "");
foreach ($a as $val) {
echo "$val\n";
@@ -98,23 +95,20 @@ foreach ($a as $val) {
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
Above function call would return all the <acronym>SNMP</acronym> objects from the
<acronym>SNMP</acronym> agent running on localhost. One can step through the values
with a loop
</para>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmprealwalk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmprealwalk</function></member>
+ </simplelist>
</refsect1>
</refentry>
diff --git a/reference/snmp/functions/snmpwalkoid.xml b/reference/snmp/functions/snmpwalkoid.xml
index b61d8a44112f..a9d8afa8db2d 100644
--- a/reference/snmp/functions/snmpwalkoid.xml
+++ b/reference/snmp/functions/snmpwalkoid.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.snmpwalkoid" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmpwalkoid">
<refnamediv>
<refname>snmpwalkoid</refname>
<refpurpose>Query for a tree of information about a network entity
@@ -19,7 +19,7 @@
<para>
<function>snmpwalkoid</function> function is used to read all object ids
- and their respective values from an SNMP agent specified by
+ and their respective values from an SNMP agent specified by
<parameter>hostname</parameter>.
</para>
@@ -28,61 +28,59 @@
<function>snmpwalk</function> has historical reasons. Both
functions are provided for backward compatibility.
Use <function>snmprealwalk</function> instead.
- </para>
+ </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>
- The number of microseconds until the first timeout.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>retries</parameter></term>
- <listitem>
- <para>
- The number of times to retry if timeouts occur.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </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>
+ The number of microseconds until the first timeout.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>retries</parameter></term>
+ <listitem>
+ <para>
+ The number of times to retry if timeouts occur.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -96,21 +94,19 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>snmpwalkoid</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>snmpwalkoid</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
-$a = snmpwalkoid("127.0.0.1", "public", "");
+$a = snmpwalkoid("127.0.0.1", "public", "");
for (reset($a); $i = key($a); next($a)) {
echo "$i: $a[$i]<br />\n";
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
Above function call would return all the SNMP objects from the
SNMP agent running on localhost. One can step through the values
@@ -120,11 +116,9 @@ for (reset($a); $i = key($a); next($a)) {
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>snmpwalk</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>snmpwalk</function></member>
+ </simplelist>
</refsect1>
</refentry>
diff --git a/reference/snmp/snmp/get.xml b/reference/snmp/snmp/get.xml
index ab96ab5af931..6dd71ea73f21 100644
--- a/reference/snmp/snmp/get.xml
+++ b/reference/snmp/snmp/get.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="snmp.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="snmp.get">
<refnamediv>
<refname>SNMP::get</refname>
<refpurpose>Fetch an <acronym>SNMP</acronym> object</refpurpose>
@@ -27,32 +27,30 @@
will return <acronym>SNMP</acronym> object as string. If
<parameter>objectId</parameter> is a array, all requested <acronym>SNMP</acronym>
objects will be returned as associative array of the <acronym>SNMP</acronym> object ids and their
- values.
+ values.
</para>
- <para>
<variablelist>
- <varlistentry>
- <term><parameter>objectId</parameter></term>
- <listitem>
- <para>
- The <acronym>SNMP</acronym> object (OID) or objects
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>preserveKeys</parameter></term>
- <listitem>
- <para>
- When <parameter>objectId</parameter> is a array and
- <parameter>preserveKeys</parameter> set to &true; keys in results
- will be taken exactly as in <parameter>objectId</parameter>,
- otherwise <varname>SNMP::oid_output_format</varname> property is used to determinate
- the form of keys.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <varlistentry>
+ <term><parameter>objectId</parameter></term>
+ <listitem>
+ <para>
+ The <acronym>SNMP</acronym> object (OID) or objects
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>preserveKeys</parameter></term>
+ <listitem>
+ <para>
+ When <parameter>objectId</parameter> is a array and
+ <parameter>preserveKeys</parameter> set to &true; keys in results
+ will be taken exactly as in <parameter>objectId</parameter>,
+ otherwise <varname>SNMP::oid_output_format</varname> property is used to determinate
+ the form of keys.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
diff --git a/reference/snmp/snmp/getnext.xml b/reference/snmp/snmp/getnext.xml
index b67a1f6ae502..175f0a9d4b56 100644
--- a/reference/snmp/snmp/getnext.xml
+++ b/reference/snmp/snmp/getnext.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="snmp.getnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="snmp.getnext">
<refnamediv>
<refname>SNMP::getnext</refname>
<refpurpose>Fetch an <acronym>SNMP</acronym> object which
@@ -27,20 +27,18 @@
will return <acronym>SNMP</acronym> object as string. If
<parameter>objectId</parameter> is a array, all requested <acronym>SNMP</acronym>
objects will be returned as associative array of the <acronym>SNMP</acronym> object ids and their
- values.
+ values.
</para>
- <para>
<variablelist>
- <varlistentry>
- <term><parameter>objectId</parameter></term>
- <listitem>
- <para>
- The <acronym>SNMP</acronym> object (OID) or objects
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <varlistentry>
+ <term><parameter>objectId</parameter></term>
+ <listitem>
+ <para>
+ The <acronym>SNMP</acronym> object (OID) or objects
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
diff --git a/reference/snmp/snmp/set.xml b/reference/snmp/snmp/set.xml
index e6325e6c139c..15da7c91d999 100644
--- a/reference/snmp/snmp/set.xml
+++ b/reference/snmp/snmp/set.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="snmp.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="snmp.set">
<refnamediv>
<refname>SNMP::set</refname>
<refpurpose>Set the value of an SNMP object</refpurpose>
@@ -124,11 +124,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>SNMP::get</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>SNMP::get</methodname></member>
+ </simplelist>
</refsect1>
</refentry>