> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/de/automatisierung/runbooks/runbook-references/overview.md). # Überblick Dieses Dokument bietet einen umfassenden Überblick über alle derzeit im RealmJoin-Portal verfügbaren Runbooks. Jedes Runbook wird zusammen mit einer kurzen Beschreibung oder Synopse aufgeführt, um ein klares Verständnis seines Zwecks und seiner Funktionalität zu vermitteln. Um eine einfache Navigation zu gewährleisten, sind die Runbooks in verschiedene Bereiche nach ihrem Anwendungsgebiet unterteilt. Die folgenden Kategorien sind derzeit verfügbar: * Gerät * Gruppe * Organisation * Benutzer Jede Kategorie enthält mehrere Runbooks, die nach ihrer Funktionalität weiter in Unterkategorien unterteilt sind. Die Runbooks sind innerhalb jeder Unterkategorie alphabetisch sortiert. ### Gerät #### AVD | Runbook-Name | Synopse | | ---------------------- | -------------------------------------------------------------------------------- | | Host neu starten | Startet einen bestimmten AVD Session Host neu. | | Drain-Modus umschalten | Setzt den Drain-Modus für einen bestimmten AVD Session Host auf true oder false. | #### Allgemein | Runbook-Name | Synopse | | --------------------------------------- | ------------------------------------------------------------------------------- | | Gruppen anhand einer Vorlage zuweisen | Weist einem Gerät cloud-only-Gruppen auf Basis einer Vorlage zu. | | GroupTag ändern | Weist diesem Gerät einen neuen AutoPilot GroupTag zu. | | Geräte-Compliance prüfen | Prüft den Compliance-Status eines Geräts. | | Aktualisierbare Ressourcen prüfen | Prüft, ob ein Gerät bei Windows Update for Business angebunden ist. | | Aktualisierbare Ressourcen registrieren | Registriert das Gerät bei Windows Update for Business. | | Gerät außer Betrieb nehmen | Entfernt oder nimmt ein Windows-Gerät außer Betrieb. | | Primären Benutzer entfernen | Entfernt den primären Benutzer von einem Gerät. | | Gerät umbenennen | Benennt ein Gerät um. | | Primären Benutzer festlegen | Legt einen neuen primären Benutzer auf einem von Intune verwalteten Gerät fest. | | Aktualisierbare Ressourcen abmelden | Meldet das Gerät von Windows Update for Business ab. | | Gerät löschen | Löscht ein Windows- oder macOS-Gerät. | | Verwaltete App-Daten löschen | Selektives App-Löschen - Unternehmens-App-Daten von diesem MAM-Gerät entfernen | #### Sicherheit | Runbook-Name | Synopse | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | Defender-Status prüfen | Prüft das Vorhandensein und den Risikostatus eines Geräts in Entra ID und Microsoft Defender for Endpoint | | Gerät aktivieren oder deaktivieren | Aktiviert oder deaktiviert ein Gerät in Entra ID | | Gerät isolieren oder freigeben | Isoliert dieses Gerät. | | PIN eines Mobilgeräts zurücksetzen | Setzt das Kennwort bzw. den PIN-Code eines Mobilgeräts zurück. | | Codeausführung einschränken oder freigeben | Erlaubt auf einem Gerät nur die Ausführung von Microsoft-signiertem Code oder entfernt eine bestehende Einschränkung. | | BitLocker-Wiederherstellungsschlüssel anzeigen | Zeigt alle BitLocker-Wiederherstellungsschlüssel für ein Gerät an. | | FileVault-Wiederherstellungsschlüssel anzeigen | Zeigt den Wiederherstellungsschlüssel für macOS FileVault an. | | LAPS-Kennwort anzeigen | Zeigt das lokale Administratorkennwort für ein Gerät an. | ### Gruppe #### Geräte | Runbook-Name | Synopse | | --------------------------------------------- | --------------------------------------------------------------------------------- | | Aktualisierbare Ressourcen prüfen | Prüft, ob Geräte in einer Gruppe bei Windows Update for Business angebunden sind. | | Aktualisierbare Ressourcen abmelden (geplant) | Meldet Geräte von Windows Update for Business ab. | #### Allgemein | Runbook-Name | Synopse | | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | Verschachtelte Gruppe hinzufügen oder entfernen | Eine verschachtelte Gruppe zu einer Gruppe hinzufügen oder daraus entfernen | | Besitzer hinzufügen oder entfernen | Einen Office 365-Gruppenbesitzer hinzufügen oder entfernen | | Benutzer hinzufügen oder entfernen | Ein Gruppenmitglied hinzufügen oder entfernen | | Sichtbarkeit ändern | Die Sichtbarkeit einer Gruppe ändern | | Alle Mitglieder auflisten | Alle Mitglieder einer Gruppe auflisten, einschließlich Mitgliedern, die Teil verschachtelter Gruppen sind | | Besitzer auflisten | Alle Besitzer einer Office 365-Gruppe auflisten. | | Benutzergeräte auflisten | Geräte auflisten, die Gruppenmitgliedern gehören. | | Gruppe entfernen | Entfernt eine Gruppe. Bei Microsoft 365-Gruppen werden auch die zugehörigen Ressourcen (Teams, SharePoint-Website) entfernt. | | Gruppe umbenennen | Benennt eine Gruppe um. | #### Mail | Runbook-Name | Synopse | | ------------------------------------------- | ---------------------------------------------------------------------------------------------- | | Externe E-Mail aktivieren oder deaktivieren | Ermöglicht oder verhindert, dass externe Personen E-Mails an eine Microsoft 365-Gruppe senden. | | Im Adressbuch anzeigen oder ausblenden | Zeigt eine Gruppe im Adressbuch an oder blendet sie aus. | #### Teams | Runbook-Name | Synopse | | ---------------- | -------------------- | | Team archivieren | Ein Team archivieren | ### Organisation #### Anwendungen | Runbook-Name | Synopse | | ---------------------------------------------------------- | -------------------------------------------------------------------------------------- | | App-Registrierung hinzufügen | Eine App-Registrierung zu Azure AD hinzufügen | | GSA-App-Registrierung hinzufügen | Eine GSA-App-Registrierung zu Azure AD hinzufügen | | App-Registrierung löschen | Eine App-Registrierung aus Azure AD löschen | | GSA-App-Registrierung löschen | Eine GSA-App-Registrierung einschließlich zugehöriger Objekte aus Azure AD löschen | | Benutzer von Enterprise-Anwendungen exportieren | Einen Bericht über alle Besitzer und Benutzer von (Enterprise-)Anwendungen exportieren | | Inaktive Enterprise-Anwendungen auflisten | Enterprise-Anwendungen ohne kürzliche Anmeldungen auflisten | | Bericht über App-Registrierungen | Einen umfassenden Bericht über App-Registrierungen erstellen und per E-Mail senden | | Ablaufende Anwendungsanmeldeinformationen melden (geplant) | Das Ablaufdatum aller Anmeldeinformationen von App-Registrierungen auflisten | | App-Registrierung aktualisieren | Eine App-Registrierung in Azure AD aktualisieren | #### Geräte | Runbook-Name | Synopse | | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | Autopilot-Gerät hinzufügen | Ein Windows-Gerät in Windows Autopilot importieren | | Gerät über Unternehmenskennung hinzufügen | Ein Gerät über die Unternehmenskennung in Intune importieren | | Treiberupdates automatisch genehmigen (geplant) | Neue Treiberupdates in Intune-Treiberupdate-Richtlinien automatisch genehmigen | | Autopilot-Geräte bereinigen (geplant) | Verwaiste und veraltete Windows Autopilot-Geräteregistrierungen bereinigen | | Endpoint Analytics-Baseline erstellen | Erstellt Endpoint Analytics-Baselines in Microsoft Intune mit einem festgelegten Namensschema. | | Gerätenamen deduplizieren (geplant) | Doppelte Intune-Geräteanzeigenamen mithilfe eines Präfixes und eines zufälligen Suffixes erkennen und umbenennen | | Veraltete Geräte löschen (geplant) | Geplantes Löschen veralteter Geräte auf Basis des letzten Aktivitätsdatums und der Plattform | | BitLocker-Wiederherstellungsschlüssel abrufen | Den BitLocker-Wiederherstellungsschlüssel abrufen | | Benutzer über veraltete Geräte benachrichtigen (geplant) | Primäre Benutzer per E-Mail über ihre veralteten Geräte benachrichtigen | | Geräte außer Betrieb nehmen | Mehrere Geräte entfernen oder außer Betrieb nehmen | | Geräte ohne primären Benutzer melden (geplant) | Meldet alle in Intune verwalteten Geräte, denen kein primärer Benutzer zugewiesen ist. | | Abweichung des primären Benutzers melden (geplant) | Vergleicht die Zuweisungen des primären Benutzers in Intune mit RealmJoin für Windows-Geräte. | | Veraltete Geräte melden (geplant) | Geplanter Bericht über veraltete Geräte auf Basis des letzten Aktivitätsdatums und der Plattform. | | Benutzer mit mehr als 5 Geräten melden (geplant) | Benutzer mit mehr als fünf registrierten Geräten melden | | Windows-Geräte ohne Autopilot melden (geplant) | Meldet alle Windows-Entra-Geräte, denen kein zugehöriges Windows-Autopilot-Objekt zugeordnet ist. | | Geräte-Seriennummern mit Entra ID synchronisieren (geplant) | Intune-Seriennummern mit Entra ID-Erweiterungsattributen synchronisieren | #### Allgemein | Runbook-Name | Synopse | | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | Geräte von Benutzern zu einer Gruppe hinzufügen (geplant) | Geräte von Benutzern in einer bestimmten Gruppe mit einer anderen Gerätegruppe synchronisieren | | Management Partner hinzufügen | Management Partner Links (PAL) auflisten oder hinzufügen | | Microsoft Store-App-Logos hinzufügen | Logos von Microsoft Store-Apps (neu) in Intune aktualisieren | | Office 365-Gruppe hinzufügen | Eine Office 365-Gruppe und eine SharePoint-Website erstellen, optional ein (Teams-)Team erstellen. | | SafeLinks-Ausschluss hinzufügen oder entfernen | Einen SafeLinks-URL-Ausschluss aus einer Richtlinie hinzufügen oder entfernen | | SmartScreen-Ausschluss hinzufügen oder entfernen | Einen SmartScreen-URL-Indikator in Microsoft Defender hinzufügen oder entfernen | | Vertrauenswürdige Website hinzufügen oder entfernen | Einen URL-Eintrag in der Intune-Richtlinie für vertrauenswürdige Websites hinzufügen oder entfernen | | Primäre Benutzer von Geräten zu einer Gruppe hinzufügen (geplant) | Primäre Benutzer von in Intune verwalteten Geräten nach Plattform in eine Entra ID-Gruppe synchronisieren | | Security Group hinzufügen | Eine Microsoft Entra ID Security Group erstellen | | Benutzer hinzufügen | Ein neues Benutzerkonto erstellen | | Viva Engage-Community hinzufügen | Eine Viva Engage- (Yammer-)Community erstellen | | Gruppen anhand einer Vorlage zuweisen (geplant) | Cloud-only-Gruppen vielen Benutzern auf Basis einer vordefinierten Vorlage zuweisen | | Geräte massenweise aus Autopilot löschen | Autopilot-Objekte anhand der Seriennummer massenweise löschen | | Geräte massenweise aus Intune außer Betrieb nehmen | Geräte anhand von Seriennummern massenweise aus Intune außer Betrieb nehmen | | AAD-Synchronisierungsstatus prüfen (geplant) | Den letzten Azure AD Connect-Synchronisierungsstatus prüfen | | Zuweisungen von Geräten prüfen | Intune-Zuweisungen für einen oder mehrere Gerätenamen prüfen | | Zuweisungen von Gruppen prüfen | Intune-Zuweisungen für einen oder mehrere Gruppennamen prüfen | | Zuweisungen von Benutzern prüfen | Intune-Zuweisungen für einen oder mehrere Benutzerprinzipalnamen prüfen | | Autopilot-Seriennummern prüfen | Prüft, ob angegebene Seriennummern in Autopilot vorhanden sind | | Ausschluss für Geräte-Onboarding prüfen (geplant) | Nicht registrierte Autopilot-Geräte zu einer Ausschlussgruppe hinzufügen | | Bericht über registrierte Geräte (geplant) | Zeigt aktuelle erstmalige Geräteregistrierungen an | | Alle Autopilot-Geräte exportieren | Alle Windows-Autopilot-Geräte auflisten oder exportieren | | Alle Intune-Geräte exportieren | Eine Liste aller Intune-Geräte und ihrer Registrierungsorte exportieren | | Cloud PC-Nutzung exportieren (geplant) | Tägliche Nutzungsdaten für Windows 365 in Azure Table Storage schreiben | | Nicht konforme Geräte exportieren | Nicht konforme Intune-Geräte und Einstellungen exportieren | | Richtlinienbericht exportieren | Einen Bericht über Tenant-Richtlinien aus Intune und Entra ID erstellen. | | Externe Gastbenutzer einladen | Externe Gastbenutzer zur Organisation einladen | | Alle Administrative Template-Richtlinien auflisten | Alle Administrative Template-Richtlinien und ihre Zuweisungen auflisten | | Fehler bei der Lizenzzuweisung von Gruppen auflisten | Gruppen mit Fehlern bei der Lizenzzuweisung melden | | Office 365-Lizenzbericht | Einen Office 365-Lizenzbericht erstellen | | Ablauf von Apple-MDM-Zertifikaten melden (geplant) | Ablauf von Apple-Geräteverwaltungszertifikaten überwachen/melden | | Lizenzzuweisung melden (geplant) | Einen Bericht über die verfügbare Lizenzanzahl basierend auf Schwellenwerten erstellen und per E-Mail senden | | PIM-Aktivierungen melden (geplant) | Geplanter Bericht über PIM-Aktivierungen | | Alle Geräte synchronisieren | Alle Intune-Windows-Geräte synchronisieren | | Apple-Token synchronisieren | Apple Enrollment Program-Token und VPP-Token mit Intune synchronisieren | | Mitglieder von Channel oder Gruppe synchronisieren (geplant) | Mitglieder zwischen einem Teams Shared Channel oder einer Gruppe und einer Entra-Sicherheitsgruppe synchronisieren | | Besitzer von Shared Channels synchronisieren (geplant) | Sicherstellen, dass die Mitglieder einer Security Group Besitzer der zugeordneten Teams und ihrer gemeinsamen Kanäle sind. | #### Mail | Runbook-Name | Synopse | | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | Verteilerliste hinzufügen | Eine klassische Verteilergruppe erstellen | | Gerätepostfach hinzufügen | Ein Gerätepostfach erstellen | | E-Mail-Kontakt hinzufügen | Einen neuen Exchange Online-E-Mail-Kontakt mit optionalen Einstellungen für Anzeigename und Adresslisten erstellen | | Öffentlichen Ordner hinzufügen oder entfernen | Einen öffentlichen Ordner hinzufügen oder entfernen | | Teams-Mailkontakt hinzufügen oder entfernen | Einen Kontakt erstellen/entfernen, um schöne E-Mail-Adressen für Teams-Kanäle zu ermöglichen. | | Tenant Allow/Block List hinzufügen oder entfernen | Einträge zur Tenant Allow/Block List hinzufügen oder entfernen | | Raumpostfach hinzufügen | Eine Raumpostfachressource erstellen | | Freigegebenes Postfach hinzufügen | Ein freigegebenes Postfach erstellen | | Postfächer ausblenden (geplant) | Spezielle Postfächer in der Globalen Adressliste ein- oder ausblenden | | Booking-Konfiguration festlegen | Microsoft Bookings-Einstellungen für die Organisation konfigurieren | #### Telefon | Runbook-Name | Synopse | | ------------------------------------- | -------------------------------------------------------------- | | Teams-Telefonnummernzuweisung abrufen | Prüft, ob eine Telefonnummer in Microsoft Teams zugewiesen ist | #### Sicherheit | Runbook-Name | Synopse | | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | Defender-Indikator hinzufügen | Einen neuen Microsoft Defender for Endpoint-Indikator erstellen | | Conditional Access-Richtlinien sichern | Conditional Access-Richtlinien in ein Azure Storage Account exportieren | | SMS-Authentifizierungs-Telefonnummer finden | Den Benutzer finden, der mit einer bestimmten SMS-basierten Authentifizierungs-Telefonnummer verknüpft ist | | Administratoren auflisten | Entra ID-Rolleninhaber auflisten und optional ihre MFA-Methoden auswerten | | Ablaufende Rollenzuweisungen auflisten | Azure AD-Rollenzuweisungen auflisten, die innerhalb einer bestimmten Anzahl von Tagen ablaufen | | Inaktive Geräte auflisten | Inaktive Geräte ohne kürzliche Anmeldung oder Intune-Synchronisierung auflisten oder exportieren | | Inaktive Benutzer auflisten | Benutzer ohne kürzliche interaktive Anmeldungen auflisten | | Information Protection-Labels auflisten | Microsoft Information Protection-Labels auflisten | | PIM-Rollengruppen ohne Besitzer auflisten (geplant) | Rollenzuweisungsfähige Gruppen mit berechtigten Rollenzuweisungen, aber ohne Besitzer auflisten | | Benutzer nach Anzahl ihrer MFA-Methoden auflisten | Benutzer nach der Anzahl ihrer registrierten MFA-Methoden melden | | Verwundbare App-Registrierungen auflisten | App-Registrierungen auflisten, die möglicherweise anfällig für CVE-2021-42306 sind | | Ausstehende EPM-Anfragen überwachen (geplant) | Ausstehende Erhöhungsanfragen für Endpoint Privilege Management (EPM) überwachen und melden | | Geänderte Conditional Access-Richtlinien benachrichtigen | Eine Benachrichtigungs-E-Mail senden, wenn in den letzten 24 Stunden Conditional Access-Richtlinien erstellt oder geändert wurden. | | EPM-Erhöhungsanfragen melden (geplant) | Bericht für Erhöhungsanfragen von Endpoint Privilege Management (EPM) erstellen | | Sichere MFA-Benutzer mit einer Gruppe synchronisieren (geplant) | Benutzer mit registrierten sicheren MFA-Methoden in eine Entra ID-Gruppe synchronisieren | ### Benutzer #### AVD | Runbook-Name | Synopse | | ----------------- | ----------------------------------------------------------- | | Benutzer abmelden | Meldet einen bestimmten Benutzer von seiner AVD-Sitzung ab. | #### Allgemein | Runbook-Name | Synopse | | ------------------------------------- | --------------------------------------------------------------------------------------- | | Gruppen anhand einer Vorlage zuweisen | Cloud-only-Gruppen einem Benutzer anhand einer Vorlage zuweisen | | Lizenz zuweisen oder entfernen | Einem Benutzer über die Gruppenmitgliedschaft eine Lizenz zuweisen oder entfernen | | Windows 365 zuweisen | Einen Windows 365 Cloud PC für einen Benutzer zuweisen und bereitstellen | | Gruppenmitgliedschaften auflisten | Gruppenmitgliedschaften für diesen Benutzer auflisten | | Gruppenbesitz auflisten | Gruppenbesitz für diesen Benutzer auflisten. | | Manager auflisten | Managerinformationen für diesen Benutzer auflisten | | Benutzer dauerhaft offboarden | Einen Benutzer dauerhaft offboarden | | Benutzer vorübergehend offboarden | Einen Benutzer vorübergehend offboarden | | Windows 365 erneut bereitstellen | Einen Windows 365 Cloud PC erneut bereitstellen | | Windows 365 skalieren | Einen vorhandenen Windows 365 Cloud PC für einen Benutzer skalieren | | Windows 365-Zuweisung entfernen | Einen Windows 365 Cloud PC für einen Benutzer entfernen und die Bereitstellung aufheben | #### Mail | Runbook-Name | Synopse | | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | E-Mail-Adresse hinzufügen oder entfernen | Eine E-Mail-Adresse für ein Postfach hinzufügen oder entfernen | | OWA-Postfachrichtlinie zuweisen | Einem Benutzer eine OWA-Postfachrichtlinie zuweisen | | In freigegebenes Postfach konvertieren | Ein Benutzerpostfach in ein freigegebenes Postfach und zurück konvertieren | | Vollzugriff delegieren | FullAccess-Berechtigungen für ein Postfach an einen anderen Benutzer delegieren oder eine vorhandene Delegierung entfernen | | Senden als delegieren | SendAs-Berechtigungen für einen anderen Benutzer für dessen Postfach delegieren oder eine vorhandene Delegierung entfernen | | Senden im Auftrag delegieren | SendOnBehalf-Berechtigungen für das Postfach des Benutzers delegieren | | Im Adressbuch ein- oder ausblenden | Ein Postfach im Adressbuch aus- oder einblenden | | Postfachberechtigungen auflisten | Postfachberechtigungen für ein Postfach auflisten | | Raumpostfachkonfiguration auflisten | Raumpostfachkonfiguration auflisten | | Archivpostfach verwalten | Das Exchange Online-Archivpostfach eines Benutzers verwalten | | Postfach entfernen | Ein freigegebenes Postfach, Raum- oder Buchungskalender endgültig löschen | | Abwesenheitsnotiz festlegen | Abwesenheitsbenachrichtigungen für ein Postfach aktivieren oder deaktivieren | | Raumpostfachkonfiguration festlegen | Ressourcenrichtlinien für Raumpostfächer festlegen | #### Telefon | Runbook-Name | Synopse | | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | Teams Phone deaktivieren | Offboarding der Microsoft Teams-Telefonie | | Teams-Benutzerinformationen abrufen | Sprachstatus von Microsoft Teams für einen Benutzer abrufen | | Teams-Benutzerrichtlinien zuweisen | Richtlinien für Microsoft Teams einem für Microsoft Teams aktivierten Benutzer zuweisen | | Dauerhafte Anrufweiterleitung für Teams festlegen | Sofortige Anrufweiterleitung für einen Teams-Benutzer festlegen | | Teams Phone festlegen | Einem für Microsoft Teams aktivierten Benutzer eine Telefonnummer zuweisen, Anrufe aktivieren und bestimmte Richtlinien für Microsoft Teams zuweisen. | #### Sicherheit | Runbook-Name | Synopse | | --------------------------------------------- | --------------------------------------------------------------------------------------- | | Riskanten Benutzer bestätigen oder verwerfen | Kompromittierung bestätigen oder einen riskanten Benutzer verwerfen | | Temporary Access Pass erstellen | Einen Temporary Access Pass für einen Benutzer erstellen | | Kennwortablauf aktivieren oder deaktivieren | Den Kennwortablauf für einen Benutzer aktivieren oder deaktivieren | | MFA-Methoden auflisten | Alle MFA-/Authentifizierungsmethoden eines Benutzers auflisten | | MFA zurücksetzen | Alle Authentifizierungsmethoden für Apps und Mobiltelefone für einen Benutzer entfernen | | Kennwort zurücksetzen | Das Kennwort eines Benutzers zurücksetzen | | Zugriff entziehen oder wiederherstellen | Benutzerzugriff entziehen oder wiederherstellen | | MFA für Mobiltelefon festlegen oder entfernen | Die MFA-Methode für das Mobiltelefon eines Benutzers festlegen oder entfernen | #### Benutzerinformationen | Runbook-Name | Synopse | | ---------------------- | ---------------------------------------------------------- | | Benutzer umbenennen | Einen Benutzer oder ein Postfach umbenennen | | Foto festlegen | Das Profilfoto für einen Benutzer festlegen | | Benutzer aktualisieren | Metadaten und Mitgliedschaften des Benutzers aktualisieren | --- # 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.realmjoin.com/de/automatisierung/runbooks/runbook-references/overview.md?ask=&goal= ``` `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.