Inscrire des agents
Introduction
Vous pouvez inscrire des agents Workspace Environment Management (WEM) sans configurer Citrix Cloud Connector. Avant cela, tenez compte des points suivants :
- L’inscription s’applique à la fois aux machines appartenant au domaine et aux machines non jointes au domaine, mais s’applique uniquement aux machines physiques et aux machines virtuelles persistantes.
- Pour les machines virtuelles gérées par Citrix DaaS, nous vous recommandons d’utiliser la même méthode pour connecter l’agent à Citrix Cloud que pour le VDA : via le Cloud Connector ou la méthode non liée au domaine. Consultez la section Déterminer la méthode de configuration à utiliser.
- Pour vous assurer que les machines virtuelles persistantes s’inscrivent correctement :
- Supprimez les informations spécifiques à la machine en généralisant une machine virtuelle avant de créer une image. Pour plus d’informations sur l’utilisation de Sysprep pour généraliser une machine virtuelle, consultez la documentation produit Microsoft : https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/sysprep--generalize--a-windows-installation?view=windows-11.
Cette fonctionnalité nécessite que vous sélectionniez Ignorer la configuration lors de l’installation de l’agent et que vous n’activiez pas la stratégie de service Discover Citrix Cloud Connector from CVAD .
Inscrire des agents
Vous avez la possibilité de déterminer comment inscrire vos agents WEM. Il y a deux façons :
-
Inscrivez-vous sur invitation. Cela nécessite la console Web. Les utilisateurs peuvent être invités à participer au processus d’inscription.
-
Inscrivez-vous avec le jeton porteur ou le client sécurisé API. Cela ne nécessite pas de console et n’oblige pas les utilisateurs à participer au processus d’inscription.
S’inscrire sur invitation
Pour gérer les appareils des utilisateurs à distance et en toute sécurité, vous inscrivez les appareils utilisateur dans WEM.
Voici un flux de travail général pour s’inscrire sur invitation :
-
Dans Gérer > Console Web > Inscription > Invitation, activez Inscription sur invitation, puis générez une clé d’inscription.
-
Sur la machine de l’agent, installez la clé d’inscription à l’aide de l’outil d’inscription.
- Ouvrez l’invite de commandes en tant qu’administrateur.
-
Exécutez la commande suivante. (
<enrollment key>Remplacez-le par la clé réelle.)Citrix.Wem.Agent.EnrollmentUtility.exe configenrollmentkey -k <enrollment key>
Conseil :
- L’outil d’inscription, Citrix.WEM.Agent.EnrollmentUtility.exe, est disponible dans le dossier d’installation de l’agent. Pour plus d’informations, consultez la section Outil d’inscription.
- Lors de la préparation d’une image principale, vous pouvez installer l’agent sur l’image principale. Ensuite, vous utilisez l’image principale comme modèle pour créer des machines pour vos utilisateurs. Ainsi, vous n’avez pas besoin d’installer la clé d’inscription pour chaque agent.
-
Dans Gérer > Console Web > Inscription > Invitation, envoyez une invitation d’inscription aux utilisateurs.
Une fois que les utilisateurs ont reçu l’invitation, ils peuvent inscrire leurs appareils à l’aide du code d’invitation. Consultez la section Inscrire l’agent avec un code d’invitation.
Une fois qu’un appareil est inscrit, il devient géré et apparaît dans Gérer > Console Web > Inscription > Agents inscrits. Vous pouvez l’ajouter à un jeu de configuration souhaité pour une gestion précise. Consultez Gérer l’agent inscrit.
Inscrire l’agent avec un code d’invitation
Important :
L’inscription d’un agent nécessite des autorisations d’administrateur local.
En tant qu’utilisateurs, vous recevez l’e-mail d’invitation suivant :
Inscrivez votre appareil à l’aide du code d’invitation comme suit :
-
Ouvrez le menu Démarrer de votre bureau et sélectionnez Citrix > WEM Enrollment Registration Utility.
Conseil :
Si l’utilitaire n’est pas disponible dans le menu Démarrer, accédez au dossier d’installation de l’agent WEM et ouvrez Citrix.WEM.Agent.Enrollment.reUtility.exe.
-
Dans Enrollment Registration Utility, vérifiez que l’état de la clé d’inscription est Installé et cliquez sur Inscrire l’agent.
Remarque :
Si l’état de la clé d’inscription n’est pas Installé, contactez votre administrateur.
-
Dans la fenêtre Inscrire l’agent, collez le code d’invitation (copié à partir de l’e-mail d’invitation) et cliquez sur Commencer l’inscription.
Si l’agent s’inscrit correctement, le message suivant s’affiche : L’agent a été inscrit avec succès. Vous pouvez cliquer sur Fermer pour revenir à l’utilitaire d’inscription, qui affiche les informations suivantes :
Remarque :
L’inscription à l’aide du jeton porteur ou du client sécurisé par API ne nécessite pas la participation de la clé d’inscription. Si vous utilisez l’ utilitaire d’enregistrement des inscriptions pour vérifier l’état de l’inscription sur une machine d’agent inscrite avec le jeton porteur ou le client sécurisé par API, le champ État de la clé d’inscription apparaît comme Non installé et le champ État d’inscription apparaît comme Inscrits.
S’inscrire avec le jeton porteur ou le client sécurisé API
Pour inscrire une machine d’agent, effectuez les opérations suivantes :
-
Connectez-vous à Citrix Cloud et obtenez un jeton porteur ou un client sécurisé par API pour l’authentification auprès du service API Citrix. Pour plus d’informations sur la façon de générer un client sécurisé par API et un jeton porteur, consultez la section Premiers pas avec les API Citrix Cloud.
-
Ouvrez une session sur la machine sur laquelle l’agent est installé.
-
Ouvrez une fenêtre d’invite de commande.
-
Pour inscrire l’agent avec le jeton du porteur, tapez la commande suivante :
Citrix.Wem.Agent.EnrollmentUtility.exe enroll --customer "customerid" --bearer "bearertoken" --url "api.wem.cloud.com"
Conseil :
Lorsque vous utilisez un jeton porteur, sachez que l’URL de base est unique pour chaque région. Pour plus d’informations, consultez la section URL de base. Si elle n’est pas spécifiée, l’URL de la région des États-Unis (api.wem.cloud.com) est utilisée.
-
Pour inscrire l’agent auprès du client sécurisé API, tapez la commande suivante :
Citrix.Wem.Agent.EnrollmentUtility.exe enroll --customer "customerid" --clientid "clientid" --clientsecret "clientsecret" --authurl "api-us.cloud.com" --url "api.wem.cloud.com"
Conseil :
- Lorsque vous utilisez un client sécurisé, sachez qu'il existe deux URL.- La première URL est l’URL d’authentification, qui est unique pour chaque région. Pour plus d’informations, consultez la section Get started with Citrix Cloud APIs. Si elle n’est pas spécifiée, l’URL de la région des États-Unis (api-us.cloud.com) est utilisée.
- La deuxième URL est l’URL de base, qui est également unique pour chaque région. Pour plus d’informations, consultez la section URL de base. Si elle n’est pas spécifiée, l’URL de la région des États-Unis (api.wem.cloud.com) est utilisée.
-
Vous pouvez également, à l’étape 3, créer un fichier de configuration au format JSON et utiliser le fichier avec la commande suivante :
Citrix.Wem.Agent.EnrollmentUtility.exe enroll --config "configfilepath"
Remarque :
Nous vous recommandons de supprimer le fichier de configuration après l’inscription car il contient des informations sensibles.
Le format du fichier de configuration est le suivant :
Conseil :
Lorsque vous utilisez un jeton au porteur ou un client sécurisé, vous pouvez laisser les champs correspondants vides.
{
"CustomerId": The Citrix Cloud customer ID,
"ClientId": The secure client ID of the Citrix Cloud API client,
"ClientSecret": The secure client secret of the Citrix Cloud API client,
"AuthUrl": The base URL of the Citrix Cloud API used to get the bearer
token,
"BearerToken": The Citrix Cloud bearer token,
"BaseUrl": The base URL of the WEM RESTful APIs
}
<!--NeedCopy-->
Exemple de sortie :
Gérer l’agent inscrit
Après avoir inscrit un agent, utilisez la console de gestion pour le lier à un ensemble de configuration souhaité pour une gestion précise.
- Dans la console Web, accédez à Objets de répertoire, puis ajoutez la machine agent à un jeu de configuration. Consultez la section Objets du répertoire.
- Dans l’ancienne console, accédez à Objets Active Directory > Machines, puis ajoutez la machine de l’agent à un jeu de configuration. Consultez la section Objets Active Directory.
- Pour plus d’informations sur l’ajout de machines n’appartenant pas à un domaine, voir Gérer des machines n’appartenant pas à un domaine.
Remarque :
- Après avoir ajouté une machine inscrite ne faisant pas partie d’un domaine, l’agent s’enregistre d’abord auprès du jeu de configuration du site par défaut ou du jeu de configuration des agents indépendants (s’il est activé). Une fois l’agent enregistré, vous pouvez ajouter la machine à d’autres jeux de configuration.
Création et rotation de clés
Une clé de service est créée dans le cloud lorsqu’un agent s’inscrit avec succès à WEM. Tenez compte des règles suivantes :
- La clé expire dans 90 jours. Après son expiration, l’agent doit se connecter au service WEM pour faire pivoter la clé. Par défaut, l’agent se connecte automatiquement pour faire pivoter la clé 14 jours avant l’expiration.
- La clé expirée est conservée pendant 180 jours. L’agent doit effectuer une rotation de clé dans un délai de 180 jours. Après cela, la clé sera supprimée.
- Si la clé est supprimée, l’agent utilisant la clé ne peut plus se connecter au service WEM. L’agent doit être réinscrit.
Remarque :
Un changement d’identité peut entraîner une discordance entre la clé de service et l’identité de l’agent. Un changement d’identité peut se produire, par exemple, lorsqu’une machine d’agent rejoint ou quitte un domaine. Dans ce cas, vous devez laisser l’agent se connecter au service WEM lorsque la clé est toujours valide afin que l’agent puisse faire pivoter la clé.
Outil d’inscription
L’outil d’inscription de l’agent, Citrix.WEM.Agent.EnrollmentUtility.exe, est disponible dans le dossier d’installation de l’agent WEM. Par défaut, l’agent est installé dans le dossier par défaut suivant.
-
C:\Program Files (x86)\Citrix\Workspace Environment Management Agent(sur système d’exploitation 64 bits) -
C:\Program Files\Citrix\Workspace Environment Management Agent(sur système d’exploitation 32 bits)
Options de ligne de commande avec l’outil d’inscription
L’outil propose les options suivantes :
| Paramètre | Description |
|---|---|
| status | Affiche l’état d’inscription actuel de la machine de l’agent. |
| s’inscrire | Inscrit la machine de l’agent auprès du service de gestion de l’environnement Citrix Workspace. |
| configenrollmentkey | Configure la clé d’inscription. |
| aide | Affiche plus d’informations sur une commande spécifique. |
| version | Affiche les informations de version de l’outil. |
Par exemple, pour afficher l’état d’inscription de l’agent, tapez la commande suivante :
Citrix.Wem.Agent.EnrollmentUtility.exe status
L’outil propose les options d’inscription suivantes :
| Paramètre | Description |
|---|---|
| –config | Lit les configurations à partir d’un fichier de configuration au format JSON. |
| -c, –customer | ID client Citrix Cloud. |
| -b, –bearer | Le jeton porteur Citrix Cloud. |
| –clientid | ID client sécurisé du client de l’API Citrix Cloud. |
| –clientsecret | Le secret client sécurisé du client de l’API Citrix Cloud. |
| –authurl | URL de base de l’API Citrix Cloud utilisée pour obtenir le jeton du porteur. Par défaut : api-us.cloud.com. |
| -u, –url | URL de base des API RESTful WEM. Par défaut : api.wem.cloud.com. |
| -f, –force | Inscrit la machine de l’agent quel que soit son statut d’inscription actuel. Par défaut : false. |
| -k, –key | Définit la clé d’inscription. |
| -f, –file | Lit la clé d’inscription à partir d’un fichier et définit la clé d’inscription. |
| -s, –status | Affiche l’état actuel de la clé d’inscription. |
| –help | Affiche l’aide de l’applet de commande. |
| –version | Affiche les informations de version de l’outil. |
Codes de retour
L’outil peut renvoyer les codes suivants :
| Code | Description |
|---|---|
| 0 | Aucune erreur |
| 1 | Arguments non valides |
| 2 | Permissions insuffisantes |
| 3 | Service hôte de l’agent non prêt |
| 4 | Erreur lors de l’appel d’API dist |
| 100 | Exception non gérée |
| 1000 | Agent non inscrit |
| 1001 | Agent actuellement inscrit. Lors de l’inscription de l’agent, l’opération est ignorée sauf si l’option —force est spécifiée. |
| 2000 | Clé d’inscription non installée |
| 2001 | Clé d’inscription installée |
Désinscrire l’agent
Pour désinscrire l’agent, utilisez le programme d’installation de l’agent lors de la désinstallation de l’agent, avec la commande suivante :
citrix_wem_agent_bundle.exe /uninstall Disenroll=1
Après avoir désinstallé l’agent, la clé de registre suivante est supprimée :
HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\WEM\Agent\EnrollmentData