admin/doc-fr
1
0
Fork 0
mirror of https://github.com/macintoshplus/doc-fr.git synced 2026-03-26 01:42:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
6c8ac3d8347644cdf014da1da170fbd80553c5df
doc-fr/reference/snmp/snmp.xml
Sergey Panteleev 88c89e4481 More stub syncs with EN (#146) 
Co-authored-by: George Peter Banyard <girgias@php.net>
2021-12-27 12:52:01 +00:00

433 lines
16 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e5021b6d8b29a6a1127399f8e85eaddacaffa53d Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<phpdoc:classref xml:id="class.snmp" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns="http://docbook.org/ns/docbook">
<title>La classe SNMP</title>
<titleabbrev>SNMP</titleabbrev>
<partintro>
<!-- {{{ SNMP intro -->
<section xml:id="snmp.intro">
&reftitle.intro;
<para>
Représente une session <acronym>SNMP</acronym>.
</para>
</section>
<!-- }}} -->
<section xml:id="snmp.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>SNMP</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<classname>SNMP</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>array</type>
<varname linkend="snmp.props.info">info</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="snmp.props.max-oids">max_oids</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname linkend="snmp.props.valueretrieval">valueretrieval</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="snmp.props.quick-print">quick_print</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="snmp.props.enum-print">enum_print</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname linkend="snmp.props.oid-output-format">oid_output_format</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="snmp.props.oid-increasing-check">oid_increasing_check</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname linkend="snmp.props.exceptions-enabled">exceptions_enabled</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.snmp')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.snmp')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-noerror">SNMP::ERRNO_NOERROR</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-generic">SNMP::ERRNO_GENERIC</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-timeout">SNMP::ERRNO_TIMEOUT</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-error-in-reply">SNMP::ERRNO_ERROR_IN_REPLY</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-oid-not-increasing">SNMP::ERRNO_OID_NOT_INCREASING</varname>
<initializer>16</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-oid-parsing-error">SNMP::ERRNO_OID_PARSING_ERROR</varname>
<initializer>32</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-multiple-set-queries">SNMP::ERRNO_MULTIPLE_SET_QUERIES</varname>
<initializer>64</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.errno-multiple-set-queries">SNMP::ERRNO_ANY</varname>
<initializer>126</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.version-1">SNMP::VERSION_1</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.version-2c">SNMP::VERSION_2C</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.version-2c">SNMP::VERSION_2c</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.class.constants.version-3">SNMP::VERSION_3</varname>
<initializer>3</initializer>
</fieldsynopsis>
</classsynopsis>
</section>
<!-- {{{ SNMP properties -->
<section xml:id="snmp.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="snmp.props.max-oids">
<term><varname>max_oids</varname></term>
<listitem>
<para>Nombre maximal de OID par demande GET/SET/GETBULK</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.valueretrieval">
<term><varname>valueretrieval</varname></term>
<listitem>
<para>Contrôle la façon dont les valeurs SNMP seront retournées</para>
<table>
<title/>
<tgroup cols="2">
<tbody>
<row>
<entry><constant>SNMP_VALUE_LIBRARY</constant></entry>
<entry>
Les valeurs retournées le seront de la même façon que par la bibliothèque
Net-SNMP.
</entry>
</row>
<row>
<entry><constant>SNMP_VALUE_PLAIN</constant></entry>
<entry>
Les valeurs retournées le seront en valeur pleine, sans l'information de type SNMP.
</entry>
</row>
<row>
<entry><constant>SNMP_VALUE_OBJECT</constant></entry>
<entry>
Les valeurs retournées le seront sous forme d'objets avec les propriétés
"value" et "type", où le type pourra être une constante SNMP_OCTET_STR,
SNMP_COUNTER etc... La façon dont la "value" est retournée est basée
suivant la constante définie : <constant>SNMP_VALUE_LIBRARY</constant> ou
<constant>SNMP_VALUE_PLAIN</constant>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.quick-print">
<term><varname>quick_print</varname></term>
<listitem>
<para>Valeur du paramètre <parameter>quick_print</parameter> dans la bibliothèque NET-<acronym>SNMP</acronym></para>
<para>
Définit la valeur du paramètre <parameter>quick_print</parameter> dans la bibliothèque NET-<acronym>SNMP</acronym>.
Lorsqu'il est défini (1), la bibliothèque <acronym>SNMP</acronym> retournera des valeurs rapidement
imprimables. Cela signifie uniquement que les valeurs seront imprimées. Lorsque le
paramètre <parameter>quick_print</parameter> n'est pas défini (par défaut), la bibliothèque
NET-<acronym>SNMP</acronym> imprimera des informations additionnelles incluant le type
de la valeur (i.e. IpAddress ou OID). De plus, si quick_print n'est pas activé, la bibliothèque
imprimera les valeurs hexadécimales pour toutes les chaînes contenant jusqu'à 3 caractères.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.enum-print">
<term><varname>enum_print</varname></term>
<listitem>
<para>
Contrôle la façon dont les valeurs enum sont imprimées.
</para>
<para>
Permet d'indiquer à walk/get etc. s'ils doivent automatiquement
chercher les valeurs enum dans le MIIB et les retourner en plus de leurs
chaînes humainement lisibles.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.oid-output-format">
<term><varname>oid_output_format</varname></term>
<listitem>
<para>Contrôle le format de sortie OID</para>
<table>
<title>Représentation OID .1.3.6.1.2.1.1.3.0 pour diverses
valeurs de <varname>oid_output_format</varname></title>
<tgroup cols="2">
<tbody>
<row><entry><constant>SNMP_OID_OUTPUT_FULL</constant></entry><entry>La forme complète, comme "iso.org.dod...."</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_NUMERIC</constant></entry><entry>La forme numérique, comme ".1.3.6.1.4.1.8072.3.2.10"</entry> </row>
<row><entry><constant>SNMP_OID_OUTPUT_MODULE</constant></entry><entry>La forme courte, comme "NET-SNMP-TC::linux"</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_SUFFIX</constant></entry><entry>TBD</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_UCD</constant></entry><entry>TBD</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_NONE</constant></entry><entry>TBD</entry></row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.oid-increasing-check">
<term><varname>oid_increasing_check</varname></term>
<listitem>
<para>Contrôle la vérification de la désactivation pour l'augmentation
de l'OID lors du parcours de l'arbre OID</para>
<para>
Quelques agents <acronym>SNMP</acronym> sont connus pour retourner des OIDs
dans la mauvais ordre, mais peuvent malgré tout continuer le parcours.
D'autres agents retournent des OIDs dans la mauvais ordre et peuvent
conduire la méthode <methodname>SNMP::walk</methodname> dans une boucle infinie
tant que la limite de mémoire n'est pas atteinte. La bibliothèque PHP SNMP,
par défaut, effectue la vérification de l'augmentation de l'OID et stoppe
le parcours sur l'arbre OID lorsqu'elle détecte une possible boucle
en émettant une alerte.
Définissez la variable <varname>oid_increasing_check</varname> à &false;
pour désactiver cette vérification.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.exceptions-enabled">
<term><varname>exceptions_enabled</varname></term>
<listitem>
<para>
Contrôle quelle exception SNMPException sera émise au lieu
des alertes. Utiliser l'opérateur OR des constantes
<constant>SNMP::ERRNO_*</constant>. Par défaut, toutes les exceptions
SNMP sont désactivées.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.info">
<term><varname>info</varname></term>
<listitem>
<para>
Propriété en lecture seul contenant la configuration de l'agent distant : nom d'hôte,
port, délai d'expiration par défaut, nombre de récupération par défaut</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ SNMP constants -->
<section xml:id="snmp.class.constants">
&reftitle.constants;
<section xml:id="snmp.class.constants.error-types">
<title>Types d'erreurs <acronym>SNMP</acronym></title>
<variablelist>
<varlistentry xml:id="snmp.class.constants.errno-noerror">
<term><constant>SNMP::ERRNO_NOERROR</constant></term>
<listitem>
<para>Aucune erreur spécifique <acronym>SNMP</acronym> n'est survenue.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.errno-generic">
<term><constant>SNMP::ERRNO_GENERIC</constant></term>
<listitem>
<para>Une erreur <acronym>SNMP</acronym> générique est survenue.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.errno-timeout">
<term><constant>SNMP::ERRNO_TIMEOUT</constant></term>
<listitem>
<para>Demande à l'agent <acronym>SNMP</acronym> d'atteindre le délai d'expiration.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.errno-error-in-reply">
<term><constant>SNMP::ERRNO_ERROR_IN_REPLY</constant></term>
<listitem>
<para>L'agent <acronym>SNMP</acronym> retourne une erreur dans la réponse.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.errno-oid-not-increasing">
<term><constant>SNMP::ERRNO_OID_NOT_INCREASING</constant></term>
<listitem>
<para>
L'agent <acronym>SNMP</acronym> n'incrémente plus l'OID
lors de l'exécution de la commande WALK (BULK).
Ceci indique qu'un problème survient avec l'agent
<acronym>SNMP</acronym>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.errno-oid-parsing-error">
<term><constant>SNMP::ERRNO_OID_PARSING_ERROR</constant></term>
<listitem>
<para>
La bibliothèque échoue lors de l'analyse de l'OID (et/ou le type
pour la commande SET). Aucune requête n'est effectuée.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.errno-multiple-set-queries">
<term><constant>SNMP::ERRNO_MULTIPLE_SET_QUERIES</constant></term>
<listitem>
<para>
La bibliothèque utilisera plusieurs requêtes pour l'opération SET
demandée. Cela signifie que l'opération sera effectuée de façon
non transactionnelle et que les morceaux suivants pourront échouer
si un mauvais type ou une mauvaise valeur est fourni.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.errno-any">
<term><constant>SNMP::ERRNO_ANY</constant></term>
<listitem>
<para>
Tous les codes opérateur OR des constantes SNMP::ERRNO_*.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="snmp.class.constants.protocols">
<title>Versions du protocole <acronym>SNMP</acronym></title>
<variablelist>
<varlistentry xml:id="snmp.class.constants.version-1">
<term><constant>SNMP::VERSION_1</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.version-2c">
<term><constant>SNMP::VERSION_2C</constant>, <constant>SNMP::VERSION_2c</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.class.constants.version-3">
<term><constant>SNMP::VERSION_3</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- }}} -->
</partintro>
&reference.snmp.entities.snmp;
</phpdoc:classref>
<!-- 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
-->
Reference in New Issue View Git Blame Copy Permalink