Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(plugins-doc) update documentation for centreon-plugin-applications-protocol-[cifs,ftp,sftp] plugins #3269

Merged
merged 7 commits into from
May 16, 2024
Merged

feat(plugins-doc) update documentation for centreon-plugin-applications-protocol-[cifs,ftp,sftp] plugins #3269

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
68789b1
update cifs, ftp and sftp documentation
Evan-Adam May 3, 2024
15a70fa
update cifs, ftp and sftp documentation arguments
Evan-Adam May 3, 2024
cc7f95e
fix(plugins-doc) change description of arguments
Evan-Adam May 14, 2024
5dc7281
fix(plugin-doc) add generic options and typos
Evan-Adam May 14, 2024
adbb78e
fix(plugin-doc) add plugin output examples and ponctuations.
Evan-Adam May 15, 2024
16f1d70
fix(plugin-doc) Fix ftp service template name
Evan-Adam May 15, 2024
7876b8c
Apply suggestions from code review
Evan-Adam May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
388 changes: 308 additions & 80 deletions ...s-pp/current/integrations/plugin-packs/procedures/applications-protocol-cifs.md
View file
Open in desktop

Large diffs are not rendered by default.

335 changes: 312 additions & 23 deletions ...cs-pp/current/integrations/plugin-packs/procedures/applications-protocol-ftp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,331 @@
id: applications-protocol-ftp
title: FTP Server
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## Prerequisites
## Contenu du pack

### Centreon Plugin
### Modèles

Install this plugin on each needed poller:
Le connecteur de supervision **FTP Server** apporte un modèle d'hôte :

``` shell
* **App-Protocol-FTP-custom**

Le connecteur apporte les modèles de service suivants
(classés selon le modèle d'hôte auquel ils sont rattachés) :

<Tabs groupId="sync">
<TabItem value="App-Protocol-FTP-custom" label="App-Protocol-FTP-custom">

| Alias | Modèle de service | Description |
|:----------|:------------------------------|:--------------------------------------------------------|
| FTP-Login | App-Protocol-FTP-Login-custom | Contrôle la connexion FTP à distance via login/password |
Evan-Adam marked this conversation as resolved.
Show resolved Hide resolved

> Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **App-Protocol-FTP-custom** est utilisé.

</TabItem>
<TabItem value="Non rattachés à un modèle d'hôte" label="Non rattachés à un modèle d'hôte">

| Alias | Modèle de service | Description |
|:---------------|:-----------------------------------|:-------------------------------------------------------------------------------------------------------------------------------|
| FTP-Commands | App-Protocol-FTP-Commands-custom | Contrôle permettant d'executer une commande sur un serveur FTP distant |
Evan-Adam marked this conversation as resolved.
Show resolved Hide resolved
| FTP-Date | App-Protocol-FTP-Date-custom | Contrôle permettant de vérifier la date des fichiers d'un répertoire ou d'un fichier en particulier sur un serveur FTP distant |
| FTP-FilesCount | App-Protocol-FTP-FilesCount-custom | Compter les fichiers dans un répertoire FTP distant |

> Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité.

</TabItem>
</Tabs>

### Métriques & statuts collectés

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

<Tabs groupId="sync">
<TabItem value="FTP-Commands" label="FTP-Commands">

Coming soon

</TabItem>
<TabItem value="FTP-Date" label="FTP-Date">

Coming soon

</TabItem>
<TabItem value="FTP-FilesCount" label="FTP-FilesCount">

| Métrique | Unité |
|:------------|:------|
| files | N/A |

</TabItem>
<TabItem value="FTP-Login" label="FTP-Login">

Coming soon

</TabItem>
cg-tw marked this conversation as resolved.
Show resolved Hide resolved
</Tabs>

## Prérequis

*Specify prerequisites that are relevant. You may want to just provide a link\n\
to the manufacturer official documentation BUT you should try to be as complete\n\
as possible here as it will save time to everybody.*
cg-tw marked this conversation as resolved.
Show resolved Hide resolved

## Installer le connecteur de supervision

### Pack

1. Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet
n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Gestionnaire de connecteurs de supervision**.
Au contraire, si la plateforme utilise une licence *offline*, installez le paquet
sur le **serveur central** via la commande correspondant au gestionnaire de paquets
associé à sa distribution :

<Tabs groupId="sync">
<TabItem value="Alma / RHEL / Oracle Linux 8" label="Alma / RHEL / Oracle Linux 8">

```bash
dnf install centreon-pack-applications-protocol-ftp
```

</TabItem>
<TabItem value="Alma / RHEL / Oracle Linux 9" label="Alma / RHEL / Oracle Linux 9">

```bash
dnf install centreon-pack-applications-protocol-ftp
```

</TabItem>
<TabItem value="Debian 11" label="Debian 11">

```bash
apt install centreon-pack-applications-protocol-ftp
```

</TabItem>
<TabItem value="CentOS 7" label="CentOS 7">

```bash
yum install centreon-pack-applications-protocol-ftp
```

</TabItem>
</Tabs>

2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **FTP Server**
depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**.

### Plugin

À partir de Centreon 22.04, il est possible de demander le déploiement automatique
du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et
que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette
étape n'est pas requise.

> Plus d'informations dans la section [Installer le plugin](/docs/monitoring/pluginpacks/#installer-le-plugin).

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

<Tabs groupId="sync">
<TabItem value="Alma / RHEL / Oracle Linux 8" label="Alma / RHEL / Oracle Linux 8">

```bash
dnf install centreon-plugin-Applications-Protocol-Ftp
```

</TabItem>
<TabItem value="Alma / RHEL / Oracle Linux 9" label="Alma / RHEL / Oracle Linux 9">

```bash
dnf install centreon-plugin-Applications-Protocol-Ftp
```

</TabItem>
<TabItem value="Debian 11" label="Debian 11">

```bash
apt install centreon-plugin-applications-protocol-ftp
```

</TabItem>
<TabItem value="CentOS 7" label="CentOS 7">

```bash
yum install centreon-plugin-Applications-Protocol-Ftp
```

Grant access to the FTP server you would like to monitor
</TabItem>
</Tabs>

## Utiliser le connecteur de supervision

### Utiliser un modèle d'hôte issu du connecteur

1. Ajoutez un hôte à Centreon depuis la page **Configuration > Hôtes**.
2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource.
3. Appliquez le modèle d'hôte **App-Protocol-FTP-custom**. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.

| Macro | Description | Default value | Mandatory |
|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:|
| FTPUSERNAME | FTP Username | | |
| FTPPASSWORD | FTP Password | | |
| FTPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | |

5. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

### Utiliser un modèle de service issu du connecteur

1. Si vous avez utilisé un modèle d'hôte et coché la case **Créer aussi les services liés aux modèles**, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, [créez les services désirés manuellement](/docs/monitoring/basic-objects/services) et appliquez-leur un modèle de service.
2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (**Obligatoire**) doivent être renseignées.

## Centreon Configuration
<Tabs groupId="sync">
<TabItem value="FTP-Commands" label="FTP-Commands">

### Create a new FTP server
| Macro | Description | Default value | Mandatory |
|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:|
| FTPCOMMAND | Set command to test. (can be : binary; ascii; cwd,DIR; rmdir,DIR; mdkir,DIR; ls,DIR; rename,OLDNAME,NEWNAME; delete,FILENAME; get,REMOTE_FILE,LOCAL_FILE; put,LOCAL_FILE,REMOTE_FILE | cwd,DIR | |
| CRITICAL | Threshold | | |
| WARNING | Threshold | | |
| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | |

Go to *Configuration \> Hosts* and click *Add*. Then, fill the form as shown by
the following table:
</TabItem>
<TabItem value="FTP-Date" label="FTP-Date">

| Field | Value |
| :----------------------------------- | :------------------------- |
| Host name | *Name of the host* |
| Alias | *Host description* |
| IP | *Host IP Address* |
| Monitored from | *Monitoring Poller to use* |
| Host Multiple Templates | App-Protocols-FTP-custom |
| Macro | Description | Default value | Mandatory |
|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:|
| DIRECTORY | Check files in the directory (no recursive) | | |
Evan-Adam marked this conversation as resolved.
Show resolved Hide resolved
| CRITICAL | Threshold | | |
| WARNING | Threshold | | |
| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | |

Click on the *Save* button.
</TabItem>
<TabItem value="FTP-FilesCount" label="FTP-FilesCount">

| Macro | Description | Default value | Mandatory |
|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:|
| DIRECTORY | Check files in the directory (no recursive) | | |
Evan-Adam marked this conversation as resolved.
Show resolved Hide resolved
| WARNING | Threshold | | |
| CRITICAL | Threshold | | |
| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | |

</TabItem>
<TabItem value="FTP-Login" label="FTP-Login">

| Macro | Description | Default value | Mandatory |
|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:|
| CRITICAL | Threshold | | |
| WARNING | Threshold | | |
| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | |

</TabItem>
</Tabs>

3. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). Le service apparaît dans la liste des services supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

## Comment puis-je tester le plugin et que signifient les options des commandes ?

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne
de commande depuis votre collecteur Centreon en vous connectant avec
l'utilisateur **centreon-engine** (`su - centreon-engine`). Vous pouvez tester
que le connecteur arrive bien à superviser une ressource en utilisant une commande
telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

```bash
/usr/lib/centreon/plugins/centreon_protocol_ftp.pl \
--plugin=apps::protocols::ftp::plugin \
--mode=login \
--hostname=10.0.0.1 \
--username='' \
--password='' \
--warning='' \
--critical=''
```

La commande devrait retourner un message de sortie similaire à :

```bash
OK: |
```
cg-tw marked this conversation as resolved.
Show resolved Hide resolved

### Monitor your FTP Server with SSL or TLS
### Diagnostic des erreurs communes

#### What you need to configure
Rendez-vous sur la [documentation dédiée](../getting-started/how-to-guides/troubleshooting-plugins.md)
pour le diagnostic des erreurs communes des plugins Centreon.

On your Host or Host template, please set the following macro :
### Modes disponibles

| Macro | Value |
| :-------------- | :----- |
| FTPEXTRAOPTIONS | \--ssl |
Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution
du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est
implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce
modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre
`--list-mode` à la commande :

```bash
/usr/lib/centreon/plugins/centreon_protocol_ftp.pl \
--plugin=apps::protocols::ftp::plugin \
--list-mode
```

Le plugin apporte les modes suivants :

| Mode | Modèle de service associé |
|:-------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|
| commands [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/protocols/ftp/mode/commands.pm)] | App-Protocol-FTP-Commands-custom |
| date [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/protocols/ftp/mode/date.pm)] | App-Protocol-FTP-Date-custom |
| filescount [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/protocols/ftp/mode/filescount.pm)] | App-Protocol-FTP-FilesCount-custom |
| login [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/protocols/ftp/mode/login.pm)] | App-Protocol-FTP-Login-custom |

### Options disponibles

#### Options génériques

Les options génériques sont listées ci-dessous :

| Option | Description |
|:-------|:------------|

#### Options des modes

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

<Tabs groupId="sync">
<TabItem value="FTP-Commands" label="FTP-Commands">

| Option | Description |
|:-------|:------------|

</TabItem>
<TabItem value="FTP-Date" label="FTP-Date">

| Option | Description |
|:-------|:------------|

</TabItem>
<TabItem value="FTP-FilesCount" label="FTP-FilesCount">

| Option | Description |
|:-------|:------------|

</TabItem>
<TabItem value="FTP-Login" label="FTP-Login">

| Option | Description |
|:-------|:------------|

</TabItem>
</Tabs>
cg-tw marked this conversation as resolved.
Show resolved Hide resolved

Pour un mode, la liste de toutes les options disponibles et leur signification peut être
affichée en ajoutant le paramètre `--help` à la commande :

```bash
/usr/lib/centreon/plugins/centreon_protocol_ftp.pl \
--plugin=apps::protocols::ftp::plugin \
--mode=login \
--help
```