php-doc-en/reference/snmp/functions/snmp3-set.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.snmp3-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>snmp3_set</refname>
  <refpurpose>Set the value of an SNMP object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>snmp3_set</methodname>
   <methodparam><type>string</type><parameter>host</parameter></methodparam>
   <methodparam><type>string</type><parameter>sec_name</parameter></methodparam>
   <methodparam><type>string</type><parameter>sec_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>priv_protocol</parameter></methodparam>
   <methodparam><type>string</type><parameter>priv_passphrase</parameter></methodparam>
   <methodparam><type>string</type><parameter>object_id</parameter></methodparam>
   <methodparam><type>string</type><parameter>type</parameter></methodparam>
   <methodparam><type>string</type><parameter>value</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>1000000</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>5</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>snmp3_set</function> is used to set the value of an <acronym>SNMP</acronym> object
   specified by the <parameter>object_id</parameter>.
  </para>
  <para>
   Even if the security level does not use an auth or priv protocol/password valid values have to be specified.
  </para>
  
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>host</parameter></term>
    <listitem>
     <para>
      The hostname of the SNMP agent (server).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>sec_name</parameter></term>
    <listitem>
     <para>
      the security name, usually some kind of username
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>sec_level</parameter></term>
    <listitem>
     <para>
      the security level (noAuthNoPriv|authNoPriv|authPriv)
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_protocol</parameter></term>
    <listitem>
     <para>
      the authentication protocol (MD5 or SHA)
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_passphrase</parameter></term>
    <listitem>
     <para>
      the authentication pass phrase
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>priv_protocol</parameter></term>
    <listitem>
     <para>
      the privacy protocol (DES or AES)
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>priv_passphrase</parameter></term>
    <listitem>
     <para>
      the privacy pass phrase
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object_id</parameter></term>
    <listitem>
     <para>
      The <acronym>SNMP</acronym> object id.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>type</parameter></term>
    <listitem>
     &snmp.set.type.values;
     &snmp.set.type.values.asn.mapping;
     &snmp.set.type.values.equal.note;
     &snmp.set.type.values.bitset.note;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>value</parameter></term>
    <listitem>
     <para>
      The new value
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
      The number of microseconds until the first timeout.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>retries</parameter></term>
    <listitem>
     <para>
      The number of times to retry if timeouts occur.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <para>
   If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown.
   If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
   <example>
    <title>Using <function>snmp3_set</function></title>
    <programlisting role="php">
<![CDATA[
<?php
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifAlias.3', 's', "foo");
?>
 ]]>
    </programlisting>
   </example>
   <example>
    <title>Using <function>snmp3_set</function> for setting BITS <acronym>SNMP</acronym> object id</title>
    <programlisting role="php">
<![CDATA[
<?php
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'x', 'F0');
?>
 ]]>
    </programlisting>
   </example>
 </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
-->