command line and python cli doc

Signed-off-by: 21pages <sunboeasy@gmail.com>
2026-10-25 21:40:13 +00:00 · 2025-10-20 08:31:21 +08:00
1 parent c568758dec
commit ba5415ba7b
@@ -83,18 +83,185 @@ Gmail in diesem Beispiel
 7. Geben Sie  in `Von` Ihr Gmail-Konto ein, z. B. `myrustdeskserver@gmail.com`.
 8. Klicken Sie zum Speichern auf `Check`.

-## Gerätebenutzer, -gruppen und -strategien den Geräten zuweisen
-Der Benutzer ist der RustDesk-Benutzer, der auf dem Gerät eingeloggt ist oder dem Gerät zugewiesen wurde, indem Sie auf `Bearbeiten` neben dem Gerät klicken. Klicken Sie auf das Feld `Benutzer` und wählen Sie Ihren Benutzer aus der Dropdown-Liste aus. Damit wird die Gruppe auf der Grundlage der Gruppe, der der Benutzer zugewiesen wurde, automatisch zugewiesen.
+## Gerätebenutzer/Strategien/Gerätegruppen Geräten über die Webkonsole zuweisen

-Dies kann auch über die API in der Befehlszeile bei der Bereitstellung oder später erfolgen, indem Sie die ausführbare Datei RustDesk aufrufen, gefolgt von `--assign --token <generatedtoken> --user_name <username>`. Dazu gehen Sie zu `Einstellungen → Token → Erstellen` und erstellen ein Token mit Geräteberechtigungen. Ein Beispiel hierfür wäre unter Windows: `"C:\Program Files\RustDesk\rustdesk.exe" --assign --token <generatedtoken> --user_name <newuser>`.
+Der Benutzer ist der RustDesk-Benutzer, der auf dem Gerät angemeldet ist oder dem Gerät durch Klicken auf **Bearbeiten (Edit)** neben dem Gerät zugewiesen wurde.  
+Klicke in das **Benutzer (User)**-Feld und wähle deinen Benutzer aus dem Dropdown-Menü.  
+Du kannst auch mehrere Geräte einem Benutzer zuweisen, indem du in der **Benutzerliste (User List)** auf **Mehr → Geräte zuweisen (Assign Devices)** klickst.

-Sie können die Strategie z. B. auch mit `--assign --token <generatedtoken> --strategy_name <strategyname>` zuweisen.
+Um ein Gerät einer Gerätegruppe hinzuzufügen, klicke in der **Geräteliste (Device List)** auf **Bearbeiten (Edit)** neben dem Gerät und ändere die **Gruppe (Group)**, oder gehe zur Liste **Gerätegruppen (Device Groups)**, klicke auf den Namen einer Gruppe und passe die darin enthaltenen Geräte an.

-Sie können auch das Adressbuch auf diese Weise zuweisen, z. B. `--assign --token <generatedtoken> --address_book_name <addressbookname>` oder `--assign --token <generatedtoken> --address_book_name <addressbookname> --address_book_tag <addressbooktag> --address_book_alias <alias>`. `--address_book_alias` erfordert RustDesk Server Pro >=1.5.8 und Client >=1.4.1.
+Um eine Strategie einem Gerät zuzuweisen, bewege die Maus auf die rechte Seite der **Strategieliste (Strategy List)** und klicke im Menü auf **Geräte bearbeiten (Edit Devices)**, **Benutzer bearbeiten (Edit Users)** oder **Gerätegruppen bearbeiten (Edit Device Groups)**, um die entsprechenden Geräte, Benutzergeräte oder Gerätegruppengeräte zur ausgewählten Strategie hinzuzufügen.

-Sie können auch den Geräte-Gruppennamen auf diese Weise zuweisen, z. B. `--assign --token <generatedtoken> --device_group_name <devicegroupname>`.
+---
+
+## API-Token
+
+Zuerst musst du zu **Settings → Tokens → Create** gehen und ein Token mit den erforderlichen Berechtigungen erstellen:  
+**Device, Audit Log, User, Group, Strategy, Address Book**.  
+
+Nach der Erstellung kannst du diese Tokens über die **Befehlszeile (Command Line)** oder das **Python CLI** verwenden, um Aktionen mit den entsprechenden Berechtigungen auszuführen.
+
+### Zuweisung über Token in der Befehlszeile
+
+Du kannst auch die RustDesk-Programmdatei mit dem Parameter `--assign` verwenden, um Zuweisungen vorzunehmen.  
+Damit kannst du Benutzer, Strategien, Adressbücher oder Gerätegruppen direkt über die Befehlszeile einem Gerät zuweisen.
+
+**Beispiel:**  
+
+    "C:\Program Files\RustDesk\rustdesk.exe" --assign --token <generatedtoken> --user_name <username>
+
+---
+
+Unterstützte Parameter  
+
+| Parameter                               | Beschreibung                                       | RustDesk Server Pro | RustDesk Client |
+| --------------------------------------- | -------------------------------------------------- | ------------------- | --------------- |
+| `--user_name <username>`                | Weist dem Gerät einen Benutzer zu                  |                     |                 |
+| `--strategy_name <strategyname>`        | Weist dem Gerät eine Strategie zu                  |                     |                 |
+| `--address_book_name <addressbookname>` | Weist das Gerät einem Adressbuch zu                |                     |                 |
+| `--address_book_tag <addressbooktag>`   | Weist über Adressbuch-Tag zu                       |                     |                 |
+| `--address_book_alias <alias>`          | Weist über Adressbuch-Alias zu                     | 1.5.8               | 1.4.1           |
+| `--address_book_password <password>`    | Setzt das Passwort für den Adressbucheintrag       | 1.6.6               | 1.4.3           |
+| `--address_book_note <note>`            | Fügt eine Notiz für den Adressbucheintrag hinzu    | 1.6.6               | 1.4.3           |
+| `--device_group_name <devicegroupname>` | Weist das Gerät einer Gerätegruppe zu              |                     |                 |
+| `--note <note>`                         | Fügt dem Gerät eine Notiz hinzu                    | 1.6.6               | 1.4.3           |
+| `--device_username <device_username>`   | Legt den Gerätenutzernamen fest                    | 1.6.6               | 1.4.3           |
+| `--device_name <device_name>`           | Legt den Gerätenamen fest                          | 1.6.6               | 1.4.3           |
+
+In der Windows-Befehlszeile wird standardmäßig keine Ausgabe angezeigt.  
+Um eine Ausgabe zu erhalten, führe den Befehl wie folgt aus:  
+`"C:\Program Files\RustDesk\rustdesk.exe" <arg1> <arg2> ... | more`  
+oder  
+`"C:\Program Files\RustDesk\rustdesk.exe" <arg1> <arg2> ... | Out-String`  
+(siehe [hier](https://github.com/rustdesk/rustdesk/discussions/6377#discussioncomment-8094952)).
+
+---
+
+### Python CLI Verwaltungstools
+
+#### Benutzerverwaltung (`users.py`)
+
+**Hilfe anzeigen:**  
+    ./users.py -h
+
+**Benutzer anzeigen:**  
+    ./users.py --url <url> --token <token> view [--name <username>] [--group_name <group_name>]
+
+**Filter:**  
+`--name`: Benutzername  
+`--group_name`: Benutzergruppe
+
+**Beispiel:**  
+    ./users.py --url https://example.com --token <token> view --group_name admins
+
+**Operationen:**  
+`view` kann durch `enable`, `disable` oder `delete` ersetzt werden.
+
+**Beispiel (Benutzer deaktivieren):**  
+    ./users.py --url https://example.com --token <token> disable --name testuser
+
+---
+
+#### Geräteverwaltung (`devices.py`)
+
+**Hilfe anzeigen:**  
+    ./devices.py -h
+
+**Geräte anzeigen:**  
+    ./devices.py --url <url> --token <token> view [--id <device_id>] [--device_name <device_name>] [--user_name <user_name>] [--group_name <group_name>] [--device_group_name <device_group_name>] [--offline_days <days>]
+
+**Filter:**  
+`--id`: Geräte-ID  
+`--device_name`: Gerätename  
+`--user_name`: Zugewiesener Benutzer  
+`--group_name`: Benutzergruppe  
+`--device_group_name`: Gerätegruppe  
+`--offline_days`: Offline-Tage
+
+**Beispiel:**  
+    ./devices.py --url https://example.com --token <token> view --user_name mike
+
+**Operationen:**  
+`view` kann durch `enable`, `disable`, `delete` oder `assign` ersetzt werden.
+
+**Beispiel (Gerät zuweisen):**  
+    ./devices.py --url https://example.com --token <token> assign --device_name PC01 --assign_to user_name=mike
+
+---
+
+#### Adressbuchverwaltung (`ab.py`)
+
+**Hilfe anzeigen:**  
+    ./ab.py -h
+
+**Freigegebene Adressbücher anzeigen:**  
+    ./ab.py --url <url> --token <token> view-ab [--ab-name <address_book_name>]
+
+**Persönliche Adressbuch-GUID abrufen:**  
+    ./ab.py --url <url> --token <token> get-personal-ab
+
+**Ein freigegebenes Adressbuch hinzufügen:**  
+    ./ab.py --url <url> --token <token> add-ab --ab-name <name> [--note <note>] [--password <password>]
+
+**Ein freigegebenes Adressbuch aktualisieren oder löschen:**  
+    ./ab.py --url <url> --token <token> update-ab --ab-guid <guid> [--ab-update-name <new_name>] [--note <note>]  
+    ./ab.py --url <url> --token <token> delete-ab --ab-guid <guid>
+
+**Peers in einem Adressbuch anzeigen:**  
+    ./ab.py --url <url> --token <token> view-peer --ab-guid <guid> [--peer-id <peer_id>] [--alias <alias>]
+
+**Peer hinzufügen, aktualisieren oder löschen:**  
+    ./ab.py --url <url> --token <token> add-peer --ab-guid <guid> --peer-id <peer_id> [--alias <alias>] [--note <note>] [--tags tag1,tag2]  
+    ./ab.py --url <url> --token <token> update-peer --ab-guid <guid> --peer-id <peer_id> [--alias <alias>] [--note <note>] [--tags tag1,tag2]  
+    ./ab.py --url <url> --token <token> delete-peer --ab-guid <guid> --peer-id <peer_id>
+
+**Tag-Verwaltung:**  
+    ./ab.py --url <url> --token <token> view-tag --ab-guid <guid>  
+    ./ab.py --url <url> --token <token> add-tag --ab-guid <guid> --tag-name <name> [--tag-color 0xFF00FF00]  
+    ./ab.py --url <url> --token <token> update-tag --ab-guid <guid> --tag-name <name> --tag-color 0xFFFF0000  
+    ./ab.py --url <url> --token <token> delete-tag --ab-guid <guid> --tag-name <name>
+
+**Zugriffsregelverwaltung:**  
+    ./ab.py --url <url> --token <token> view-rule --ab-guid <guid>  
+    ./ab.py --url <url> --token <token> add-rule --ab-guid <guid> [--rule-type user|group|everyone] [--rule-user <user>] [--rule-group <group>] --rule-permission ro|rw|full  
+    ./ab.py --url <url> --token <token> update-rule --rule-guid <rule_guid> --rule-permission rw  
+    ./ab.py --url <url> --token <token> delete-rule --rule-guid <rule_guid>
+
+**Beispiel (Lesezugriff für Benutzer „mike“ hinzufügen):**  
+    ./ab.py --url https://example.com --token <token> add-rule --ab-guid <guid> --rule-user mike --rule-permission ro
+
+---
+
+#### Prüfprotokolle (`audits.py`)
+
+**Hilfe anzeigen:**  
+    ./audits.py -h
+
+**Verbindungsprotokolle anzeigen:**  
+    ./audits.py --url <url> --token <token> view-conn [--remote <peer_id>] [--conn-type <type>] [--page-size <n>] [--current <n>] [--created-at <"YYYY-MM-DD HH:MM:SS">] [--days-ago <n>]
+
+**Dateiübertragungsprotokolle anzeigen:**  
+    ./audits.py --url <url> --token <token> view-file [--remote <peer_id>] [--page-size <n>] [--current <n>] [--created-at <"YYYY-MM-DD HH:MM:SS">] [--days-ago <n>]
+
+**Alarmprotokolle anzeigen:**  
+    ./audits.py --url <url> --token <token> view-alarm [--device <device_id>] [--page-size <n>] [--current <n>] [--created-at <"YYYY-MM-DD HH:MM:SS">] [--days-ago <n>]
+
+**Konsolenprotokolle anzeigen:**  
+    ./audits.py --url <url> --token <token> view-console [--operator <username>] [--page-size <n>] [--current <n>] [--created-at <"YYYY-MM-DD HH:MM:SS">] [--days-ago <n>]
+
+**Filter:**  
+`--remote`: Peer-ID (für Verbindungs- oder Dateiübertragungsprotokolle)  
+`--conn-type`: 0=Remote Desktop, 1=Dateiübertragung, 2=Portweiterleitung, 3=Kamera anzeigen, 4=Terminal  
+`--device`: Geräte-ID (für Alarmprotokolle)  
+`--operator`: Benutzername des Operators (für Konsolenprotokolle)  
+`--created-at`: Zeitfilter, z. B. "2025-09-16 14:15:57"  
+`--days-ago`: Filtert Datensätze, die neuer als die angegebene Anzahl von Tagen sind  
+`--page-size` / `--current`: Seitengröße / Aktuelle Seite
+
+**Beispiel:**  
+    ./audits.py --url https://example.com --token <token> view-conn --remote 123456789 --days-ago 7

-Die Befehlszeile unter Windows hat standardmäßig keine Ausgabe. Um die Ausgabe zu erhalten, führen Sie bitte `"C:\Program Files\RustDesk\rustdesk.exe" <arg1> <arg2> ... | more` oder `"C:\Program Files\RustDesk\rustdesk.exe" <arg1> <arg2> ... | Out-String` aus, siehe [hier](https://github.com/rustdesk/rustdesk/discussions/6377#discussioncomment-8094952).

 ## Suche nach einem Gerät
 1. Gehen Sie zu Geräte.