ソフトウェアの分類 (v2)

API でサポートされる操作

• カタログに存在する関係を使用した製品へのコンポーネント・インスタンスの割り当て
• カスタム・バンドルを使用した製品へのコンポーネント・インスタンスの割り当て。バンドルは WebUI で先に作成する必要があります。
• メトリック計算からの製品の除外と除外のクリア
• インベントリーからのコンポーネントの抑止と抑止のクリア
• Cloud Pak または FlexPoint バンドルへの製品の割り当て
• 1 回の呼び出しによる製品に対するコンポーネントおよび Cloud Pak に対する製品の割り当て
• カスタム・バンドル関係に基づいた製品と Cloud Pak へのコンポーネントの割り当て

許可

この API を使用するには、「エンドポイントの表示」権限および「ハードウェア・インベントリーの表示」権限が必要です。

リソース URL

https://hostname:port/api/sam/v2/software_instances?token=token

リソース情報

パラメーター

表 2. パラメーター以下にリストされているパラメーターはオプションです。必要に応じて、これらのパラメーターを照会に含めることができます。すべてのオプション・パラメーターの範囲外の値は無視されます。

パラメーター	説明	タイプ
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 に設定されています。	ブール値

会話例

1. コンポーネントの割り当て

   課金タイプが「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 
   } 

2. 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

   Response code: 207 
   Content-Type: application/json; charset=utf-8 
   { 
       "valid_instances": { 
        "Suppressed": 1 
       }, 
       "invalid_instances": {}, 
       "unmodified_instances": 0 
   } 

3. 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

   Response code: 207 
   Content-Type: application/json; charset=utf-8 
   { 
     "valid_instances": { 
      "Unsuppressed": 1 
     }, 
     "invalid_instances": {}, 
     "unmodified_instances": 0 
   } 

4. 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

   Response code: 207 
   Content-Type: application/json; charset=utf-8 
   { 
     "valid_instances": { 
       "Excluded": 1 
     }, 
     "invalid_instances": {}, 
     "unmodified_instances": 0 
   } 

5. 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

   Response code: 207 
   Content-Type: application/json; charset=utf-8 
   { 
     "valid_instances": { 
     "Included": 1 
     }, 
     "invalid_instances": {}, 
     "unmodified_instances": 0 
   } 

Cloud Pak または FlexPoint バンドルへの製品の割り当て

要求

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 に対する製品の割り当て

• 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
}

カスタム・バンドル関係に基づいた製品と Cloud Pak へのコンポーネントの割り当て

コンポーネントを製品に割り当て、次にカスタム・バンドル関係を使用して可能性として製品を Cloud Pak に割り当てるには、以下のフィールドが必要です。

• instance_id または以下を含むフィールドの組み合わせ。
  • コンピューターを識別するフィールド: computer_dns_name or computer_bigfix_id
  • ソフトウェアを識別するフィールド: discoverable_guid (その後で discovery_path パラメーターを使用して精度を上げることも可能)
• product_release_guid
• metric_id
• is_charged
• create_custom_bundling を 1 に設定、または createCustomBundling を HTTP PUT 要求全体に対してグローバルに設定。
• bundle_name または bundle_guid またはその両方 (Cloud Pak へのバンドルを同じ要求で実行する必要がある場合)

例 2

要求

PUT https://hostname:port/api/sam/v2/software_instances?createCustomBundling=true

要求ヘッダー

Accept: application/json 
             Accept-Language: en-US
             Token: <token>

要求本文

{
    "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
}

詳しくは、「チュートリアル: 2 台の BigFix Inventory サーバー間でのソフトウェア割り当ての移行」を参照してください。