> For the complete documentation index, see [llms.txt](https://help.glpi-project.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.glpi-project.org/glpi-12/fr/administration/rules/inventorytools.md).

# Règles d'inventaire

Ces règles déterminent comment les données collectées lors des inventaires automatiques `Agent GLPI` sont analysées et intégrées dans la base GLPI.\
Les différents moteurs de règles présentés ci-dessous sont exécutés dans **l’ordre indiqué**.

Pour chaque actif inventorié, les différents moteurs s’arrêtent dès que les critères d’une règle sont satisfaits. Les autres règles du moteur ne seront pas testées ni exécutées. 

## **Transformation des types d’actifs**

Ces règles permettent de remplacer un type d’actif détecté par l’agent GLPI par un type d’actifs personnalisés.<br>

Exemple : Cette règle permet à GLPI de détecter automatiquement les ordinateurs `Dell` du modèle `PowerEdge R740` et de transformer le type de l’actif en **`Serveur`**

Penser à activer la capacité **« Inventaire »** dans l’actif personnalisé pour qu’il apparaisse dans la liste des types d’objets pouvant être assignés.

### Critères disponibles

| Nom                                          | Description                                                   | Clé                      | Opérateur(s)                                                                                                                                                                                                                                                          |
| -------------------------------------------- | ------------------------------------------------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entité de destination pour l'actif           | Entité à laquelle l'actif sera rattaché lors de l'inventaire. | `entities_id`            | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`                                                                                                              |
| Système de virtualisation                    | Type de système de virtualisation de l'actif.                 | `virtualmachinetypes_id` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`                                                                                                              |
| Statut                                       | Statut de l’actif                                             | `states_id`              | `est`, `n'est pas`                                                                                                                                                                                                                                                    |
| Parc > Modèle                                | Modèle de système de virtualisation de l'actif.               | `model`                  | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Fabricant                                    | Fabriquant de l’actif.                                        | `manufacturer`           | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Port réseau > MAC                     | Adresses MAC de l’actif                                       | `mac`                    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Port réseau > IP                      | Adresses IP de l’actif.                                       | `ip`                     | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `correspond au CIDR`, `ne correspond pas au CIDR`, `est déjà présent`, `est vide` |
| Parc > Port réseau > Description du port     | Descriptions des ports réseaux                                | `ifdescr`                | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Port réseau > Numéro de port          | Numéro des ports réseaux                                      | `ifnumber`               | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Numéro de série                       | Numéro de série de l'actif.                                   | `serial`                 | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > UUID                                  | UUID de l'actif.                                              | `uuid`                   | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Agent > Device ID                            | Identifiant de l'agent.                                       | `device_id`              | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Numéro de série OS                    | Numéro de série du système d'exploitation.                    | `mskey`                  | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Nom                                   | Nom de l'actif.                                               | `name`                   | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Agent > Tag d'inventaire                     | Tag d'inventaire de l'agent.                                  | `tag`                    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Système d'exploitation                | Nom du système d'exploitation.                                | `osname`                 | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Système d'exploitation > Commentaires | Commentaires du système d'exploitation.                       | `oscomment`              | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Type d'élément                        | Type d’élément inventorié (ordinateur, imprimante, etc.).     | `itemtype`               | `est`, `n'est pas`, `existe`, `n'existe pas`                                                                                                                                                                                                                          |
| Parc > Domaine                               | Domaine auquel l'actif appartient.                            | `domains_id`             | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Est partiel                                  | Indique si l'inventaire est partiel.                          | `partial`                | `est`, `n'est pas`                                                                                                                                                                                                                                                    |

### Actions disponibles

| Nom                      | Description                                               | Clé       | Actions    |
| ------------------------ | --------------------------------------------------------- | --------- | ---------- |
| Assigner le type d'objet | Assigner un type d'objet spécifique à l'actif inventorié. | `_assign` | `Assigner` |

***

## **Règles d’affectation des objets aux entités**

Ces règles permettent de définir automatiquement à quelle **entité GLPI** rattacher un actif lors de son inventaire (création ou mise à jour), afin de respecter la hiérarchie organisationnelle configurée dans GLPI.

Exemple : Cette règle permet d’assigner automatiquement l’entité `Marketing` aux actifs de type `Server` dont l’adresse IP commence par `10.0.20.`

### Critères disponibles

| Nom                                   | Description                                               | Clé         | Opérateurs                                                                                                                                                                                                                            |
| ------------------------------------- | --------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tag d'inventaire                      | Tag d'inventaire de l'actif.                              | `tag`       | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Domaine                               | Domaine auquel appartient l'actif.                        | `domain`    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Sous-réseau                           | Sous-réseau de l'actif.                                   | `subnet`    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `correspond au CIDR`, `ne correspond pas au CIDR` |
| Adresse IP                            | Liste des IPs de l'actif.                                 | `ip`        | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `correspond au CIDR`, `ne correspond pas au CIDR` |
| Nom de l'équipement                   | Nom de l'actif.                                           | `name`      | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Numéro de série                       | Numéro de série de l'actif.                               | `serial`    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Type d'élément                        | Type d’élément inventorié (ordinateur, imprimante, etc.). | `itemtype`  | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Système d'exploitation > Commentaires | Commentaires du système d'exploitation.                   | `oscomment` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Source                                | Source de l'import.                                       | `_source`   | `est`, `n'est pas`                                                                                                                                                                                                                    |

### Actions disponibles

<table data-search="false"><thead><tr><th>Nom</th><th>Description</th><th>Clé</th><th>Actions</th></tr></thead><tbody><tr><td>Entité</td><td>Assigne l'élément à une entité spécifique.</td><td><code>entities_id</code></td><td><code>Assigner</code></td></tr><tr><td>Lieu</td><td>Assigne l'élément à un lieu spécifique.</td><td><code>locations_id</code></td><td><code>Asigner</code></td></tr><tr><td>Entité depuis TAG</td><td>Assigne l'entité selon une expression régulière sur le tag.</td><td><code>_affect_entity_by_tag</code></td><td><code>Assigner valeur depuis l'expression régulière</code></td></tr><tr><td>Refuser l'import</td><td>Ignore l'import de l'élément.</td><td><code>_ignore_import</code></td><td><code>Oui</code></td></tr><tr><td>Sous-entités</td><td>Applique l’assignation de l’entité de façon récursive aux sous-entités.</td><td><code>is_recursive</code></td><td><code>Oui / non</code></td></tr><tr><td>Groupe responsable</td><td>Assigner le groupe responsable.</td><td><code>groups_id_tech</code></td><td><code>Assigner</code></td></tr><tr><td>Technicien responsable</td><td>Assigner le technicien responsable.</td><td><code>users_id_tech</code></td><td><code>Assigner</code></td></tr></tbody></table>

***

## **Règles de localisation**

Ces règles servent à affecter automatiquement un lieu GLPI à un actif.

Exemple : Cette règle permet d’assigner automatiquement le lieu `Paris` aux actifs de type `Serveur` dont l’adresse IP commence par `10.0.20.`

### Critères disponibles

| Nom                                   | Description                                                 | Clé         | Opérateurs                                                                                                                                                                                                                             |
| ------------------------------------- | ----------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Parc > Type d'élément                 | Type d’élément inventorié (ordinateur, imprimante, etc.).   | `itemtype`  | `est`, `n'est pas`, `existe`, `n'existe pas`                                                                                                                                                                                           |
| Agent > Tag d'inventaire              | Tag d'inventaire de l'actif.                                | `tag`       | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Domaine                               | Domaine réseau auquel appartient l’actif.                   | `domain`    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Sous-réseau                           | Liste des sous-réseau de l’actif.                           | `subnet`    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `correspond au CIDR`, `ne correspond pas au CIDR` |
| Port réseau > IP                      | Liste des IPs de l’actif.                                   | `ip`        | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `correspond au CIDR`, `ne correspond pas au CIDR` |
| Nom                                   | Nom de l’actif.                                             | `name`      | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Numéro de série                       | Numéro de série de l’actif.                                 | `serial`    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |
| Système d'exploitation > Commentaires | Commentaires associés au système d’exploitation de l’actif. | `oscomment` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                                    |

### Actions disponibles

| Nom  | Description                | Clé            | Actions                                                     |
| ---- | -------------------------- | -------------- | ----------------------------------------------------------- |
| Lieu | Assigner un lieu à l’actif | `locations_id` | `Assigner`, `Assigner valeur depuis l'expression régulière` |

***

## **Règles d’import et de liaison des équipements (actifs)**

Ces règles définissent la manière dont GLPI recherche les actifs afin de déterminer s’il doit mettre à jour un élément existant ou en créer un nouveau. Elles permettent ainsi d’éviter les doublons et d’assurer la cohérence ainsi que la fiabilité de la base de données.

Il existe deux types de règles :

1. **Règles par type d’actif**\
   Ces règles s’appliquent spécifiquement à un type d’actif (ordinateur, serveur, imprimante, etc.). Elles permettent de définir un comportement précis selon la catégorie de matériel.
2. **Règles globales**\
   Ces règles s’appliquent à tous les types d’actifs sans distinction. Par exemple reconcilier et mettre à jour un actif depuis l’adresse MAC de l’actif

«De manière générale, les règles de réconciliation natives de GLPI suffisent à assurer une réconciliation correcte des actifs dans la grande majorité des cas.

Toute ajout ou adaptation de ces règles doit être effectuée avec prudence et préalablement testée dans un environnement de test, afin de garantir leur bon fonctionnement avant toute mise en production.

### Critères disponibles

| Nom                                                               | Description                                                   | Clé                      | Opérateurs                                                                                                                                                                                                                                                            |
| ----------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entité de destination pour l'actif                                | Entité GLPI de l’actif                                        | `entities_id`            | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`                                                                                                              |
| Système de virtualisation                                         | Type de virtualisation                                        | `virtualmachinetypes_id` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`                                                                                                              |
| Statut                                                            | Statut de l’actif                                             | `states_id`              | `est`, `n'est pas`                                                                                                                                                                                                                                                    |
| Parc > Modèle                                                     | Modèle de l’actif                                             | `model`                  | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Fabricant                                                         | Fabricant de l’actif                                          | `manufacturer`           | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Port réseau > MAC                                          | Liste des adresse MAC de l’actif                              | `mac`                    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Port réseau > IP                                           | Liste des adresse IP de l’actif                               | `ip`                     | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `correspond au CIDR`, `ne correspond pas au CIDR`, `est déjà présent`, `est vide` |
| Parc > Port réseau > Description du port                          | Description des ports réseaux de l’actif                      | `ifdescr`                | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Port réseau > Numéro de port                               | Numéros des ports réseau de l’actif                           | `ifnumber`               | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Numéro de série                                            | Numéro de série de l’actif                                    | `serial`                 | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > UUID                                                       | UUID de l’actif                                               | `uuid`                   | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Agent > Device ID                                                 | Identifiant de l'agent.                                       | `device_id`              | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Numéro de série du système d'exploitation                  | Numéro de série du système d’exploitation                     | `mskey`                  | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Nom                                                        | Nom de l’actif                                                | `name`                   | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Agent > Tag d'inventaire                                          | TAG d’inventaire de l’actif                                   | `tag`                    | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Système d'exploitation                                     | Nom du système d’exploitation                                 | `osname`                 | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Système d'exploitation > Commentaires                      | Commentaires associés au système d’exploitation               | `oscomment`              | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Parc > Type d'élément                                             | Type d’élément inventorié                                     | `itemtype`               | `est`, `n'est pas`, `existe`, `n'existe pas`                                                                                                                                                                                                                          |
| Parc > Domaine                                                    | Domaine associés à l’actif                                    | `domains_id`             | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `est déjà présent`, `est vide`                                                    |
| Élément lié                                                       |                                                               | `linked_item`            | `est déjà présent`                                                                                                                                                                                                                                                    |
| Général > Restreindre la recherche dans une entité définie        | Limite la recherche à une entité spécifique                   | `entityrestrict`         | `Yes`                                                                                                                                                                                                                                                                 |
| Général > Restreindre les critères au même port réseau            | Applique la règle uniquement aux critères du même port réseau | `link_criteria_port`     | `Yes`                                                                                                                                                                                                                                                                 |
| Général > Uniquement les critères de cette règle dans les données | N’applique que les critères définis dans cette règle          | `only_these_criteria`    | `Yes`                                                                                                                                                                                                                                                                 |
| Est partiel                                                       | Indique si l’import est partiel                               | `partial`                | `est`, `n'est pas`                                                                                                                                                                                                                                                    |

### **Opérateus spécifiques**

| Opérateurs                                                  | Description                                                                                                                                                        | Valeur en entrée                       | Exemple (champ - opérateur - pattern)                                                                                           | Résultat                                                                                                                                                                                        |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Restreindre la recherche dans une entité définie**        | Limite la recherche d'un équipement existant à l'entité de destination de l'inventaire. Clé : `entityrestrict`                                                     | Aucune, le critère s'active avec `oui` | `Restreindre la recherche dans une entité définie` - `oui`                                                                      | La règle ne doit relier l'inventaire qu'à un équipement situé dans l'entité définie.                                                                                                            |
| **Restreindre les critères au même port réseau**            | Impose que les critères réseau (adresse MAC, adresse IP, nom ou numéro de port) soient trouvés sur un même port réseau de l'équipement. Clé : `link_criteria_port` | Aucune, le critère s'active avec `oui` | `Adresse MAC` - `est déjà présent` ; `Adresse IP` - `est déjà présent` ; `Restreindre les critères au même port réseau` - `oui` | Sans ce critère, la MAC et l'IP peuvent appartenir à deux ports différents du même équipement. Avec ce critère, l'équipement n'est retenu que si un seul port porte à la fois la MAC et l'IP.   |
| **Uniquement les critères de cette règle dans les données** | Applique la règle seulement si les données d'inventaire ne contiennent aucun autre critère que ceux utilisés dans la règle. Clé : `only_these_criteria`            | Aucune, le critère s'active avec `oui` | `Numéro de série` - `existe` ; `Uniquement les critères de cette règle dans les données` - `oui`                                | La règle s'applique si l'inventaire ne remonte que le numéro de série. Si l'inventaire contient aussi une adresse MAC ou un UUID, la règle ne s'applique pas et GLPI passe à la règle suivante. |

### Actions disponibles

| Nom                    | Description                                                                                               | Clé              | Actions               |
| ---------------------- | --------------------------------------------------------------------------------------------------------- | ---------------- | --------------------- |
| Lien vers l'inventaire | Permet de lier l’actif à l’inventaire                                                                     | `_inventory`     | `Liaison si possible` |
| Refuser l'import       | Permet de refuser l’import de l’actif et consigne l’événement dans l’historique des équipements refusés.  | `_ignore_import` | `Ignorer l'import`    |

### **Valeurs possibles pour l’action `Liaison si possible`**

| Nom                                        | Description                                                                                                                      |
| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| `Liaison si possible`                      | Mettre à jour l’actif si possible ; sinon, le créer.                                                                             |
| `Liaison si possible, sinon import refusé` | Mettre à jour l’actif si possible ; sinon, refuser l’import et consigner l’événement dans l’historique des équipements refusés.  |
| `Import refusé (pas de journaux)`          | L’import est refusé sans consigner l’événement dans l’historique des équipements refusés.                                        |

### Historique des équipements refusés

Lorsque l’actif est refusé à l’import par GLPI en raison des règles en vigueur (import refusé avec journalisation), l’événement de refus sera consigné dans l’historique des équipements refusés. Vous y trouverez la règle ayant entraîné le refus de l’import.

 Exemple : cet actif a été refusé car le champ `nom` n’est pas renseigné dans les données d’inventaire. On peut constater que c’est la règle **Computer constraint (name)** qui est à l’origine de ce refus.

Vous pouvez récupérer le fichier d’inventaire (1) ou relancer l’import (2) une fois que vos règles auront été adaptées, afin de vérifier leur bon fonctionnement.

### Réglage par défaut

Si vous souhaitez réinitialiser les règles de réconciliation des matériels pour revenir aux règles natives de GLPI, un bouton de réinitialisation est disponible à cet effet.

Cette action **remplace toutes les règles**, y compris les règles natives ainsi que celles que vous auriez pu créer ou personnaliser.

***

## **Dictionnaires**

Les dictionnaires dans GLPI permettent de **rationaliser et d’homogénéiser les données importées**.\
Ils servent notamment à **normaliser les noms de fabriquants, modèles, logiciels, types ou systèmes d’exploitation**, afin d’éviter les doublons, les variations d’orthographe et les incohérences dans la base de données.

### Logiciels

#### **Critères**

| Nom                                | Description                        | Clé                | Opérateurs                                                                                                                                                                                                                 | Exemple          |
| ---------------------------------- | ---------------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| Logiciel                           | Nom du logiciel                    | `name`             | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                         | `Microsoft Word` |
| Éditeur                            | Editeur du logiciel                | `manufacturer`     | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                         | `Microsoft`      |
| Entité                             | Entité du logiciel                 | `entities_id`      | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`, `sous`, `pas sous`, `sous`, `pas sous` | `Entité root`    |
| Catégories de l'outil d'inventaire | Catégories de l'agent d'inventaire | `_system_category` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `fini par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas`                                         | `Bureautique`    |

#### **Actions**

<table data-search="false"><thead><tr><th>Nom</th><th>Description</th><th>Clé</th><th>Actions</th></tr></thead><tbody><tr><td>Logiciel</td><td>Assigner un logiciel</td><td><code>name</code></td><td><code>Assigner le résultat de l'expression régulière</code></td></tr><tr><td>Ignorer l'import</td><td>Ignorer le logiciel à l’import</td><td><code>_ignore_import</code></td><td><code>Oui</code></td></tr><tr><td>Version</td><td>Assigner une version au logiciel</td><td><code>version</code></td><td><code>Assigner</code>, <code>Assigner le résultat de l'expression régulière</code>, <code>Ajouter le résultat de l'expression régulière</code></td></tr><tr><td>Éditeur</td><td>Assigner un fabriquant au logiciel</td><td><code>manufacturer</code></td><td><code>Assigner</code>, <code>Assigner le résultat de l'expression régulière</code>, <code>Ajouter le résultat de l'expression régulière</code></td></tr><tr><td>Associable à un ticket</td><td>Est associable à un ticket</td><td><code>is_helpdesk_visible</code></td><td><code>Oui / Non</code></td></tr><tr><td>Entité</td><td>Assigner une entité au logiciel</td><td><code>new_entities_id</code></td><td><code>Assigner</code></td></tr><tr><td>Catégorie</td><td>Assigner une catégorie au logiciel</td><td><code>softwarecategories_id</code></td><td><code>Assigner</code>, <code>Assigner le résultat de l'expression régulière</code></td></tr></tbody></table>

### Fabriquants

#### **Critères**

| Nom       | Description       | Clé    | Opérateurs                                                                                                                                                                          | Exemple     |
| --------- | ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| Fabricant | Nom du fabriquant | `name` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Microsoft` |

#### **Actions**

| Nom       | Description            | Clé    | Actions                                                                                           |
| --------- | ---------------------- | ------ | ------------------------------------------------------------------------------------------------- |
| Fabricant | Assigner un fabriquant | `name` | `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Imprimantes

#### **Critères**

| Nom          | Description                 | Clé            | Opérateurs                                                                                                                                                                          | Exemple             |
| ------------ | --------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| Nom          | Nom de l’imprimante         | `name`         | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `HP LaserJet 1020`  |
| Fabricant    | Fabriquant de l’imprimante  | `manufacturer` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `HP`                |
| Commentaires | Commentaire de l’imprimante | `comment`      | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Imprimante réseau` |

#### **Actions**

| Nom              | Description                      | Clé              | Actions                                                      |
| ---------------- | -------------------------------- | ---------------- | ------------------------------------------------------------ |
| Nom              | Nom de l’imprimante              | `name`           | `Assigner`, `Assigner le résultat de l'expression régulière` |
| Ignorer l'import | Ignorer l’imprimante à l’import  | `_ignore_import` | `Oui`                                                        |
| Fabricant        | Fabriquant de l’imprimante       | `manufacturer`   | `Assigner`                                                   |
| Type de gestion  | Mettre la gestion comme ‘global’ | `is_global`      | `Assigner`                                                   |

### Modèles d'ordinateurs

#### **Critères**

| Nom       | Description               | Clé            | Opérateurs                                                                                                                                                                          | Exemple       |
| --------- | ------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| Modèle    | Nom du modèle de moniteur | `name`         | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Dell U2720Q` |
| Fabricant | Fabricant du moniteur     | `manufacturer` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Dell`        |

#### **Actions**

| Nom    | Description        | Clé    | Actions                                                                                                       |
| ------ | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| Modèle | Assigner un modèle | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Modèle des moniteurs

#### **Critères**

| Nom       | Description               | Clé            | Opérateurs                                                                                                                                                                          | Exemple       |
| --------- | ------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| Modèle    | Nom du modèle de moniteur | `name`         | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Dell U2720Q` |
| Fabricant | Fabricant du moniteur     | `manufacturer` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Dell`        |

#### **Actions**

| Nom    | Description        | Clé    | Actions                                                                                                       |
| ------ | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| Modèle | Assigner un modèle | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Modèles d'imprimante

#### **Critères**

| Nom       | Description                | Clé          | Opérateurs                                                                                                                                                                          | Exemple                |
| --------- | -------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
| Modèle    | Nom du modèle d'imprimante | `name`       | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `HP LaserJet Pro M404` |
| Fabricant | Fabricant de l'imprimante  | manufacturer | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `HP`                   |

#### **Actions**

| Nom    | Description        | Clé    | Actions                                                                                                       |
| ------ | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| Modèle | Assigner un modèle | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Modèles de périphériques

#### **Critères**

| Nom       | Description                   | Clé          | Opérateurs                                                                                                                                                                          | Exemple                |
| --------- | ----------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
| Modèle    | Nom du modèle de périphérique | name         | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Logitech MX Master 3` |
| Fabricant | Fabricant du périphérique     | manufacturer | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Logitech`             |

#### **Actions**

| Nom    | Description        | Clé    | Actions                                                                                                       |
| ------ | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| Modèle | Assigner un modèle | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Modèles de matériels réseau

#### **Critères**

| Nom       | Description                      | Clé          | Opérateurs                                                                                                                                                                          | Exemple      |
| --------- | -------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| Modèle    | Nom du modèle du matériel réseau | name         | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Cisco 2960` |
| Fabricant | Fabricant du matériel réseau     | manufacturer | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Cisco`      |

#### **Actions**

| Nom    | Description        | Clé    | Actions                                                                                                       |
| ------ | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| Modèle | Assigner un modèle | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Modèles de téléphones

#### **Critères**

| Nom       | Description                | Clé          | Opérateurs                                                                                                                                                                          | Exemple     |
| --------- | -------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| Modèle    | Nom du modèle de téléphone | name         | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `iPhone 15` |
| Fabricant | Fabricant du téléphone     | manufacturer | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Apple`     |

#### **Actions**

| Nom    | Description        | Clé    | Actions                                                                                                       |
| ------ | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| Modèle | Assigner un modèle | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### **Modèle d'actif personnalisable**

#### **Critères**

| Nom       | Description                | Clé          | Opérateurs                                                                                                                                                                          | Exemple     |
| --------- | -------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| Modèle    | Nom du modèle de téléphone | name         | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `iPhone 15` |
| Fabricant | Fabricant du téléphone     | manufacturer | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Apple`     |

#### **Actions**

| Nom    | Description        | Clé    | Actions                                                                                                       |
| ------ | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| Modèle | Assigner un modèle | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Types de moniteurs

#### **Critères**

| Nom  | Description      | Clé    | Opérateurs                                                                                                                                                                          | Exemple     |
| ---- | ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| Type | Type de moniteur | `name` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Écran LCD` |

#### **Actions**

| Nom  | Description      | Clé    | Actions                                                                                                       |
| ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| Type | Assigner un type | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Types d'imprimantes

#### **Critères**

| Nom  | Description       | Clé    | Opérateurs                                                                                                                                                                          | Exemple |
| ---- | ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Type | Type d'imprimante | `name` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Laser` |

#### **Actions**

| Nom  | Description      | Clé    | Actions                                                                                                       |
| ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| Type | Assigner un type | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Types d'ordinateurs

#### **Critères**

| Nom  | Description       | Clé    | Opérateurs                                                                                                                                                                          | Exemple    |
| ---- | ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| Type | Type d'ordinateur | `name` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Portable` |

#### **Actions**

| Nom  | Description      | Clé    | Actions                                                                                                       |
| ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| Type | Assigner un type | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Types de téléphones

#### **Critères**

| Nom  | Description       | Clé    | Opérateurs                                                                                                                                                                          | Exemple      |
| ---- | ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| Type | Type de téléphone | `name` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Smartphone` |

#### **Actions**

| Nom  | Description      | Clé    | Actions                                                                                                       |
| ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| Type | Assigner un type | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Types de matériels réseau

#### **Critères**

| Nom  | Description             | Clé    | Opérateurs                                                                                                                                                                          | Exemple  |
| ---- | ----------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| Type | Type de matériel réseau | `name` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Switch` |

#### **Actions**

| Nom  | Description      | Clé    | Actions                                                                                                       |
| ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| Type | Assigner un type | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

### Types de périphériques

#### **Critères**

| Nom  | Description          | Clé    | Opérateurs                                                                                                                                                                          | Exemple   |
| ---- | -------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| Type | Type de périphérique | `name` | `est`, `n'est pas`, `contient`, `ne contient pas`, `commence par`, `finit par`, `expression rationnelle vérifie`, `expression rationnelle ne vérifie pas`, `existe`, `n'existe pas` | `Clavier` |

#### **Actions**

| Nom  | Description      | Clé    | Actions                                                                                                       |
| ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| Type | Assigner un type | `name` | `Assigner`, `Assigner le résultat de l'expression régulière`, `Ajouter le résultat de l'expression régulière` |

Pour les dictionnaires liés aux **systèmes d’exploitation**, **des règles natives sont fournies par défaut dans GLPI**, mais elles sont **désactivées**.

Ces règles permettent notamment de :

* **Standardiser les noms des systèmes d’exploitation** importés (ex. « Windows 10 Pro » ou « Win 10 » → « Windows 10 Professional »).
* **Reconnaître et classer les versions et éditions** des systèmes d’exploitation.

Dans le cadre de l’offre **GLPI-Network**, il est possible d’**obtenir un fichier d’import de règles** pour les dictionnaires logiciels.

Ce fichier permet de :

* **Importer rapidement et de manière standardisée** une liste de règles préconfigurées dans le moteur des dictionnaires logiciels de GLPI.
* **Appliquer automatiquement des règles de normalisation**, afin d’éviter les doublons ou les variations dans les noms de logiciels.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.glpi-project.org/glpi-12/fr/administration/rules/inventorytools.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
