Agent-Verwaltungsbefehle

Ansichten:

Alle Agenten auflisten

clish agent show

Zweck

Zeigt die Liste aller registrierten Agenten oder detaillierte Informationen über einen bestimmten Agenten an Liste aller Agenten clish agent show

Agent Name  Hostname  State       Attrs             Version
----------  --------  ----------  ----------------  -------
demo-1      -         running     C:Y K:OK H:✓      v1.0.0
demo-2      -         onboarding  C:N K:MISS H:✓    v1.0.0
page 1/1

Attributes Explanation

C: Verbindungsstatus (Y=Verbunden, N=Getrennt, ?=Unbekannt)
K: Anmeldestatus (OK=Konfiguriert, MISS=Fehlend/Ungültig, ?=Unbekannt)
H: Gesundheitsstatus (✓=Nicht infiziert, ✗=Infiziert, ?=Unbekannt)

Show specific agent details

clish agent show --instance <agent-name>

Beispiel

clish agent show --instance demo-1

Output example

Agent Name       : demo-1
Agent ID         : f461e289-c396-4f5b-8119-bea0a697d513
Device Hostname  : -
State            : running
Health           : healthy
ONTAP Connected  : connected
Credential       : configured
Log Level        : info
Quarantine       : disabled
Agent Version    : v1.0.0
Last Seen        : -
Reason           : -

Available Flags

--instance <name>: Details für einen bestimmten Agenten anzeigen
--page <number>: Seitennummer für die Agentenliste (Standard: 1)

Erstellen Sie eine Agenteninstanz

clish agent create

Zweck

Erstellen Sie eine neue Agenteninstanz

clish agent create --name <agent-name>

Beispiel

clish agent create --name demo-3

Output example

Agent 'demo03' created successfully with ID: f461e289-c396-4f5b-8119-bea0a697d513

Requirements

Der Agentenname muss dem Muster entsprechen: ^[a-zA-Z0-9_-]{1,20}$. Das bedeutet, dass er weniger als 20 Zeichen lang sein und nur alphanumerische Zeichen sowie die folgenden Sonderzeichen enthalten darf: ^[]-_{}$
Der Name muss bei allen Agenten eindeutig sein

Agenteninstanz löschen

clish agent delete

Zweck

Agenteninstanz löschen

clish agent delete --instance <agent-name> [--yes]

Beispiel

# With confirmation prompt
clish agent delete --instance demo-1
# Skip confirmation prompt
clish agent delete --instance demo-1 --yes

Output example

Are you sure you want to delete agent 'demo-1'? (y/yes to confirm): y
Agent 'demo-1' deleted successfully

Available flags

--instance <name>: Zu löschender Agent-Instanzname (erforderlich)
-y, --yes: Bestätigungsaufforderung überspringen

Hinweise

Standardmäßig erfordert der Befehl eine Benutzerbestätigung vor dem Löschen
Verwenden Sie das -y- oder --yes-Flag, um die Bestätigungsaufforderung zu überspringen (nützlich für die Automatisierung)
Das Löschen ist dauerhaft und kann nicht rückgängig gemacht werden
Alle Agentenkonfigurationen, Anmeldedaten und Quarantänedaten werden entfernt

Erstellen Sie ein Onboarding-Token

clish agent onboarding-token issue

Zweck

Erstellen Sie ein Onboarding-Token für die Agentenregistrierung

clish agent onboarding-token issue --instance <agent-name>

Beispiel

clish agent onboarding-token issue --instance demo-1

Output example

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fweJf36POk6yJV_adQssw5c

Hinweise

Token ist für die anfängliche Verbindung des Agenten erforderlich
Token hat eine begrenzte Gültigkeitsdauer
Der Agent muss dieses Token für die WebSocket-Verbindungsherstellung verwenden

Agent erneut einbinden

clish agent re-onboard

Zweck

Einen Agenten erneut einbinden, indem sein Status zurückgesetzt und ein neuer Onboarding-Token ausgestellt wird

clish agent re-onboard --instance <agent-name>

Beispiel

clish agent re-onboard --instance demo-1

Output example

Agent re-onboarded successfully!

Onboarding Token:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fweJf36POk6yJV_adQssw5c

Next Steps:
1. Update the agent's config.yaml with the new onboarding token
2. Restart the agent
3. The agent will automatically receive a new device token after onboarding
4. Re enter the credential using the 'agent credential modify' command

When to use

Dieser Befehl ist für Szenarien konzipiert, in denen:

Der Gerätetoken des Agenten ist abgelaufen
Agent kann keine Verbindung zum Verwaltungsdienst herstellen
Sie müssen den Verbindungsstatus des Agents zurücksetzen, während Sie seine Konfiguration beibehalten

Hinweise

Der Agent muss sich im getrennten Zustand befinden, bevor er erneut eingebunden wird
Wenn der Agent derzeit verbunden ist, schlägt der Befehl mit einer Fehlermeldung fehl
Dieser Vorgang bewahrt:
- Agenten-ID
- Agent-Einstellungen (Protokollebene, Quarantäne-Konfiguration)
- Daten in Quarantäne
Nach dem erneuten Onboarding müssen Sie:
- Aktualisieren Sie die Konfigurationsdatei des Agents mit dem neuen Onboarding-Token
- Starten Sie den Agenten neu
- Anmeldeinformationen erneut mit dem Befehl agent credential modify eingeben

Error example

Wenn Sie versuchen, einen verbundenen Agenten erneut zu integrieren:

Agent:
                demo-1 (ID: f461e289-c396-4f5b-8119-bea0a697d513) Current State: running
              Connection: connected
              Error: Agent is currently
              connected. Please ensure the agent is disconnected before
          re-onboarding.

ONTAP SVM-Anmeldedaten aktualisieren

clish agent credential modify

Zweck

Aktualisieren Sie die ONTAP SVM-Anmeldedaten für einen Agenten

clish agent credential modify --instance <agent-name>

Beispiel

clish agent credential modify --instance demo-1
# Interactive prompts: 
# username: admin 
# password: [hidden input]

Output example

Credentials updated successfully

Credential validation process

Wenn Sie Anmeldedaten aktualisieren, führt der Verwaltungsdienst eine Echtzeitüberprüfung durch, um sicherzustellen, dass die Anmeldedaten korrekt funktionieren.

Possible error scenarios

Agent not connected
```
Error: agent 'demo-1' is not connected via WebSocket, cannot validate credentials
```
- Lösung
  
  Stellen Sie sicher, dass der Agent ausgeführt wird und mit dem Verwaltungsdienst verbunden ist
Invalid agent state
```
Error: agent 'demo-1' is in state 'onboarding', cannot set credentials
```
- Lösung
  
  Warten Sie, bis der Agent den Zustand "Anmeldeinformationen erforderlich" oder "läuft" erreicht
Validation timeout:
```
Error: Agent did not respond to credential validation within timeout period
```
- Possible causes:
  - Netzwerkverbindungsprobleme zwischen Agent und SVM
  - Der Agent bearbeitet andere hochpriorisierte Aufgaben
  - Der Agentendienst reagiert nicht
- Lösung:
  - Überprüfen Sie die Agentenprotokolle auf Verbindungsfehler
  - Netzwerkverbindung zu SVM überprüfen
  - Überprüfen Sie den Status der Agentengesundheit mit clish agent show --instance <name>
Credentials rejected by agent:
```
Error: Agent rejected credentials: Failed to connect to SVM: authentication failed
```
- Possible causes
  - Ungültiger Benutzername oder ungültiges Kennwort
  - SVM-Benutzerkonto ist gesperrt oder deaktiviert
  - SVM ist vom Agenten aus nicht erreichbar
- Lösung
  - Überprüfen Sie, ob die Anmeldedaten für das Ziel-SVM korrekt sind
  - Check SVM user account status
  - Netzwerkverbindung zwischen Agent und SVM testen

Hinweise

Passworteingabe wird während der Eingabe verborgen
Anmeldeinformationen werden in Kubernetes Secrets gespeichert
Betrifft nur die angegebene Agenteninstanz
Anmeldedaten werden in Echtzeit validiert mit automatischem Rollback bei Fehlern

Agent-Protokollebene anzeigen

clish agent loglevel show

Zweck

Aktuelles Protokollierungsniveau für einen Agenten anzeigen

clish agent loglevel show --instance <agent-name>

Beispiel

clish agent loglevel show --instance demo-1

Output example

Log Level for demo-1 : info

Ändern Sie die Protokollebene des Agenten

clish agent loglevel modify

Zweck

Ändern Sie die Protokollebene für einen Agenten

clish agent loglevel modify --instance <agent-name> --loglevel <level>

Beispiel

clish agent loglevel modify --instance demo-1 --loglevel debug

Output example

Log level for demo-1 set to debug

Available Log Levels

info: Standardbetriebsprotokollierung
warning: Nur Warnungen und Fehlermeldungen
Fehler: Nur Fehlermeldungen

Anzeige der Quarantäne-Einstellungen

clish agent quarantine show

Zweck

Quarantäne-Einstellungen für einen Agenten anzeigen

clish agent quarantine show --instance <agent-name>

Beispiel:

clish agent quarantine show --instance demo-1

Output example

Quarantine for demo-1 : disabled

Ändern Sie die Quarantäne-Funktionalität

clish agent quarantine modify

Zweck

Aktivieren oder deaktivieren Sie die Quarantäne-Funktionalität für einen Agenten

clish agent quarantine modify --instance <agent-name> --enabled <true|false>

Beispiele

# Enable quarantine
clish agent quarantine modify --instance demo-1 --enabled true

# Disable quarantine  
clish agent quarantine modify --instance demo-1 --enabled false

Output example

Quarantine for demo-1 set to enabled

Quarantäne-Datei-Einträge anzeigen

clish agent quarantine files show

Zweck

Zeige alle Quarantäne-Dateieinträge für den Agenten an, einschließlich ihres Status, ihrer Zeitstempel und der zugehörigen Dateipfade.

clish agent quarantine files show [flags]

Available flags

--instance <name> : Agent-Instanzname (optional, zeigt alle Agentendateien an, wenn nicht angegeben)
--page <number> : Seitennummer für die Liste der unter Quarantäne gestellten Dateien (Standard: 1)
--quarantine-id <id> : Detaillierte Informationen für eine bestimmte Quarantäne-Datei nach ID anzeigen
--status <quarantined|restored|restoring|quarantine-error|restore-error> : Nach Status filtern

Beispiele

Alle Quarantäne-Dateien für alle Agenten anzeigen:
```
clish agent quarantine files show
```
Zeige Quarantäne-Dateien für einen bestimmten Agenten mit dem Status "quarantined":
```
clish agent quarantine files show --status quarantined
```
Detaillierte Informationen für eine bestimmte Quarantäne-Datei-ID anzeigen:
```
clish agent quarantine files show --quarantine-id 105
```

Output examples

Quarantine ID  Agent Name  Timestamp            Status            Original Path                                       Quarantine Path                                     
-------------  ----------  -------------------  ----------------  --------------------------------------------------  --------------------------------------------------  
108            agent-01    2025-11-26 08:14:38  quarantine-error  \\FS01.CORP.LOCAL\share\finance\budget_v4.txt       C:\ProgramData\Agent\Quar...budget_v4_150ba326.txt  
107            agent-01    2025-11-26 08:08:38  quarantined       \\FS01.CORP.LOCAL\share\public\unknown_file.exe     C:\ProgramData\Agent\Quar...nown_file_da098e5c.exe  
106            agent-01    2025-11-26 07:51:38  quarantined       \\FS01.CORP.LOCAL\share\hr\resume_batch_5.doc       C:\ProgramData\Agent\Quar...e_batch_5_c2616949.doc  
105            agent-01    2025-11-26 07:44:38  restore-error     \\FS01.CORP.LOCAL\share\hr\resume_batch_5.doc       C:\ProgramData\Agent\Quar...e_batch_5_785dd8bd.doc  
104            agent-02    2025-11-24 09:00:32  quarantined       \\FS02.CORP.LOCAL\users\test\macro_virus.xlsm       C:\ProgramData\Agent\Quar...cro_virus_bbb1b9f9.xlsm  
103            agent-02    2025-11-24 08:15:47  restored          \\FS02.CORP.LOCAL\users\test\macro_virus.xlsm       C:\ProgramData\Agent\Quar...cro_virus_4baf367a.xlsm  
102            agent-01    2025-11-24 06:12:49  restore-error     \\FS01.CORP.LOCAL\share\it\script_tool.ps1          C:\ProgramData\Agent\Quar...ript_tool_f402f3d5.ps1  
101            agent-01    2025-11-23 16:42:09  restored          \\FS01.CORP.LOCAL\share\it\script_tool.ps1          C:\ProgramData\Agent\Quar...ript_tool_df5bb5be.ps1  

Page 1/1 (8 total quarantine files)

Quarantine File Details
=======================
ID              : 105
Agent Name      : agent-01
Scan ID         : 73a12b4c-81de-493f-b253-ae3fefe76d28
Status          : restore-error
Reason Code     : 201
Reason          : File not found in quarantine area
Timestamp       : 2025-11-26 07:44:38

File Paths
----------
Original Path   : \\FS01.CORP.LOCAL\share\hr\resume_batch_5.doc
Quarantine Path : C:\ProgramData\Agent\Quarantine\resume_batch_5_785dd8bd.doc

Scan-Metriken anzeigen

clish agent scan-metrics show

Zweck

Zeigen Sie die Scan-Metriken für einen Agenten oder alle Agenten innerhalb eines angegebenen Zeitraums an

clish agent scan-metrics show [flags]

Available flags

--instance <name>: Name der Agent-Instanz (optional, zeigt die Zusammenfassung aller Agenten, wenn nicht angegeben)
--time-range <range>: Zeitraum (1d, 7d, 30d)
--from <date>: Startdatum (Format: 2025-01-01, maximaler Zeitraum von 6 Monaten)
--to <date>: Enddatum (Format: 2025-01-08, maximaler Bereich von 6 Monaten)

Beispiele

Zeige die Metriken für alle Agenten (letzter Tag - Standard):
```
clish agent scan-metrics show
```
Zeige die Metriken für einen bestimmten Agenten (letzte 7 Tage):
```
clish agent scan-metrics show --instance demo-1 --time-range 7d
```
Zeigen Sie die Metriken mit benutzerdefiniertem Datumsbereich:
clish agent scan-metrics show --instance demo-1 --from 2025-01-01 --to 2025-01-08

Output example

Agent Metrics

Agent/Time    Total Scans  Clean  Infected  Error  Quarantined  Dropped
----------    -----------  -----  --------  -----  -----------  -------
demo-1        1500         1450   30        15     25           5
demo-2        2000         1980   10        5      8            2

Summary:
  Total Scans      : 3500
  Clean            : 3430
  Infected         : 40
  Error            : 20
  Quarantined      : 33
  Dropped          : 7

Hinweise

Der Standardzeitraum beträgt 1 Tag, wenn keine Flags angegeben sind
Sowohl --from als auch --to müssen zusammen angegeben werden
Der maximale Zeitraum beträgt 6 Monate
Das Startdatum darf nicht mehr als 6 Monate in der Vergangenheit liegen

Scan-Ereignisse anzeigen

clish agent scan-events show

Zweck

Scan-Ereignisse für einen Agenten oder alle Agenten anzeigen, gefiltert nach Status

clish agent scan-events show [flags]

Available flags

--instance <name>: Name der Agent-Instanz (optional, zeigt alle Agentenereignisse an, wenn nicht angegeben)
--id <event-id>: Detaillierte Informationen für spezifische Ereignis-ID anzeigen
--status <status>: Status (Infiziert, Fehler, Quarantäne) - erforderlich für Listenmodus
--page <number>: Seitennummer (Standard: 1, Seitengröße: 20)

Beispiele

Zeige infizierte Ereignisse für alle Agenten:

clish agent scan-events show --status infected

Fehlerereignisse für spezifischen Agenten anzeigen (Seite 2):

clish agent scan-events show --instance demo-1 --status error --page 2

Detaillierte Informationen für ein bestimmtes Ereignis anzeigen:
```
clish agent scan-events show --id 12345
```

Output examples

Listenmodus - infiziert:

ID     Agent Name  Timestamp            Status    Filename                    File Type  Malware Name      Malware Type
--     ----------  ---------            ------    --------                    ---------  ------------      ------------
12345  demo-1      2025-01-15 10:30:45  infected  /data/suspicious.exe        PE32       Trojan.Generic    trojan
12346  demo-1      2025-01-15 11:22:10  infected  /data/malware.doc           Office     Macro.Downloader  macro

Page 1/5 (95 total events)

Listenmodus - Fehler:

ID     Agent Name  Timestamp            Status  Filename              File Type  Error Code  Error Msg
--     ----------  ---------            ------  --------              ---------  ----------  ---------
12347  demo-2      2025-01-15 09:15:30  error   /data/corrupted.zip   ZIP        1001        File corrupted
12348  demo-2      2025-01-15 10:45:22  error   /data/large.tar.gz    GZIP       1002        File size exceeded

Page 1/3 (58 total events)

Detail mode

Scan Event Details
==================
Scan ID    : abc123-def456-ghi789
Source     : ontap-agent
Client ID  : agent-demo-1
Timestamp  : 2025-01-15 10:30:45
Status     : infected

File Information
----------------
Filename   : /data/suspicious.exe
SHA256     : a1b2c3d4e5f6...
File Type  : PE32

Malware Details
---------------
Malware Name : Trojan.Generic
Malware Type : trojan

Tags
----
  - high-risk
  - external-source

Hinweise

--status-Flag ist für den Listenmodus erforderlich (nicht bei Verwendung von --id)
Gültige Statuswerte: infected, error, quarantined
Die Seitengröße ist auf 20 Ereignisse pro Seite festgelegt
Detailmodus (mit --id) zeigt vollständige Ereignisinformationen einschließlich Tags
Verschiedene Spalten werden basierend auf dem Ereignisstatus angezeigt