コンピューター・システムの取得

インフラストラクチャー内のコンピューター・システムに関する情報を要求するには、api/sam/computer_systems エレメントに対して GET 操作を使用します。

重要: この REST API は、 api/sam/v2/computers REST API に完全に置換される予定です。api/sam/computer_systems REST API に基づいているカスタム・ツールまたは内部プロセスがある場合は、新しいバージョンの API を使用するようにツールを調整することをお勧めします。これに関する情報については、以下を参照してください。computer_systems REST API と v2/computers REST API の列のマッピング

この API は、物理コンピューター・システムおよび仮想コンピューター・システムに関する情報を取得します。BigFix クライアントがインストールされているコンピューターは別として、これにはクライアントがデプロイされていないホスト・システムも含まれています。これは、一部の仮想化タイプ (VMware ESXi や IBM PowerVMなど) では、ホスト・レベルでのソフトウェアのインストールが許可されていないためです。しかし、サーバーとその仮想マシン間の適切な階層を構築し、PVU および RVU 使用量を正しく報告するには、このようなホスト・コンピューター・システムに関連するデータを取得する必要があります。

type プロパティーは、コンピューター・システムがホスト・コンピューターであるのか、仮想コンピューターであるのかを決定します。ホストには、例えば、エージェントがインストールされたラップトップ、ESX ハイパーバイザー、および仮想化サーバーが考えられます。仮想マシンと呼ばれるのは、ホスト上にデプロイ可能な仮想マシンのみです。したがって、REST API の結果は、単一レポート、特にコンピューター・レポートおよびハードウェア・インベントリー・レポートとは比較しないでください。

コンピューター・システムに関する情報を取得するには、次の URL を使用します。
https://hostname:port/api/sam/computer_systems?token=token
重要:
  • この API を使用するには、「すべてのコンピューター」グループに割り当てられていて、「ハードウェア・インベントリーの表示」権限が付与されている必要があります。
  • 各 API 要求は、token パラメーターを使用して認証する必要があります。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコン「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。
  • デフォルトでは、取得したデータは id 別にソートされます。
1. 操作の説明
操作の詳細 「説明」
操作 GET /api/sam/computer_systems
目的 コンピューター・システムのリストを返します。
HTTP メソッド GET
リソース URI https://server_host_name:port_number/api/sam/computer_systems
URL リンク関係 n/a
URI 照会パラメーター 適用可能な照会パラメーターのリストについては、以下を参照してください。「照会パラメーター」
要求ヘッダー
ヘッダー
Accept-Language (オプション)
en-US (英語のみをサポート)

応答の言語のネゴシエーションに使用されます。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。

要求ペイロード n/a
要求 Content-Type
  • application/json
応答ヘッダー
ヘッダー
Content-Type
application/json

応答のコンテンツ・タイプを指定します。

ヘッダー
Content-Language
en-US, …

応答のコンテンツの言語を指定します。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。

ヘッダー
Import-Mode
noneidlerunningpending

データ・インポートの状況を示します。

ヘッダー
Import-Progress
パーセント値 (例: 59)。

データ・インポートの進行状況をパーセントで示します。

ヘッダー
Import-Last-Status
successfulfailed

最後のデータ・インポート状況を示します。

ヘッダー
Import-Last-Success-Time
日付 (例: 2014-06-18T04:00:29Z)。

最後の正常なデータ・インポートの時刻を示します。

応答ペイロード Computer Systems element
応答 Content-Type
  • application/json
正常な HTTP 応答コード
  • 200 - OK
エラーの HTTP 応答コード
  • 500 – "Bad Request" 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

メッセージの本文にはエラー・メッセージと詳細が含まれます。

照会パラメーター

照会パラメーターは、検索結果の絞り込みに使用できます。以下の表は、api/sam/computer_systems エレメントに対して使用できる照会パラメーターを示しています。
2. ソフトウェア製品を取得するための照会パラメーター
パラメーター 「説明」 必須
columns[] 取得する列を指定します。このパラメーターを指定しない場合は、一連のデフォルトの列が取得されます。使用可能な列については、応答の本文を参照してください。例:
名前とバージョンの列を取得します。
URL?columns[]=name&columns[]=version
いいえ ストリング
order 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。例:
タイプの降順で並び替えるには、次のように指定します。
URL?order[]=type desc
いいえ ストリング
限界値 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。 いいえ 数字
offset 結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。例:
レコード 150 の後から始まる 50 件のレコードを取得するには、次のとおり指定します。
URL?limit=50&offset=150
いいえ 数字
token 固有のユーザー認証 ID。自分のトークンは、BigFix Inventory の「プロファイル」設定に表示できます。 はい 英数字
criteria 特定の条件と合致するレコードを取得します。このパラメーターでは、以下の構造が 1 行で記述されている必要があります。
<criteria> ::= <left-brace> <boolean-operator><colon> <left-bracket> 
<criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace>
<boolean-operator> ::= "and" | "or"
<criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket>
<column> ::= <json-string>
<operator> ::= <json-string>
<value> ::= <json-array> | <json-string> | <json-numver> | <json-null>

演算子について詳しくは、共通のコネクターおよび演算子を参照してください。

例: オペレーティング・システムに「AIX」または特定の日付範囲の前回表示日が含まれているコンピューター・システムを取得するには、次のとおり指定します。
URL?criteria={ "or": [ ["os", "contains", "aix"], 
{ "and": [ ["last_seen", ">", "1970-01-01T00:00:00+00:00Z"], 
["last_seen", "<", "1970-01-02T00:00:00+00:00Z"] ] } ] }
「前回表示日時」など、日時の値を使用する列の場合、特定の日付の代わりにある期間のデータを取得することもできます。これを行うには、last または next<operator> として使用し、次の規則で時刻の値を指定します。PxD/PxW/PxM/PxY。ここで、x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。例えば、過去 7 日間の間にレポートしたコンピューター・システムを取得するには、次の API 要求を使用します。
URL?criteria={"and":[["last_seen","last","P7D"]]}

HTTP 会話の例

要求
GET api/sam/computer_systems
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
応答ヘッダー
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
上記の応答ヘッダーの後には、Import-Mode で表わされるデータ・インポートの現在の状況に応じてそれぞれ異なる項目が続きます。返される値について理解するために、以下の定義を確認してください。
  • none - データ・インポートが一度も開始されていない
  • idle - データ・インポートは現在実行されていない
  • running - データ・インポートは進行中
  • pending - ユーザー・インターフェースで実行されるアクションが、データ・インポートを開始して変更を有効にすることを必要とする
データ・インポートが一度も開始されていない場合:
Import-Mode: none
データ・インポートが進行中の場合:
Import-Mode: running
Import-Progress: 41
データ・インポートが実行されていない場合:
Import-Mode: idle/pending
Import-Last-Status: successful
Import-Last-Success-Time: Mon, 23 Jun 2014 12:18:29 GMT
応答の本文 (JSON)
特定の項目がデフォルトで非表示になっている場合、一般 URL を使用してもその項目は取得されません。このようなデータを取得するには、照会パラメーターを使用して、非表示の列の名前を指定する必要があります。例えば、以下に示すように、columns[] パラメーターを使用して、server_id 列および datasource_id 列を取得できます。
URL?columns[]=server_id&columns[]=datasource_id
{	
 "id": 25,
 "parent_id"=9,                        //ID of a host for a VM 
 "computer_id": 2,                     //hidden by default
 "computer_remote_id": 123,            //hidden by default
 "server_id": 24,                      //hidden by default
 "datasource_name"="Data source",      //hidden by default
 "datasource_id"=1,                    //hidden by default
 "type"="virtual",                     //type: virtual or host
 "os": "Linux Red Hat Enterprise Server 6.2)",
 "host_name": "NC040221",
 "dns_name": "NC040221.kraklab.pl.ibm.com",
 "ip_address": [
    "9.167.40.221",
    "192.168.122.1" ],
 "last_seen": "2014-04-08T14:33:41Z",
 "hardware_manufacturer": "IBM",
 "hardware_model": "System x3550 M2 -[794662G]-", 
 "hardware_serial_number": "99B7166",
 "hardware_type": "7946",              //hidden by default
 "hardware_name": "IBM Corp. 7946",    //hidden by default
 "processor_brand_string": "Intel(R) Xeon(R) CPU E7-3400 @ 2.40GHz",
 "processor_type": "Multi-core",
 "processor_brand": "Xeon(R)",
 "processor_vendor": "Intel(R)",
 "processor_model": "3400-3699 or 5500-5699",
 "partition_cores" : 1,                //null for host serves
 "server_processors": 1,
 "server_cores": 8,
 "pvu_per_core": 70,                   //hidden by default
 "uuid":"50305bd3-1f09-7294-7033-b903767d4605" //hidden by default
 "cluster_id":"1"                      // hidden by default 
}		//ID of the cluster to which the computer system
 		belongs. Available only for type: host.