Zum Hauptinhalt springen

CLI-Befehle

Alle Befehle folgen dem Muster: unraid-api <command> [options].

Dienstverwaltung​

Start​

unraid-api start [--log-level <level>]

Startet den Unraid API-Dienst.

Optionen:

  • --log-level: Protokollierungsstufe festlegen (trace|debug|info|warn|error|fatal)

Alternative: Sie können die Protokollierungsstufe auch mit der Umgebungsvariable LOG_LEVEL festlegen:

LOG_LEVEL=trace unraid-api start

Stoppen​

unraid-api stop [--delete]

Stoppt den Unraid API-Dienst.

  • --delete: Optional. Das PM2-Heimverzeichnis löschen.

Neustart​

unraid-api restart [--log-level <level>]

Startet den Unraid API-Dienst neu.

Optionen:

  • --log-level: Protokollierungsstufe festlegen (trace|debug|info|warn|error|fatal)

Alternative: Sie können die Protokollierungsstufe auch mit der Umgebungsvariable LOG_LEVEL festlegen:

LOG_LEVEL=trace unraid-api restart

Protokolle​

unraid-api logs [-l <lines>]

Zeigt die API-Protokolle an.

  • -l, --lines: Optional. Anzahl der anzusehenden Zeilen (standardmäßig: 100)

Konfigurationsbefehle​

Konfiguration​

unraid-api config

Zeigt aktuelle Konfigurationswerte an.

Umgebung wechseln​

unraid-api switch-env [-e <environment>]

Wechselt zwischen Produktions- und Staging-Umgebungen.

  • -e, --environment: Optional. Zielumgebung (production|staging).

Entwicklermodus​

Sie können Entwickleroptionen auch über die Weboberfläche unter Einstellungen → Verwaltungszugriff → Entwickleroptionen in der WebGUI verwalten.

unraid-api developer                       # Interactive prompt for tools
unraid-api developer --sandbox true        # Enable %%GraphQL|graphql%% sandbox
unraid-api developer --sandbox false       # Disable %%GraphQL|graphql%% sandbox
unraid-api developer --enable-modal        # Enable modal testing tool
unraid-api developer --disable-modal       # Disable modal testing tool

Entwicklerfunktionen für die API konfigurieren:

  • GraphQL Sandbox: Enable/disable Apollo GraphQL sandbox at /graphql
  • Modal-Testwerkzeug: Aktivieren/deaktivieren des UI-Modul-Tests im Unraid-Menü.

API-Schlüsselverwaltung​

API-Schlüssel können auch über die Weboberfläche unter Einstellungen → Verwaltungszugriff → API-Schlüssel in der WebGUI verwaltet werden.

API-Schlüsselbefehle​

unraid-api apikey [options]

Erstellen und verwalten Sie API-Schlüssel über die CLI.

Optionen:

  • --name <name>: Name des Schlüssels
  • --create: Erstellen Sie einen neuen Schlüssel
  • -r, --roles <roles>: Comma-separated list of roles
  • -p, --permissions <permissions>: Comma-separated list of permissions
  • -d, --description <description>: Description for the key

SSO (Single Sign-On)-Verwaltung​

For OIDC/SSO provider configuration, see the web interface at Settings → Management Access → API → OIDC in the WebGUI or refer to the OIDC Provider Setup guide.

SSO-Befehlsbasis​

unraid-api sso

Optionen:

unraid-api sso add-user
# or
unraid-api sso add
# or
unraid-api sso a

SSO-Benutzer entfernen:

unraid-api sso remove-user
# or
unraid-api sso remove
# or
unraid-api sso r

Für die OIDC/SSO-Anbieter-Konfiguration siehe die Weboberfläche unter Einstellungen → Verwaltungszugriff → API → OIDC oder beziehen Sie sich auf den OIDC-Anbieter-Einrichtungsleitfaden.

unraid-api sso list-users
# or
unraid-api sso list
# or
unraid-api sso l

SSO-Token validieren:

Ein SSO-Token validieren und seinen Status zurückgeben.

unraid-api sso validate-token <token>
# or
unraid-api sso validate
# or
unraid-api sso v

Berichterstellung​

SSO-Benutzer entfernen​

unraid-api report [-r] [-j]

Ein Systembericht erstellen.

  • -r, --raw: Rohbefehlsausgabe anzeigen
  • -j, --json: Ausgabe im JSON-Format anzeigen

Most commands require appropriate permissions to modify system state. Some commands require the API to be running or stopped. Store API keys securely as they provide system access. SSO configuration changes may require a service restart.