エージェント管理コマンド

ビュー:

すべてのエージェントを一覧表示

clish agent show

目的

すべての登録済みエージェントの一覧または特定のエージェントに関する詳細情報を表示しますすべてのエージェントを一覧表示 clish エージェント表示

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: 接続状態 (Y=接続済み, N=未接続, ?=不明)
K: 認証情報の状態 (OK=設定済み, MISS=不足/無効, ?=不明)
H: 健康状態 (✓=健康, ✗=不健康, ?=不明)

Show specific agent details

clish agent show --instance <agent-name>

例

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>: 特定のエージェントの詳細を表示
--page <number>: エージェントリストのページ番号 (デフォルト: 1)

エージェントインスタンスを作成

clish agent create

目的

新しいエージェントインスタンスを作成する

clish agent create --name <agent-name>

例

clish agent create --name demo-3

Output example

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

要件

エージェント名はパターン^[a-zA-Z0-9_-]{1,20}$に一致する必要があります。つまり、20文字未満で、英数字と次の特殊文字のみを含む必要があります: ^[]-_{}$
名前はすべてのエージェント間で一意でなければなりません

エージェントインスタンスの削除

clish agent delete

目的

エージェントインスタンスの削除

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

例

# 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>: 削除するエージェントインスタンス名 (必須)
-y, --yes: 確認プロンプトをスキップ

備考

デフォルトでは、コマンドは削除前にユーザの確認を必要とします
-yまたは--yesフラグを使用して確認プロンプトをスキップします (自動化に便利です)
削除は永久的であり、元に戻すことはできません
すべてのエージェント構成、認証情報、および隔離データが削除されます

オンボーディングトークンを作成

clish agent onboarding-token issue

目的

エージェント登録用のオンボーディングトークンを生成する

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

例

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

Output example

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fweJf36POk6yJV_adQssw5c

備考

エージェントの初回接続にはトークンが必要です
トークンには有効期間が制限されています
エージェントはWebSocket接続の確立にこのトークンを使用しなければなりません

エージェントを再オンボードする

clish agent re-onboard

目的

エージェントの状態をリセットし、新しいオンボーディングトークンを発行して再オンボードします

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

例

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

このコマンドは、次のようなシナリオに対応しています:

エージェントのデバイストークンの有効期限が切れました
エージェントは管理サービスに再接続できません
エージェントの接続状態をリセットする必要がありますが、その構成は保持してください

備考

エージェントは再オンボーディングする前に切断状態でなければなりません
エージェントが現在接続されている場合、コマンドはエラーメッセージと共に失敗します
この操作は保持します:
- エージェントID
- エージェント設定 (ログレベル、隔離設定)
- 隔離データ
再オンボーディング後、次のことを行う必要があります。
- エージェントの構成ファイルを新しいオンボーディングトークンで更新してください
- エージェントを再起動します
- agent credential modify コマンドを使用して認証情報を再入力してください

Error example

接続されたエージェントを再オンボードしようとすると:

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の認証情報を更新

clish agent credential modify

目的

エージェントのONTAP SVM認証情報を更新する

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

例

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

Output example

Credentials updated successfully

Credential validation process

認証情報を更新すると、管理サービスはリアルタイムで検証を行い、認証情報が正しく機能することを確認します。

Possible error scenarios

Agent not connected
```
Error: agent 'demo-1' is not connected via WebSocket, cannot validate credentials
```
- ソリューション
  
  エージェントが稼働して管理サービスに接続されていることを確認してください
Invalid agent state
```
Error: agent 'demo-1' is in state 'onboarding', cannot set credentials
```
- ソリューション
  
  エージェントが認証情報が必要な状態または実行中の状態になるのを待ちます
Validation timeout:
```
Error: Agent did not respond to credential validation within timeout period
```
- Possible causes:
  - エージェントとSVM間のネットワーク接続問題
  - エージェントは他の高優先度タスクを処理しています
  - エージェントサービスが応答しません
- 解決策:
  - 接続エラーについてエージェントログを確認してください
  - SVMへのネットワーク接続を確認
  - clish agent show --instance <name>でエージェントの健康状態を確認してください
Credentials rejected by agent:
```
Error: Agent rejected credentials: Failed to connect to SVM: authentication failed
```
- Possible causes
  - ユーザ名またはパスワードが正しくない
  - SVMユーザアカウントがロックされているか無効になっています
  - エージェントからSVMにアクセスできません
- 解決策
  - ターゲットSVMの認証情報が正しいことを確認してください
  - SVMユーザアカウントのステータスを確認
  - エージェントとSVM間のネットワーク接続をテストする

備考

パスワード入力は入力中に非表示になります
認証情報はKubernetes Secretsに保存されます
指定されたエージェントインスタンスにのみ影響します
認証情報はリアルタイムで検証され、失敗時には自動的にロールバックされます

エージェントのログレベルを表示

clish agent loglevel show

目的

エージェントの現在のログレベルを表示

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

例

clish agent loglevel show --instance demo-1

Output example

Log Level for demo-1 : info

エージェントのログレベルを変更

clish agent loglevel modify

目的

エージェントのログレベルを変更する

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

例

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

Output example

Log level for demo-1 set to debug

Available Log Levels

info: 標準操作ログ
警告: 警告およびエラーメッセージのみ
エラー: エラーメッセージのみ

隔離設定を表示する

clish agent quarantine show

目的

エージェントの隔離設定を表示する

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

例:

clish agent quarantine show --instance demo-1

Output example

Quarantine for demo-1 : disabled

隔離機能を変更する

clish agent quarantine modify

目的

エージェントの隔離機能を有効化または無効化する

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

例

# 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

隔離ファイルの記録を表示

clish agent quarantine files show

目的

エージェントのすべての隔離ファイル記録を表示し、ステータス、タイムスタンプ、および関連するファイルパスを含めます。

clish agent quarantine files show [flags]

Available flags

--instance <name> : エージェントインスタンス名 (オプション、指定されていない場合はすべてのエージェントファイルを表示)
--page <number> : 隔離ファイルリストのページ番号 (デフォルト: 1)
--quarantine-id <id> : IDで特定の隔離ファイルの詳細情報を表示
--status <quarantined|restored|restoring|quarantine-error|restore-error> : ステータスでフィルター

例

すべてのエージェントの隔離ファイルを表示:
```
clish agent quarantine files show
```
特定のエージェントの「隔離済み」ステータスの隔離ファイルを表示:
```
clish agent quarantine files show --status quarantined
```
特定の隔離ファイルIDの詳細情報を表示:
```
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

検索メトリクスを表示

clish agent scan-metrics show

目的

指定された期間内にエージェントまたはすべてのエージェントの検索メトリクスを表示する

clish agent scan-metrics show [flags]

Available flags

--instance <name>: エージェントインスタンス名 (省略可能、指定しない場合はすべてのエージェントの要約を表示)
--time-range <range>: 時間範囲 (1日, 7日, 30日)
--from <date>: 開始日 (形式: 2025-01-01、最大6か月範囲)
--to <date>: 終了日 (形式: 2025-01-08、最大6か月範囲)

例

すべてのエージェントのメトリクスを表示 (過去1日 - デフォルト):
```
clish agent scan-metrics show
```
特定のエージェントのメトリクスを表示 (過去7日間):
```
clish agent scan-metrics show --instance demo-1 --time-range 7d
```
カスタム日付範囲でメトリクスを表示:
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

備考

フラグが指定されていない場合、デフォルトの時間範囲は1日です
--fromと--toは一緒に指定する必要があります
最大期間は6か月です
開始日が過去6ヶ月以上前であってはなりません

検索イベントを表示

clish agent scan-events show

目的

ステータスでフィルタリングされたエージェントまたはすべてのエージェントの検索イベントを表示

clish agent scan-events show [flags]

Available flags

--instance <name>: エージェントインスタンス名 (省略可能、指定しない場合はすべてのエージェントイベントを表示)
--id <event-id>: 特定のイベントIDの詳細情報を表示
--status <status>: ステータス (感染、エラー、隔離) - リストモードに必要
--page <number>: ページ番号 (デフォルト: 1, ページサイズ: 20)

例

すべてのエージェントの感染イベントを表示:
```
clish agent scan-events show --status infected
```
特定のエージェントのエラーイベントを表示 (ページ2):
```
clish agent scan-events show --instance demo-1 --status error --page 2
```
特定のイベントの詳細情報を表示:
```
clish agent scan-events show --id 12345
```

Output examples

リストモード - 感染済み:

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)

リストモード - エラー:

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

備考

--statusフラグはリストモードで必要です (--idを使用する場合は不要です)
有効なステータス値: infected, error, quarantined
ページサイズは1ページあたり20イベントに固定されています
詳細モード (--idを使用) では、タグを含む完全なイベント情報が表示されます
イベントのステータスに基づいて異なる列が表示されます