ユーザステージ

ユーザステージを作成し、ボット作成で使用するステージをカスタマイズして保存します。作成したステージは、Neurons Bots エディタの [ステージ] > [ユーザ] で再利用できます。

ユーザステージを作成するには

メインメニュー > [Neurons Bots] に移動します。
[Neurons Bots] ホームページが表示されます。
[汎用ボット] タブまたは [調査ボット] タブを選択します。
[ボットの作成] または [調査を作成] を選択します。
[ボットの作成] または [調査を作成] ページが表示されます。
ボットトリガ (スケジュールまたはカスタムアクション) を選択します。
ターゲットタイプ ([デバイス] または [ユーザ]) を選択します。
ボットの [名前] を入力します。任意で、簡潔な説明を入力します。
[作成] をクリックします。
Bots エディタのページが表示されます。
新しいボットは非アクティブな下書きバージョンとして保存されます。
[新規ボット] エディタページで、[ユーザステージの管理] を選択して [ユーザステージマネージャ] ページを表示します。
[ユーザステージマネージャ] ページで、[作成] ドロップダウンをクリックし、次の中から目的のステージを選択します。
- PowerShell クエリ
- PowerShell アクション
- Bash アクション
- コマンドアクション
- OSQuery
[ユーザステージエディタ] ページで、[ステージ名] を入力します。例: ファイル/フォルダの圧縮
任意で、説明を入力します。説明テキストは、ボットエディタ内と、[ステージ設定] パネルから [ステージ情報] が選択されたときに表示されます。例: このステージでは、指定したパスのソースファイルが、宛先パス内に、指定した圧縮レベルで圧縮されます。
スクリプトコードを入力します。
例:
Compress-Archive -path C:\logs\file.txt
-destinationpath C:\logs\file.zip
-compressionlevel Optimal

ハードコードの一部を変数に置き換えることで、このスクリプトをより柔軟にすることができます。これにより、ステージを使用するときに要素をカスタマイズできるようになります。
例:
Compress-Archive -path __Path to Source File or Folder__
-destinationpath __Destination Path__
-compressionlevel __Compression level|options:Fastest,Optimal,No Compression__

Ctrl + Space を選択して、[オプション変数] または [値変数] を挿入します。

[オプション変数] は、設定内に選択ドロップダウンとして表示されます。使用可能なオプションは、スクリプトに入力したものになります。この例の場合: 圧縮レベルオプションである Fastest、Optimal、No Compression。

[値変数] は、設定内にテキストボックスとして、スクリプトに入力したラベルとともに表示されます。この例の場合: ソースファイルまたはソースフォルダへのパス、宛先パス、および圧縮レベル。

この例の場合、[ステージ設定] は次のようになります。

[ステージ設定] を完了します。使用可能な設定は、作成しているユーザステージのタイプによって異なります。

PowerShell クエリ

別のユーザとして実行:

システム
ログオンしたユーザ

タイプ:

PowerShell
コア
自動

出力: 下流のフィルタ結果ステージで使用する、または別のステージの変数として使用する、PowerShell クエリによって返された各列名の出力を追加します。

単数形の結果: オン/オフを切り替えます。単一/複数の結果を使用して、クエリがデバイスごとに単一の結果を返すか複数の結果を返すかを定義します。これにより、変数が下流のステージで直接トークン入力として使用できるようになるか (単一)、for-each 結果ブロック内のステージでのみ使用でき、結果ごとにブロック内のステージをループするようになる (複数) かが決まります。

PowerShell クエリの例:

標準のボットステージを使用するだけでは目的のカスタム動作を実現できない場合に、環境に対して問い合わせるには、PowerShell を使用します。

クエリを正常に実行するには、次のことを確認してください。

スクリプトの出力が JSON であること (ConvertTo-JSON コマンドレットを使用できます)。
[ステージ設定] で、各データフィールドを出力エントリとして指定できます。

既定では、スクリプトのタイムアウトは25分です。

PowerShell タイプ:

[PowerShell] タイプに [コア] を選択すると、PowerShell スクリプトは PowerShell Core 上で実行されます。実行しているコンピュータに .Net Core 3.1 Desktop Runtime バージョン24.64.28315以降がインストールされている必要があります。
[PowerShell] タイプに [自動] を選択すると、クエリは .Net Core 3.1 Desktop Runtime バージョン24.64.28315以降を検索します。結果は次のようになります。
- 当該ランタイムがインストールされている場合、スクリプトは PowerShell Core に対して実行されます。
- 当該ランタイムがインストールされていない場合、スクリプトは PowerShell に対して実行されます。

出力タイプ:

結果が複数形で表示されるようにする場合はオンに切り替え、結果が単数形で表示されるようにする場合はオフに切り替えます。

単数 - 出力タイプが単数形として指定されている場合、1つのオブジェクトを JSON 形式で返せます。

$name = [System.Net.Dns]::GetHostName()

ConvertTo-Json @([customobject]@{Name = $name;})

複数 - 出力タイプが複数形として指定されている場合、JSON 形式のオブジェクト配列として、データを返す必要があります。
[{“Example Field”: “A”}, {“Example Field”: “B”}]
配列内のオブジェクトにはプリミティブ型が含まれます。 [ステージインスペクタ] の [出力] フィールドでは、[Example] フィールドをバインドして、[名前] を入力する必要があります。
$processes = Get-Process | Select-Object Name
ConvertTo-Json $processes

[適用して閉じる] を選択して、ユーザステージを保存します。
既存のユーザステージを編集した場合は、新規バージョンが作成されます。保存時、このユーザステージを使用しているボットはすべて、最新バージョンを使用するように更新する必要がある旨、警告するダイアログが表示されます。

アクション

任意のユーザステージに対して次のアクションを実行できます。

複製: ユーザステージを選択し、[アクション] > [複製] を選択します。 [ステージを複製] ダイアログが表示されます。一意の名前を入力し、[複製] を選択します。ステージの作成が成功したことを知らせるポップアップメッセージが表示されます。複製されたステージがリストに表示され、選択して編集できるようになります。

削除: 1つ以上のユーザステージを選択し、[アクション] > [削除] を選択します。 [ステージを削除] ダイアログが表示されます。 [削除] を選択して、ステージの削除を確認します。このアクションは元に戻すことができず、それを使用したボットからのステージは非推奨になります。非推奨のステージは赤い枠線で示されます。

ユーザ ステージ