ソフトウェアの分類 (v2)
9.2.14 から使用可能です。api/sam/v2/software_instances
エレメントに対して PUT
操作を使用して、ソフトウェアの分類を定義、変更、または移行することができます。
API でサポートされる操作
- カタログに存在する関係を使用した製品へのコンポーネント・インスタンスの割り当て
- カスタム・バンドルを使用した製品へのコンポーネント・インスタンスの割り当て。バンドルは WebUI で先に作成する必要があります。
- メトリック計算からの製品の除外と除外のクリア
- インベントリーからのコンポーネントの抑止と抑止のクリア
- FlexPoint オファリングまたは Cloud Pak への製品の割り当て
- 1 回の呼び出しによる製品に対するコンポーネントおよび Cloud Pak に対する製品の割り当て
権限
この API を使用するには、「エンドポイントの表示」権限および「ハードウェア・インベントリーの表示」権限が必要です。
リソース URL
https://hostname:port/api/sam/v2/software_instances?token=token
重要: この API を使用して、ソフトウェア・バンドルを更新または移行することができます。更新できるのは、ソフトウェア・カタログで定義されているか、以前に WebUI で手動で作成されたバンドルのみです。
リソース情報
操作の詳細 | 「説明」 |
---|---|
HTTP メソッド | PUT |
要求ヘッダー |
応答の言語をネゴシエーションします。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
要求フォーマット | application/json |
応答ヘッダー |
応答のコンテンツ・タイプを指定します。 |
応答のコンテンツの言語を指定します。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
|
応答ペイロード | n/a element |
応答フォーマット | application/json |
応答コード |
|
パラメーター
重要: コンポーネント・インスタンスを製品要求に割り当てるには、以下のパラメーターが必要です。
- token
- is_charged
- metric_id
- product_release_guid
- instance_id、または、以下のようなパラメーターの組み合わせ: コンピューターを識別するパラメーター:computer_dns_name または computer_bigfix_id と、ソフトウェアを識別するパラメーター:discoverable_guid (その後で discovery_path パラメータを使用して精度を上げることも可能です)。
パラメーター | 説明 | タイプ |
---|---|---|
instance_id | コンポーネント・インスタンスの識別子。 | 数字 |
computer_bigfix_id | BigFix で定義されているコンピューターの ID。 | 数字 |
computer_dns_name | コンピューターの DNS。 | ストリング |
discoverable_guid | コンポーネントの GUID。 | ストリング |
discovery_path | コンポーネントがインストールされているパス。BigFix 製品の場合のみ使用できます。BigFix 以外の製品の場合、戻り値は null です。 |
ストリング |
product_release_guid | プロダクト・リリース GUID。 | ストリング |
metric_id | 製品で使用されているライセンス・メトリックの ID。各 metric_id の意味については、以下を参照してください:メトリック ID およびコード名。 |
ストリング |
is_confirmed | 製品に対するコンポーネントの割り当てが確認されているかどうかの情報。 | ブール値 |
is_excluded | 製品が価格計算から除外されているかどうかの情報。 | ブール値 |
is_suppressed | コンポーネントがインストールされているコンピューターで抑止されているかどうかの情報。 | ブール値 |
exclusion_or_suppress_comment | 除外または抑止時に提供されたコメント。 | ストリング |
is_charged | 製品に対するコンポーネントの割り当てが課金対象かどうかの情報。 | ブール値 |
token | 固有のユーザー認証 ID。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。 | 英数字 |
verbose | API 要求の結果についての説明情報。デフォルトで、このパラメーターは false に設定されています。 | ブール値 |
simulate | このパラメーターを API 要求に追加することにより、呼び出しをテストして結果と状況を表示することができます。デフォルトで、このパラメーターは false に設定されています。 | ブール値 |
注: 単一の要求で複数の値を変更できます。例えば、単一の要求を使用してコンポーネントを再割り当てし、その状況を「確認済み」に変更することができます。
会話例
- コンポーネントの割り当て
課金タイプが「0」でメトリック ID が 6 のバンドルを使用して、ID 214 のコンポーネント・インスタンスを GUID 7E9162CD-B894-48B3-AFB7-1234567890AB の製品リリースに割り当てます。
- 要求
-
PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 Content-Type: application/json { "rows": [ { "instance_id": 214, "product_release_guid": "7E9162CD-B894-48B3-AFB7-1234567890AB", "metric_id": 6, "is_charged": 0 } ] }
- 応答本文
-
Response code: 207 Content-Type: application/json; charset=utf-8 { "valid_instances": { "Bundled": 1 }, "invalid_instances": {}, "unmodified_instances": 0 }
- BigFix Inventory から ID が 103 のコンポーネント・インスタンスを抑止します。
- 要求
-
PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 Content-Type: application/json { "rows": [ { "instance_id": 103, "is_suppressed": 1 } ] }
- 応答
-
Response code: 207 Content-Type: application/json; charset=utf-8 { "valid_instances": { "Suppressed": 1 }, "invalid_instances": {}, "unmodified_instances": 0 }
- ID 73 のコンポーネント・インスタンスの抑止をクリアします
- 要求
-
PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 Content-Type: application/json { "rows": [ { "instance_id": 73, "is_suppressed": 0 } ] }
- 応答
-
Response code: 207 Content-Type: application/json; charset=utf-8 { "valid_instances": { "Unsuppressed": 1 }, "invalid_instances": {}, "unmodified_instances": 0 }
- ID が 94 のコンポーネント・インスタンスに割り当てられた製品をメトリック計算から除外します
- 要求
-
PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 Content-Type: application/json { "rows": [ { "instance_id": 94, "is_excluded": 1 } ] }
- 応答
-
Response code: 207 Content-Type: application/json; charset=utf-8 { "valid_instances": { "Excluded": 1 }, "invalid_instances": {}, "unmodified_instances": 0 }
- ID が 58 のコンポーネント・インスタンスに割り当てられた製品の除外をクリアします
- 要求
-
PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 Content-Type: application/json { "rows": [ { "instance_id": 58, "is_excluded": 0 } ] }
- 応答
-
Response code: 207 Content-Type: application/json; charset=utf-8 { "valid_instances": { "Included": 1 }, "invalid_instances": {}, "unmodified_instances": 0 }
FlexPoint オファリングまたは Cloud Pak への製品の割り当て
製品を FlexPoint オファリングまたは Cloud Pak に割り当てるには、以下のフィールドが必要です。
- instance_id または以下を含むフィールドの組み合わせ。
- コンピューターを識別するフィールド:computer_dns_name または computer_bigfix_id
- ソフトウェアを識別するフィールド:discoverable_guid (その後で discovery_path パラメーターを使用して精度を上げることも可能)
- bundle_name または bundle_guid またはその両方
- 要求
-
PUT api/sam/v2/software_instances?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 { "rows": [ { "instance_id":4, "bundle_name":"Unified Governance \u0026 Integration" } ] }
- 応答ヘッダー
-
207 - OK
- 応答本文
-
{ "valid_instances": {"Assigned to CloudPak":1}, "invalid_instances":{}, "unmodified_instances":0 }
1 回の呼び出しによる製品に対するコンポーネントおよび Cloud Pak に対する製品の割り当て
1 つの REST API 呼び出しでコンポーネントを製品に割り当て、次に製品を Cloud Pak に割り当てるには、以下のフィールドが必要です。
- instance_id または以下を含むフィールドの組み合わせ。
- コンピューターを識別するフィールド:computer_dns_name または computer_bigfix_id
- ソフトウェアを識別するフィールド:discoverable_guid (その後で discovery_path パラメーターを使用して精度を上げることも可能)
- product_release_guid
- metric_id
- is_charged
- bundle_name または bundle_guid またはその両方
- 要求
-
PUT api/sam/v2/software_instances?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 { "rows": [ { "instance_id":1423, "product_release_guid":"1bde5fc0-0e29-496a-b581-bacdaa75810f", "metric_id":5, "is_charged":1, "bundle_name":"IBM Db2 Standard Edition Extension for IBM Cloud Pak for Data" } ] }
- 応答ヘッダー
-
207 - OK
- 応答本文
-
{ "valid_instances": { "Bundled":1, "Assigned to CloudPak":1 }, "invalid_instances":{}, "unmodified_instances":0 }
会話例 - BigFix サーバー間でのソフトウェア割り当ての移行
詳しくは、下記を参照してください。チュートリアル: 2 台の BigFix サーバー間でのソフトウェア割り当ての移行。