Files
doc-fr/reference/snmp/functions/snmpwalk.xml
George Peter Banyard a8cc0957ba Apply b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3
Generate methodsynopses based on stubs for recent changes
2021-10-02 22:55:28 +01:00

144 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.snmpwalk" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>snmpwalk</refname>
<refpurpose>Reçoit tous les objets <acronym>SNMP</acronym> d'un agent</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>snmpwalk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>
<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>snmpwalk</function> est utilisé pour lire toutes les valeurs d'un
agent <acronym>SNMP</acronym> spécifié par <parameter>hostname</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
L'agent SNMP (serveur).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>community</parameter></term>
<listitem>
<para>
La communauté de lecture.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_id</parameter></term>
<listitem>
<para>
Si &null;, <parameter>object_id</parameter> est pris comme racine des
objets <acronym>SNMP</acronym> et tous les objets de cet arbre sont retournés sous la
forme d'un tableau.
</para>
<para>
Si <parameter>object_id</parameter> est spécifié, tous les objets <acronym>SNMP</acronym>
suivant cet <parameter>object_id</parameter> sont retournés.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Le nombre de microsecondes depuis le premier timeout.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>retries</parameter></term>
<listitem>
<para>
Le nombre de tentative dans le cas où le délai d'expiration survient.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un tableau de valeurs de l'objet <acronym>SNMP</acronym>, en commençant par
<parameter>object_id</parameter> ou &false; si une erreur survient.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>snmpwalk</function></title>
<programlisting role="php">
<![CDATA[
<?php
$a = snmpwalk("127.0.0.1", "public", "");
foreach ($a as $val) {
echo "$val\n";
}
?>
]]>
</programlisting>
</example>
</para>
<para>
L'appel à la fonction ci-dessus retournera tous les objets <acronym>SNMP</acronym>
depuis l'agent <acronym>SNMP</acronym> exécuté sur l'hôte local. On parcourt les valeurs
via une boucle.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>snmprealwalk</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->