コンピュータのリストを取得する（BashおよびPowerShell）

ビュー:

Workload Securityが保護している (または検出した) コンピュータのリストを取得し、返されたデータを各コンピュータのセキュリティステータスを含むように絞り込みます。List Computers操作を使用してコンピュータのリストを取得します。オプションのexpandクエリパラメータを使用してステータス情報に焦点を当てます。

コンピュータを一覧表示すると、デフォルトで利用可能なすべてのコンピュータ情報が返されます。expand クエリパラメータを使用すると、関心のある情報のみが返されます。最低限、各コンピュータの基本情報 (コンピュータID、ポリシーID、プラットフォームなど) が返されます。

expandクエリ文字列を含めない場合、すべてのコンピュータ情報が返されます。

返される情報のカテゴリ	`expand`のサポートされている値
最小情報	`なし`
すべての情報	`すべて`(デフォルト)
現在のステータス	`computerStatus`, `securityUpdates`,`tasks`
設定	`コンピューター設定`,`インターフェース`
セキュリティモジュールの設定	`allSecurityModules`(すべてのモジュールの情報を含む)、`antiMalware`、`applicationControl`、`ファイアウォール`、`integrityMonitoring`、`intrusionPrevention`、`logInspection`、`SAP`、`webReputation`
仮想マシン情報	`allVirtualMachineSummaries`(すべての種類の仮想マシンの情報を含む)、`azureARMVirtualMachineSummary`、`azureVMVirtualMachineSummary`、`ec2VirtualMachineSummary`、`ESXSummary`、`noConnectorVirtualMachineSummary`、`vcloudVMVirtualMachineSummary`、`vmwareVMVirtualMachineSummary`、`workspaceVirtualMachineSummary`、

開始前の準備

お使いの環境がBashまたはPowerShellを使用してAPIを利用するように設定されていることを既に確認しているはずです。

このレシピを完了するために必要な次の情報を収集します。

Workload SecurityのURL
APIキーの秘密鍵

Bash

ターミナルまたは使用しているコマンドラインツールを開きます。
次のコマンドを入力してリクエストの詳細を保存します。<YOUR URL>をWorkload SecurityのURLに、<YOUR SECRET KEY>をAPIキーのシークレットに置き換えてください。
- url=<YOUR URL>
  
  例えば、url=https://cloudone.trendmicro.com
- secret=<YOUR SECRET KEY>
  
  例えば、secret=5C58EADA-04BC-4ABC-45CF-B72925A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8=
- expand=computerStatus
以下のコマンドを入力して、対応データを保存するJSONファイルを指定します。<FILE PATH>を作成するファイルに置き換えてください。.json拡張子を持つファイル名を指定してください。

file=<FILE PATH>

例えば、file=~/Documents/computers_status.jsonはファイルをホームディレクトリに保存します。
リクエストを送信するには、次のコマンドを入力します。

curl -X GET "$url/api/computers?expand=$expand" -H "api-secret-key: $secret" -H "api-version: v1" > $file

返されたJSONを端末で読みやすい形式で表示するには (ファイルに書き込む代わりに)、cURLコマンドの結果をjqにパイプします。前述のコマンドでは、> $fileを| jq .に置き換えてください。
JSONファイルをウェブブラウザで開いてください。ウェブブラウザはJSONを読みやすい形式に整形するはずです。コンピュータの配列を表すJSONコードが表示されます。各コンピュータは次の例に似たコードで表されています。
```
{
    "hostName": "gui2-336",
    "displayName": "",
    "description": "",
    "lastIPUsed": "127.0.1.1",
    "platform": "Unknown",
    "groupID": 0,
    "policyID": 1,
    "relayListID": 0,
    "lastSendPolicyRequest": 1566335191390,
    "agentVersion": "0.0.0.0",
    "computerStatus": {
        "agentStatus": "inactive",
        "agentStatusMessages": [
            "Unmanaged (Unknown)"
        ]
    },
    "ID": 201
}
```
computerStatusキーにはステータス情報が含まれています。この例では、コンピュータは保護されていません。
オプションとして、expand変数の値を変更して、返されるJSONにどのように影響するかを確認してみてください。例えば、expand=computerPropertiesと入力して、curlコマンドを再実行してください。

PowerShell

PowerShellを起動します。
TLS 1.2を使用するには、次のコマンドを入力します.TLS 1.2は、セキュリティで保護された接続を確立するためにManagerで必要となります。
[Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12
次のコマンドを入力してリクエストの詳細を保存します。<YOUR URL>をWorkload SecurityのURLに、<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}
- $expand="computerStatus"
次のコマンドを入力して、レスポンスデータを保存するJSONファイルを指定します。<FILE PATH>を作成するファイルに置き換えてください。.json拡張子のファイル名を指定します。

$file="<ファイルパス>"

例えば、$file="$HOME\Documents\computers_status.json"はホームディレクトリの下にファイルを保存します。
リクエストを送信するには、次のコマンドを入力します。
Invoke-RestMethod "$url/api/computers?expand=$expand" -Headers $headers -OutFile $file
WebブラウザでJSONファイルを開きます。WebブラウザはJSONを読み取り可能にフォーマットする必要があります。コンピュータの配列を表すJSONコードが表示されます。各コンピュータは、次の例のようなコードで表されます。
```
{
    "hostName": "gui2-336",
    "displayName": "",
    "description": "",
    "lastIPUsed": "127.0.1.1",
    "platform": "Unknown",
    "groupID": 0,
    "policyID": 1,
    "relayListID": 0,
    "lastSendPolicyRequest": 1566335191390,
    "agentVersion": "0.0.0.0",
    "computerStatus": {
        "agentStatus": "inactive",
        "agentStatusMessages": [
            "Unmanaged (Unknown)"
        ]
    },
    "ID": 201
}
```
computerStatusキーにはステータス情報が含まれています。この例では、コンピュータは保護されていません。
オプションとして、expand変数の値を変更して、返されるJSONにどのように影響するかを確認してみてください。例えば、$expand="computerProperties"と入力してInvoke-RestMethodコマンドを再実行します。

次の点に注意してください。

テキストエディタでJSONファイルを開くと、コードは1行に表示され、読みにくいものになります。WebブラウザはJSONを読みやすくするように書式を設定する傾向があります。ブラウザでJSONが自動的にフォーマットされない場合は、ブラウザプラグインをインストールすることをお勧めします。
複数の値をexpandクエリパラメータに含めるには、APIコールのURLに各値のexpandクエリ文字列を含める必要があります。例えば、?expand=computerStatus&expand=computerProperties

コンピュータのリストを取得する（BashおよびPowerShell）

開始前の準備

Bash

PowerShell

関連リソース