doc-fr/reference/snmp/functions/snmp3-walk.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<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>Récupère tous les objets <acronym>SNMP</acronym> depuis un agent</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>snmp3_walk</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>string</type><parameter>security_name</parameter></methodparam>
   <methodparam><type>string</type><parameter>security_level</parameter></methodparam>
   <methodparam><type>string</type><parameter>auth_protocol</parameter></methodparam>
   <methodparam><type>string</type><parameter>auth_passphrase</parameter></methodparam>
   <methodparam><type>string</type><parameter>privacy_protocol</parameter></methodparam>
   <methodparam><type>string</type><parameter>privacy_passphrase</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>
   La fonction <function>snmp3_walk</function> est utilisée pour lire
   toutes les valeurs depuis un agent <acronym>SNMP</acronym> spécifié
   par le paramètre <parameter>host</parameter>. 
  </para>
  <para>
   Même si le niveau de sécurité n'utilise pas de protocole
   d'authentification, des valeurs valides doivent être spécifiées.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>hostname</parameter></term>
    <listitem>
     <para>
      Le nom de l'hôte de l'agent SNMP (serveur).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_name</parameter></term>
    <listitem>
     <para>
      Le nom de la sécurité, habituellement, le nom de l'utilisateur.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_level</parameter></term>
    <listitem>
     <para>
      Le niveau de sécurité (noAuthNoPriv|authNoPriv|authPriv).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_protocol</parameter></term>
    <listitem>
     <para>
      Le protocole d'authentification (MD5 ou SHA).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_passphrase</parameter></term>
    <listitem>
     <para>
      La phrase secrète d'authentification.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_protocol</parameter></term>
    <listitem>
     <para>
      Le protocole privé (DES ou AES).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_passphrase</parameter></term>
    <listitem>
     <para>
      La phrase secrète privée.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object_id</parameter></term>
    <listitem>
     <para>
      Si vaut &null;, <parameter>object_id</parameter> sera la racine
      de l'arbre des objets <acronym>SNMP</acronym> et tous les
      objets sous-jacents sont retournés sous forme d'un tableau. 
     </para>
     <para>
      Si <parameter>object_id</parameter> est spécifié,
      tous les objets <acronym>SNMP</acronym> sous l'objet
      <parameter>object_id</parameter> seront retournés.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
      Le nombre de microsecondes avant le premier délai d'expiration
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>retries</parameter></term>
    <listitem>
     <para>
      Le nombre de tentatives dans le cas où le délai d'expiration
      survient.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau de valeurs d'objets <acronym>SNMP</acronym>
   en commençant depuis l'objet <parameter>object_id</parameter>
   comme racine, ou &false; si une erreur survient.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>snmp3_walk</function></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>
   L'appel à la fonction précédente retournera tous les objets
   <acronym>SNMP</acronym> depuis l'agent
   <acronym>SNMP</acronym> s'exécutant sur 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
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
-->