Micro-apps

Intégrer Citrix Virtual Apps and Desktops Service

Déployez l’intégration Citrix Virtual Apps and Desktops Service (CVAD) pour rechercher et exécuter des actions en libre-service à partir de votre instance Citrix Workspace. Les utilisateurs peuvent vérifier l’état de leurs machines associées qui sont défectueuses. Effectuez des opérations telles que le redémarrage, la déconnexion et la fermeture de session. Les administrateurs peuvent également activer le mode de maintenance pour les machines défectueuses.

Ce modèle prend en charge uniquement les machines défectueuses pour empêcher l’intégration de gérer un volume de données potentiellement énorme à chaque synchronisation. Pour plus d’informations sur l’inclusion de toutes les machines dans la synchronisation, consultez la section Modifier le point de terminaison pour effectuer une recherche sur toutes les machines.

Pour plus d’informations sur les micro-apps, consultez la section Utiliser les micro-apps Citrix Virtual Apps and Desktops Service.

Vérifier les conditions préalables

Pour configurer cette intégration, vous devez activer Citrix Workspace avec le service de micro-apps et Citrix Virtual Apps and Desktops Service. Cette intégration n’est pas compatible avec une instance CVAD locale. Toutefois, ce modèle d’intégration prend en charge les VDA locaux si vous utilisez Citrix Virtual Apps and Desktops Service pour la négociation des connexions.

Les valeurs que vous entrez dans les micro-apps Citrix Workspace sont les suivantes :

  • URL de base : https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/. Consultez Déterminer l’URL de base.
  • ID de site : vous avez besoin de l’ID de site du locataire pour que la micro-app interagisse avec les API Citrix Virtual Apps and Desktops Service. Consultez Obtenir l’ID de site.
  • ID client : ID client utilisé dans les API REST, requis pour accéder à toutes les API REST. Votre ID client se trouve dans Citrix Cloud.
  • URL du jeton : https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients. Consultez Proxy API.
  • ID client : ID client créé sur le site Web Gestion des identités et des accès de Citrix Cloud. Ceci est nécessaire pour obtenir le jeton de porteur requis pour l’authentification de toutes les API Rest. Consultez Générer l’ID client et la clé secrète client.
  • Clé secrète client : clé secrète créée sur le site Web Gestion des identités et des accès de Citrix Cloud. Ceci est nécessaire pour obtenir le jeton de porteur requis pour l’authentification de toutes les API Rest.

Autorisations

Lors de la création du client sécurisé à partir du site Gestion des identités et des accès, le compte avec lequel vous êtes connecté lors de la génération du client sécurisé doit disposer des autorisations Citrix Virtual Apps and Desktops Service suivantes :

  • Administrateur en lecture seule, Tous : permet d’extraire les données de Citrix Virtual Apps and Desktops Service.
  • Administrateur de session, Tous : permet d’effectuer des actions de déconnexion et de redémarrage.
  • Administrateur du service d’assistance, Tous : permet de d’activer et désactiver le mode de maintenance.

Les informations d’identification du client sécurisé héritent des autorisations de l’utilisateur connecté. Si les autorisations de l’utilisateur connecté lors de la création du client sécurisé sont modifiées, ces nouvelles autorisations s’appliquent également à l’intégration.

Configuration UPN

Les adresses e-mail doivent être utilisées pour le nom d’utilisateur principal (UPN) pour le fournisseur d’identité associé à Workspace.

Si les UPN de votre fournisseur d’identité ne sont pas les mêmes que les adresses e-mail des utilisateurs, les micro-apps ne seront pas en mesure d’afficher leurs sessions ou bureaux dans l’espace de travail.

Pour plus d’informations sur les fournisseurs d’identité, consultez la section Ouvrir un compte sur Citrix Cloud.

Proxy API

Citrix fournit des proxy API dans plusieurs régions. Choisissez un proxy le plus proche de la région dans laquelle réside votre instance Citrix Cloud :

  • Production (US) https://api-us.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients
  • Production (UE) https://api-eu.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients
  • Production (AP-S) https://api-ap-s.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients

Générer l’ID client et la clé secrète client

L’ID client et la clé secrète client (client sécurisé) sont nécessaires pour obtenir le jeton de porteur requis pour l’authentification de toutes les API Rest. Créez ces informations sur la page Gestion des identités et des accès Citrix Cloud. Pour plus d’informations, consultez Génération des ID client et de la clé secrète.

Obtenir l’ID de site

L’ID de site du locataire de Citrix Virtual Apps and Desktops Service permet à la micro-app d’interagir avec les API Citrix Virtual Apps and Desktops Service. Utilisez l’infrastructure PowerShell pour obtenir la réponse ou utilisez un client API REST pour appeler cette valeur. Les deux procédures sont décrites ci-dessous. Choisissez-en une.

Obtenir l’ID de site à l’aide de PowerShell

Vous pouvez trouver l’ID de votre site à l’aide de PowerShell. Vous avez besoin des ID suivants : customerID, clientID et clientSecret.

  1. Accédez au script PowerShell disponible ici : https://github.com/philwiffen/get-cvads-siteid/blob/main/Get-CVADS-SiteID.ps1
  2. Téléchargez et modifiez le script, ou collez son contenu dans un éditeur de code.
  3. Entrez les éléments customerID, clientID et clientSecret entre guillemets en regard des variables PowerShell situées en haut du script. Par exemple :

    • $customerID = "companycustomerid"
    • $clientID = "f539b28c-6f93-93c2-b526-49c48289f62e"
    • $clientSecret = "FDFLG3fgGKDKD=="
  4. Exécutez le script dans PowerShell.
  5. Copiez et enregistrez la réponse de l’ID de site pour une utilisation ultérieure.

    Exemple de réponse : c396f2fa-7824-41bc-9eed-db4d19ad1968

Obtenir l’ID de site à l’aide du client API

Configurez la requête API REST et obtenez la valeur d’ID à partir de la réponse.

  1. Ouvrez n’importe quel client API REST. Par exemple : https://insomnia.rest/download/core/.
  2. Appelez ce point de terminaison en remplaçant {customerID} par votre ID client :

    curl --request GET \
      --url
    https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/me
    
  3. Choisissez OAuth2 comme méthode d’authentification.
  4. Pour l’URL du jeton d’accès, utilisez https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients.
  5. Utilisez l’ID client et la clé secrète client que vous avez générés dans la procédure précédente.
  6. Remplacez les informations d’identification par In Request Body.
  7. Sélectionnez Fetch Token.
  8. Sélectionnez Send en regard de l’URL de la requête.
  9. La réponse répertorie vos sites. Si plusieurs sites sont présents, vous devez sélectionner le site approprié pour cette intégration. Par exemple :

    {
      "UserId": "34234234234234234",
      "DisplayName": "name",
      "ExpiryTime": "11:58:20 AM",
      "RefreshExpirationTime": "10:58:20 PM",
      "VerifiedEmail": "user@citrix.com",
      "Customers": [
        {
          "Id": "customerID",
          "Name": null,
          "Sites": [
            {
              "Id": "siteID" (this is the value that you need to collect)
              "Name": "Site Name"
            }
          ]
        }
      ]
    }
    
  10. Obtenez la valeur Id et enregistrez-la.

Déterminer l’URL de base

L’intégration nécessite une URL de base configurée pour vos points de terminaison API Citrix Virtual Apps and Desktops Service. Cette URL est unique à chaque locataire.

Le format est le suivant : https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/

  • Remplacez les deux occurrences de {customerID} par votre ID client pour Citrix Cloud.
  • Remplacez {siteID} par votre ID de site que vous avez obtenu lors du processus précédent.

Ajouter l’intégration aux micro-apps Citrix Workspace

Ajoutez l’intégration Citrix Virtual Apps and Desktops Service aux micro-apps Citrix Workspace. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus. Des micro-apps prêtes à l’emploi sont proposées, ainsi que des notifications et des actions préconfigurées qui sont prêtes à être utilisées dans votre espace de travail.

Procédez comme suit :

  1. Sur la page Intégrations de micro-apps, sélectionnez Ajouter nouvelle intégration et Ajouter une nouvelle intégration à partir des modèles fournis par Citrix.
  2. Choisissez la vignette Citrix Virtual Apps and Desktops Service.
  3. Donnez un nom d’intégration à l’intégration.
  4. Renseignez la section Paramètres du connecteur.
    • Entrez l’URL de base de l’instance : https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/.
    • Sélectionnez une icône pour l’intégration dans la bibliothèque d’icônes ou gardez l’icône par défaut.

    Configuration CVAD 1

  5. Sous Authentification du service, sélectionnez OAuth 2.0 dans le menu Méthode d’authentification et complétez les détails d’authentification. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus. Utilisez le protocole de sécurité OAuth 2.0 pour générer des jetons de demande/autorisation pour l’accès délégué. Il est recommandé de toujours utiliser OAuth 2.0 comme méthode d’authentification de service lorsque cette méthode est disponible. OAuth 2.0 garantit que votre intégration respecte la conformité maximale en matière de sécurité avec votre micro-app configurée.

    1. Sélectionnez Informations d’identification du client dans le menu Flux de type d’autorisation.
    2. Entrez client_credentials dans le champ Valeur de type d’autorisation.
    3. Sélectionnez Corps de la requête dans le menu Autorisation de jeton.
    4. Sélectionnez URL du formulaire codée dans le menu Type de contenu du jeton.
    5. Confirmez le champ URL du jeton. Cette valeur est pré-remplie : https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients
    6. Saisissez votre ID client. L’ID du client permet de définir la chaîne représentant les informations d’inscription client uniques au serveur d’autorisation.
    7. Entrez la Clé secrète client. La clé secrète client est une chaîne unique émise avec l’ID client.

    Configuration CVAD 2

  6. Dans le champ Limitation du taux de demandes, entrez 120.
  7. (Facultatif) Activez la fonction Journalisation pour conserver 24 heures de journalisation à des fins de support.
  8. Sélectionnez Enregistrer pour continuer.

    Configuration CVAD 3

La page Intégrations de micro-apps s’ouvre avec votre intégration ajoutée et ses micro-apps associées. Vous êtes maintenant prêt à définir et exécuter votre première synchronisation de données. Pour plus d’informations sur les règles de synchronisation, ainsi que sur la synchronisation qui ne respecte pas ses règles de planification et de veto, consultez la section Synchroniser les données.

Pour plus d’informations sur les points de terminaison d’API et les entités de table, consultez la section Spécifications du connecteur Citrix Virtual Apps and Desktops Service.

Synchroniser toutes les machines

Ce modèle d’intégration est conçu pour prendre en charge uniquement les machines défectueuses. Il empêche ainsi l’intégration de gérer un volume de données potentiellement énorme à chaque synchronisation.

Vous pouvez effectuer les modifications suivantes pour accéder à toutes les machines. Toutefois, les performances de synchronisation ralentiront et vous devrez ajuster le calendrier de synchronisation en conséquence.

Pour synchroniser toutes les machines :

  1. Vous devez supprimer la notification Machine défectueuse dans la micro-app Mode administrateur ou l’empêcher d’exécuter automatiquement chaque synchronisation.
  2. Modifiez le point de terminaison pour effectuer une recherche sur toutes les machines.

Modifier la notification Machine défectueuse dans la micro-app Mode Administrateur

Effectuez ces étapes pour empêcher les abonnés de la micro-app Mode Administrateur de recevoir des notifications pour chaque machine synchronisée chaque fois qu’une synchronisation est effectuée.

  1. Sur la page Intégrations de micro-apps, sélectionnez l’intégration Citrix Virtual Apps and Desktops Service.
  2. Sélectionnez la micro-app Mode Administrateur. L’affichage Notifications doit déjà être visible, mais si ce n’est pas le cas, sélectionnez Notifications.
  3. Sélectionnez le menu d’options (points de suspension) dans la notification Une machine est défectueuse et sélectionnez Supprimer pour supprimer complètement la notification ou Modifier la notification.

    • Si vous avez supprimé la notification, passez à la section suivante : Modifier le point de terminaison pour effectuer une recherche sur toutes les machines.
    • Si vous avez modifié la notification, désactivez l’option Exécuter automatiquement cet événement après la modification des données d’intégration, puis sélectionnez Enregistrer.

Modifier le point de terminaison pour effectuer une recherche sur toutes les machines

Supprimez SearchFilter dans la synchronisation complète et incrémentielle du point de terminaison Machines.

  1. Sur la page Intégrations de micro-apps, sélectionnez le menu en regard de l’intégration Citrix Virtual Apps and Desktops Service, puis Modifier. L’écran Chargement des données s’ouvre. Si vous êtes sur l’écran de configuration, sélectionnez Chargement des données dans la colonne de navigation gauche.
  2. Sélectionnez le menu en regard du point de terminaison Machines, puis sélectionnez Modifier ou sélectionnez le nom du point de terminaison : Machines.

    Points de terminaison CVAD

  3. Sur l’écran Modifier le point de terminaison de données, sous Synchronisation complète, sélectionnez l’onglet CORPS et supprimez SearchFilter en conservant {} dans CORPS.
  4. Faites défiler l’écran vers le bas, puis sous Synchronisation incrémentielle, sélectionnez l’onglet CORPS et supprimez SearchFilter à nouveau en conservant {} dans CORPS.

    Écran SearchFilter

  5. Sélectionnez Appliquer en bas de l’écran et confirmez vos sélections.

N’oubliez pas d’ajuster la synchronisation. Consultez Synchroniser les données pour de plus amples informations.

Utiliser les micro-apps CVAD

L’intégration Citrix Virtual Apps and Desktops Service est fournie avec des micro-apps prêtes à l’emploi. Commencez avec ces micro-apps et personnalisez-les en fonction de vos besoins.

Mes bureaux : permet de rechercher vos bureaux Citrix Virtual Desktops défectueux et d’effectuer des actions en libre-service à partir de Citrix Workspace, telles que le redémarrage.

Notification ou Page Workflows de cas d’utilisation
Page Détails du bureau virtuel Fournit une page contenant les détails du bureau, ainsi que les options Redémarrer bureau et Forcer redémarrage du bureau.
Page Bureaux virtuels Fournit une liste consultable des bureaux virtuels Citrix Virtual Desktops défectueux associés à l’utilisateur, ainsi qu’un lien vers la page Détails du bureau virtuel.

Mes sessions : permet de rechercher vos sessions Citrix Virtual Desktops et d’effectuer des actions en libre-service à partir de Citrix Workspace, telles que la déconnexion et la fermeture de session.

Notification ou Page Workflows de cas d’utilisation
Page Liste des sessions Fournit une liste consultable des sessions Virtual Desktops associées à l’utilisateur, ainsi qu’un lien vers la page Détails de la session.
Page Détails de la session Fournit une page contenant les détails de la session Virtual Desktop et de la machine, ainsi que les options Fermer session et Déconnecter session.

Bureaux virtuels (mode administrateur) : permet aux administrateurs CVAD Citrix Workspace de rechercher des machines défectueuses, d’afficher leurs détails, de mettre les machines en mode de maintenance et de redémarrer les machines.

Notification ou Page Workflows de cas d’utilisation
Notification Une machine est défectueuse Lorsqu’un nouvel enregistrement d’une machine signale un état défectueux, tous les abonnés reçoivent une notification, ainsi qu’un bouton Redémarrer bureau qui renvoie à la page Détails du bureau virtuel.
Page Liste des bureaux virtuels Fournit une liste consultable des bureaux Citrix Virtual Desktops défectueux, ainsi qu’un lien vers la page Détails du bureau virtuel. Vous pouvez effectuer une recherche par machine ou par utilisateur.
Page Détails du bureau virtuel Fournit une page contenant les détails du bureau, ainsi que les options Redémarrer bureau, Forcer redémarrage du bureau, Activer le mode Maintenance et Désactiver le mode Maintenance.
Intégrer Citrix Virtual Apps and Desktops Service