<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.snmp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'snmp.set.php',
    1 => 'SNMP::set',
    2 => 'D&eacute;finit la valeur d\'un objet SNMP',
  ),
  'up' => 
  array (
    0 => 'class.snmp.php',
    1 => 'SNMP',
  ),
  'prev' => 
  array (
    0 => 'snmp.getnext.php',
    1 => 'SNMP::getnext',
  ),
  'next' => 
  array (
    0 => 'snmp.setsecurity.php',
    1 => 'SNMP::setSecurity',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/snmp/snmp/set.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="snmp.set" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SNMP::set</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.4.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SNMP::set</span> &mdash; <span class="dc-title">Définit la valeur d&#039;un objet SNMP</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-snmp.set-description">
  <h3 class="title">Description</h3>

  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SNMP::set</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$objectId</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$type</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$value</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Demande à l&#039;agent distant <abbr title="Simple Network Management Protocol">SNMP</abbr> de définir la valeur
   d&#039;un ou plusieurs objets SNMP spécifiés par son identifiant
   <code class="parameter">objectId</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-snmp.set-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <dl>
   <p class="simpara">
    Si <code class="parameter">objectId</code> est une <a href="language.types.string.php" class="link">chaîne de caractères</a>, alors
    les paramètres <code class="parameter">type</code> et <code class="parameter">value</code>
    doivent aussi être une <a href="language.types.string.php" class="link">chaîne de caractères</a>. Si <code class="parameter">objectId</code>
    est un <a href="language.types.array.php" class="link">tableau</a>, le paramètre <code class="parameter">value</code> doit être un
    tableau de même taille contenant les valeurs correspondantes, et le
    paramètre <code class="parameter">type</code> pourra être soit une <a href="language.types.string.php" class="link">chaîne de caractères</a> (sa
    valeur sera utilisée pour toutes les paires
    <code class="parameter">objectId</code>-<code class="parameter">value</code>) ou bien
    un tableau de même taille avec des paires OID-valeur. Lorsqu&#039;une autre
    combinaison de paramètres est fournie, des alertes de niveau
    E_WARNING peuvent être émises avec une description détaillée.
   </p>
   
    <dt><code class="parameter">objectId</code></dt>
    <dd>
     <span class="simpara">
      L&#039;identifiant de l&#039;objet SNMP.
     </span>
     <span class="simpara">
      Lorsque le nombre d&#039;OIDs dans le tableau object_id est supérieur
      à la propriété max_oids de l&#039;objet, la méthode devra utiliser plusieurs
      requêtes pour effectuer les mises à jour demandées. Dans ce cas,
      la vérification du type et de la valeur est effectuée par morceau,
      aussi, la seconde requête (et les autres sous-requêtes) échouera
      en raison d&#039;un mauvais type ou d&#039;une mauvaise valeur pour l&#039;OID demandé.
      Afin de repérer ce comportement, une alerte est émise lorsque le nombre
      d&#039;OIDs dans le tableau object_id est supérieur à la propriété max_oids.
     </span>
    </dd>
   
   
    <dt><code class="parameter">type</code></dt>
    <dd>
     <p class="para">
Le <abbr>MIB</abbr> définit le type de chaque identifiant d&#039;objets. Il doit
être spécifié sous la forme d&#039;un simple caractère depuis la liste suivante.
</p>
<table class="doctable table">
<caption><strong>types</strong></caption>

    <tbody class="tbody">
        <tr><td>=</td><td>Le type est récupéré depuis le MIB</td></tr>

        <tr><td>i</td><td>INTEGER</td> </tr>

        <tr><td>u</td><td>INTEGER</td></tr>

        <tr><td>s</td><td>STRING</td></tr>

        <tr><td>x</td><td>HEX STRING</td></tr>

        <tr><td>d</td><td>DECIMAL STRING</td></tr>

        <tr><td>n</td><td>NULLOBJ</td></tr>

        <tr><td>o</td><td>OBJID</td></tr>

        <tr><td>t</td><td>TIMETICKS</td></tr>

        <tr><td>a</td><td>IPADDRESS</td></tr>

        <tr><td>b</td><td>BITS</td></tr>

    </tbody>

</table>

<p class="para">
Si la constante <strong><code>OPAQUE_SPECIAL_TYPES</code></strong> a été définie lors
de la compilation de la bibliothèque <abbr title="Simple Network Management Protocol">SNMP</abbr>, les caractères suivants
seront également disponibles :
</p>
<table class="doctable table">
<caption><strong>types</strong></caption>

    <tbody class="tbody">
        <tr><td>U</td><td>int64 non-signé</td></tr>

        <tr><td>I</td><td>int64 signé</td></tr>

        <tr><td>F</td><td>float</td></tr>

        <tr><td>D</td><td>double</td></tr>

    </tbody>

</table>


     <p class="para">
La plupart de ces valeurs utilise le type ASN.1 correspondant. &#039;s&#039;, &#039;x&#039;, &#039;d&#039; et &#039;b&#039;
sont toutes des façons différentes de spécifier la valeur OCTET STRING et le type non-signé
&#039;u&#039; est également utilisé pour gérer les valeurs Gauge32.
</p>

     <p class="para">
Si les fichiers MIB sont chargés dans l&#039;arbre MIB avec &quot;snmp_read_mib&quot; ou en les spécifiant
dans la configuration de libsnmp, &#039;=&#039; pourra être utilisé comme paramètre
de type pour tous les identifiants d&#039;objets, vu que le type peut automatiquement être lu depuis le MIB.
</p>

     <p class="para">
Notez qu&#039;il y a 2 façons de définir une variable de type BITS like i.e.
&quot;SYNTAX    BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}&quot;:
</p>
<ul class="itemizedlist">
<li class="listitem">
    <span class="simpara">
        En utilisant le type &quot;b&quot; et une liste d&#039;octets. Cette méthode n&#039;est pas
        recommandée vu que la requête GET pour un même OID retournera i.e. 0xF8.
    </span>
</li>
<li class="listitem">
    <span class="simpara">
        En utilisant le type &quot;x&quot; et un nombre hexadécimal mais sans(!) le préfixe usuel
        &quot;0x&quot;.
    </span>
</li>
</ul>
<p class="para">
Reportez-vous à la section sur les exemples pour plus de détails.
</p>

    </dd>
   
   
    <dt><code class="parameter">value</code></dt>
    <dd>
     <span class="simpara">
      La nouvelle valeur.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-snmp.set-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="simpara">
   Cette fonction retourne <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> en cas de succès ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-snmp.set-errors">
<h3 class="title">Erreurs / Exceptions</h3>
<p class="para">
    Cette méthode ne lance aucune exception par défaut.
    Pour activer l&#039;émission d&#039;exceptions SNMPException lorsque
    des erreurs de la bibliothèque surviennent,
    le paramètre de la classe SNMP <code class="parameter">exceptions_enabled</code>
    doit être défini à la valeur correspondante. Voir les <a href="class.snmp.php#snmp.props.exceptions-enabled" class="link">
    explications sur <code class="parameter">SNMP::$exceptions_enabled</code></a>
    pour plus de détails.
</p>
</div>



 <div class="refsect1 examples" id="refsect1-snmp.set-examples">
  <h3 class="title">Exemples</h3>
  <div class="example" id="snmp.set.example.basic">
   <p><strong>Exemple #1 Définit un seul identifiant d&#039;objet <abbr title="Simple Network Management Protocol">SNMP</abbr></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  $session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_2C</span><span style="color: #007700">, </span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"private"</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">'SNMPv2-MIB::sysContact.0'</span><span style="color: #007700">, </span><span style="color: #DD0000">'s'</span><span style="color: #007700">, </span><span style="color: #DD0000">"Nobody"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="snmp.set.example.multiple">
   <p><strong>Exemple #2 Définit plusieurs valeurs en utilisant un seul appel à la méthode <span class="methodname"><strong>SNMP::set()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  $session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_2C</span><span style="color: #007700">, </span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"private"</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'SNMPv2-MIB::sysContact.0'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SNMPv2-MIB::sysLocation.0'</span><span style="color: #007700">), array(</span><span style="color: #DD0000">'s'</span><span style="color: #007700">, </span><span style="color: #DD0000">'s'</span><span style="color: #007700">), array(</span><span style="color: #DD0000">"Nobody"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Nowhere"</span><span style="color: #007700">));<br /></span><span style="color: #FF8000">// ou<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'SNMPv2-MIB::sysContact.0'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SNMPv2-MIB::sysLocation.0'</span><span style="color: #007700">), </span><span style="color: #DD0000">'s'</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"Nobody"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Nowhere"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="snmp.set.example.bits">
   <p><strong>Exemple #3 Exemple avec <span class="methodname"><strong>SNMP::set()</strong></span> pour configurer l&#039;identifiant d&#039;objet <abbr title="Simple Network Management Protocol">SNMP</abbr> BITS</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  $session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_2C</span><span style="color: #007700">, </span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"private"</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">'FOO-MIB::bar.42'</span><span style="color: #007700">, </span><span style="color: #DD0000">'b'</span><span style="color: #007700">, </span><span style="color: #DD0000">'0 1 2 3 4'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// ou<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">'FOO-MIB::bar.42'</span><span style="color: #007700">, </span><span style="color: #DD0000">'x'</span><span style="color: #007700">, </span><span style="color: #DD0000">'F0'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-snmp.set-seealso">
  <h3 class="title">Voir aussi</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="snmp.get.php" class="methodname" rel="rdfs-seeAlso">SNMP::get()</a> - R&eacute;cup&egrave;re un objet SNMP</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>