Welcome
Intégration à l'API REST
L'intégration des systèmes externes est une fonction clé de BigFix Inventory. Une logique métier est activée pour l'intégration et les interfaces sont fournies pour les points d'intégration communs.
API REST
Gérer de grandes quantités d'informations à l'aide de l'interface utilisateur de l'application peut s'avérer chronophage. Vous pouvez utiliser les API REST comme alternative à l'interface graphique utilisateur pour réduire le temps requis pour gérer votre inventaire système et le contenu de votre catalogue des logiciels.
API principales
Les API de cœur incluent tous les ensembles principaux d'API intégrées à BigFix Inventory.
Associations d'API REST
Disponible à partir de la version 9.2.8. Pour les API REST de la version 2, vous pouvez utiliser des associations pour extraire des données supplémentaires dans le cadre des demandes d'API. Par exemple, vous pouvez extraire des informations détaillées sur le matériel de l'ordinateur dans le cadre de la demande d'API software_instances.

Page d'accueil de la documentation BigFix
Documentation de BigFix Inventory 10
Présentation
Familiarisez-vous avec les principaux concepts nécessaires pour comprendre le fonctionnement de BigFix Inventory et découvrez les fonctionnalités et fonctions introduites dans chacune des versions de l'application.
Installation
Découvrez les conditions requises et les scénarios d'installation disponibles pour vous assurer que le déploiement de BigFix Inventory s'effectue correctement dans votre environnement.
Configuration
Après avoir installé BigFix Inventory, configurez l'application. Créez des comptes pour les utilisateurs qui ont besoin d'accéder à l'application et configurez des analyses pour collecter des données d'inventaire de logiciels et de matériel depuis votre environnement.
Mise à niveau
Une nouvelle version de est publiée régulièrement, généralement à la fin de chaque trimestre calendaire. Procédez à une mise à niveau régulière vers la nouvelle version pour tirer pleinement parti des nouvelles fonctions et des correctifs d'application.
Gestion de l'infrastructure
Une fois que vous avez terminé la configuration initiale de , apprenez à gérer les composants de son infrastructure : gestionnaires de machine virtuelle, serveur, base de données et sources de données.
Inventaire de logiciels et utilisation des licences
Vous pouvez classer les logiciels reconnus de sorte que les rapports de BigFix Inventory reflètent vos autorisations et montrent correctement l'utilisation des métriques de licence en fonction de produits particuliers.
Gestion des menaces de sécurité
Apprenez à utiliser pour gérer les menaces de sécurité dans votre environnement. Vous pouvez voir si l'un des composants installés est sujet à une CVE (Common Vulnerability and Exposure).
Tutoriels
Les tutoriels permettent de comprendre la manière d'utiliser . Ils sont constitués de modules qui ciblent des objectifs vastes. Les modules comprennent des tâches qui montrent comment configurer des paramètres spécifiques, étape par étape.
Sécurité
Configurez diverses fonctions de sécurité pour protéger de manière adéquate les actifs et ressources de l'entreprise dans le modèle de données lorsque vous utilisez BigFix Inventory.
Traitement des incidents et support
Découvrez les solutions aux problèmes courants qui peuvent survenir lorsque vous utilisez BigFix Inventory et comment trouver des journaux et des fichiers de trace qui vous aident à les résoudre.
Optimisation des performances
Cette section explique comment planifier l'infrastructure de BigFix Inventory et comment configurer le serveur d'applications pour obtenir des performances optimales. Les instructions ci-dessous s'appliquent à des environnements big data, ainsi qu'à des environnements plus petits dotés de configurations matérielles moins performantes.
Intégration à l'API REST
L'intégration des systèmes externes est une fonction clé de BigFix Inventory. Une logique métier est activée pour l'intégration et les interfaces sont fournies pour les points d'intégration communs.
- API REST
  Gérer de grandes quantités d'informations à l'aide de l'interface utilisateur de l'application peut s'avérer chronophage. Vous pouvez utiliser les API REST comme alternative à l'interface graphique utilisateur pour réduire le temps requis pour gérer votre inventaire système et le contenu de votre catalogue des logiciels.
  - Produits et composants logiciels
    BigFix Inventory détecte les composants logiciels qui sont fournis avec le produit.
  - Ressources de l'API REST et méthodes HTTP
    Les opérations du protocole de l'API REST de BigFix Inventory sont définies en tant que méthodes HTTP sur certaines ressources REST.
  - éléments courants des API REST
    Vous utilisez des connecteurs et opérateurs pour générer des segments de requêtes qui filtrent les conditions et valeurs correspondantes.
  - Mappage des versions d'API REST
    Disponible à partir de la version 9.2.8. Pour certains API REST, la version 2 a été créée pour améliorer des fonctions ou l'expérience. Dans de tels cas, l'API d'origine devient obsolète avec le temps et seule la version 2 continue d'être développée. Si certains de vos outils personnalisés ou processus internes reposent sur de telles API REST, il est recommandé de les ajuster de sorte qu'ils utilisent la nouvelle version des API.
  - API REST pour l'extraction du jeton d'authentification
    Utilisez l'opération POST sur l'élément api/get_token pour demander votre jeton unique requis pour authentifier les demandes API REST.
  - API REST pour l'extraction de la version BigFix Inventory
    Utilisez l'opération GET sur l'élément api/sam/about pour demander des informations sur la version de BigFix Inventory.
  - API principales
    Les API de cœur incluent tous les ensembles principaux d'API intégrées à BigFix Inventory.
    - API REST pour matériel (v2)
      Disponible à partir de la version 9.2.8. Vous pouvez utiliser les demandes d'API REST pour extraire rapidement de grandes quantités de données liées à votre inventaire matériel et notamment les données historiques sur les ordinateurs retirés. Vous pouvez ensuite transmettre ces données à d'autres applications qui les traiteront et les analyseront.
    - API REST pour l'extraction de l'inventaire des logiciels et de l'utilisation des métriques, et pour la classification des logiciels (v2)
      Disponible à partir de la version 9.2.8. Vous pouvez utiliser des demandes API REST pour extraire rapidement de grandes quantités de données liées à l'utilisation des métriques de licence et à l'inventaire logiciel, y compris les données historiques des logiciels désinstallés. Vous pouvez ensuite transmettre ces données à d'autres applications qui les traiteront et les analyseront.
    - Associations d'API REST
      Disponible à partir de la version 9.2.8. Pour les API REST de la version 2, vous pouvez utiliser des associations pour extraire des données supplémentaires dans le cadre des demandes d'API. Par exemple, vous pouvez extraire des informations détaillées sur le matériel de l'ordinateur dans le cadre de la demande d'API software_instances.
      - Association component_cpe
        Disponible à partir de la version 9.2.12. Utilisez l'association component_cpe pour extraire des informations sur le composant détecté comme indiqué dans le dictionnaire CPé (Common Platform énumeration) dans le cadre d'autres demandes d'API REST.
      - association d'ordinateurs
        Disponible à partir de la version 9.2.10. Utilisez l'association computer pour extraire des informations sur les détails de l'ordinateur et les propriétés de l'ordinateur personnalisé dans le cadre des requêtes d'API REST.
      - Association computer_details
        Disponible à partir de la version 9.2.10. Utilisez l'association computer_details pour extraire des informations sur les détails de l'ordinateur et les propriétés de l'ordinateur personnalisé dans le cadre des requêtes d'API REST.
      - Association computer_health
        Disponible à partir de la version 9.2.8. Utilisez l'association computer_health pour extraire des informations sur l'état de l'ordinateur, telles que le statut des analyses de logiciel ou la version du client BigFix installé, dans le cadre de demandes d'API REST.
      - Association computer_hardware
        Disponible à partir de la version 9.2.8. Utilisez l'association computer_hardware pour extraire des informations détaillées sur le matériel dans le cadre d'autres demandes d'API REST.
      - Association CVE
        Disponible à partir de la version 9.2.13. Utilisez l'association cve pour extraire des informations sur les CVE (Common Vulnerabilities and Exposures) qui ont été mises en correspondance avec un composant spécifique via sa version détaillée dans le cadre d'autres requêtes d'API REST.
      - Association discovery_details
        Disponible à partir de la version 9.2.11. Utilisez l'association discovery_details pour extraire les détails d'un fichier qui a entraîné la reconnaissance de composants dans le cadre d'une requête d'API REST. Les détails incluent le nom et la taille du fichier, ainsi que le chemin dans lequel il a été trouvé.
      - Association designated_computer
        Disponible à partir de la version 9.2.12. Utilisez l'association designated_computer pour extraire des informations sur les ordinateurs conçus pour analyser des disques partagés dans le cadre d'autres demandes d'API REST.
      - Association mounted_shared_disks
        Disponible à partir de la version 9.2.12. Utilisez l'association mounted_shared_disks pour extraire des informations sur les disques partagés montés sur chaque ordinateur dans le cadre d'autres requêtes d'API REST.
      - Association release_component_lifecycle
        Disponible à partir de la version 9.2.13. Utilisez l'association release_component_lifecycle pour extraire des informations spécifiant à quel moment un composant atteint la fin de sa prise en charge dans le cadre d'autres demandes API REST.
      - Association shared_disk_members
        Disponible à partir de la version 9.2.12. Utilisez l'association shared_disk_members pour extraire des informations sur les ordinateurs où des disques partagés sont montés dans le cadre d'autres demandes API REST.
      - Association tags
        Disponible à partir de la version 9.2.14. Utilisez l'association tags pour extraire des informations sur des balises dans d'autres demandes API REST.
      - Association usage_data
        Disponible à partir de la version 9.2.8. Utilisez l'association usage_data pour extraire des informations sur l'utilisation de l'application dans le cadre d'autres demandes d'API REST.
      - Association de groupes d'ordinateurs
        Utilisez l'association Computer group pour extraire des informations sur le groupe d'ordinateurs associé aux contrats.
      - Association de métrique
        Utilisez l'association metric pour extraire des informations sur les métriques associées aux contrats.
      - Association de bons de commande
        Utilisez l'association purchase_orders pour extraire des informations sur les bons de commande associés aux contrats.
      - Association de produits logiciels
        Utilisez l'association software_products pour extraire des informations sur les produits logiciels associés aux contrats.
    - API REST pour l'extraction des résultats d'analyse bruts
      Disponible à partir de la version 9.2.2. L'extraction des résultats d'analyse bruts via l'API REST est destinée à améliorer la surveillance de votre environnement en vous permettant de reconnaître rapidement des logiciels qui ont été installés ou modifiés récemment. En utilisant les importations de données abrégées, les données concernant vos logiciels atteignent le serveur bien plus rapidement, et en même temps vous permettent d'augmenter le nombre des importations que vous pouvez exécuter chaque jour.
    - Extraction de la vue unifiée
      Les API de vue unifiée vous fournissent une vue unifiée des instances.
  - API de configuration
    Les API de configuration incluent toutes les API dont vous avez besoin pour configurer l'application.
  - API historiques
    Pour certains API REST, la version 2 a été créée pour améliorer des fonctions ou l'expérience. Dans ce cas, l'API d'origine est dépréciée et la version 2 est prise en charge. Vous devez ajuster vos outils personnalisés ou processus internes à la nouvelle version de ces API.
Glossaire
Guide au format PDF

Associations d'API REST

9.2.8 Disponible à partir de la version 9.2.8. Pour les API REST de la version 2, vous pouvez utiliser des associations pour extraire des données supplémentaires dans le cadre des demandes d'API. Par exemple, vous pouvez extraire des informations détaillées sur le matériel de l'ordinateur dans le cadre de la demande d'API software_instances.

Syntaxe

Pour extraire les données supplémentaires, utilisez la syntaxe suivante de la requête :

<URL>?columns[]=<association>.<column>&token=<token>

Où :

<URL> correspond à la requête d'API REST
<association> représente le nom de l'association à partir de laquelle vous souhaitez extraire la colonne
<column> représente le nom de la colonne à extraire
<token> représente l'identificateur d'authentification d'utilisateur unique

Par exemple :

GET api/sam/v2/software_instances?columns[]=computer_health.catalog_version
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

Remarque : Utilisez des associations d'API pour extraire des informations qui ne peuvent pas être obtenues directement via une API existante.