Définition des seuils de métrique de licence et des zones personnalisées (v2)

Disponible à partir de la version 9.2.10. Utilisez l'opération PUT sur l'élément api/sam/v2/license_usage pour configurer les seuils des métriques de licence, ainsi que les valeurs de zones personnalisées ajoutées dans le rapport Toutes les métriques.

Droits

Utilisateur Vous devez disposer du droit Gérer les contrats pour utiliser cette API.

URL de la ressource

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

Informations sur les ressources

Tableau 1. Informations sur les ressources
Détails de l'opération	Description
Méthode HTTP	`PUT`
En-têtes de demande	Fonction métier `Accept-Language` (Facultatif) Valeurs en-US (seul l'anglais est pris en charge) Négocie la langue de la réponse. Si l'en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Format de demande	`application/json`
En-têtes de réponse	En-tête `Content-Type` Valeurs `application/json` Définit le type de contenu de la réponse.
	En-tête `Content-Language` Valeurs en-US, … Définit la langue du contenu de la réponse. Si l'en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
	En-tête `computerGroupId` Valeurs éntier Indique l'ID du groupe d'ordinateurs pour lequel les valeurs sont modifiées.
Charge de la réponse	n/a
Format de réponse	`application/json`
Codes de réponse	`200 – OK` `400 – "Bad Request"` Si un paramètre contient des erreurs `401 – "Unauthorized user"` si l'utilisateur dont le jeton est utilisé pour l'authentification n'est pas autorisé à accéder aux données `404 – "Not Found"` si un paramètre n'existe pas `406 – "Not Acceptable`" si l'importation est en cours et que les valeurs ne peuvent pas être modifiées. Pour plus d'informations sur la vérification du statut de l'importation, voir : Exécution d'importations de données.

Description de schéma

Pour extraire la liste de toutes les colonnes utilisées par cette API REST, ainsi que leurs descriptions, utilisez la demande suivante :

GET api/sam/v2/schemas/license_usage.json?token=token

Paramètres de requête

Tableau 2. Paramètres de requête
Colonne	Description	Obligatoire	Type
computerGroupId	Identificateur du groupe d'ordinateurs pour lequel vous souhaitez mettre à jour les valeurs. Si vous n'indiquez pas ce paramètre, les valeurs sont mises à jour pour le groupe d'ordinateurs de l'utilisateur dont le jeton est utilisé pour l'authentification. Pour afficher les ID des groupes d'ordinateurs, connectez-vous à BigFix Inventory et accédez à Rapports > Groupes d'ordinateurs. Ensuite, survolez l'icône Gérer la vue de rapport , puis cliquez sur Configurer la vue et sélectionnez la colonne d'ID pour l'afficher sur le rapport.
bundle_id	ID du groupement FlexPoint ou du Cloud Pak auquel le produit est affecté.	✓	éntier
product_id	Identificateur du produit logiciel.	✓	éntier
metric_id	Identificateur de la métrique de licence. Pour la liste des identificateurs de métriques, voir : ID et noms de code de métrique.	✓	Chaîne
threshold	Nombre maximal d'unités de métrique que le produit est autorisé à utiliser au sein d'un groupe d'ordinateurs.	✓	éntier
custom_field_number	Zone personnalisée qui a été ajoutée au rapport Toutes les métriques. Pour obtenir la liste de toutes les zones personnalisées, affichez le schéma license_usage.json.		Problèmes divers

Remarque : Vous pouvez modifier plusieurs valeurs lors d'une même demande. Par exemple, vous pouvez utiliser une même demande pour définir le seuil de métrique, configurer une valeur d'une zone personnalisée et effacer la valeur d'une autre zone personnalisée.

Exemple de conversation - Définition d'un seuil de métrique de licence

Pour extraire des informations sur l'identificateur du produit pour lequel vous souhaitez définir le seuil de métrique de licence, utilisez la demande GET suivante : La demande renvoie l'ID et le nom du produit, ainsi que l'ID de métrique et le nom de code.

Demande

GET api/sam/v2/license_usage?columns[]=product_id&columns[]=product_name
&columns[]=metric_id&columns[]=metric_code_name&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

Réponse

[{
"product_id": 29258,
"product_name": "WebSphere Service Registry and Repository",
"metric_id": 3,
"metric_code_name": "PVU_FULL_CAP"
}]

Pour modifier la valeur du seuil de métrique de licence, utilisez la demande PUT suivante :
Une relation entre le produit indiqué par le paramètre product_id et la métrique de licence indiquée par le paramètre metric_id doit exister dans le catalogue des logiciels. Sinon, la demande renvoie une erreur. Si la relation n'existe pas dans le catalogue des logiciels, vous pouvez la créer dans le panneau Produits et métriques. Pour plus d'informations, voir : Affectation d'une métrique supplémentaire à un produit.
Demande
```
PUT api/sam/v2/license_usage?product_id=29258&metric_id=3
&threshold=300&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
```
Réponse
```
200 - OK
```

Conseil : Pour automatiser la procédure, vous pouvez créer un script qui effectue l'analyse syntaxique des résultats renvoyés par la demande GET, lance l'itération de ces résultats et les met à jour un par un à l'aide de la requête PUT.

Exemple de conversation - Définition de la valeur d'une zone personnalisée

Pour vérifier la liste des zones personnalisées qui ont été créées dans le rapport Toutes les métriques, affichez le schéma license_usage.json. Le schéma répertorie toutes les colonnes, y compris les zones personnalisées. Identifiez la zone personnalisée pour laquelle vous souhaitez définir la valeur.
Demande - Vérification de la liste des zones personnalisées existantes
```
GET api/sam/v2/schemas/license_usage.json?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
```
Réponse - Liste de toutes les colonnes, y compris les zones personnalisées
```
[{
"product_name":
      {
       "type": "string",
       "description": "Name of the software product."
       },
...
"custom_field_1":
       {
       "type": "boolean",
       "title": "Requires Extension"
       }
}]
```

Après avoir identifié le nom de la zone personnalisée, utilisez la demande PUT.

Demande

PUT api/sam/v2/license_usage?product_id=29258&metric_id=3&bundle_id=3496
&custom_field_1=1&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

Réponse

200 - OK

Exemple de conversation - éffacement d'un seuil de métrique de licence

Pour extraire des informations sur l'identificateur du produit pour lequel vous souhaitez effacer le seuil de métrique de licence, utilisez la demande GET ci-dessous. La demande renvoie l'ID et le nom du produit, l'ID et le nom de la métrique, ainsi que la valeur de seuil.

Demande

GET api/sam/v2/license_usage?columns[]=product_id&columns[]=product_name
&columns[]=metric_id&columns[]=metric_name&columns[]=threshold
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

Réponse

[{
"product_id": 29258,
"product_name": "WebSphere Service Registry and Repository",
"metric_id": 3,
"metric_name": "PVU Full Capacity"
"threshold": 300
}]

Pour effacer le seuil de métrique de licence, indiquez une valeur vide dans le paramètre threshold. La même méthode est utilisée pour effacer les valeurs des zones personnalisées.
Demande
```
PUT api/sam/v2/license_usage?product_id=29258&metric_id=3
&threshold=&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
```
Réponse
```
200 - OK
```