Server & Workload Protection でポリシーを検索して、ポリシーに関する情報を取得します。たとえば、推奨設定モードがオフになっているポリシーを検索したり、特定のポリシーを名前で検索して保護モジュールの設定ステータスを表示したりできます。このレシピでは、検索ポリシーポリシーを名前で検索する操作。
開始前の準備
このレシピを完了するために必要な次の情報を収集します。
-
Server & Workload Protectionのポリシーの名前または名前の一部
-
マネージャのURL
-
APIキーの秘密鍵
バッシュ
手順
- ターミナルまたは任意のコマンドラインツールを開きます。
- 次のコマンドを入力して、リクエストに関する詳細を保存します。
<YOUR URL>
のURLでServer & Workload Protection、 と<YOUR SECRET KEY>
API キーのシークレットを使用して:-
url=<YOUR URL>
たとえば、url=https://cloudone.trendmicro.com
-
secret=<YOUR SECRET KEY>
たとえば、secret=5C58EADA-04BC-4ABC-45CF-B72925A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8=
-
- 次のコマンドを入力して、検索文字列を保存します。
<YOUR POLICY NAME>
検索するポリシーの名前の全部または一部を指定します。keyword="%<YOUR POLICY NAME>%"
たとえば、keyword="%Base Policy%"
- 次のコマンドを入力して、対応データを保存する JSON ファイルを指定します。
<FILE PATH>
作成するファイルと一緒に。 .json 拡張子が付いたファイル名を指定します。file=<FILE PATH>
たとえば、file=~/Documents/policy_search.json
- 次のコマンドを入力して要求を送信します。
curl -X POST "$url/api/policies/search" -H "api-secret-key: $secret" -H "api-version: v1" -H "Content-Type: application/json" \ -d "{ \ \"searchCriteria\": [ \ { \ \"fieldName\": \"name\", \ \"stringTest\": \"equal\", \ \"stringValue\": \"$keyword\", \ \"stringWildcards\": true \ } \ ] \ }" \ -k > $file
は-k
オプションは、 Server & Workload Protection が自己署名証明書を使用してTLS接続を確立する場合にのみ必要です。これは実稼働環境での使用には適していません。ヒント
返された JSON をターミナルで (ファイルに書き込むのではなく) 読み取り可能な形式で出力するには、cURL コマンドの結果をパイプして次のようにします。 jq 。上記のコマンドで、次のように置き換えます。> $file
と| jq .
。 - WebブラウザでJSONファイルを開きます。 (WebブラウザでJSONを読み取り可能な形式にする必要があります。)次の例のように、1つ以上のポリシーの配列を表すJSONコードが表示されます。
{ name: "Base Policy", description: "A policy from which all other policies can inherit. ", policySettings: {...}, recommendationScanMode: "ongoing", autoRequiresUpdate: "on", ID: 1, antiMalware: {...}, webReputation: {...}, sensingMode: {...}, firewall: {...}, intrusionPrevention: {...}, integrityMonitoring: {...}, logInspection: {...}, applicationControl: {...} }
ヒント
例を簡潔にするために、複数のプロパティ (オブジェクト) で構成される値は次のように表されます。。検索結果にすべての情報が表示されます。
- (オプション) キーワード変数の値を変更して、検索結果への影響を確認します。たとえば、次のように入力します。
keyword=%linux%
を再実行します。curl
コマンド。
次に進む前に
PowerShell
手順
- PowerShellを開きます。
- Managerがセキュアな接続を確立するために必要なTLS 1.2を使用するには、次のコマンドを入力します。
[Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12
- 次のコマンドを入力して、リクエストに関する詳細を保存します。
<YOUR URL>
のURLでServer & Workload Protection、 と<YOUR SECRET KEY>
API キーのシークレットを使用して:-
$url = "<YOUR URL>"
たとえば、url=https://cloudone.trendmicro.com
-
$secret = "<YOUR API KEY SECRET>"
たとえば、$secret="5C58EADA-04BC-4ABC-45CF-B72725A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8="
-
$headers = @{‘api-version’ = “v1”; ‘api-secret-key’ = $secret; 'Content-Type' = "application/json"}
-
- 次のコマンドを入力して、検索文字列を保存します。
<YOUR POLICY NAME>
検索するポリシーの名前の全部または一部を指定します。$keyword="%<YOUR POLICY NAME>%"
たとえば、$keyword="%Base Policy%"
- 次のコマンドを入力して、対応データを保存する JSON ファイルを指定します。
<FILE PATH>
作成するファイルと一緒に。 .json 拡張子が付いたファイル名を指定します。$file="<FILE PATH>"
たとえば、$file="$HOME\Documents\policy_search.json"
- 次のコマンドを入力して要求を送信します。
Invoke-RestMethod -Method 'Post' -Uri "$url/api/policies/search" -Headers $headers -Body @" {"searchCriteria": [ { "fieldName": "name", "stringTest": "equal", "stringValue": "$keyword", "stringWildcards": true } ]} "@ -OutFile $file
エラーメッセージが表示された場合The underlying connection was closed: An unexpected error occurred on a send
をクリックしてPowerShellを閉じ、再度PowerShellを開いて、手順を繰り返します。 - WebブラウザでJSONファイルを開きます。 (WebブラウザでJSONを読み取り可能な形式にする必要があります。)次の例のように、1つ以上のポリシーの配列を表すJSONコードが表示されます。
{ name: "Base Policy", description: "A policy from which all other policies can inherit. ", policySettings: {...}, recommendationScanMode: "ongoing", autoRequiresUpdate: "on", ID: 1, antiMalware: {...}, webReputation: {...}, sensingMode: {...}, firewall: {...}, intrusionPrevention: {...}, integrityMonitoring: {...}, logInspection: {...}, applicationControl: {...} }
ヒント
例を簡潔にするために、複数のプロパティ (オブジェクト) で構成される値は次のように表されます。。検索結果にすべての情報が表示されます。
- (オプション) キーワード変数の値を変更して、検索結果への影響を確認します。たとえば、次のように入力します。
keyword=%linux%
を再実行します。Invoke-RestMethod
コマンド
次に進む前に
備考
-
JSONファイルをテキストエディタで開くと、コードが1行で表示されて読みにくい場合があります。 Webブラウザは、JSONを読みやすい形式にする傾向があります。ブラウザでJSONが自動的にフォーマットされない場合は、フォーマットするブラウザプラグインをインストールすることを検討してください。
-
APIレファレンス/参照情報の200対応の例は、検索ポリシー操作では、検索可能なフィールドを示すポリシーフィールドについて説明します。