snmp3-set.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<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>Устанавливает значение объекта SNMP</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>snmp3_set</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><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>snmp3_set</function> используется для установки значения объекта <acronym>SNMP</acronym>,
   указанного в <parameter>object_id</parameter>.
  </para>
  <para>
   Даже если уровень безопасности не использует протокол авторизации или пароль, необходимо указать корректные значения.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>hostname</parameter></term>
    <listitem>
     <para>
      Имя хоста агента (сервера) SNMP.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_name</parameter></term>
    <listitem>
     <para>
      Имя безопасности, обычно какое-то имя пользователя.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_level</parameter></term>
    <listitem>
     <para>
      Уровень безопасности (noAuthNoPriv|authNoPriv|authPriv).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_protocol</parameter></term>
    <listitem>
     <para>
      Протокол аутентификации (MD5 или SHA).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_passphrase</parameter></term>
    <listitem>
     <para>
      Пароль для аутентификации.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_protocol</parameter></term>
    <listitem>
     <para>
      Протокол конфиденциальности (DES или AES).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_passphrase</parameter></term>
    <listitem>
     <para>
      Пароль конфиденциальности.
     </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>
 </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>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>Пример использования <function>snmp3_set</function> для установки BITS идентификатору объекта <acronym>SNMP</acronym></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');
// или
  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
-->