Files
doc-fr/reference/snmp/functions/snmp2-set.xml
George Peter Banyard a8cc0957ba Apply b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3
Generate methodsynopses based on stubs for recent changes
2021-10-02 22:55:28 +01:00

162 lines
4.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.snmp2-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp2_set</refname>
<refpurpose>Définit la valeur d'un objet <acronym>SNMP</acronym></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>snmp2_set</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>
La fonction <function>snmp2_set</function> est utilisée pour
définir la valeur d'un objet <acronym>SNMP</acronym>
spécifié par son identifiant <parameter>object_id</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
Le nom d'hôte de l'agent <acronym>SNMP</acronym> (serveur).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>community</parameter></term>
<listitem>
<para>
La communauté d'écriture.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_id</parameter></term>
<listitem>
<para>
L'identifiant de l'objet <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>
La nouvelle valeur.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Le nombre de microsecondes avant le premier délai d'expiration.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>retries</parameter></term>
<listitem>
<para>
Le nombre de tentatives dans le cas où le délai d'expiration survient.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<para>
Si l'hôte SNMP rejète le type de données, une alerte de type
E_WARNING sera émis, comme "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length.".
Si un OID inconnu ou invalide est spécifié, l'alerte émise contiendra
probablement ceci : "Could not add variable".
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemple avec <function>snmp2_set</function></title>
<programlisting role="php">
<![CDATA[
<?php
snmp2_set("localhost", "public", "IF-MIB::ifAlias.3", "s", "foo");
?>
]]>
</programlisting>
</example>
<example>
<title>Exemple avec <function>snmp2_set</function> pour configurer l'identifiant de l'objet <acronym>SNMP</acronym> BITS</title>
<programlisting role="php">
<![CDATA[
<?php
snmp2_set("localhost", "public", 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
snmp2_set("localhost", "public", 'FOO-MIB::bar.42', 'x', 'F0');
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>snmp2_get</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
-->