svn: /phpdoc/en/trunk/reference/snmp/functions/ snmp3-walk.xml

From: Date: Sat, 19 Feb 2011 18:44:47 +0000
Subject: svn: /phpdoc/en/trunk/reference/snmp/functions/ snmp3-walk.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-7787@lists.php.net to get a copy of this message
ch Sat, 19 Feb 2011 18:44:47 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=308489 Log: Added documentation for snmp3_walk() Changed paths: U phpdoc/en/trunk/reference/snmp/functions/snmp3-walk.xml Modified: phpdoc/en/trunk/reference/snmp/functions/snmp3-walk.xml =================================================================== --- phpdoc/en/trunk/reference/snmp/functions/snmp3-walk.xml 2011-02-19 18:44:08 UTC (rev 308488) +++ phpdoc/en/trunk/reference/snmp/functions/snmp3-walk.xml 2011-02-19 18:44:47 UTC (rev 308489) @@ -4,9 +4,9 @@ <refentry xml:id="function.snmp3-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>snmp3_walk</refname> - <refpurpose>Description</refpurpose> + <refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -23,13 +23,14 @@ <methodparam choice="opt"><type>string</type><parameter>retries</parameter></methodparam> </methodsynopsis> <para> - + <function>snmpwalk</function> function is used to read all the values from + an <acronym>SNMP</acronym> agent specified by the <parameter>hostname</parameter>. </para> - - &warn.undocumented.func; - + <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> @@ -37,7 +38,7 @@ <term><parameter>host</parameter></term> <listitem> <para> - + The hostname of the SNMP agent (server). </para> </listitem> </varlistentry> @@ -45,7 +46,7 @@ <term><parameter>sec_name</parameter></term> <listitem> <para> - + the security name, usually some kind of username </para> </listitem> </varlistentry> @@ -53,7 +54,7 @@ <term><parameter>sec_level</parameter></term> <listitem> <para> - + the security level (noAuthNoPriv|authNoPriv|authPriv) </para> </listitem> </varlistentry> @@ -61,7 +62,7 @@ <term><parameter>auth_protocol</parameter></term> <listitem> <para> - + the authentication protocol (MD5 or SHA) </para> </listitem> </varlistentry> @@ -69,7 +70,7 @@ <term><parameter>auth_passphrase</parameter></term> <listitem> <para> - + the authentication pass phrase </para> </listitem> </varlistentry> @@ -77,7 +78,7 @@ <term><parameter>priv_protocol</parameter></term> <listitem> <para> - + the privacy protocol (DES or AES) </para> </listitem> </varlistentry> @@ -85,7 +86,7 @@ <term><parameter>priv_passphrase</parameter></term> <listitem> <para> - + the privacy pass phrase </para> </listitem> </varlistentry> @@ -93,15 +94,21 @@ <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> @@ -109,21 +116,61 @@ <term><parameter>retries</parameter></term> <listitem> <para> - + The number of retries in case timeouts occur. </para> </listitem> </varlistentry> </variablelist> </refsect1> - + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - + Returns an array of <acronym>SNMP</acronym> 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 +$ret = snmp3_walk('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName'); +var_export($ret); +?> +]]> + </programlisting> + </example> + </para> + <para> + Above function call would return all the <acronym>SNMP</acronym> objects from the + <acronym>SNMP</acronym> agent running on localhost: +<![CDATA[ +array ( + 0 => 'STRING: lo', + 1 => 'STRING: eth0', + 2 => 'STRING: eth2', + 3 => 'STRING: sit0', + 4 => 'STRING: sixxs', +) +]]> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>snmp3_real_walk</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file

« previous php.doc.cvs (#7787) next »