> For the complete documentation index, see [llms.txt](https://docs.verge.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verge.io/knowledge-base/fr/backup-dr/vmwarebackupdrguide.md).

# Guide de sauvegarde et de reprise après sinistre VMware

### **Vue d’ensemble**

La fonctionnalité VergeOS VMware fournit une interface directe avec vSphere (indépendante du stockage) pour exécuter un agent de sauvegarde pour les machines virtuelles VMware. L’agent VergeOS initie les instantanés, avec la possibilité d’accéder aux sauvegardes complètes et incrémentielles, soit pour une importation unique, soit pour une sauvegarde continue et de la DR pour les environnements vSphere.

***

#### **Configuration des sauvegardes VMware - Étapes générales**

* **Créer un service VMware** (Cela crée une connexion directe à l’environnement vSphere.)
* **Créer des planifications.**
* **Attribuer des planifications aux VM** (différentes planifications peuvent être attribuées à différentes VM.)

***

#### Création d’un service VMware

La première étape pour créer une sauvegarde/importation des VM VMware vers VergeOS consiste à créer un service VMware. Le service VMware établit une connexion directe de l’agent avec vSphere ; un accès réseau et des identifiants de connexion administrateur à l’environnement vSphere sont requis.

***

#### Pour créer un nouveau service VMware :

1. Accédez à **Importation/Exportation** > **Services VMware** dans le menu supérieur.
2. Cliquez **Nouveau service** dans le menu de gauche.

#### Paramètres du service VMware :

4. Entrez un **Nom** pour le service VMware (obligatoire).
5. En général, il est recommandé de conserver les **2 cœurs** et **2 Go de RAM** **par défaut** paramètres en place ; ils conviendront dans presque toutes les situations.
6. **En option**, un **cluster** peut être sélectionné (ou laisser --Default--).
7. **En option**, un **cluster de basculement** peut être sélectionné (ou laisser --Default--).
8. **En option**, un **nœud préféré** peut être sélectionné pour exécuter ce service (ou laisser --None-- afin que le système sélectionne le nœud).
9. **En option**, entrez un **Description** pour enregistrer des informations supplémentaires, si souhaité.
10. Sélectionnez le **En cas de perte d'alimentation** paramètre souhaité :
    * ***Dernier état*** - Le service ne sera rallumé que s’il était allumé au moment de la panne de courant.
    * ***Laisser éteint*** - Le service ne sera pas rallumé lorsque le courant sera rétabli (quel que soit son état au moment de la panne).
    * ***Mise sous tension*** - Le service sera rallumé lorsque le courant sera rétabli (quel que soit son état au moment de la panne).
11. Sélectionnez un **Réseau** sur lequel exécuter le service VMware.

{% hint style="info" %}
**La NIC de la machine virtuelle du service est par défaut en DHCP. Pour attribuer plutôt une adresse IP statique, voir** [**Configuration des paramètres IPv4 de la NIC de la machine virtuelle du service VMware**](/knowledge-base/fr/networking/vmware-service-vm-nic-ipv4-configuration.md)**.**
{% endhint %}

***

#### Paramètres vSphere :

![dr1-1.png](/files/574437e236919d8d0077e0410b8add5c366428c0)

1. Entrez les **DNS ou IP vSphere** (obligatoire). L’adresse doit être accessible depuis le réseau sélectionné pour le service.

{% hint style="info" %}
**Il est recommandé de se connecter au cluster vSphere plutôt qu’à un nœud ESX(i) individuel.**
{% endhint %}

1. Le **port vSphere** est ***443***; il s’agit du port d’écoute habituel pour les connexions client VMware. Modifiez-le vers un autre port si nécessaire.
2. Entrez les **VMware Utiliser**nom d’utilisateur.
3. Entrez les **Mot de passe vSphere** pour l’utilisateur ci-dessus.
4. Le **Autoriser les certificats non sécurisés** l’option peut être sélectionnée si l’adresse vSphere n’utilise pas de certificat signé par une autorité de certification (par ex. certificats auto-signés).
5. Cliquez **Soumettre** pour enregistrer le nouveau service.
6. Vous êtes renvoyé à la liste des Services VMware où le nouveau service apparaîtra. **Cliquez sur le service** pour le sélectionner.
7. Cliquez **Mise sous tension** dans le menu de gauche pour démarrer le service et tenter la connexion à vSphere.

Après le démarrage du service, **double-cliquez pour ouvrir le tableau de bord du service VMWare.**

***

#### Modifier les paramètres vSphere avancés (facultatif) :

Une fois le service allumé, les paramètres vSphere avancés peuvent être modifiés, si souhaité.

{% hint style="info" %}
**Les paramètres par défaut conviennent à la plupart des installations.**
{% endhint %}

Cliquez **Modifier** dans le menu de gauche.

* **Nombre max. de sauvegardes VM simultanées - nombre de sauvegardes VMware exécutées en parallèle. Le paramètre par défaut (4) convient généralement ; toutefois, ce nombre peut être augmenté pour accélérer les processus de sauvegarde à partir de systèmes Vsphere disposant de ressources CPU élevées et d’une bande passante disponible suffisante. À l’inverse, ce paramètre peut être réduit pour les systèmes disposant de ressources CPU plus faibles et d’une bande passante disponible plus faible.**
* **Nom de l’instantané créé automatiquement pendant la sauvegarde - nom attribué à l’instantané temporaire créé par VMware et utilisé pendant l’opération de sauvegarde.**
* **Planification de sauvegarde VM par défaut - définit la planification de sauvegarde qui sera automatiquement attribuée à toutes les nouvelles VM VMware détectées par le service. Au départ, ce paramètre est défini sur --None--, ce qui configurera les nouvelles VM pour n’utiliser aucune planification (aucune sauvegarde) par défaut. Une fois les planifications créées, la valeur par défaut peut être modifiée afin d’attribuer une planification de sauvegarde spécifique à toute nouvelle VM détectée.**
* **Activer automatiquement le suivi des modifications par VM - ce paramètre activera automatiquement la fonctionnalité CBT (changed block tracking) de VMware pour chaque VM incluse dans les sauvegardes différentielles et à provisionnement fin. Par défaut, ce paramètre est activé (activé recommandé). Si ce paramètre est désactivé et que CBT n’est pas activé autrement sur VMware, une sauvegarde différentielle reviendra par défaut à une sauvegarde complète (les journaux de sauvegarde indiqueront ce changement).**
* **Niveau de stockage de sauvegarde - niveau de stockage VergeOS dans lequel stocker les données de sauvegarde. Par défaut, ce paramètre est défini sur le niveau 4.** ***Remarque : la modification de ce paramètre n’affecte que les nouvelles sauvegardes complètes. (Autrement dit : si une sauvegarde a déjà été effectuée vers un autre niveau, les sauvegardes différentielles continueront d’être stockées dans ce niveau ; le nouveau paramètre prendra effet dès qu’une autre sauvegarde complète sera effectuée.***

Une fois les paramètres vSphere modifiés selon les besoins, cliquez sur **Soumettez.**

***

#### Paramètres vSphere avancés :

1. Cliquez **Actualiser les VM** dans le menu de gauche pour détecter les machines virtuelles VMware. Cela lancera une connexion au système vSphere et les VM détectées apparaîtront dans la section Machines virtuelles VMware de la page.

Sur le tableau de bord, vérifiez le statut (en haut à gauche). Si le service s’est connecté avec succès au système vSphere, le statut affichera **En ligne** et **En cours d'exécution**.

Un statut d’erreur indique que la connexion n’a pas été établie en raison de : identifiants de connexion incorrects, SSL non sécurisé (sans activer l’option pour SSL non sécurisé), adresse invalide ou problème réseau pour joindre le système VSphere.

Voir l’annexe A : Dépannage des erreurs de connexion pour plus d’informations.

***

### Création d’une planification de sauvegarde VMware

Une planification est un regroupement de tâches de sauvegarde. Une seule planification peut inclure diverses sauvegardes, telles que des sauvegardes horaires, quotidiennes, hebdomadaires et mensuelles, et permettre d’effectuer des sauvegardes à différents intervalles, chacune avec des règles de rétention différentes. De plus, différents types de sauvegardes peuvent être inclus dans la même planification : complète (provisionnée en épais), complète (provisionnée en fin) et différentielle.

Différentes planifications peuvent être créées pour être appliquées à différentes VM ; par exemple, une planification générale pourrait être utilisée pour les VM de production, tandis qu’une planification moins stricte serait appliquée aux VM de développement et de test ; une autre planification comprenant des sauvegardes fréquentes avec une rétention plus courte pourrait être appliquée aux VM SQL, etc.

***

#### Planification par défaut

Lorsqu’un nouveau service VMWare est créé, une planification nommée « Default » est automatiquement créée. Cette planification peut être modifiée pour répondre aux besoins de votre organisation. Vous pouvez également créer autant de nouvelles planifications que nécessaire.

***

#### Pour créer une nouvelle planification :

1. Depuis le **Tableau de bord du service VMware** (Import/Export > services VMware > double-cliquez sur le service cible dans la liste.)
2. Cliquez **Planifications** dans le menu de gauche.
3. Cliquez **Nouveau** dans le menu de gauche.
4. Entrez un **Nom** pour la nouvelle planification.
5. **Optionnellement, une description** peut être saisie pour enregistrer davantage d’informations.
6. Cliquez **Soumettre**.
7. La liste des planifications apparaîtra. **Double-cliquez sur la nouvelle planification.**

À ce stade, la planification n’est qu’un conteneur vide ; une ou plusieurs tâches doivent être ajoutées à la planification.

8. Cliquez **Nouvelle tâche** dans le menu de gauche ou cliquez sur le **+ Ajouter une tâche** option sur le tableau de bord de la planification.
9. Entrez un **Nom** descriptif pour la tâche (par ex. : Midnight\_7days ; weekly\_1monthretention ; yearly\_perpetual, etc.)
10. Sélectionnez la planification souhaitée pour la tâche de sauvegarde. (Les options granulaires offrent une grande flexibilité dans la planification des tâches.)

***

#### Exemple de planification de tâche :

***Ex. : Tous les jours ouvrables à 17 h 15***

![dr3.png](/files/377d073e90a746b3b843b8fffba3ca98a9d8fac3)

***Ex. : Toutes les 2 heures, de 7 h à 17 h, sauf le dimanche :***

![dr4.png](/files/1193fe5fbe8a12eabd17404f15650bf5a55937a5)

***Ex. : Mensuellement, le dernier jour du mois :***

![dr6.png](/files/58e66775944989dbf13cce2be63bec473b3f7007)

***Ex. : Une seule fois, le 2019-04-01 à midi :***

![dr7.png](/files/19c3d74337da2519619e038552a87ae9088dbe2a)

10. Par défaut, une tâche récurrente est configurée pour s’exécuter de façon permanente. **En option, une expiration de tâche** peut être définie, ce qui fera cesser la tâche à la date et à l’heure sélectionnées. Pour définir une expiration pour la tâche : désélectionnez la case à cocher Jamais et saisissez la date et l’heure d’expiration souhaitées.
11. **Par défaut, le nom du travail de sauvegarde** sera par défaut : *NomPlanification - NomTâche-AAAA-MM-JJ HH:MM* (ex : prodschedule - hourly - 2019-01-29 11:00 pour une sauvegarde créée à partir de la planification « prodschedule », tâche « hourly », à 11 h)**.** **En option, un nom de travail de sauvegarde** peut être défini et peut inclure n’importe quelle combinaison de ces variables de date formatées :

* ***%Y*** année à 4 chiffres
* ***%m*** mois à 2 chiffres (01 à 12)
* ***%d*** jour du mois à 2 chiffres (01 à 31)
* ***%H*** heure à 2 chiffres (format 24 h)
* ***%M*** minute à 2 chiffres (00 à 59)

**Exemple :** L’entrée : « *%m-%d-%Y:%H%M-sqlbackup* », exécutée le 26 janv. 2019 à 11 h produit une sauvegarde nommée « *01-26-2019:11:00-sqlbackup* »

12. Sélectionnez le **paramètre de rétention du travail de sauvegarde**; il s’agit de la durée pendant laquelle conserver la sauvegarde. (Unités sélectionnables : minutes, jours (par défaut), heures, années, toujours).

{% hint style="info" %}
**Après l’exécution d’une sauvegarde, l’expiration des instances individuelles du travail de sauvegarde peut être modifiée manuellement ; les instances de travaux de sauvegarde peuvent également être supprimées manuellement avant la date/l’heure d’expiration.**
{% endhint %}

1. Le **Quiesce Snapshots** l’option peut être sélectionnée pour activer la fonctionnalité de quiesce de VMWare **(Remarque : VMware Guest Tools requis.)** Lorsque cette option est activée, VMWare suspend les processus en cours sur le système d’exploitation invité afin que le contenu du système de fichiers se trouve dans un état cohérent connu au moment où l’instantané est pris ; ce processus peut inclure des opérations telles que le vidage des tampons modifiés du cache en mémoire du système d’exploitation vers le disque, ou d’autres tâches spécifiques aux applications. Consultez la documentation VMware pour plus d’informations sur la fonctionnalité de quiesce.
2. En option, **Nombre minimal de travaux de sauvegarde à conserver** peut être sélectionné. Ce paramètre remplace les expirations individuelles des sauvegardes afin de conserver en place le nombre minimal spécifié de sauvegardes (les plus récentes). Cela peut fournir un filet de sécurité, destiné à empêcher que toutes les sauvegardes expirent avant que de nouvelles sauvegardes ne soient créées : dans des situations telles qu’un système éteint pendant une période donnée ou un intervalle d’erreurs de sauvegarde.
3. Sélectionnez un **Mode de sauvegarde**.

* **Différentielle** - transfère uniquement les modifications depuis la dernière sauvegarde complète VMware. En raison de la façon dont les sauvegardes différentielles sont stockées dans vSAN, une sauvegarde différentielle peut être utilisée directement et ne dépend pas d’une sauvegarde complète ou d’autres différentielles pour une opération de restauration.

{% hint style="info" %}
**Cela nécessite que le Changed Block Tracking (CBT) soit activé sur les VM vSphere.**
{% endhint %}

* **Sauvegarde complète (provisionnée en épais)** - Sauvegarde complète, demandant tous les blocs à VMware.
* **Sauvegarde complète (provisionnée en fin)** - Sauvegarde complète, demandant uniquement les blocs alloués à VMware.

{% hint style="info" %}
**Cela nécessite que le Changed Block Tracking (CBT) soit activé sur les VM vSphere.**
{% endhint %}

**\*** Les sauvegardes complètes différentielles et à provisionnement fin utilisent la fonctionnalité CBT de vSphere. Veuillez consulter l’annexe B pour des informations et des considérations concernant cette fonctionnalité.

***

#### Utilisation des sauvegardes différentielles et complètes

{% hint style="info" %}
**Une sauvegarde complète est d’abord nécessaire et doit également être effectuée régulièrement. Les sauvegardes différentielles sont plus rapides et utilisent moins de ressources/bande passante, car seules les modifications depuis la dernière sauvegarde complète sont demandées. Une stratégie prudente inclura des sauvegardes complètes régulières (par ex. : quotidienne, hebdomadaire, bihebdomadaire), avec des sauvegardes différentielles entre les deux.**
{% endhint %}

16. Lorsque la tâche est configurée selon les besoins, cliquez sur **Soumettez.**
17. Vous êtes renvoyé à la page de planification et la nouvelle tâche apparaîtra dans la section Tâches. Cliquez sur le **+ Ajouter une tâche** bouton et répétez les étapes ci-dessus pour ajouter des tâches supplémentaires à la planification.

***

### Attribution des planifications

Une fois le service VMware créé et correctement connecté au système VSphere, la liste des machines virtuelles VMware découvertes apparaîtra sur le tableau de bord du service VMware. ![dr8.png](/files/8b2c6674fe46d9c0ffa6b4ca4d4946695de400f2) Par défaut, la planification de toutes les VM est définie sur --None--.

***

#### Pour appliquer une planification à une ou plusieurs VM :

1. Depuis le **Tableau de bord du service VMware**, cliquez sur **Machines virtuelles** dans le menu de gauche.
2. **Sélectionnez la ou les VM souhaitées** dans la liste. (Les VM sélectionnées affichent une case cochée à gauche.) Astuce : si vous souhaitez sélectionner toutes les VM de la liste, cliquez sur la case à cocher dans le coin supérieur gauche.
3. Cliquez **Modifier les planifications de sauvegarde** dans le menu de gauche.
4. **Sélectionnez** le **Planifiez** dans la liste déroulante, puis cliquez sur **Soumettez.**
5. La planification de sauvegarde attribuée à chaque VM est affichée dans la liste des VM VMware.

***

#### Définir la planification de sauvegarde par défaut

La planification de sauvegarde VM par défaut peut être définie pour attribuer automatiquement une planification de sauvegarde à toutes les nouvelles VM VMware détectées par le service.

1. Depuis le tableau de bord du service VMware, cliquez sur **Modifier** dans le menu de gauche.
2. Dans **Planification de sauvegarde VM par défaut,** sélectionnez la planification souhaitée dans la liste déroulante.
3. Cliquez **Soumettre** pour enregistrer la modification.

La planification de sauvegarde par défaut est affichée sur le tableau de bord du service VMware.

***

### Sauvegardes manuelles

Des sauvegardes manuelles peuvent également être effectuées sur les VM à l’aide du service VMware ; cela peut être utile pour créer une sauvegarde immédiatement avant des travaux de maintenance, tels qu’une mise à niveau du système d’exploitation invité, une mise à jour d’application ou d’autres modifications de configuration.

***

#### Pour effectuer une sauvegarde manuelle de VM :

1. Depuis le tableau de bord du service VMware, cliquez sur **Machines virtuelles** dans le menu de gauche.
2. **Sélectionnez une ou plusieurs VM** dans la liste. (Astuce : pour sélectionner toutes les VM, cliquez sur la case à cocher dans le coin supérieur gauche.)
3. Cliquez **Sauvegarde** dans le menu de gauche.
4. Une boîte de dialogue de confirmation apparaîtra ; cliquez sur **Oui** pour poursuivre la sauvegarde.
5. **Revenir au tableau de bord du service VMware** (Astuce : vous pouvez utiliser le fil d’Ariane en haut ou le bouton de retour du navigateur pour revenir au tableau de bord du service.)
6. Cliquez **Travaux de sauvegarde** dans le menu de gauche.

La sauvegarde manuelle devrait apparaître en haut de la liste et affichera le statut « Running » jusqu’à son achèvement, moment auquel le statut affichera « Complete ».

Pour les sauvegardes manuelles, le *Nom* affiché sera le nom de la première VM sélectionnée pour la sauvegarde, et le *tâche de planification* colonne indiquera une sauvegarde manuelle. Des colonnes supplémentaires affichent le nombre de VM sauvegardées (*nombre de VM*), *Démarré* et *Terminé* heure et, le *Expire* paramètre de la sauvegarde.

***

#### **Pour modifier le nom et/ou l’expiration d’un travail de sauvegarde :**

1. **Double-cliquez sur le travail de sauvegarde** dans la liste.
2. Le tableau de bord du travail de sauvegarde s’affiche. Cliquez sur **Modifier** dans le menu de gauche.
3. Apportez **des modifications aux champs Nom/Expiration** selon les besoins.
4. Cliquez **Soumettre** pour enregistrer les modifications.

***

#### **Pour supprimer un travail de sauvegarde :**

1. **Double-cliquez sur le travail de sauvegarde** dans la liste.
2. Le tableau de bord du travail de sauvegarde s’affiche. Cliquez sur **Supprimer** dans le menu de gauche.
3. Cliquez **Oui** pour confirmer l’opération de suppression.

### Restaurations

***

#### Au niveau du fichier

La VM est importée dans l’environnement VergeOS (Depuis le *tableau de bord du travail de sauvegarde, double-cliquez sur la VM individuelle -> cliquez sur Import VM*.)

La VM est mise sous tension dans l’environnement VergeOS, où les fichiers peuvent être extraits vers le NAS VergeOS et accessibles via CIFS ou NFS.

***

#### Restaurer les systèmes vers un environnement VMware

Des VM individuelles ou des sauvegardes complètes de systèmes VMware peuvent être renvoyées vers l’environnement VMware.

***

#### DR/Continuité d’activité

Les VM VMware sont démarrées dans VergeOS à partir de la sauvegarde. Le Site-Sync intégré fournit le mécanisme pour synchroniser hors site les sauvegardes VMware afin d’être prêt pour une récupération rapide en cas de sinistre ou d’indisponibilité du site principal.

### Annexe A

***

#### Dépannage des erreurs de connexion VMware

Remarque : vérifiez les journaux (en bas de la page du tableau de bord) pour d’éventuelles informations supplémentaires.

* **Vérifiez la saisie de l’adresse correcte** (IP ou nom de domaine)
* **Vérifiez la connexion réseau**
* Si vous utilisez un nom de domaine, vérifiez la résolution DNS du nom.
* Le réseau sur lequel le service VMware s’exécute doit avoir accès à l’adresse/au port vSphere fourni sur le port 443 (ou le port sélectionné).
* La NIC de la machine virtuelle du service doit avoir une configuration IP valide (DHCP ou [adresse IP statique](/knowledge-base/fr/networking/vmware-service-vm-nic-ipv4-configuration.md)).

{% hint style="info" %}
**Le moteur de diagnostic intégré peut aider à tester la connexion réseau. (Tableau de bord des services VMware -> Afficher le service -> Diagnostic)**
{% endhint %}

* **Vérifiez les identifiants de connexion à vsphere**
  * Doit être le nom d’utilisateur/le mot de passe corrects pour un compte administrateur VSphere
* **Certificat SSL**
  * Si vous utilisez un certificat auto-signé, l’option permettant d’autoriser les certificats non sécurisés doit être activée. Pour modifier un service VMware existant : depuis le *Tableau de bord du service VMware -> Modifier -> cochez la case Désactiver la vérification du certificat hôte SSL*

### Annexe B

***

#### Changed Block Tracking (CBT) de VMware

Les sauvegardes différentielles et complètes (provisionnées en fin) utilisent la fonctionnalité CBT de VMware pour ne demander que les blocs modifiés depuis la dernière sauvegarde complète, ou les blocs en cours d’utilisation. Cela peut permettre des opérations plus rapides et moins gourmandes en bande passante. (VergeOS propose une option permettant d’activer automatiquement CBT pour toutes les VM.) L’article KB VMware suivant fournit plus d’informations, y compris les exigences VMware pour l’utilisation de CBT : [https://kb.vmware.com/s/article/1020128\_](https://kb.vmware.com/s/article/1020128)

***

**Considérations/précautions CBT**

L’utilisation de CBT pour fournir des sauvegardes plus rapides et plus efficaces est généralement acceptable. Cependant, il est important de considérer que des défauts dans CBT peuvent compromettre les sauvegardes ayant utilisé cette fonctionnalité. Il s’agit d’un problème source qui n’est pas contrôlé par un agent tiers accédant à VMware pour la sauvegarde.

Les stratégies suivantes sont recommandées pour atténuer les risques potentiels liés à l’utilisation de la fonctionnalité CBT :

1. En tant que client/utilisateur VMware, restez informé des problèmes connus et appliquez les mises à jour et correctifs disponibles dès qu’ils sont publiés. Par le passé, il y a eu des bogues concernant la fonctionnalité CBT, pour lesquels VMware a fourni des correctifs afin de réparer les défauts CBT connus.
2. Bien que VergeOS stocke toutes les sauvegardes dans le vSAN de manière à ce qu’elles soient autonomes (toute sauvegarde, y compris différentielle, peut être utilisée directement et ne dépend pas d’une autre sauvegarde pour les opérations de restauration), une stratégie de sauvegarde prudente inclura une planification comportant à la fois des sauvegardes complètes et des sauvegardes différentielles entre celles-ci. Par exemple, une planification courante utilisée par de nombreuses organisations consiste à exécuter une sauvegarde complète chaque semaine ou deux fois par semaine, et des différentielles les jours intermédiaires.
3. Lorsque c’est possible, utilisez la sauvegarde complète provisionnée en épais pour celles qui sont destinées à une conservation à long terme.

***

{% hint style="info" %}
**Informations sur le document**

* Dernière mise à jour : 2024-09-03
* Version de VergeOS : 4.12.6
  {% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.verge.io/knowledge-base/fr/backup-dr/vmwarebackupdrguide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
