Classification des logiciels (v2)

L'API prend en charge les actions suivantes

• Affectation d'une instance de composant à un produit à l'aide d'une relation existante dans un catalogue
• Affectation d'une instance de composant à un produit à l'aide d'un regroupement personnalisé. Le regroupement doit être créé précédemment dans WebUI.
• Exclusion de produits du calcul de métrique et effacement de l'exclusion
• Suppression du composant du stock et effacement de la suppression
• Affectation d'un produit à une offre FlexPoint ou à un Cloud Pak
• Affectation d'un composant à un produit et à un produit à un Cloud Pak dans un seul appel

Permissions

Vous devez disposer des droits Afficher les nœuds finaux et Afficher l'inventaire matériel pour utiliser cette API.

URL de la ressource

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

Informations sur les ressources

Paramètres

Tableau 2. ParamètresLes paramètres répertoriés ci-dessous sont facultatifs. Vous pouvez les inclure dans votre requête en fonction de vos besoins. Pour tous les paramètres facultatifs, les valeurs situées en dehors de la plage admise sont ignorées.

Paramètre	Description	Type
instance_id	Identificateur de l'instance de composant.	Numérique
computer_bigfix_id	Identificateur de l'ordinateur, tel que défini dans BigFix.	Numérique
computer_dns_name	Serveur de noms de domaine de l'ordinateur.	Chaîne
discoverable_guid	Identificateur global unique du composant.	Chaîne
discovery_path	Chemin d'accès sous lequel le composant est installé. Disponible uniquement pour les produits BigFix. Pour les produits non BigFix, la valeur renvoyée est null.	Chaîne
product_release_guid	Identificateur global unique de la version du produit.	Chaîne
metric_id	Identificateur de la métrique de licence utilisée par le produit. Pour plus d'informations sur la signification de chaque metric_id, voir : ID et noms de code de métrique.	Chaîne
is_confirmed	Indique si l'affectation du composant au produit est confirmée.	Valeur boléenne
is_excluded	Indique si le produit est exclu des calculs de tarification.	Valeur boléenne
is_suppressed	Indique si le composant est supprimé sur l'ordinateur sur lequel il est installé.	Valeur boléenne
exclusion_or_suppress_comment	Commentaire fourni lors de l'exclusion ou de la suppression.	Chaîne
is_charged	Informations indiquant si l'affectation d'un composant à un produit est modifiée.	Valeur boléenne
Jeton	Identificateur d'authentification utilisateur unique. Vous pouvez l'extraire en utilisant l'API REST pour l'extraction du jeton d'authentification. Vous pouvez également vous connecter à BigFix Inventory, survoler l'icône Utilisateur et cliquer sur Profil. Cliquez ensuite sur Afficher le jeton.	Alphanumérique
verbose	Informations décrivant le résultat d'une demande d'API. Par défaut, ce paramètre est associé à la valeur false.	Valeur boléenne
simulate	En ajoutant ce paramètre à la demande d'API, vous pouvez tester l'appel pour afficher ses résultats et son statut. Par défaut, ce paramètre est associé à la valeur false.	Valeur boléenne

Exemple de conversation

1. Affectation d'un composant

   Affectez une instance de composant avec ID 214 à une édition de produit avec GUID 7E9162CD-B894-48B3-AFB7-1234567890AB en utilisant le regroupement avec la métrique avec ID 6 qui a facturé le type "0".

   Demande

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

   Corps de la réponse

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

2. Supprimez une instance de composant avec ID 103 de BigFix Inventory.

   Demande

   PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 
   Content-Type: application/json 
   { 
     "rows": [ 
       { 
         "instance_id": 103, 
         "is_suppressed": 1 
       } 
     ] 
   } 

   Réponse

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

3. Effacer la suppression d'une instance de composant avec ID 73

   Demande

   PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 
   Content-Type: application/json 
   { 
     "rows": [ 
       { 
         "instance_id": 73, 
         "is_suppressed": 0 
       } 
     ] 
   } 

   Réponse

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

4. Exclure du calcul de métrique le produit affecté à l'instance de composant avec ID 94

   Demande

   PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 
   Content-Type: application/json 
   { 
     "rows": [ 
       { 
         "instance_id": 94, 
         "is_excluded": 1 
       } 
     ] 
   } 

   Réponse

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

5. Effacer l'exclusion d'un produit affecté à une instance de composant avec ID 58

   Demande

   PUT https://example.com:9081/api/sam/v2/software_instances?token=1234567890abcdef1234567890abcdef12345678 
   Content-Type: application/json 
   { 
     "rows": [ 
       { 
         "instance_id": 58, 
         "is_excluded": 0 
       } 
     ] 
   } 

   Réponse

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

Affectation d'un produit à une offre FlexPoint ou à un Cloud Pak

Demande

PUT api/sam/v2/software_instances?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
{
    "rows": [
        {
         "instance_id":4,
         "bundle_name":"Unified Governance \u0026 Integration"
        }
    ]
}

En-tête de réponse

207 - OK

Corps de la réponse

{
"valid_instances":
         {"Assigned to CloudPak":1},
"invalid_instances":{},
"unmodified_instances":0
}

Affectation d'un composant à un produit et un produit à un Cloud Pak dans un seul appel

• product_release_guid
• metric_id
• is_charged
• bundle_name ou bundle_guid ou les deux

Demande

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

En-tête de réponse

207 - OK

Corps de la réponse

{
"valid_instances":
        {
        "Bundled":1,
        "Assigned to CloudPak":1
        },
"invalid_instances":{},
"unmodified_instances":0
}

Exemple de conversation - Migration des affectations de logiciels entre des serveurs BigFix

Pour plus d'informations, voir : Tutoriel : Migration des affectations de logiciels entre des serveurs BigFix.