Guide rapide

XOAP Dispositifs sont des points d'extrémité où Connecteur XOAP Il est installé et enregistré dans votre espace de travail. Une fois connecté, les appareils deviennent visibles dans le module Inventory et peuvent être utilisés pour exécuter des requêtes et des commandes, collecter des données d’inventaire et (si activé lors de l’installation) participer à des Image Management workflows.

Ajouter un appareil (installer le connecteur XOAP)

1. Aller à Inventaire → Équipements et cliquez sur + Ajouter un appareil.
2. Dans le cadre de la Téléchargez le connecteur XOAP Dans la section « Plateforme », sélectionnez la plateforme cible (Windows / macOS / Linux) et cliquez sur Télécharger.
3. En Inscrivez-vous et démarrez le connecteur XOAP, sélectionnez API key ceux-ci devraient être utilisés pour l’inscription.
4. Copiez le commandement d'installation généré et exécutez-le sur l'appareil cible :
   • Windows : Exécuter Windows PowerShell en tant qu’administrateur
   • Linux/macOS : Exécutez le commandement avec les privilèges appropriés (par exemple, en utilisant sudo si nécessaire)
5. Après la fin de l'installation, le service Connector est automatiquement lancé.
6. Une fois le dispositif connecté, il apparaîtra dans Inventaire → Équipements avec un statut en ligne.

Supprimer un appareil

1. En Inventaire → Équipements, Cliquez sur Menu d’action (⋮) à côté du dispositif.
2. Sélectionner Supprimer.
3. Confirmer la suppression.

Informations supplémentaires utiles

Prérequis de la clé API

Pour enregistrer un appareil, vous devez d'abord créer un API key dans XOAP (sous Connexions). L’installateur utilise cette clé pour enregistrer le périphérique dans votre espace de travail.

Comportement de service

Le connecteur XOAP fonctionne comme un service (Windows) / démon (Linux/Mac).

Image Management bande-flag

Si le dispositif sera utilisé pour Image Management, Installez le connecteur en utilisant le –imagemanagement une balise qui permet d’activer les fonctionnalités requises lors de l’inscription.

Exigences de connectivité

Le dispositif doit pouvoir accéder au serveur XOAP (HTTPS/443, directement ou via un proxy) pour s'enregistrer et rester connecté.

Des appareils contre des nœuds

Un seul point d’extrémité peut apparaître les deux comme un Dispositif dans Inventaire (Connecteur XOAP installé) et comme un Node dans Configuration Management (enregistrés via la configuration). Ces vues sont complémentaires — l’une n’exclut pas l’autre.

Option de déploiement massé (PSADT + Application Management)

Le Connecteur XOAP L'installateur peut être emballé dans un PSAppDeployToolkit (PSADT) emballé et déployé via Application Management À :

• Il a déjà réussi Nœuds, et
• des nouveaux points d’accès dans le cadre de l’intégration.

Documentation technique

Le Dispositifs page dans Inventaire liste des points d'extrémité où le Connecteur XOAP est installé et inscrit dans un espace de travail. Une fois connecté, les appareils peuvent exécuter les fonctionnalités d’inventaire (par exemple Requêtes via osquery) et supporte les actions opérationnelles telles que l’exécution de commandes/scripts, le transfert de fichiers et l’installation d’applications.

Un appareil peut être géré dans plusieurs zones XOAP simultanément :

• Le même point d’extrémité peut apparaître comme un Node dans Configuration Management et comme un Dispositif dans Inventaire. Ces zones sont distinctes et Ne vous excluez pas les uns les autres.

Conditions préalables

• API key doit exister dans XOAP Connections avant d'installer/enregistrer le connecteur XOAP.
• Des privilèges d’administrateur/root locaux sont nécessaires pour installer le connecteur et configurer le service.

Installation et enregistrement du connecteur XOAP

En Inventaire → Dispositifs → Ajouter un agent, Choisissez la plateforme et la clé API. XOAP génère un commandement d’installation qui enregistre l’appareil dans le bon espace de travail.

Windows (PowerShell en tant qu’administrateur) :

.\XOAP.Connector.Installer.exe –install –apiKey APIKEY –workspace WORKSPACEID

Linux (exécuté avec sudo) :

./XOAP.Connector.Installer –install –apiKey APIKEY –workspace WORKSPACEID

Image Management bande-flag

Si le dispositif doit être utilisé pour Image Management un usage industriel, installez le connecteur avec le Image Management drapeau :

.\XOAP.Connector.Installer.exe –installer –apiKey APIKEY –workspace WORKSPACEID –ImageManagement

Si Image Management cette option n’est pas activée lors de l’installation, l’appareil fonctionnera toujours avec les fonctionnalités d’Inventaire, mais certaines fonctionnalités Image Management spécifiques pourraient ne pas être disponibles.

Début de la mise en service

Après l’installation, le service XOAP Connector est lancé automatiquement. Si nécessaire, il peut être lancé manuellement :

Start-Service XOAPConnector

Qu’est-ce qui est installé lors de l’installation du connecteur XOAP

Lors de l'installation, l'utilitaire d'installation de l'interrupteur XOAP Détecte d’abord les composants existants et installe uniquement ce qui manque ou ce qui est nécessaire. Si une composante est déjà installée et correspond à la version prévue, cette étape est omise.

Les composants manipulés par l'installateur

1) Les paquets binaries de l’interconnexion XOAP

• Télécharge le package de sortie de la dernière version du connecteur XOAP et l’extraire dans :
  • C:\Program Files\XOAP\Connector
• Crée ou met à jour la configuration du connecteur dans le cadre de l’inscription (clé API + espace de travail).

2) Service de connexion XOAP pour Windows

• Installe un service Windows nommé XOAPConnector
• Commence le service après l'installation (et configure généralement son démarrage automatique).

3) Installer les fichiers de persistance

• Les fichiers d’installation et de support persistent sous :
  • C:\Program Files\XOAP\Installer

4) osquery (Dépendance Inventory / Queries)

• Détecte l'installation et la version d'osquery.
• Si elles sont manquantes (ou plus anciennes que requis), téléchargez et installez osquery (MSI).
• Si le logiciel est déjà installé et que la version correspond à celle requise ou est plus récente, l’installation est ignorée.

5) Matériel de support (installateurs préparés / conditions préalables)

L'installateur peut préparer les préalables nécessaires aux workflows de XOAP (en fonction de l'utilisation du scénario ou de la fonctionnalité):

• Pâtissier (souvent requis pour les workflows liés à Image Management-)
• Azure CLI (utilisé lors de l'interaction avec les workflows d'Azure)
• Initialisation de WinGet Il peut être exécuté pour faciliter la manipulation préalable sur Windows.

Localisations temporaires de téléchargement

Les paquets téléchargés (par exemple le fichier ZIP du connecteur et le fichier MSI d’osquery) sont généralement classés dans l’espace suivant :

• C:\Users\\AppData\Local\Temp…

Mise à jour et désinstallation (commandes opérationnelles facultatives)

Selon la configuration de votre distribution/installateur, l’utilitaire connecteur peut supporter des opérations de cycle de vie telles que :

Mise à jour

\XOAP.Connector-Installer.exe – update

Désinstaller

.\XOAP.Connector-Installer.exe – désinstallation

Actions des appareils dans l’inventaire

Depuis menu d'action du dispositif (⋮) vous pouvez effectuer des opérations sur un appareil connecté, telles que :

• Affichage du journal d'activité de l'agent: Ouvrir les journaux de l’exécution du connecteur pour une analyse de dépannage.
• Exécuter une commandeExécute un commandement depuis la bibliothèque de commandes du dispositif.
• Exécuter une requêteExécute une requête d’inventaire basée sur osquery sur le périphérique.
• Exécuter le script: Exécute un script sur le dispositif.
  • Les scripts sont sélectionnés dans la Les ressources XOAP espace (les scripts doivent d'abord exister sous forme de ressources).
• Installer des applicationsAffecte et déclenche l’installation des applications (selon votre Application Management configuration).
• Transfert de fichier:
  • TéléchargerRetrouver un fichier depuis le périphérique vers XOAP (ajouter éventuellement ce fichier aux Ressources).
  • ChargementTéléchargez un fichier sur le dispositif soit à partir des ressources XOAP, soit depuis votre machine locale.
• SupprimerSupprime le périphérique de la liste des appareils (l’installation manuelle est une action/un processus distinct).

Plus d'informations

Des appareils contre des nœuds

Un appareil peut être géré comme un Dispositif (Inventaire) et un Node (Configuration Management) en même temps.

Déploiement généralisé

Le connecteur XOAP peut être emballé (par exemple en tant que PSAppDeployToolkit (PSADT) un package) et déployé à grande échelle grâce à Application Management Pour les Nodos gérés existants — et utilisé également comme installateur standardisé pour les nouveaux appareils.

Image Management Activation

Si un appareil est destiné à participer à Image Management, Installez –imagemanagement dès le début afin d’assurer que les capacités correctes soient activées.

Sur le système, les journaux du connecteur XOAP local peuvent être trouvés dans le Gestionnaire d'événements / Journaux de Windows / Application.

The post Devices appeared first on XOAP.

Guide rapide

XOAP Requêtes sont des requêtes basées sur SQL qui sont exécutées directement sur les appareils gérés afin de collecter des données d’inventaire et opérationnelles. Lorsqu’elles sont Connecteur XOAP Une fois installé, il s’exécute également. osquery, Les requêtes XOAP utilisent ce moteur osquery pour exécuter des commandes SQL sur l’endpoint et renvoyer les résultats vers XOAP.

Créer une nouvelle requête

1. En Inventaire → Demandes, cliquer + Ajouter une requête.
2. Tapez un Nom de la requête.
3. Sélectionnez l'objectif OS.
4. (Facultatif) Ajouter Tags et un Description.
5. En Commandement, Insérez la requête SQL à exécuter sur le dispositif.
6. Cliquez sur Ajouter créer la requête.

Modifier une requête

1. Ouvrez les détails de la requête (par exemple, via l’onglet « Quêtes ») Régions option/icône).
2. Cliquez sur Editer.
3. Mettre à jour les métadonnées de la requête (nom, système d’exploitation, tags, description) et/ou les Commandement.
4. Sauvez vos modifications.

Supprimer une requête

1. Dans la liste « Demandes », sélectionnez la requête (ou plusieurs requêtes).
2. Supprimez-le en utilisant la commande Supprimer option/icône.
3. Confirmer la suppression.

Informations supplémentaires utiles

Compatibilité avec les OS

Tous les requêtes ne fonctionnent pas sur tous les systèmes d'exploitation. En pratique, indiquez l'étendue du système d'exploitation dans le nom de la requête (par exemple, WIN_, LINUX_, MAC_ ou ALL_), afin de savoir clairement si une requête est spécifique à un système d'exploitation ou universelle.

Rendre les requêtes efficaces

Préférez les filtres ciblés et limitez le nombre de résultats lorsque cela est possible. Les requêtes volumineuses (des tables importantes, de nombreux joins ou des analyses étendues) peuvent augmenter la charge sur les serveurs d'extrémité et ralentir la collecte des données.

Documentation technique

Requêtes dans XOAP sont Les instructions SQL exécutées sur les terminaux Pour récupérer des informations relatives aux inventaires et à la sécurité (logiciel, utilisateurs, processus, services, extensions de navigateur, groupes locaux, etc.). XOAP utilise ces requêtes pour collecter des données structurées provenant des appareils et les présenter centralement dans le module Inventaire.

osquery C'est un agent d'extrémité open source qui expose les données du système d'exploitation via un Interface SQL. Intérieurement, il mape les informations système en “ tables ” virtuelles (par exemple, les processus, les utilisateurs, les services, les programmes, les chrome_extensions) que vous pouvez consulter à l’aide de la syntaxe SQL standard. Le résultat est une couche d’inventaire cohérente et accessible à partir de toutes les plateformes supportées.

Lorsque le Connecteur XOAP est installé sur un appareil, osquery est déployé dans le cadre de l’installation. XOAP déclenche alors la requête SQL configurée sur l’endpoint via le Connector et collecte les résultats pour les rendre disponibles dans XOAP pour l’analyse et la publication.

Flux à haut niveau :

1. Vous définissez une requête (SQL + métadonnées du système d’exploitation cible) dans XOAP.
2. Le système XOAP déclenche l’exécution sur les endpoints sélectionnés via le système XOAP Connector.
3. osquery exécute le SQL localement et renvoie des lignes (des résultats).
4. XOAP stocke et affiche les données retournées dans Inventory.

Voici quelques exemples simples d’instructions SQL avec osquery que vous pouvez utiliser comme modèles :

Informations de base sur le système

SELECT hostname, cpu_type, cpu_subtype, physical_memory

À partir de system_info;

Liste des utilisateurs locaux

SELECT nom d'utilisateur, uid, description

D'utilisateurs

ORDER BY nom d'utilisateur ;

Logiciel installé (orienté vers Windows)

SELECT nom, version, emplacement d'installation, éditeur

À partir de programmes

ORDER BY nom ;

Le schéma des tables osquery peut être trouvé sur https://osquery.io/schema/5.21.0/

The post Queries appeared first on XOAP.

Guide rapide

Bibliothèque de commandes C’est un référentiel centralisé de commandes réutilisables pouvant être exécutées sur des appareils gérés. Il vous permet de standardiser les tâches opérationnelles courantes (par exemple, la résolution de problèmes, la collecte de données, les vérifications rapides) en stockant les commandes en un seul endroit et en les réutilisant dans l’ensemble de l’environnement. Les commandes peuvent être créées pour différents environnements tels que PowerShell, PowerShell Core, Bash/Shell, ou CMD.

Ajouter une nouvelle commande

1. Cliquez sur + Ajouter une commande.
2. Tapez un Nom de commande.
3. Sélectionnez l'option Type (par exemple, PowerShell Core, PowerShell, Bash/Shell, CMD).
4. (Facultatif) Ajouter Tags et un Description.
5. Collez ou écrivez le Commandement contenu.
6. Cliquez sur Ajouter créer le commandement.

Modifier une commande

1. Ouvrez le commandement (par exemple, via Régions / icône oculaire).
2. Dans le cadre de la Version actuelle Panneau, cliquez Editer.
3. Mettre à jour le contenu et/ou les métadonnées de la commande selon les besoins.
4. Sauvez les modifications (une nouvelle version est créée).

Supprimer une commande

1. Cliquez sur Supprimer (symbole de la poubelle) à côté du commandement.
2. Confirmer la suppression.

Informations supplémentaires utiles

Compatibilité avec les OS

Certains types de commandes sont spécifiques au système d'exploitation. Utilisez Tags (par exemple, Windows, Linux) et/ou des conventions de nommage permettant d’indiquer clairement la plateforme cible.

Je préfère les commandes non interactives

Évitez les messages d'aide et les interactions avec l'interface utilisateur ; les commandes doivent être exécutées sans supervision.

Maintenez la sortie lisible

Réalisez une sortie claire et structurée (et incluez un traitement des erreurs) afin de simplifier le dépannage et les audits.

Documentation technique

Le Bibliothèque de commandes est le magasin centralisé d’XOAP Des commandes versionnées et réutilisables Il peut être exécuté sur des appareils gérés via la couche d’exécution XOAP Inventory/Connector. Il est conçu pour des tâches opérationnelles telles que le dépannage, les vérifications de validation, la collecte de logs et les actions de correction légères.

Un commandement dans la bibliothèque est défini par :

• Les métadonnées (nom, description, tags)
• Type de temps de fonctionnement (PowerShell, PowerShell Core, Bash/Shell, CMD)
• Corps de commande (le texte réel du script/commande)
• Informations sur la version (numéro de version et message)

Les commandes sont exécutées sur les appareils qui disposent de Connecteur XOAP installé.

Types de commandes (exécution en temps réel)

Lors de la création d'un commandement, vous sélectionnez un Type ce qui définit l'interprète/runtime utilisé sur le dispositif :

• PowerShell
  Exécutions à l’aide de Windows PowerShell (typiquement 5.1 sous Windows).
• PowerShell Core
  Exécutions à l’aide de PowerShell 7+ (cross-platform lorsque disponible).
• Bash/Shell
  Exécutions à l’aide d’un shell sous Linux/macOS (généralement /bin/bash ou /bin/sh, selon le périphérique).
• CMD
  Exécutez les commandes à l’aide du Windows Command Prompt (cmd.exe).

Comportement de la versionnage

Les commandes sont Artworks avec version. Toute modification de la définition d’une commande (en particulier le corps de la commande) doit être considérée comme une nouvelle version afin que vous puissiez :

• Découvrez qui a modifié quoi et pourquoi
• Dirigez-vous en avant en toute sécurité
• Maintien de la reproductibilité des actions opérationnelles dans différents environnements

Meilleure pratique : Utilisez des messages de version courts et significatifs (par exemple : “ Ajouter un filtre de service ”, “ Fixer la casse des références ”, “ Soutien PS7 ”).

Les champs et leur signification

Dans le cadre de la Ajouter une commande Dialogue :

• Nom de commande
  Identifiant unique et lisible par l’homme. Utilisez un système de noms cohérent, comme par exemple :
  windows-check-service-status / linux-journalctl-last-50
• Type
  Le runtime/interpréteur utilisé pour exécuter le commandement sur le périphérique cible.
• Tags
  Utilisé pour le filtrage et l’organisation (OS, objectif, équipe, environnement).
• Description (facultatif)
  Brève explication de l'objectif, des résultats attendus et des conditions préalables éventuelles.
• Commandement
  Le contenu du script/commande. Ce contenu ne doit pas nécessiter d’interaction de la part de l’utilisateur et doit pouvoir être exécuté à plusieurs reprises sans risque.

Modèle d'exécution et résultats

Les commandes sont exécutées à distance et renvoient :

• Code d’exutoire (succès/échecs)
• Produit standard (résultats)
• Écart standard (erreurs)

Modèles recommandés

• Retour une sortie lisible par l'homme plus une sortie structurée simple lorsque possible (chaînes de clés/valeurs).
• Utilisez des codes d'exitation explicites :
  • 0 = succès
  • non-zéro = échec ou échec partiel
• Écrivez les erreurs dans stderr et conservez stdout pour les résultats normaux.

Considérations opérationnelles et de sécurité

Non interactif uniquement

• Évitez les messages d'avertissement (Read-Host, pause, confirmation interactive).
• Supposons que le commandement soit exécuté sans supervision.

Idempotence

• Je préfère les commandes qui peuvent être exécutées plusieurs fois sans effets secondaires nocifs.
• Pour les commandes de réparation, vérifiez l’état actuel avant de le modifier.

Logistique

• Pour les commandes de dépannage, incluez des détails contextuels (nom de l’hôte, date et heure, versions pertinentes).

Meilleures pratiques pour la création d'une bibliothèque maintenable

• Convention de désignation : os-purpose-action (par exemple, windows-inventory-installed-software)
• Étiqueté : OS + équipe + catégorie (par exemple, sécurité, dépannage, etc.)
• Scénario restreint : Un seul commandement = un seul objectif. Évitez les scripts “ faites tout ”.
• Prérequis pour le document : Outils, modules, permissions ou chemins requis.
• Test sur les pilotes : Valider le produit sur un petit nombre d'appareils avant une utilisation généralisée.
• Je préfère PowerShell Core pour les plates-formes multiples : Si votre flotte le permet, cela simplifie la réutilisation.

Exemples (commandes simples et sûres)

PowerShell (Windows) – afficher l’état d’un service

Get-Service -Name “WinRM” | Select-Object Name, Status, StartType

PowerShell (Windows) – 50 derniers erreurs du journal d’événements (Système)

Obtenir les événements de WinEvent -LogName System -MaxEvents 50 |
  Where-Object { $_.LevelDisplayName -in “Error”,”Critical” } |
  Sélectionner l'option TimeCreated, Id, ProviderName, Message

CMD (Windows) – informations de base sur le réseau

ipconfig /all

Bash (Linux) – résumé de l’utilisation du disque

df -h

Troubleshooting

Si une commande échoue à exécuter ou renvoie une sortie inattendue, les causes les plus fréquentes sont les suivantes :

• Incorrect Type sélectionné (par exemple, commande Bash sous Windows)
• Le runtime n’est pas installé (par exemple, PowerShell 7 manquant pour les commandes “PowerShell Core”)
• Différences d'OS (pathologies, outils, gestionnaires de services)
• Le commandement est interactif ou requiert un TTY.

Recommandation : Commencez par les commandes de diagnostic à usage exclusif, puis ajoutez les actions de correction uniquement après validation et après avoir obtenu les autorisations nécessaires.

The post Commands library appeared first on XOAP.