add fr documentation TODO: developer guide

This commit is contained in:
Kevin Duret 2015-01-02 13:33:27 +01:00
parent 5b6faeda00
commit 5e9529d66b
4 changed files with 846 additions and 0 deletions

256
docs/fr/conf.py Normal file
View File

@ -0,0 +1,256 @@
# -*- coding: utf-8 -*-
#
# Centreon documentation build configuration file, created by
# sphinx-quickstart on Wed Nov 7 16:30:34 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
on_centreon_rtd = os.environ.get('CENTREON_RTD', None) == 'True'
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.todo', 'sphinx.ext.intersphinx']
intersphinx_mapping = {
'centreon-engine': ('http://documentation.centreon.com/docs/centreon-engine/en/latest', None),
'centreon-broker': ('http://documentation.centreon.com/docs/centreon-broker/en/latest', None),
'centreon-clib': ('http://documentation.centreon.com/docs/centreon-clib/en/latest', None),
'ces': ('http://documentation.centreon.com/docs/centreon-enterprise-server/en/latest', None),
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
todo_include_todos = True
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Centreon Plugins'
copyright = u'2014, Merethis'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
if on_centreon_rtd:
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'centreon'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['/srv/themes']
else:
html_theme = 'default'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'Centreondoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Centreon.tex', u'Centreon Plugins Documentation',
u'Merethis', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'centreon', u'Centreon Plugins Documentation',
[u'Merethis'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Centreon', u'Centreon Documentation',
u'Merethis', 'Centreon', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

14
docs/fr/index.rst Normal file
View File

@ -0,0 +1,14 @@
Bienvenue dans la documentation Centreon Plugins!
=================================================
Centreon Plugins est un ensemble de bibliothèques et plugins de supervision
écrits en Perl. Ceci est licencié sour les termes de `GNU General Public
License Version 2 <https://www.gnu.org/licenses/gpl-2.0.html>`_ tel que
publié par la "Fondation pour le logiciel libre".
Sommaire :
.. toctree::
:maxdepth: 2
user/index

566
docs/fr/user/guide.rst Normal file
View File

@ -0,0 +1,566 @@
***********
Description
***********
"centreon-plugins" est un projet gratuit et open source de supervision des sytèmes.
Ce projet peut être utilisé avec Centreon, Icinga et tout logiciel de supervision compatible avec les plugins nagios.
La dernière version est disponible sur le dépôt git suivant: http://git.centreon.com/centreon-plugins.git
************
Installation
************
-------------
Debian Wheezy
-------------
Télécharger la dernière version de "centreon-plugins" depuis le dépôt:
::
# aptitude install git
# git clone http://git.centreon.com/centreon-plugins.git
Pour superviser les systèmes SNMP, vous devez installer les paquets suivants:
::
# aptitude install perl libsnmp-perl
Vous pouvez installer d'autres paquets pour utiliser plus de plugins:
::
# aptitude install libxml-libxml-perl libjson-perl libwww-perl libxml-xpath-perl libnet-telnet-perl libnet-ntp-perl libnet-dns-perl libdbi-perl libdbd-mysql-perl libdbd-pg-perl
Pour utiliser la fonctionnalité 'memcached', vous devez installer le module CPAN suivant (pas de paquet debian): http://search.cpan.org/~wolfsage/Memcached-libmemcached-1.001702/libmemcached.pm
-------------
Centos/Rhel 6
-------------
Télécharger la dernière version de "centreon-plugins" depuis le dépôt:
::
# yum install git
# git clone http://git.centreon.com/centreon-plugins.git
Pour superviser les systèmes SNMP, vous devez installer les paquets suivants:
::
# yum install perl net-snmp-perl
Vous pouvez installer d'autres paquets pour utiliser plus de plugins:
::
# yum install perl-XML-LibXML perl-JSON perl-libwww-perl perl-XML-XPath perl-Net-Telnet perl-Net-DNS perl-DBI perl-DBD-MySQL perl-DBD-Pg
Pour utiliser la fonctionnalité 'memcached', vous devez installer le module CPAN suivant (paquet disponible dans 'rpmforge'): http://search.cpan.org/~wolfsage/Memcached-libmemcached-1.001702/libmemcached.pm
*******************
Utilisation basique
*******************
Nous allons utiliser un exemple basique pour montrer comment superviser un système. J'ai terminé partie installation et je veux superviser un système Linux par SNMP.
Tout d'abord, j'ai besoin de trouver le plugin à utiliser dans la liste:
::
$ perl centreon_plugins.pl --list-plugin | grep -i linux | grep 'PLUGIN'
PLUGIN: os::linux::local::plugin
PLUGIN: os::linux::snmp::plugin
Il semblerait que 'os::linux::snmp::plugin' est le bon. donc je vérifie avec l'option ``--help`` pour être sûr:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --help
...
Plugin Description:
Check Linux operating systems in SNMP.
C'est exactement ce dont j'ai besoin. Maintenant je vais utiliser l'option ``--list-mode`` pour connaître ce que je peux faire avec celui-ci:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --list-mode
...
Modes Available:
processcount
time
list-storages
disk-usage
diskio
uptime
swap
cpu-detailed
load
traffic
cpu
inodes
list-diskspath
list-interfaces
packet-errors
memory
tcpcon
storage
J'aimerai tester le mode 'load':
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load
UNKNOWN: Missing parameter --hostname.
Il ne fonctionne pas car certaines options sont manquantes. Je peux avoir une description du mode et ses options avec l'option ``--help``:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load --help
Je dois éventuellement configurer certaines options SNMP:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public
OK: Load average: 0.00, 0.00, 0.00 | 'load1'=0.00;;;0; 'load5'=0.00;;;0; 'load15'=0.00;;;0;
Je peux spécifier des seuils avec les options ``--warning`` et ``--critical``:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --warning=1,2,3 --critical=2,3,4
OK: Load average: 0.00, 0.00, 0.00 | 'load1'=0.00;0:1;0:2;0; 'load5'=0.00;0:2;0:3;0; 'load15'=0.00;0:3;0:4;0;
***
FAQ
***
----------------------------------
Qu'est ce que je peux superviser ?
----------------------------------
L'option ``--list-plugin`` peut être utilisée pour obtenir la liste des plugins, ainsi qu'une courte description.
Les en-têtes du tableau signifient:
* Transport: Le point de contrôle a des options internes pour le transport
* Protocole: qu'est-ce qui est utilisé pour obtenir les inforations de supervision?
* Experimental: Le point de contrôle est en cours de développement
+----------------+--------------------+----------------------------+--------------------------------------------+--------------+--------------------------------------------------------------------------+
| | | Transport | Protocole | | |
| Categorie | Point de contrôle +-------+----------+---------+--------+--------+-------+-------+----------+ Experimental | Commentaires |
| | | ssh | telnet | wsman | snmp | http | wmi | jmx | custom | | |
+================+====================+=======+==========+=========+========+========+=======+=======+==========+==============+==========================================================================+
| | Active Directory | | | | | | | | * | | Utilise la commande 'dcdiag'. Doit être installée sur Windows. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Apache | | | | | * | | | | | Requiert le module Apache 'mod_status'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Apc | | | | | * | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Apcupsd | * | | | | | | | * | | Utilise les commandes 'apcupsd'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Bluemind | | | | | * | | | | | Utilise l'API 'influxdb'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Exchange | | | | | | | | * | | Utilise un script powershell. Doit être installé sur Windows. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Hddtemp | | | | | | | | * | | Ouvre une connexion TCP personnalisée |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | | | | | | | * | | | | Doit être installé sur Windows. |
| | IIS +-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| Application | | | | * | | | * | | | * | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Lmsensors | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Msmq | | | | | | | | * | * | Doit être installé sur Windows. Pas encore développé. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Nginx | | | | | * | | | | | Requiert le module 'HttpStubStatusModule'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Pacemaker | * | | | | | | | * | | Utilise la commande 'crm_mon'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Pfsense | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Selenium | | | | | | | | * | | Se connecte à un serveur Selenium pour jouer un scenario. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Tomcat | | | | | * | | | | | Requiert tomcat webmanager. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Varnish | * | | | | | | | * | | Utilise les commandes varnish. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | VMWare | | | | | | | | * | | Requiert le connecteur 'centreon_esxd' de Merethis. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Pfsense | | | | * | | | | | | |
+----------------+--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Informix | | | | | | | | * | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | MS SQL | | | | | | | | * | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| Base de | MySQL | | | | | | | | * | | |
| données +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Oracle | | | | | | | | * | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Postgres | | | | | | | | * | | |
+----------------+--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | ATS Apc | | | | * | | | | | * | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | PDU Apc | | | | * | | | | | * | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | PDU Eaton | | | | * | | | | | * | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Standard Printers | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Sensorip | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Sensormetrix Em01 | | | | | * | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Cisco UCS | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| Matériel | Dell Openmanage | | | | * | | | | | | Requiert "l'agent openmanage" sur le système d'exploitation. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | HP Proliant | | | | * | | | | | | Requiert "l'agent HP Insight" sur le système d'exploitation. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | HP Blade Chassis | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | IBM HMC | * | | | | | | | * | * | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | IBM IMM | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Sun hardware | * | * | | * | | | | * | | Peut superviser plusieurs types de matériel Sun. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | UPS Mge | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | UPS Standard | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | UPS Powerware | | | | * | | | | | | |
+----------------+--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Alcatel Omniswitch | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Arkoon | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Aruba | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Bluecoat | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Brocade | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Checkpoint | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Cisco | | | | * | | | | | | Plusieurs modèles cisco (2800, Nexus,...) |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Citrix Netscaler | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Dell Powerconnect | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| Réseau | F5 Big-Ip | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Fortinet Fortigate | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Fritzbox | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | HP Procurve | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Juniper | | | | * | | | | | | Peut superviser: 'SSG', 'SA', 'SRX' et 'MAG'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Palo Alto | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Radware Alteon | | | | * | | | | | * | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Ruggedcom | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Securactive | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Stonesoft | | | | * | | | | | | |
+----------------+--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | | * | | | | | | | * | | Utilise les commandes AIX. |
| | AIX +-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | | | | | | | * | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Freebsd | | | | * | | | | | | Utilise l'agent 'bsnmpd'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| Système | | * | | | | | | | * | | Utilise les commandes Linux. |
| d'exploitation | Linux +-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Solaris | * | | | | | | | * | | Utilise les commandes Solaris. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | | | | | * | | | | | | |
| | Windows +-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | | | | * | | | * | | | * | |
+----------------+--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Dell MD3000 | | | | | | | | * | | Requiert la commande 'SMcli'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Dell TL2000 | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | EMC Clariion | | | | | | | | * | | Requiert la commande 'navisphere'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | EMC DataDomain | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | EMC Recoverypoint | * | | | | | | | * | | Utilise les commandes de l'appliance. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | HP Lefthand | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | HP MSA2000 | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| Stockage | HP p2000 | | | | | | * | | | | Utilise l'API XML. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | IBM DS3000 | | | | | | | | * | | Utilise la commande 'SMcli'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | IBM DS4000 | | | | | | | | * | | Utilise la commande 'SMcli'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | IBM DS5000 | | | | | | | | * | | Utilise la commande 'SMcli'. |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | IBM TS3100 | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | IBM TS3200 | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Netapp | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Qnap | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Synology | | | | * | | | | | | |
| +--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
| | Violin 3000 | | | | * | | | | | | |
+----------------+--------------------+-------+----------+---------+--------+--------+-------+-------+----------+--------------+--------------------------------------------------------------------------+
------------------------------------------------------
Comment puis-je supprimer les données de performance ?
------------------------------------------------------
Par exemple, je vérifie les connexions tcp d'un serveur linux par SNMP avec la commande suivante:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=tcpcon --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public
OK: Total connections: 1 | 'total'=1;;;0; 'con_closed'=0;;;0; 'con_closeWait'=0;;;0; ' con_synSent'=0;;;0; 'con_established'=1;;;0; 'con_timeWait'=0;;;0; 'con_lastAck'=0;;;0 ; 'con_listen'=5;;;0; 'con_synReceived'=0;;;0; 'con_finWait1'=0;;;0; 'con_finWait2'=0; ;;0; 'con_closing'=0;;;0;
Il y a trop de données de performances et je veux seulement garder la donnée de performance 'total'. J'utilise l'option ``--filter-perfdata='total'``:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=tcpcon --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --filter-perfdata='total'
OK: Total connections: 1 | 'total'=1;;;0;
Je peux utiliser une expression régulière dans l'option ``--filter-perfdata``. Donc, je peux exclure les données de performance commençant par 'total':
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=tcpcon --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --filter-perfdata='^(?!(total))'
OK: Total connections: 1 | 'con_closed'=0;;;0; 'con_closeWait'=0;;;0; 'con_synSent'=0;;;0; 'con_established'=1;;;0; 'con_timeWait'=0;;;0; 'con_lastAck'=0;;;0; 'con_listen'=5;;;0; 'con_synReceived'=0;;;0; 'con_finWait1'=0;;;0; 'con_finWait2'=0;;;0; 'con_closing'=0;;;0;
----------------------------------------------------------
Comment puis-je ajuster un seuil: critique si valeur < X ?
----------------------------------------------------------
"centreon-plugins" gère les seuils nagios: https://nagios-plugins.org/doc/guidelines.html#THRESHOLDFORMAT
Par exemple, je veux vérifier que 'crond' fonctionne (s'il y a moins de 1 processus, critique). J'ai deux solutions:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=processcount --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --process-name=crond --critical=1:
CRITICAL: Number of current processes running: 0 | 'nbproc'=0;;1:;0;
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=processcount --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --process-name=crond --critical=@0:0
CRITICAL: Number of current processes running: 0 | 'nbproc'=0;;@0:0;0;
------------------------------------------------------------
Comment puis-je vérifier la valeur d'un OID SNMP générique ?
------------------------------------------------------------
Il y a un plugin SNMP générique pour vérifier cela. Voici un exemple pour obtenir l'OID SNMP 'SysUptime':
::
$ perl centreon_plugins.pl --plugin=snmp_standard::plugin --mode=numeric-value --oid='.1.3.6.1.2.1.1.3.0' --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public
---------------------------------------------------------------------
Comment utiliser un serveur memcached pour la rétention des données ?
---------------------------------------------------------------------
Quelques plugins ont besoin de stocked des données. Il y a deux solutions pour les stocker:
* Un fichier sur le disque (par default)
* Un serveur memcached
Pour utiliser 'memcached', vous devez avoir un serveur memcached et le module CPAN 'Memcached::libmemcached' installé.
Vous pouvez renseigner le serveur memcached avec l'option ``--memcached``:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=traffic --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --verbose --skip --skip-speed0 --memcached=127.0.0.1
OK: All traffic are ok | 'traffic_in_lo'=197.40b/s;;;0;10000000 'traffic_out_lo'=197.40b/s;;;0;10000000 'traffic_in_eth0'=14539.11b/s;;;0;1000000000 'traffic_out_eth0'=399.59b/s;;;0;1000000000 'traffic_in_eth1'=13883.82b/s;;;0;1000000000 'traffic_out_eth1'=1688.66b/s;;;0;1000000000
Interface 'lo' Traffic In : 197.40b/s (0.00 %), Out : 197.40b/s (0.00 %)
Interface 'eth0' Traffic In : 14.54Kb/s (0.00 %), Out : 399.59b/s (0.00 %)
Interface 'eth1' Traffic In : 13.88Kb/s (0.00 %), Out : 1.69Kb/s (0.00 %)
.. tip::
Un fichier local est utilisé sir le serveur memcached ne répond pas.
--------------------------------------------
Qu'est-ce que l'option ``--dyn-mode`` fait ?
--------------------------------------------
Avec cette option, vous pouvez utiliser un mode avec un plugin. Cela est couramment utilisé pour les bases de données.
Par exemple, j'ai une application qui stocke des informations de supervision dans une base de données. Le développeur peut utiliser un autre plugin pour créer le point de contrôle
(pas besoin de faire les connexions SQL,... cela fait gagner du temps):
::
$ perl centreon_plugins.pl --plugin=database::mysql::plugin --dyn-mode=apps::centreon::mysql::mode::pollerdelay --host=10.30.3.75 --username='test' --password='testpw' --verbose
OK: All poller delay for last update are ok | 'delay_Central'=2s;0:300;0:600;0; 'delay_Poller-Engine'=2s;0:300;0:600;0;
Delay for last update of Central is 2 seconds
Delay for last update of Poller-Engine is 2 seconds
.. warning::
Un mode utilisant le système suivant doit le notifier (dans l'aide associée). Donc vous devriez ouvrir un fichier dans éditeur et lire à la fin de la description.
-----------------------------------------------
Comment puis-je vérifier la version du plugin ?
-----------------------------------------------
Vous pouvez vérifier la version des plugins et des modes avec l'option ``--version``:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --version
Plugin Version: 0.1
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=storage --version
Mode Version: 1.0
Vous pouvez également utiliser l'option ``--mode-version`` pour exécuter le mode seulement s'il est dans la bonne version.
Par exemple, nous voullons exécuter le mode seulement si sa version >= 2.x:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=storage --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --verbose --mode-version='2.x'
UNKNOWN: Not good version for plugin mode. Excepted at least: 2.x. Get: 1.0
*********
Dépannage
*********
----
SNMP
----
J'ai l'erreur SNMP: 'UNKNOWN:.* (tooBig).*'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
L'erreur suivante peut se produire avec certains équipements.
Vous pouvez la résoudre si vous paramétrez les options suivantes:
* ``--subsetleef=20`` ``--maxrepetitions=20``
J'ai l'erreur SNMP: 'UNKNOWN:.*Timeout'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
L'erreur suivante signifie:
* Pas d'accès réseau vers le serveur SNMP cible (un pare-feu peut bloquer le port UDP 161)
* La communauté ou la version SNMP paramétrées n'est pas correcte
J'ai l'erreur SNMP: 'UNKNOWN:.*Cant get a single value'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
L'erreur suivante signifie: l'accès SNMP fonctionne mais vous ne pouvez pas récupérer les valeurs SNMP.
Plusieurs raisons possibles:
* La valeur SNMP n'est pas encore renseignée (peut se produire lorsqu'un serveur snmp vient juste de démarrer)
* La valeur SNMP n'est pas implémentée par le constructeur
* La valeur SNMP est renseignée sur un Firmware ou OS spécifique
Il semblerait que le contrôle de processus ne fonctionne pas avec certains filtres sur les arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Avec le SNMP, il y a une limite pour la longueur des arguments qui est fixée à 128 caractères.
Donc, si vous essayez de filter avec un argument après 128 caractères, cela ne fonctionnera pas. Cela peut arriver avec les arguments java.
Pour résoudre le problème, vous devez priviliégier le contrôle via NRPE.
Pas d'accès en SNMP v3
^^^^^^^^^^^^^^^^^^^^^^
Tout d'abord, vous devez valider la connexion SNMP v3 avec snmpwalk. Lorsque cela fonctionne, vous renseignez les options SNMP v3 en ligne de commande.
L'association entre les options 'snmpwalk' et les options centreon plugin:
* -a => ``--authprotocol``
* -A => ``--authpassphrase``
* -u => ``--snmp-username``
* -x => ``--privprotocol``
* -X => ``--privpassphrase``
* -l => non nécessaire (automatique)
* -e => ``--securityengineid``
* -E => ``--contextengineid``
------
Divers
------
J'utilise une options mais il semblerait qu'elle ne fonctionne pas
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Avant d'ouvrir un ticket sur la forge, utilisez l'option ``--sanity-options``. Cela vérifie si vous avez mal orthographié une option:
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=traffic --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --interface='.*' --name --regex --verbose --skip --skip-speed0 --sanity-options
Unknown option: regex
J'ai l'erreur: "UNKNOWN: Need to specify '--custommode'."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Certains plugins ont besoin de renseigner l'option ``--custommode``. Vous pouvez connaître la valeur à renseigner avec l'option ``--list-custommode``. Un exemple::
$ perl centreon_plugins.pl --plugin=storage::ibm::DS3000::cli::plugin --list-custommode
...
Custom Modes Available:
smcli
$ perl centreon_plugins.pl --plugin=storage::ibm::DS3000::cli::plugin --custommode=smcli --list-mode
J'ai l'erreur: "UNKNOWN: Cannot write statefile .*"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Vous devez créer le dossier (avec les droits d'écriture) pour autoriser le plugin à stocker certaines données sur le disque.
J'ai l'erreur: "UNKNOWN: Cannot load module 'xxx'."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Le problème peut être:
* Un module CPAN prérequis est manquant. Vous devez l'installer
* Le module CPAN ne peut pas être chargé en raison de son chemin d'accès. Les modules Perl doivent être installés dans des chemins spécifiques
Je ne peux pas vois les messages d'aide
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Les fichiers "centreon-plugins" doivent être sous format unix (pas de retour à la ligne windows). Vous pouvez les modifier avec la commande suivante:
::
$ find . -name "*.p[ml]" -type f -exec dos2unix \{\} \;
.. Warning:: Exécutez cette commande dans le dossier "centreon-plugins".
*********************
Examples de commandes
*********************
-------
Windows
-------
Contrôler tous les disques en SNMP
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Dégradé si l'espace utilisé > 80% et critique sur l'espace utilisé > 90%:
::
$ perl centreon_plugins.pl --plugin=os::windows::snmp::plugin --mode=storage --hostname=xxx.xxx.xxx.xxx --snmp-version=2c --snmp-public=community --verbose --storage='.*' --name --regexp --display-transform-src='(..).*' --display-transform-dst='$1' --warning=80 --critical=90
OK: All storages are ok. | used_C:'=38623698944B;0:108796887040;0:122396497920;0;135996108800 used_D:'=38623698944B;0:108796887040;0:122396497920;0;135996108800
Storage 'C:' Total: 126.66 GB Used: 35.97 GB (28.40%) Free: 90.69 GB (71.60%)
Storage 'D:' Total: 126.66 GB Used: 35.97 GB (28.40%) Free: 90.69 GB (71.60%)
Dégradé si l'espace disponible < 5G et critique si l'espace disponible < 2G:
::
$ perl centreon_plugins.pl --plugin=os::windows::snmp::plugin --mode=storage --hostname=xxx.xxx.xxx.xxx --snmp-version=2c --snmp-public=community --verbose --storage='.*' --name --regexp --display-transform-src='(..).*' --display-transform-dst='$1' --warning=5497558138880 --critical=2199023255552 --units='B' --free
OK: All storages are ok. | 'free_C:'=97372344320B;0:5497558138880;0:2199023255552;0;135996108800 'free_D:'=97372344320B;0:5497558138880;0:2199023255552;0;135996108800
Storage 'C:' Total: 126.66 GB Used: 35.97 GB (28.40%) Free: 90.69 GB (71.60%)
Storage 'D:' Total: 126.66 GB Used: 35.97 GB (28.40%) Free: 90.69 GB (71.60%)
-----
Linux
-----
Contrôler le trafic de toutes les interfaces en SNMP
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Dégradé si le trafic entrant/sortant utilisé > 80% et critique si le traffic entrant/sortant utilisé > 90%. L'exemple évite également les erreurs sur les interfaces déconnectées (option ``--skip``):
::
$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=traffic --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --verbose --interface='.*' --name --regexp --skip --warning-in=80 --critical-in=90 --warning-out=80 --critical-out=90
OK: All traffic are ok | 'traffic_in_lo'=126.58b/s;0.00:8000000.00;0.00:9000000.00;0;10000000 'traffic_out_lo'=126.58b/s;0.00:8000000.00;0.00:9000000.00;0;10000000 'traffic_in_eth0'=1872.00b/s;0.00:800000000.00;0.00:900000000.00;0;1000000000 'traffic_out_eth0'=266.32b/s;0.00:800000000.00;0.00:900000000.00;0;1000000000 'traffic_in_eth1'=976.65b/s;0.00:800000000.00;0.00:900000000.00;0;1000000000 'traffic_out_eth1'=1021.68b/s;0.00:800000000.00;0.00:900000000.00;0;1000000000
Interface 'lo' Traffic In : 126.58b/s (0.00 %), Out : 126.58b/s (0.00 %)
Interface 'eth0' Traffic In : 1.87Kb/s (0.00 %), Out : 266.32b/s (0.00 %)
Interface 'eth1' Traffic In : 976.65b/s (0.00 %), Out : 1.02Kb/s (0.00 %)

10
docs/fr/user/index.rst Normal file
View File

@ -0,0 +1,10 @@
#################
Guide utilisateur
#################
.. toctree::
:maxdepth: 2
:glob:
guide