Client-Verwaltung
Controller-Client-Identitäten registrieren, authentifizieren und verwalten. Controller-Clients sind die Identität, die von Automatisierungsskripten verwendet wird, um sich mit dem Relay zu verbinden und Befehle zu erteilen.
otto client register
Registriert einen neuen Controller-Client beim Relay.
Verwendung
otto client register [Optionen]
Flags
| Flag | Kurzform | Erforderlich | Typ | Standard | Beschreibung |
|---|---|---|---|---|---|
--name | Ja | string | Anzeigename für den Controller-Client | ||
--description | Nein | string | Optionale Beschreibung | ||
--relay-url | Nein | string | Aus Konfiguration | Relay-URL für die Registrierung | |
--json | Nein | boolean | false | Ergebnis als JSON ausgeben |
Beispiele
# Neuen Client interaktiv registrieren
otto client register --name "my-automation"
# Mit Beschreibung registrieren
otto client register --name "ci-bot" --description "CI-Automatisierungsclient"
# Registrieren und JSON-Anmeldeinformationen erfassen
otto client register --name "ci-bot" --json
Nach der Registrierung wird ein Client-Secret zurückgegeben. Bewahren Sie es sicher auf — es wird nur einmal angezeigt.
Beendigungscodes
| Code | Bedeutung |
|---|---|
0 | Client erfolgreich registriert |
1 | Registrierung fehlgeschlagen oder Relay-Fehler |
otto client login
Authentifiziert einen bestehenden Controller-Client und speichert Zugangsdaten lokal.
Verwendung
otto client login [Optionen]
Flags
| Flag | Kurzform | Erforderlich | Typ | Standard | Beschreibung |
|---|---|---|---|---|---|
--client-id | Nein | string | Zu authentifizierende Client-ID | ||
--relay-url | Nein | string | Aus Konfiguration | Relay-URL |
Beispiele
# Interaktiv anmelden
otto client login
# Mit bestimmter Client-ID anmelden
otto client login --client-id abc123
Beendigungscodes
| Code | Bedeutung |
|---|---|
0 | Erfolgreich angemeldet |
1 | Anmeldung fehlgeschlagen (ungültige Anmeldeinformationen oder Relay-Fehler) |
otto client status
Zeigt den aktuellen Authentifizierungsstatus des Controller-Clients an.
Verwendung
otto client status [Optionen]
Flags
| Flag | Kurzform | Erforderlich | Typ | Standard | Beschreibung |
|---|---|---|---|---|---|
--json | Nein | boolean | false | Als JSON ausgeben |
Beispiele
otto client status
otto client status --json
Beendigungscodes
| Code | Bedeutung |
|---|---|
0 | Status gemeldet |
1 | Nicht angemeldet oder Konfiguration fehlt |
otto client forget
Entfernt lokal gespeicherte Controller-Client-Anmeldeinformationen, ohne sie beim Relay zu widerrufen.
Verwendung
otto client forget
Beispiele
otto client forget
Verwenden Sie otto client remove, um den Client auch relay-seitig zu widerrufen.
Beendigungscodes
| Code | Bedeutung |
|---|---|
0 | Lokale Anmeldeinformationen gelöscht |
otto client remove
Widerruft und entfernt einen Controller-Client vom Relay, einschließlich seiner ACL-Grants, Refresh-Sessions und aktiven Verbindungen.
Verwendung
otto client remove [Optionen]
Flags
| Flag | Kurzform | Erforderlich | Typ | Standard | Beschreibung |
|---|---|---|---|---|---|
--client-id | Nein | string | Bestimmte zu entfernende Client-ID | ||
--all | Nein | boolean | false | Alle registrierten Controller-Clients entfernen |
Beispiele
# Bestimmten Client entfernen
otto client remove --client-id abc123
# Alle Clients entfernen
otto client remove --all
--all ist nach der Bereinigung idempotent; nachfolgende Aufrufe geben null Entfernungen zurück, bis neue Clients registriert werden.
Beendigungscodes
| Code | Bedeutung |
|---|---|
0 | Client(s) entfernt |
1 | Entfernung fehlgeschlagen oder Relay-Fehler |
Verwandte Befehle
- otto pair / otto revoke — Node-Kopplung verwalten.
- Kopplungs- und Auth-Leitfaden — vollständiger Auth-Lebenszyklus.