203 docs getaggt mit "Tools"

Aktiviert ein CkArchive: stellt die archivspezifische CrateDB-Tabelle bereit und überführt das Archiv in den Zustand Activated. Führen Sie dies einmal aus, nachdem Sie die Archiv-Entität per rt-Import importiert haben.

Fügt einen neuen Identity Provider für Active Directory hinzu.

Fügt einen neuen Client mit dem Grant-Typ 'AuthorizationCode' hinzu.

Fügt einen neuen Identity Provider für Microsoft Azure Entra ID hinzu.

Fügt einen neuen Client mit dem Grant-Typ 'ClientCredentials' hinzu.

Fügt einen Client zu einer Gruppe hinzu.

Weist einem Client eine Rolle zu

Fügt einem aktivierten Raw- oder Time-Range-Archiv eine berechnete Spalte hinzu und füllt sie per Backfill auf. Die Spalte wird atomar sichtbar, sobald der Backfill abgeschlossen ist. (AB#4189)

Fügt einen benannten Kontext hinzu oder aktualisiert ihn.

Fügt einen neuen Client mit dem Grant-Typ 'device code' hinzu.

Fügt eine untergeordnete Gruppe zu einer übergeordneten Gruppe hinzu.

Fügt einen neuen Identity Provider hinzu.

Fügt einen neuen Identity Provider für die tenantübergreifende Authentifizierung über einen übergeordneten Tenant hinzu.

Fügt einen neuen Identity Provider für Open LDAP hinzu.

Gewährt einem Client den Zugriff auf einen Scope.

Fügt einen Benutzer zu einer Gruppe hinzu.

Fügt einen Benutzer zu einer Rolle hinzu

Wendet ein Overlay-URI-Set (RedirectUris / PostLogoutRedirectUris / AllowedCorsOrigins) auf einen blueprint-verwalteten Client an. Neue Einträge werden mit Source = 'overlay:<OverlayName>' geschrieben und beim erneuten Anwenden des Blueprints durch den Preservation-Durchlauf von Schritt 2a beibehalten. Idempotent — Duplikate werden stillschweigend übersprungen (jede Source). Mindestens eine der drei URI-Listen muss angegeben werden.

Hängt eine bestehende Datenbank an einen Tenant an.

Ruft den Authentifizierungsstatus gegenüber den konfigurierten Identity Services ab.

Stellt einen dauerhaften Hintergrund-Backfill in die Warteschlange, der ein Rollup über die GESAMTE Historie seines Quellarchivs befüllt / zurücksetzt, ohne dass ein Zeitstempel angegeben wird (AB#4269 / AB#4286). Ermittelt den frühesten Zeitstempel des Quellarchivs und stellt eine Neuberechnung von [sourceMin, now) in die Warteschlange; die aufwändige Arbeit läuft im Hintergrund und wird daher nie durch einen Client-Timeout abgebrochen. Gibt sofort die ID des Pending-Jobs zurück. Verwenden Sie -w/--wait, um zu pollen, bis der Job abgeschlossen ist. Ein No-op, wenn das Quellarchiv keine Daten enthält.

Cancels one execution that is still waiting in an adapter pool's queue. It never runs.

Zeigt den Abhängigkeitsbaum für ein CK-Modell aus einem Katalog an.

Pre-Flight-Prüfung für das Upgrade/die Migration eines CK-Modells.

Setzt einen Tenant auf die Werkseinstellungen zurück, indem der Construction Kit und das Runtime-Modell gelöscht werden.

Entfernt Overlay-URI-Einträge aus jedem blueprint-verwalteten Client im Tenant. Ohne -overlayName*' entspricht. Mit -overlayName<name>' entsprechen. Destruktiv — typischerweise vor einem bereinigten DumpTenant-Export verwendet; der Operator kann danach mit Apply-IdentityOverlay erneut anwenden (idempotent, No-op, wenn der Zustand übereinstimmt).

Leert den Cache eines Tenants

Playbooks mit mehreren Befehlen für typische octo-cli-Nutzungsszenarien. Jeder Schritt hat seinen eigenen kopierbaren Codeblock – fügen Sie sie nacheinander ein. Die vollständige Dokumentation pro Befehl finden Sie im Abschnitt Command Reference in der Seitenleiste.

Konfiguriert den aktiven Kontext.

Erstellt einen neuen Tenant und richtet den aktuellen Benutzer als Admin ein.

Erstellt ein Admin-Provisioning-Mapping in einem Ziel-Tenant.

Fügt eine neue API-Ressource hinzu.

Erstellt einen neuen API-Scope.

Fügt ein neues API-Secret für eine API-Ressource hinzu.

Fügt ein neues API-Secret für einen Client hinzu.

Creates a data permission (AB#4972)

Creates a policy bound to a data permission (AB#4972)

Erstellt eine E-Mail-Domain-Gruppenregel.

Erstellt ein External-Tenant-User-Mapping.

Erstellt ein Fixup-Skript

Erstellt eine Gruppe.

Erstellt eine neue Rolle

Erstellt ein neues Benutzerkonto

Löscht einen bestehenden Tenant.

Löscht ein Admin-Provisioning-Mapping aus einem Ziel-Tenant.

Löscht eine API-Ressource.

Löscht einen API-Scope.

Löscht ein Secret einer API-Ressource.

Löscht ein Secret eines Clients.

Löscht die archivspezifische CrateDB-Tabelle und markiert die CkArchive-Entität als soft-deleted. Destruktiv — historische Daten gehen verloren.

Löscht einen Client.

Deletes a data permission including its policies

Löscht eine E-Mail-Domain-Gruppenregel.

Löscht ein External-Tenant-User-Mapping.

Löscht eine Gruppe.

Löscht einen Identity Provider.

Löscht eine Rolle

Deletes the pre-sweep dump of a secret sweep run before it expires (requires SecretManagement). Use -y to skip confirmation.

Löscht einen Benutzer

Stellt einen bestimmten Datenfluss bereit.

Triggers a deploy of a deployment site. The Communication Operator creates the deployment site resources; workloads are deployed separately via DeployWorkload.

Diese Seite listet die gehosteten MCP-(Model Context Protocol)-Services-Endpunkte auf und wie man sie jeweils bei Ihrem KI-Client registriert. Für die Registrierungsmechanik siehe Getting started.

Stellt eine Pipeline-Definition auf dem zugehörigen Adapter bereit.

Stellt alle Trigger für den aktuellen Tenant bereit.

Löst die Bereitstellung eines Workloads (Adapter oder Application) über dessen übergeordneten Pool aus.

Trennt einen untergeordneten Tenant ab. Die Datenbank bleibt erhalten und kann mit Attach erneut angehängt werden.

Deaktiviert den AI Adapter für den aktuellen Tenant. Die eingespielte AgentConfig und das CK-Modell werden nicht entfernt; das erneute Aktivieren ist idempotent.

Deaktiviert ein CkArchive: Übergang in den Zustand Disabled (Daten bleiben erhalten). Nur aus dem Zustand Activated zulässig.

Deaktiviert den Communication Controller für den aktuellen Tenant.

Deaktiviert die Reporting Services für den aktuellen Tenant.

Deaktiviert die Streamdaten-Dienste für den aktuellen Tenant.

Sichert einen Tenant in eine Datei

Aktiviert den AI Adapter für den aktuellen Tenant. Der Communication Controller muss zuerst aktiviert sein (führen Sie vorher EnableCommunication aus).

Reaktiviert ein zuvor deaktiviertes Archiv: Übergang Disabled → Activated. Validiert die Spaltenpfade erneut gegen das aktuelle CK-Modell; kein DDL.

Aktiviert den Communication Controller für den aktuellen Tenant.

Aktiviert die Reporting Services für den aktuellen Tenant.

Aktiviert die Streamdaten-Dienste für den aktuellen Tenant.

Führt eine Pipeline aus und gibt die Ausführungs-ID zurück.

Exportiert die Zeilendaten eines Archivs in ein herunterladbares ZIP. Lassen Sie sowohl --fromUtc als auch --toUtc weg, um das gesamte Archiv zu exportieren; geben Sie sie an, um das halboffene Intervall [fromUtc, toUtc) zu exportieren.

Plant einen Job, um den Runtime-Modell-Graphen zu exportieren, indem RtId's und Typ als Ausgangspunkt angegeben werden. Die Datei wird über das Argument -f angegeben. Die Datei wird nach Abschluss des Jobs im ZIP-Format heruntergeladen.

Plant einen Job, um Runtime-Modelle mithilfe einer Abfrage zu exportieren. Die Datei wird über das Argument -f angegeben. Die Datei wird nach Abschluss des Jobs im ZIP-Format heruntergeladen.

Importiert alle CK-Modelle, die ein Update oder eine Reparatur benötigen. Verwenden Sie -w zum Warten, -y zum Überspringen der Bestätigung.

Friert ein CkRollupArchive zum angegebenen Zeitstempel ein. Monoton — wird abgelehnt, wenn der neue Wert früher als der aktuelle FrozenUntil liegt. Der Orchestrator erzeugt keine Buckets mehr, deren bucketEnd in den eingefrorenen Bereich fällt; bereits aggregierte Zeilen bleiben erhalten.

Generiert CA- und Service-/Server-Zertifikate zum Betrieb des OctoMesh-Operators

Ruft die Konfiguration eines bestimmten Adapters ab.

Ruft aggregierte Node-Deskriptoren von allen verbundenen Adaptern ab.

Shows what an adapter pool has queued and what it currently has leased out.

Ruft alle Adapter des aktuellen Tenants ab.

Ruft Admin-Provisioning-Mappings für einen Ziel-Tenant ab.

Gibt den Status des AI-Credential-Lease (Ablaufzeiten + Generation) für den aktiven Tenant zurück. Der Token-Klartext wird niemals offengelegt.

Ruft alle API-Ressourcen ab.

Ruft alle API-Scopes ab.

Ruft alle Secrets einer API-Ressource ab.

Ruft alle Secrets eines Clients ab.

Zeigt den Verlauf der Blueprint-Anwendungen für den aktuellen Tenant an.

Ruft einen Client anhand seiner ID ab.

Listet die Sub-Tenants auf, in die ein ClientCredentials-Client automatisch provisioniert wurde.

Ruft alle Clients ab.

Ruft die On-Demand-Lifecycle-Konfiguration des Tenants ab (Scale-to-Zero, AB#4914).

Ruft den Status eines bestimmten Datenflusses ab.

Gets all data permissions with their policies and role grants

Gets all deployment sites for the current tenant.

Ruft eine E-Mail-Domain-Gruppenregel anhand der ID ab.

Ruft alle E-Mail-Domain-Gruppenregeln ab.

Ruft ein External-Tenant-User-Mapping anhand der ID ab.

Ruft External-Tenant-User-Mappings ab.

Ruft eine Gruppe anhand der ID ab.

Ruft alle Gruppen ab.

Ruft alle Identity Provider ab.

Gibt die neueste Pipeline-Ausführung zurück.

Ruft den Debug-Zustand einer Pipeline ab.

Gibt die Debug-Point-Nodes für eine bestimmte Pipeline-Ausführung zurück.

Gibt die Ausführungshistorie der Pipeline zurück.

Ruft das Pipeline-JSON-Schema für einen bestimmten Adapter ab.

Ruft den Deployment-Status einer Pipeline ab.

Ruft Rollen ab.

Ruft den Aktivierungszustand der Funktionen des aktuellen Tenants ab (Stream Data, Communication, Reporting, AI Services).

Ruft den dauerhaften Provisioning-Lifecycle-Zustand eines untergeordneten Tenants ab.

Ruft alle untergeordneten Tenants ab.

Diese Seite führt Sie durch die Registrierung der MCP-(Model Context Protocol)-Services bei einem KI-Client und den ersten authentifizierten Tool-Aufruf. Die gehosteten Endpunkte sind auf der Seite Deployments aufgeführt.

Ruft Benutzer ab.

Listet jeden Adapter / jede Application im aktiven Tenant auf, dessen ChartName übereinstimmt.

Grants a data permission to a role

Importiert Archivzeilendaten aus einem Export-ZIP in ein Zielarchiv. Das Zielarchiv muss während des Imports deaktiviert (Disabled) sein (siehe DisableArchive). Der Bot prüft, dass das Export-Schema mit dem Zielarchiv übereinstimmt, bevor Zeilen geschrieben werden.

Plant einen Import-Job für Construction-Kit-Dateien. Die Datei wird mit dem Argument -f angegeben. Um auf den Job zu warten, verwenden Sie das Argument -w.

Importiert ein CK-Modell aus einem Katalog mit allen Abhängigkeiten. Verwenden Sie -w, um auf den Abschluss zu warten.

Plant einen Import-Job für Runtime-Dateien. Die Datei wird mit dem Argument -f angegeben. Um auf den Job zu warten, verwenden Sie das Argument -w.

Installiert ein Blueprint in den aktuellen Tenant. CK-Modelle werden geladen und Seed-Daten werden per Upsert importiert.

Zeigt installierte CK-Modell-Bibliotheken mit ihrer Katalogverfügbarkeit an. Verwenden Sie --needs-action zum Filtern.

Listet alle Blueprints auf, die derzeit auf dem aktiven Tenant installiert sind.

Listet Blueprints auf, die über die konfigurierten Kataloge verfügbar sind.

Listet CK-Modelle aus Katalogen auf. Verwenden Sie -cn, um nach Katalog zu filtern, und -q zum Suchen.

Listet die verfügbaren CK-Modell-Katalogquellen auf.

Listet alle konfigurierten Kontexte auf. Übergeben Sie -n, um Details zu einem einzelnen Kontext anzuzeigen.

Listet die neuesten Neuberechnungs-Jobs für ein Rollup-Archiv auf (neueste zuerst, auf 50 begrenzt) — zur Fehlersuche, warum eine Neuberechnung fehlgeschlagen ist.

Listet jedes Rollup-Archiv auf, das an das angegebene Quell-CkArchive angehängt ist — Runtime-ID, Status, Zeitplan, Watermark, Freeze-Zustand.

Meldet sich bei den konfigurierten Identity Services an.

Nicht-interaktive Anmeldung über OAuth2 clientcredentials. Liest die Anmeldedaten aus den Argumenten -id/-s oder aus den Umgebungsvariablen OCTOCLICLIENTID/OCTOCLICLIENT_SECRET. Der Tenant stammt aus dem aktiven Kontext.

Verbinden Sie einen KI-Assistenten über den MCP-Server mit OctoMesh, erkunden Sie Daten in natürlicher Sprache, bauen Sie Abfragen und lassen Sie den Assistenten eine kleine Auswertung oder App erzeugen - innerhalb der Grenzen Ihres Tokens.

Die OctoMesh MCP (Model Context Protocol) Services sind der Model-Context-Protocol-Server für OctoMesh. Er stellt die vollständige administrative Oberfläche der Plattform – Tenants, Identity, Blueprints, Communication Adapter, Zeitreihenarchive, generisches Construction-Kit-Entity-CRUD und Aggregationsabfragen – als rund 208 typisierte Tools bereit, die KI-Assistenten (Claude Code, Claude Desktop und jeder andere MCP-fähige Client) über den MCP-Transport Streamable HTTP aufrufen.

Weist eine oder mehrere Pipelines von ihrem aktuellen Adapter einem neuen Ziel-Adapter zu. Jede Pipeline wird atomar verschoben; Fehler bei einzelnen Pipelines brechen den Batch nicht ab. Quell- und Ziel-Adapter müssen dieselbe CkTypeId teilen.

octo-cli ist die Kommandozeilenschnittstelle zum Verwalten und Administrieren von OctoMesh. Sie bietet Befehle zum Konfigurieren von Diensten, zum Verwalten von Tenants, Benutzern, Identity Providern und mehr.

Zeigt eine Vorschau der Änderungen, die ein Blueprint-Update vornehmen würde, ohne sie anzuwenden.

Backfill: provisioniert einen markierten ClientCredentials-Client in jeden vorhandenen Sub-Tenant des aktiven Kontext-Tenants. Idempotent.

Provisioniert einen markierten ClientCredentials-Client manuell in einen bestimmten Sub-Tenant.

Provisioniert den aktuellen Benutzer in einem Ziel-Tenant.

Löst eine optimistische Neuberechnung eines Rollup-Archivs über [from, to) aus (oder fasst sie zusammen). Gibt den resultierenden Job-Snapshot zurück (Zustand, Zählungen, Fehlergrund).

Recomputes rtDisplayName/rtDisplayDescription of a tenant's entities from the CK display rules (idempotent, runs asynchronously).

Konfiguriert den Log-Level für Dienste neu

Löst ein einmaliges AI-Credential-Ticket ein und speichert die Anthropic-Abonnement-Tokens auf dem AI Adapter. Läuft anonym – der Ticket-Code authentifiziert den Aufruf, es ist kein OctoMesh-Login erforderlich. Die tokenbezogenen Argumente (-at -rt -aex -rex) sind für Entwickler-Smoke-Tests optional; fehlende Werte werden standardmäßig auf ein Fake-Paar mit einem weit in der Zukunft liegenden Ablaufdatum gesetzt.

Aktualisiert die Blueprint-Katalog-Caches im Asset Repository. Verwenden Sie -cn, um einen bestimmten Katalog zu aktualisieren.

Aktualisiert die CK-Modell-Katalog-Caches. Verwenden Sie -cn, um einen bestimmten Katalog zu aktualisieren.

Entfernt einen Client aus einer Gruppe.

Entfernt eine Rolle von einem Client

Entfernt eine berechnete Spalte aus einem Archiv. Wird abgelehnt, wenn eine andere berechnete Spalte sie noch referenziert. (AB#4189)

Entfernt einen benannten Kontext.

Entfernt eine untergeordnete Gruppe aus einer übergeordneten Gruppe.

Entfernt einen Benutzer aus einer Gruppe.

Entfernt einen Benutzer aus einer Rolle

Starts a secret sweep job: re-encrypts all Secret attributes with the active key (Reprotect, default), encrypts remaining legacy values (Encrypt), removes values whose key id is not in the key ring (CleanupUnreadable, requires -y) or only counts them (Verify). Use -w to wait, -y to skip confirmation.

Öffnet die Provisionierung eines Tenants erneut, damit der Hintergrund-Reconciler sie abschließt.

Setzt das Passwort eines Benutzers zurück

Stellt einen Tenant aus einer Dump-Datei wieder her

Restores the pre-sweep dump of a secret sweep run into the same tenant, replacing its data (requires SecretManagement). Use -y to skip confirmation, -w to wait.

Wiederholt die Aktivierung nach einem vorherigen DDL-Fehler. Nur aus dem Zustand Failed zulässig.

Widerruft das AI-Credential-Lease des aktiven Tenants. Neue Sitzungen können erst gestartet werden, wenn ein neues Abonnement registriert wurde. Der Ciphertext wird für Audit-Zwecke aufbewahrt.

Revokes a data permission from a role

Setzt den Watermark des Rollups zurück (auf die Bucket-Grenze abgeschnitten), sodass nachfolgende Orchestrator-Ticks den zurückgesetzten Bereich neu aggregieren. Destruktiv: Zeilen in diesem Bereich sind vorübergehend nicht synchron, bis der Orchestrator aufgeholt hat.

Rotates the client secret of an adapter's pipeline service account. The previous secret stops working immediately, and the adapter's pipelines / data flows must be redeployed afterwards before the new secret takes effect.

Fixup-Skripte ausführen

Shows the encryption status of Secret attributes: environment status (key ring, active and known key ids, strict mode, recurring Verify), recent sweep runs with their dump state and the last sweep report (counts per form and key id, unreadable secrets to re-enter). Never shows secret values.

Schaltet das Flag AutoProvisionInChildTenants an einem vorhandenen ClientCredentials-Client um. Das Umschalten auf true führt kein automatisches Backfill durch — verwenden Sie dafür ProvisionClientInExistingTenants.

Legt die On-Demand-Lifecycle-Konfiguration des Tenants fest (Scale-to-Zero, AB#4914). Runtime-Konfiguration — wirksam ohne erneutes Deployen des Controllers; '-sze false' ist der Not-Aus pro Tenant.

Switches a data policy between Enforce and AuditOnly (the operator flip, AB#4974)

Aktiviert oder deaktiviert die Debug-Erfassung für eine Pipeline.

Richtet die Identity Services ein

Die MCP-(Model Context Protocol)-Services stellen rund 208 Tools bereit (MCP Services 3.4, Oktober 2026), gruppiert in die unten aufgeführten Familien. Die meisten Platform-Admin-Tools spiegeln den entsprechenden octo-cli-Befehl (snakecase-Namen – z. B. CLI CreateTenant → MCP createtenant); die Aggregations- und Persisted-Query-Tools spiegeln die GraphQL-Transient-Query-Oberfläche des Asset Repository.

Häufige Fehlermodi und wie man sie behebt. Die MCP-(Model Context Protocol)-Services werfen niemals aus einem Tool heraus – jedes Problem kommt als IsSuccess: false plus einer ErrorMessage zurück. Lesen Sie zuerst die Meldung; die Tabelle unten ordnet die typischen Meldungen den Grundursachen zu.

Entfernt das Deployment eines bestimmten Datenflusses.

Undeploys a deployment site through the Communication Operator. Undeploy the deployment site's workloads first (UndeployWorkload); Cloud deployment sites release their operator resources.

Entfernt das Deployment aller Trigger für den aktuellen Tenant.

Entfernt das Deployment eines Workloads (Adapter oder Application) über seinen übergeordneten Pool. Destruktiv — der Operator entfernt den Chart per helm-uninstall.

Setzt FrozenUntil auf einem CkRollupArchive zurück. Idempotent. Übergeben Sie --acceptGaps, wenn Quelldaten innerhalb des zuvor eingefrorenen Bereichs abgeschnitten wurden und die daraus resultierenden Lücken akzeptabel sind.

Entfernt ein Blueprint vom aktiven Tenant; mit --cascade werden auch abhängige Blueprints und verwaiste Abhängigkeiten entfernt.

Entfernt einen einzelnen Client-Mirror (verwirft den Client auf der Child-Seite + die Tracking-Zeile des Parents).

Aktualisiert eine API-Ressource.

Aktualisiert einen API-Scope.

Aktualisiert ein API-Secret für eine API-Ressource.

Aktualisiert ein API-Secret für einen Client.

Wendet ein Blueprint-Update auf den aktiven Tenant an.

Aktualisiert einen vorhandenen Client.

Ersetzt die direkt zugewiesenen Rollen eines Clients (Replace-all)

Ändert die Formel einer vorhandenen berechneten Spalte auf einem aktiven Archiv. Leser behalten die bisherigen Werte, während die neue Formel per Backfill nachgefüllt wird, und wechseln dann atomar. Wird abgelehnt, wenn eine andere berechnete Spalte diese referenziert. (AB#4189)

Aktualisiert eine E-Mail-Domain-Gruppenregel.

Aktualisiert ein External-Tenant-User-Mapping.

Aktualisiert eine Gruppe.

Aktualisiert die einer Gruppe zugewiesenen Rollen.

Aktualisiert einen Identity Provider.

Aktualisiert eine Rolle

Aktualisiert das System-Construction-Kit-Modell eines Tenants auf die neueste Version.

Aktualisiert einen Benutzer

Setzt ChartVersion für einen einzelnen Workload. Löst KEIN Deployment aus — rufen Sie anschließend bei Bedarf DeployWorkload auf.

Wechselt den aktiven Kontext.