ソフトウェア・インベントリーの取得 (v2)
9.2.8 から使用可能です。 インフラストラクチャーにインストールされているソフトウェアに関する情報を要求するには、api/sam/v2/software_instances エレメントに対して GET 操作を使用します。この API は、既存のコンポーネントの詳細、および削除されたコンポーネントに関する履歴データを返します。
権限
この API を使用するには、「エンドポイントの表示」権限および「ハードウェア・インベントリーの表示」権限が必要です。
リソース URL
https://hostname:port/api/sam/v2/software_instances?token=tokenリソース情報
| 操作の詳細 | 「説明」 |
|---|---|
| HTTP メソッド | GET |
| 要求ヘッダー |
応答の言語をネゴシエーションします。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
| 要求フォーマット | application/json |
| 応答ヘッダー |
応答のコンテンツ・タイプを指定します。 |
応答のコンテンツの言語を指定します。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
|
| 応答ペイロード | Software Instances element |
| 応答フォーマット | application/json |
| 応答コード |
|
スキーマの説明
この REST API によって返されるすべての列のリストをその説明と一緒に取得するには、次の要求を使用します。
GET api/sam/v2/schemas/software_instance.json?token=<token>選択可能な列
| 列 | 「説明」 | デフォルトで表示 | タイプ |
|---|---|---|---|
| instance_id | コンポーネント・インスタンスの識別子。 | 数字 | |
| computer_id | BigFix Inventory で定義されているコンピューターの ID。 | 数字 | |
| computer_bigfix_id | BigFix で定義されているコンピューターの ID。 | 数字 | |
| computer_dns_name | コンピューターの DNS。 | string | |
| computer_name | コンピューターの名前。 | ✓ | ストリング |
| computer_ip_address | コンピューターの IP アドレス。 | ✓ | ストリング |
| computer_os | コンピューターのオペレーティング・システム。 | ストリング | |
| computer_os_type | コンピューターのオペレーティング・システムのタイプ。 | ストリング | |
| component_name | コンポーネント名。 | ✓ | ストリング |
| component_release | コンポーネントのリリース番号。 | ✓ | ストリング |
 component_detailed_version |
ソフトウェア・コンポーネントの詳細バージョン。バージョンはソフトウェア・シグニチャーとして使用されます。ソフトウェア・バージョンは、特定のパッケージ、SWID タグの最高バージョン、Windows ファイル、拡張シグニチャー・レポートなど、いくつかの方法で検出されます。パッケージに基づくディスカバリーは、BigFix Inventory  以降、使用可能です。 |
string | |
| discoverable_guid | コンポーネントの GUID。 | ストリング | |
| discoverable_family_guid | コンポーネント・ファミリーの GUID。例えば、コンポーネントが IBM DB2 Enterprise Server Edition の場合、コンポーネント・ファミリーは IBM DB2 です。 | ストリング | |
| component_publisher_name | コンポーネントの発行者。 | ストリング | |
| component_has_usage | コンポーネントの使用状況データが使用可能かどうかの情報。 | ブール値 | |
| is_present | コンポーネントがまだ環境にインストールされているかどうかの情報。 | ブール値 | |
| discovery_start | コンポーネントが初めてレポートされた日時。時間は、GMT タイム・ゾーンで示されます。 | ✓ | ストリング |
| discovery_end | コンポーネントが最後にレポートされた日時。時間は、GMT タイム・ゾーンで示されます。 | ✓ | ストリング |
| discovery_path | コンポーネントがインストールされているパス。BigFix Inventory バージョン 10.0.2 より前は、IBM 製品に対してのみ使用可能でした。BigFix Inventory 10.0.2 以降、すべての製品で使用可能です。 | ✓ | ストリング |
| product_name | コンポーネントが割り当てられている製品の名前。 | ✓ | string |
 product_guid |
製品 GUID。例えば、製品が IBM DB2 Enterprise Server Edition 10.5 の場合、製品リリースは IBM DB2 Enterprise Server Edition です。 | string | |
| product_family_guid | 製品ファミリー GUID。例えば、製品が IBM DB2 Enterprise Server Edition の場合、製品ファミリーは IBM DB2 です。 | ストリング | |
| product_publisher_name | 製品の発行者。 | ストリング | |
| product_release_name | コンポーネントが割り当てられている製品リリースの名前。 | ストリング | |
| product_release | 製品リリース番号。 | ✓ | ストリング |
| product_release_guid | プロダクト・リリース GUID。 | ストリング | |
| metric_id | 製品で使用されているライセンス・メトリックの ID。各 metric_id の意味については、以下を参照してください:メトリック ID およびコード名。 |
ストリング | |
| metric_code_name | 製品で使用されているライセンス・メトリックの固有のコード名。各 metric_code_name の意味については、以下を参照してください:メトリック ID およびコード名。 |
ストリング | |
| is_confirmed | 製品に対するコンポーネントの割り当てが確認されているかどうかの情報。 | ブール値 | |
| is_excluded | 製品が価格計算から除外されているかどうかの情報。 | ブール値 | |
| is_suppressed | コンポーネントがインストールされているコンピューターで抑止されているかどうかの情報。 | ✓ | ブール値 |
| exclusion_or_suppress_comment | 除外または抑止時に提供されたコメント。 | ストリング | |
 bundle_id |
ソフトウェア・インスタンスがバンドルされている FlexPoint オファリングまたは CloudPak の ID。使用可能な値は、以下のとおりです。
|
ストリング | |
| bundle_name |
ソフトウェア・インスタンスが割り当てられている FlexPoint オファリングまたは Cloud Pak の名前。使用可能な値は、以下のとおりです。
|
string | |
| bundle_type |
ソフトウェア・インスタンスが割り当てられているバンドルのタイプ。使用可能な値は、以下のとおりです。
|
数字 | |
| bundle_guid |
ソフトウェア・インスタンスが割り当てられている FlexPoint オファリングまたは Cloud Pak の GUID。使用可能な値は、以下のとおりです。
|
string | |
| is_vulnerable |
共通脆弱性と暴露 (CVE) がコンポーネントに一致するかどうかの情報。使用可能な値は、以下のとおりです。
|
ブール値 | |
 is_charged |
製品に対するコンポーネントの割り当てが確認されているかどうかの情報。 | ブール値 | |
| is_entitled |
特定の製品をソフトウェア資格として宣言したかどうかの情報。 | ブール値 |
適用可能な関連付け
以下の関連付けからデータを追加で取得できます。
重要: すべての関連付けは、インフラストラクチャー内に現在存在している項目に関するデータを提供します。削除されたコンピューターおよびアンインストールされたソフトウェアについては、これらの関連付けは
null を返します。照会パラメーター
| パラメーター | 「説明」 | 必須 | 値 |
|---|---|---|---|
| columns | 取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。 例: 製品名とリリースの取得 |
ストリング | |
| order | 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。 例: コンピューター ID の降順での並び替え |
英数字 | |
| 限界値 | 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。 例: 100 件のレコードの取得 |
数字 | |
| offset | 結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。 例: レコード 150 の後から始まる 50 件のレコードの取得 |
数字 | |
| token | 固有のユーザー認証 ID。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコン にカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。 |
✓ | 英数字 |
| criteria | 特定の条件と合致するレコードを取得します。このパラメーターでは、以下の構造が 1 行で記述されている必要があります。 演算子について詳しくは、以下を参照してください。「共通のコネクターおよび演算子」。 例: 製品名に「BigFix」が含まれているか、ディスカバリー開始が特定の日付範囲内であるソフトウェア・インスタンスの取得 日時の値を使用する列の場合、特定の日付の代わりにある期間のデータを取得することもできます。これを行うには、last または next を <operator> として使用し、次の規則で時刻の値を指定します。PxD/PxW/PxM/PxY。ここで、x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。 例: ライセンス使用状況のピークに寄与したソフトウェア・インスタンスを取得します。ピークの日時は次のとおりです。2018-10-10T00:00:00+00:00Z. 照会は、以下の基準を満たすインスタンスを検索します: 製品名に「DB2」 が含まれ、かつ指定されたメトリックを使用し、かつピーク内に検出を開始しているインスタンス。 PVU、RVU MAPC、および VPC の場合 その他のメトリックの場合 例: 過去 7 日間に初めて報告されたソフトウェア・インスタンスの取得 |
ストリング |
会話例 - デフォルトの列
- 要求
-
GET api/sam/v2/software_instances?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US - 応答本文
-
[{ "computer_name":"NC107069", "computer_ip_address":["10.0.107.69"], "component_name":"BigFix Platform Agent", "component_release":"9.0", "is_present":1, "discovery_start":"2016-04-28T15:37:26Z", "discovery_end":"2016-11-17T15:11:10Z", "discovery_path":"/opt/BESClient/bin/properties/version", "product_name":"BigFix for Power Management", "product_release":"9.0" }]
会話例 - すべての列
- 要求
-
GET api/sam/v2/software_instances?columns[]=discovery_path &columns[]=instance_id&columns[]=computer_id&columns[]=computer_bigfix_id &columns[]=computer_dns_name&columns[]&columns[]=computer_name &columns[]=computer_ip_address&columns[]=computer_os&columns[]=computer_os_type &columns[]=component_name&columns[]=component_release&columns[]=discoverable_guid &columns[]=component_publisher_name&columns[]=component_has_usage&columns[]=is_present &columns[]=discovery_start&columns[]=discovery_end&columns[]=product_name &columns[]=product_publisher_name&columns[]=product_release_name&columns[]=product_release &columns[]=metric_id&columns=metric_code_name&columns[]=is_confirmed &columns[]=is_excluded&columns[]=is_suppressed&columns[]=exclusion_or_suppress_comment &token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US - 応答本文
-
[{ "instance_id":1, "computer_id":3, "computer_bigfix_id":null, "computer_dns_name":"NC107069", "computer_name":"NC107069", "computer_ip_address":"10.0.107.69", "computer_os":"AIX 5.3", "computer_os_type":"AIX", "component_name":"BigFix Platform Agent", "component_release":"9.0", "discoverable_guid":"0768FB15-383C-4124-A7E2-0D76DDA06874", "component publisher name":"IBM", "component_has_usage":1, "is_present":0, "discovery_start":"2016-04-28T15:37:26Z", "discovery_end":"2016-11-17T15:11:10Z", "discovery_path":"/opt/BESClient/bin/properties/version", "product_name":"BigFix for Power Management", "product_publisher_name":"IBM", "product_release_name":"BigFix for Power Management", "product_release":"9.0", "metric_id":"6", "metric_code_name":"INTERNAL_RVU_MAPC", "is_confirmed":0, "is_excluded":0, "is_suppressed":0, "exclusion_or_suppress_comment":null }]
会話例 - 追加の列
- 要求
-
GET api/sam/v2/software_instances?columns[]=component_name &columns[]=product_name&columns[]=is_confirmed &token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US - 応答本文
-
[{ "component_name":"BigFix Platform Agent", "product_name":"BigFix for Power Management", "is_confirmed":0 }]
会話例 - 関連付け
- 要求
-
GET api/sam/v2/software_instances?columns[]=computer_id &columns[]=computer_health.catalog_version &token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US
- 応答本文
-
[{ "computer_id":1, "catalog_version":1304630 }]