<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.snmp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.snmp3-set.php',
    1 => 'snmp3_set',
    2 => 'Define el valor de un objeto SNMP',
  ),
  'up' => 
  array (
    0 => 'ref.snmp.php',
    1 => 'Funciones SNMP',
  ),
  'prev' => 
  array (
    0 => 'function.snmp3-real-walk.php',
    1 => 'snmp3_real_walk',
  ),
  'next' => 
  array (
    0 => 'function.snmp3-walk.php',
    1 => 'snmp3_walk',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/snmp/functions/snmp3-set.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.snmp3-set" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">snmp3_set</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">snmp3_set</span> &mdash; <span class="dc-title">Define el valor de un objeto SNMP</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.snmp3-set-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>snmp3_set</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$hostname</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$security_name</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$security_level</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$auth_protocol</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$auth_passphrase</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$privacy_protocol</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$privacy_passphrase</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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">$object_id</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$timeout</code><span class="initializer"> = -1</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$retries</code><span class="initializer"> = -1</span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   <span class="function"><strong>snmp3_set()</strong></span> se utiliza para definir el
   valor de un objeto <abbr title="Simple Network Management Protocol">SNMP</abbr> especificado por
   el parámetro <code class="parameter">object_id</code>.
  </p>
  <p class="simpara">
   Aunque el nivel de seguridad no utilice autenticación
   o protocolo privado por contraseña, se deben especificar valores válidos.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.snmp3-set-parameters">
  <h3 class="title">Parámetros</h3>
  <dl>
   
    <dt><code class="parameter">hostname</code></dt>
    <dd>
     <span class="simpara">
      El nombre del host del agente SNMP (servidor).
     </span>
    </dd>
   
   
    <dt><code class="parameter">security_name</code></dt>
    <dd>
     <span class="simpara">
      El nombre de seguridad, generalmente, el nombre de usuario.
     </span>
    </dd>
   
   
    <dt><code class="parameter">security_level</code></dt>
    <dd>
     <span class="simpara">
      El nivel de seguridad (noAuthNoPriv|authNoPriv|authPriv).
     </span>
    </dd>
   
   
    <dt><code class="parameter">auth_protocol</code></dt>
    <dd>
     <span class="simpara">
      El protocolo de autenticación (MD5 o SHA).
     </span>
    </dd>
   
   
    <dt><code class="parameter">auth_passphrase</code></dt>
    <dd>
     <span class="simpara">
      La frase secreta para la autenticación.
     </span>
    </dd>
   
   
    <dt><code class="parameter">privacy_protocol</code></dt>
    <dd>
     <span class="simpara">
      El protocolo privado (DES o AES).
     </span>
    </dd>
   
   
    <dt><code class="parameter">privacy_passphrase</code></dt>
    <dd>
     <span class="simpara">
      La frase secreta privada.
     </span>
    </dd>
   
   
    <dt><code class="parameter">object_id</code></dt>
    <dd>
     <span class="simpara">
      El identificador del objeto <abbr title="Simple Network Management Protocol">SNMP</abbr>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">type</code></dt>
    <dd>
     <p class="para">
El <abbr>MIB</abbr> define el tipo de cada identificador de objeto. Debe
ser especificado como un carácter simple de la lista siguiente.
</p>
<table class="doctable table">
<caption><strong>tipos</strong></caption>

    <tbody class="tbody">
        <tr><td>=</td><td>El tipo es recuperado desde el 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> ha sido definida durante
la compilación de la biblioteca <abbr title="Simple Network Management Protocol">SNMP</abbr>, los caracteres siguientes
también estarán disponibles:
</p>
<table class="doctable table">
<caption><strong>tipos</strong></caption>

    <tbody class="tbody">
        <tr><td>U</td><td>int64 sin signo</td></tr>

        <tr><td>I</td><td>int64 con signo</td></tr>

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

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

    </tbody>

</table>


     <p class="para">
La mayoría de estos valores utilizan el tipo ASN.1 correspondiente. &#039;s&#039;, &#039;x&#039;, &#039;d&#039; y &#039;b&#039;
son todas formas diferentes de especificar el valor OCTET STRING y el tipo sin signo
&#039;u&#039; también es utilizado para manejar los valores Gauge32.
</p>

     <p class="para">
Si los archivos MIB son cargados en el árbol MIB con &quot;snmp_read_mib&quot; o especificándolos
en la configuración de libsnmp, &#039;=&#039; podrá ser utilizado como parámetro
de tipo para todos los identificadores de objetos, ya que el tipo puede ser leído automáticamente desde el MIB.
</p>

     <p class="para">
Nota que hay 2 formas de definir una variable de tipo BITS como 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">
        Utilizando el tipo &quot;b&quot; y una lista de octetos. Este método no es
        recomendado ya que la petición GET para un mismo OID retornará i.e. 0xF8.
    </span>
</li>
<li class="listitem">
    <span class="simpara">
        Utilizando el tipo &quot;x&quot; y un número hexadecimal pero sin(!) el prefijo usual
        &quot;0x&quot;.
    </span>
</li>
</ul>
<p class="para">
Consúltese la sección sobre ejemplos para más detalles.
</p>

    </dd>
   
   
    <dt><code class="parameter">value</code></dt>
    <dd>
     <span class="simpara">
      El nuevo valor.
     </span>
    </dd>
   
   
    <dt><code class="parameter">timeout</code></dt>
    <dd>
     <span class="simpara">
      El número de milisegundos antes del primer tiempo límite.
     </span>
    </dd>
   
   
    <dt><code class="parameter">retries</code></dt>
    <dd>
     <span class="simpara">
      El número de intentos en caso de que se alcance el tiempo límite.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.snmp3-set-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="simpara">
   Esta función retorna <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> en caso de éxito o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error.
  </p>
  <p class="simpara">
   Si el host SNMP rechaza el tipo de datos, se muestra una alerta de tipo
   E_WARNING como &quot;Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length.&quot;
   Si se especifica un OID desconocido o inválido, la alerta será probablemente
   &quot;Could not add variable&quot;.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.snmp3-set-examples">
  <h3 class="title">Ejemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Ejemplo #1 Ejemplo con <span class="function"><strong>snmp3_set()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  snmp3_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'james'</span><span style="color: #007700">, </span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'IF-MIB::ifAlias.3'</span><span style="color: #007700">, </span><span style="color: #DD0000">'s'</span><span style="color: #007700">, </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>Ejemplo #2 Ejemplo con <span class="function"><strong>snmp3_set()</strong></span> para configurar el identificador del objeto <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 />  snmp3_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'james'</span><span style="color: #007700">, </span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</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">// or<br />  </span><span style="color: #0000BB">snmp3_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'james'</span><span style="color: #007700">, </span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</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><?php manual_footer($setup); ?>