snmpset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.snmpset" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>snmpset</refname>
  <refpurpose>Устанавливает значение объекта <acronym>SNMP</acronym></refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>snmpset</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>string</type><parameter>community</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>type</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>value</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>
   <function>snmpset</function> используется для установки значения объекта <acronym>SNMP</acronym>,
   указанного в параметре <parameter>object_id</parameter>.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       Имя хоста агента (сервера) <acronym>SNMP</acronym>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>community</parameter></term>
     <listitem>
      <para>
       Write-сообщество.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>object_id</parameter></term>
     <listitem>
      <para>
       Идентификатор объекта <acronym>SNMP</acronym>.
      </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>
       Новое значение.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       Время ожидания в микросекундах.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>retries</parameter></term>
     <listitem>
      <para>
       Количество повторных попыток при истечении времени ожидания.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <para>
   Если хост SNMP отклоняет тип данных, выводится ошибка уровня E_WARNING вроде "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length.".
   Если указан неизвестный или недопустимый OID, вероятно, выведется предупреждение "Could not add variable".
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
   <example>
    <title>Пример использования <function>snmpset</function></title>
    <programlisting role="php">
<![CDATA[
<?php
  snmpset("localhost", "public", "IF-MIB::ifAlias.3", "s", "foo");
?>
 ]]>
    </programlisting>
   </example>
   <example>
    <title>Пример использования <function>snmpset</function> для установки BITS идентификатору объекта <acronym>SNMP</acronym></title>
    <programlisting role="php">
<![CDATA[
<?php
  snmpset("localhost", "public", 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
  snmpset("localhost", "public", 'FOO-MIB::bar.42', 'x', 'F0');
?>
 ]]>
    </programlisting>
   </example>
 </refsect1>

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