snmp3-get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: dd22c782164c9f8d79f5de8991876d1588a21015 Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<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>Récupère un objet <acronym>SNMP</acronym></refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>snmp3_get</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>
  <simpara>
   La fonction <function>snmp3_get</function> est utilisée pour lire
   la valeur d'un objet <acronym>SNMP</acronym> spécifié par
   l'identifiant <parameter>object_id</parameter>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>hostname</parameter></term>
    <listitem>
     <simpara>
      Le nom de l'hôte de l'agent <acronym>SNMP</acronym> (serveur).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_name</parameter></term>
    <listitem>
     <simpara>
      Le nom de la sécurité, habituellement, le nom d'utilisateur.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_level</parameter></term>
    <listitem>
     <simpara>
      Le niveau de sécurité (noAuthNoPriv|authNoPriv|authPriv).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_protocol</parameter></term>
    <listitem>
     <simpara>
      Le protocole d'authentification (MD5 or SHA)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_passphrase</parameter></term>
    <listitem>
     <simpara>
      La phrase secrète d'authentification.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_protocol</parameter></term>
    <listitem>
     <simpara>
      Le protocole de confidentialité (<literal>"DES"</literal> ou <literal>"AES"</literal>).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_passphrase</parameter></term>
    <listitem>
     <simpara>
      La phrase secrète de confidentialité.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object_id</parameter></term>
    <listitem>
     <simpara>
      L'identifiant de l'objet <acronym>SNMP</acronym>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <simpara>
      Le nombre de microsecondes avant le premier délai d'expiration.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>retries</parameter></term>
    <listitem>
     <simpara>
      Le nombre de tentatives dans le cas où le délai d'expiration survient.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Retourne la valeur de l'objet <acronym>SNMP</acronym>
   en cas de succès, ou &false; si une erreur survient.
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.5.0</entry>
      <entry>
       Lance désormais une <exceptionname>ValueError</exceptionname> quand la
       longueur du nom d'hôte est supérieure ou égale à 128 octets, quand le
       port est négatif ou supérieur à 65535, ou quand les valeurs du délai
       d'expiration ou du nombre de tentatives sont inférieures à -1 ou
       trop grandes.
      </entry>
     </row>
     <row>
      <entry>8.1.0</entry>
      <entry>
       Le paramètre <parameter>auth_protocol</parameter> accepte désormais
       <literal>"SHA256"</literal> et <literal>"SHA512"</literal>
       lorsqu'il est supporté par libnetsnmp.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <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>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>snmp3_set</function></member>
  </simplelist>
 </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
-->