Mikroapps

Integration von Citrix Virtual Apps and Desktops Service

Mit der Integration von Citrix Virtual Apps and Desktops Service (CVADs) können Sie im Citrix Workspace nach Self-Service-Aktionen suchen und diese durchführen. Benutzer können den Status ihrer zugeordneten Maschinen überprüfen, bei denen ein Fehler vorliegt. Führen Sie Vorgänge wie Neustart, Trennen und Abmelden durch. Administratoren können auch den Wartungsmodus für fehlerhafte Maschinen aktivieren.

Diese Vorlage unterstützt fehlerhafte Maschinen nur, um zu verhindern, dass die Integration bei jeder Synchronisierung eine potenziell enorme Datenmenge verarbeitet. Weitere Informationen zum Einschließen aller Maschinen in die Synchronisierung finden Sie unter Anpassen des Endpunkts zur Suche nach allen Maschinen.

Weitere Informationen zu Mikroapps finden Sie unter Verwenden von Citrix Virtual Apps and Desktops Service-Mikroapps.

Prüfung der Voraussetzungen

Zum Einrichten dieser Integration müssen Sie Citrix Workspace mit Mikroapps und Citrix Virtual Apps and Desktops Service aktiviert haben. Diese Integration ist nicht mit on-premises CVAD kompatibel. Diese Integrationsvorlage unterstützt jedoch on-premises VDAs, wenn Sie den Citrix Virtual Apps and Desktops Service als Brokerdienst verwenden.

Dies sind die Werte, die Sie in Citrix Workspace-Mikroapps eingeben:

  • Basis-URL: https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/. Siehe Bestimmen der Basis-URL.
  • Site-ID: Sie benötigen die Mandanten-Site-ID, damit die Mikroapp mit den APIs des Citrix Virtual Apps and Desktops Service interagieren kann. Siehe Erfassen Ihrer Site-ID.
  • Kunden-ID: Die Kunden-ID wird in den Rest-APIs verwendet und ist für den Zugriff auf alle Rest-APIs erforderlich. Die Kunden-ID finden Sie in Citrix Cloud.
  • Token-URL: https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients. Siehe API-Proxy.
  • Client-ID: Die auf der Citrix Cloud-Website für Identitäts- und Zugriffsverwaltung erstellte clientID. Dies ist zum Abrufen des Bearertokens erforderlich, der zur Authentifizierung bei allen Rest-APIs benötigt wird. Siehe Generieren der Client-ID und des geheimen Clientschlüssels.
  • Geheimer Clientschlüssel: Der auf der Citrix Cloud-Website für Identitäts- und Zugriffsverwaltung erstellte geheime Schlüssel. Dies ist zum Abrufen des Bearertokens erforderlich, der zur Authentifizierung bei allen Rest-APIs benötigt wird.

Berechtigungen

Beim Erstellen des sicheren Client über die Identitäts- und Zugriffsverwaltung muss das Konto, mit dem Sie beim Erstellen des sicheren Client angemeldet sind, über folgende Berechtigungen für den Citrix Virtual Apps and Desktops Service verfügen:

  • Administrator mit Lesezugriff, Alle - Zum Abrufen von Daten aus dem Citrix Virtual Apps and Desktops Service.
  • Sitzungsadministrator, Alle - Zum Durchführen von Abmelde- und Neustartaktionen.
  • Helpdeskadministrator, Alle - Zum Aktivieren und Deaktivieren des Wartungsmodus.

Die Anmeldeinformationen für den sicheren Client erben die Berechtigungen des angemeldeten Benutzers. Wenn sich die Berechtigungen des beim Erstellen des sicheren Client angemeldeten Benutzers ändern, gelten die neuen Berechtigungen auch für die Integration.

UPN-Konfiguration

E-Mail-Adressen müssen als UPN (Benutzerprinzipalname) für den Identitätsanbieter verwendet werden, der mit Workspace verknüpft ist.

Wenn die UPNs im Identitätsanbieter nicht mit den Benutzer-E-Mail-Adressen übereinstimmen, können Mikroapps Benutzern nicht ihre Sitzungen oder Desktops in Workspace anzeigen.

Weitere Informationen über Identitätsanbieter finden Sie unter Registrierung bei Citrix Cloud.

API-Proxy

Citrix bietet API-Proxys in mehreren Regionen. Wählen Sie den Proxy, der der Region mit Ihrer Citrix Cloud-Instanz am nächsten liegt:

  • Produktion (USA) https://api-us.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients
  • Produktion (EU) https://api-eu.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients
  • Produktion (AP-S) https://api-ap-s.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients

Generieren der Client-ID und des geheimen Clientschlüssels

Client-ID und geheimer Clientschlüssel (für den sicheren Client) sind erforderlich, um den für die Authentifizierung bei allen Rest-APIs erforderlichen Bearertoken zu erhalten. Erstellen Sie diese auf der Citrix Cloud-Seite zur Identitäts- und Zugriffsverwaltung. Weitere Informationen finden Sie unter Generieren der Kunden-ID, der Client-ID und des geheimen Schlüssels.

Erfassen Ihrer Site-ID

Mit der Mandanten-Site-ID des Citrix Virtual Apps and Desktops Service kann die Mikroapp mit den APIs des Citrix Virtual Apps and Desktops Service interagieren. Verwenden Sie das PowerShell-Framework, um die Antwort zu erfassen, oder verwenden Sie einen REST-API-Client, um diesen Wert aufzurufen. Beide Verfahren werden im Folgenden erläutert. Wählen Sie ein Verfahren aus.

Erfassen der Site-ID mit PowerShell

Sie können Ihre Site-ID mit PowerShell abrufen. Sie benötigen Ihre Kunden-ID, die Client-ID und den geheimen Clientschlüssel.

  1. Rufen Sie hier das PowerShell-Skript auf: https://github.com/philwiffen/get-cvads-siteid/blob/main/Get-CVADS-SiteID.ps1
  2. Laden Sie das Skript herunter und bearbeiten Sie es, oder fügen Sie seinen Inhalt in einen Code-Editor ein.
  3. Geben Sie Ihre Kunden-ID, Client-ID und den geheimen Clientschlüssel in Anführungszeichen neben den PowerShell-Variablen oben im Skript ein. Beispiel:

    • $customerID = "companycustomerid"
    • $clientID = "f539b28c-6f93-93c2-b526-49c48289f62e"
    • $clientSecret = "FDFLG3fgGKDKD=="
  4. Führen Sie das Skript in PowerShell aus.
  5. Kopieren Sie die Site-ID-Antwort und speichern Sie sie zur späteren Verwendung.

    Beispiel einer Antwort: c396f2fa-7824-41bc-9eed-db4d19ad1968

Erfassen der Site-ID mit REST-API-Client

Richten Sie die REST-API-Anforderung ein und erfassen Sie den Id-Wert aus der Antwort.

  1. Öffnen Sie einen beliebigen REST-API-Client. Beispiel: https://insomnia.rest/download/core/.
  2. Rufen Sie diesen Endpunkt auf und ersetzen Sie {customerID} durch Ihre Kunden-ID:

    curl --request GET \
      --url
    https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/me
    
  3. Wählen Sie OAuth2 als Authentifizierungsmethode.
  4. Verwenden Sie als Zugriffstoken-URL https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients.
  5. Verwenden Sie die Client-ID und den geheimen Clientschlüssel, die Sie im vorherigen Verfahren generiert haben.
  6. Ändern Sie die Anmeldeinformationen in In Request Body.
  7. Wählen Sie Fetch Token.
  8. Wählen Sie neben der Anforderungs-URL Send.
  9. Die Antwort listet Ihre Sites auf. Bei mehreren vorhandenen Sites müssen Sie die richtige Site für diese Integration auswählen. Beispiel:

    {
      "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. Erfassen und speichern Sie den Wert Id.

Bestimmen der Basis-URL

Die Integration benötigt eine Basis-URL, die für Ihre API-Endpunkte des Citrix Virtual Apps and Desktops Service konfiguriert werden muss. Diese URL ist für jeden Mandanten eindeutig.

Dies ist das Format: https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/.

  • Ersetzen Sie zweimal {customerID} durch Ihre Kunden-ID für Citrix Cloud.
  • Ersetzen Sie {siteID} durch Ihre Site-ID, die Sie im vorherigen Verfahren erfasst haben.

Hinzufügen der Integration zu Citrix Workspace-Mikroapps

Fügen Sie die Citrix Virtual Apps and Desktops Service-Integration zu den Citrix Workspace-Mikroapps hinzu. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Dadurch werden vorkonfigurierte Mikroapps mit Benachrichtigungen und Aktionen bereitgestellt, die in Ihrem Workspace sofort einsatzbereit sind.

Führen Sie die folgenden Schritte aus:

  1. Wählen Sie auf der Seite Mikroappintegrationen die Optionen Neue Integration hinzufügen und Neue Integration aus Citrix-Vorlagen hinzufügen.
  2. Wählen Sie die Kachel des Citrix Virtual Apps and Desktops Service.
  3. Geben Sie einen Integrationsnamen ein.
  4. Geben Sie Connectorparameter ein.
    • Geben Sie die Basis-URL der Instanz ein: https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/.
    • Wählen Sie ein Symbol für die Integration aus der Symbolbibliothek aus, oder belassen Sie das Standardsymbol.

    CVADs-Konfig 1

  5. Wählen Sie unter Dienstauthentifizierung im Menü Authentifizierungsmethode die Option OAuth 2.0 und füllen Sie die Authentifizierungsdetails aus. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Generieren Sie über das Sicherheitsprotokoll OAuth 2.0 einen Anforderungs-/Autorisierungstoken zum delegierten Zugriff. Sofern verfügbar, sollten Sie stets OAuth 2.0 zur Dienstauthentifizierung verwenden. OAuth 2.0 stellt sicher, dass Ihre Integration höchste Sicherheitsansprüche mit Ihrer konfigurierten Mikroapp erfüllt.

    1. Wählen Sie im Menü Gewährungstyp - Prozess die Option Clientanmeldeinformationen.
    2. Geben Sie im Feld Gewährungstyp - Wert den Wert client_credentials ein.
    3. Wählen Sie im Menü Tokenautorisierung die Option Anforderungstext.
    4. Wählen Sie im Menü Tokeninhaltstyp die Option URL-codiertes Formular.
    5. Bestätigen Sie das Feld Token-URL. Dieser Wert ist vorausgefüllt: https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients
    6. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt.
    7. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die mit der Client-ID ausgegeben wird.

    CVADs-Konfig 2

  6. Geben Sie im Feld Anforderungsratenlimit den Wert 120 ein.
  7. (Optional) Aktivieren Sie die Umschaltfläche Protokollierung, um 24-Stunden-Protokolle für Supportzwecke zu erstellen.
  8. Wählen Sie dann Speichern.

    CVADs-Konfig 3

Die Seite Mikroappintegrationen wird geöffnet und zeigt die hinzugefügte Integration mit zugehörigen Mikroapps an. Sie können nun die erste Datensynchronisierung festlegen und ausführen. Vollständige Informationen zu Synchronisierungsregeln, zeitlich fehlgeschlagenen Synchronisierungen und zu Vetoregeln finden Sie unter Synchronisieren von Daten.

Weitere Informationen zu API-Endpunkten und Tabellenentitäten finden Sie unter Citrix Virtual Apps and Desktops Service-Connectorspezifikationen.

Synchronisieren aller Maschinen

Diese Integrationsvorlage unterstützt nur fehlerhafte Maschinen. Dadurch wird verhindert, dass die Integration bei jeder Synchronisierung eine potenziell enorme Datenmenge verarbeitet.

Sie können die folgende Änderung vornehmen, um auf alle Maschinen zuzugreifen. Dies verlangsamt jedoch die Synchronisierung, und Sie müssen den Synchronisierungszeitplan entsprechend anpassen.

Synchronisieren aller Maschinen:

  1. Die Maschinenfehler-Benachrichtigung in der Admin-Modus-Mikroapp muss entweder gelöscht werden oder es muss verhindert werden, dass sie bei jeder Synchronisierung automatisch ausgeführt wird.
  2. Ändern Sie den Endpunkt, um nach allen Maschinen zu suchen.

Ändern der Maschinenfehler-Benachrichtigung in der Admin-Modus-Mikroapp

Führen Sie diese Schritte durch, um zu verhindern, dass Abonnenten der Admin-Modus-Mikroapp bei jeder Synchronisierung auf einer beliebigen Maschine benachrichtigt werden.

  1. Wählen Sie auf der Seite Mikroappintegrationen die Citrix Virtual Apps and Desktops Service-Integration.
  2. Wählen Sie die Mikroapp Admin-Modus. Die Ansicht Benachrichtigungen sollte bereits angezeigt werden. Falls nicht, wählen Sie Benachrichtigungen.
  3. Wählen Sie das Optionsmenü (…) der Benachrichtigung Eine Maschine in einem Fehlerzustand. Wählen Sie dann Löschen, um die Benachrichtigung vollständig zu entfernen, oder bearbeiten Sie die Benachrichtigung.

    • Wenn Sie die Benachrichtigung gelöscht haben, fahren Sie mit dem nächsten Abschnitt fort: Anpassen des Endpunkts zur Suche nach allen Maschinen
    • Wenn Sie die Benachrichtigung bearbeitet haben, deaktivieren Sie die Umschaltfläche Dieses Ereignis automatisch nach Änderung der Integrationsdaten ausführen und wählen Sie Speichern.

Anpassen des Endpunkts zur Suche nach allen Maschinen

Löschen Sie den SearchFilter in der vollständigen und inkrementellen Synchronisierung des Endpunkts Maschinen.

  1. Wählen Sie auf der Seite Mikroappintegrationen das Menü neben der Citrix Virtual Apps and Desktops Service-Integration und dann Bearbeiten. Der Bildschirm Laden von Daten wird geöffnet. Wenn das Konfigurationsfenster angezeigt wird, wählen Sie in der linken Navigationsspalte die Option Laden von Daten.
  2. Wählen Sie das Menü neben dem Endpunkt Maschinen und dann Bearbeiten oder wählen Sie den Namen des Endpunkts: Maschinen.

    CVADs-Endpunkte

  3. Wählen Sie im Bildschirm Datenendpunkt bearbeiten unter Vollständige Synchronisierung die Registerkarte TEXT und löschen Sie den SearchFilter, sodass nur {} im TEXT verbleibt.
  4. Scrollen Sie nach unten, wählen Sie unter Inkrementelle Synchronisierung die Registerkarte TEXT und löschen Sie erneut den SearchFilter, sodass nur {} im TEXT verbleibt.

    Suchfilter

  5. Wählen Sie am unteren Bildschirmrand Übernehmen und bestätigen Sie.

Denken Sie daran, die Synchronisierung anzupassen. Weitere Informationen finden Sie unter Synchronisieren von Daten.

Verwenden von CVADs-Mikroapps

Die Citrix Virtual Apps and Desktops Service-Integration enthält vorkonfigurierte Mikroapps. Beginnen Sie mit diesen Mikroapps und passen Sie sie an Ihre Erfordernisse an.

Meine Desktops: Suche nach fehlerhaften virtuellen Citrix-Desktops und Ausführen von Self-Service-Aktionen wie “Neustart” über Citrix Workspace.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Virtueller Desktop - Details” Seite mit Desktopdetails und Optionen für Desktop neu starten und Neustart des Desktops erzwingen.
Seite “Virtuelle Desktops” Durchsuchbare Liste fehlerhafter virtueller Citrix-Desktops, die dem Benutzer zugeordnet sind, mit einem Link zur Seite “Virtueller Desktop - Details”.

Meine Sitzungen: Suche nach fehlerhaften virtuellen Citrix-Sitzungen und Ausführen von Self-Service-Aktionen wie “Abmelden” und “Trennen”.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Liste der Sitzungen” Durchsuchbare Liste von Virtual Desktop-Sitzungen, die dem Benutzer zugeordnet sind, mit einem Link zur Seite “Sitzungsdetails”.
Seite “Sitzungsdetails” Seite mit Virtual Desktop-Sitzungs- und Maschinendetails sowie Optionen für Von Sitzung abmelden und Sitzung trennen.

Virtual Desktops (Admin-Modus): Hiermit können Citrix Workspace CVAD-Administratoren fehlerhafte Maschinen suchen, ihre Details anzeigen, Maschinen in den Wartungsmodus versetzen und die Maschinen neu starten.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung: Eine Maschine in einem Fehlerzustand Wenn ein neuer Datensatz über eine Maschine im Fehlerzustand vorliegt, erhalten alle Abonnenten eine Benachrichtigung mit Schaltfläche Desktop neu starten, die die Seite “Virtueller Desktop - Details” öffnet.
Seite “Liste virtueller Desktops” Durchsuchbare Liste fehlerhafter virtueller Citrix-Desktops mit Link zur Seite “Virtueller Desktop - Details”. Sie können nach Maschine oder Benutzer suchen.
Seite “Virtueller Desktop - Details” Seite mit Desktopdetails und Optionen für Desktop neu starten, Neustart des Desktops erzwingen, Wartungsmodus aktivieren und Wartungsmodus deaktivieren.
Integration von Citrix Virtual Apps and Desktops Service