24 août 2026

Automatisation des installations et des mises à niveau d'Omnissa Horizon 8 avec les API LCM

À partir d'Horizon 8 version 2406, vous pouvez utiliser des API de gestion du cycle de vie d'Horizon (LCM) pour automatiser et simplifier les installations des instances d'Omnissa Horizon Connection Server et du serveur d'enrôlement. Cette page propose des exemples de haut niveau de demandes d'API LCM qui vous permettent de mettre en œuvre un workflow d'installation ou de mise à niveau automatisé.

À propos des API LCM

Les API LCM font partie des API d'Horizon Server. Pour plus d'informations, reportez-vous à la documentation sur https://developer.omnissa.com :

Le Guide de démarrage des API d'Horizon Server explique comment appeler des API à l'aide du chemin d'URL de base d'Horizon Connection Server.
Le document REST API LCM fournit des instructions pour l'utilisation des API LCM.
La Référence des API d'Horizon Server fournit des informations de référence complètes pour chaque API.

Utilisation d'API LCM dans une infrastructure Terraform

Omnissa a également mis au point un fournisseur Terraform pour Horizon 8. Vous pouvez utiliser les API LCM avec ce fournisseur Terraform pour automatiser la gestion du cycle de vie de vos déploiements d'Horizon 8.

Les conditions préalables standard s'appliquent lors de l'utilisation d'API LCM avec le fournisseur Terraform.

Vous trouverez le fournisseur Terraform pour Horizon 8 à l'adresse https://github.com/euc-dev/horizon-terraform.

Conditions préalables

Avant d'utiliser les API LCM, vous devez remplir les conditions préalables répertoriées suivantes. Les sections de cette page fournissent des détails pour chacune d'entre elles.

Version 2406 ou ultérieure d'Horizon Connection Server
Configurer WinRM
Préparer une méthode d'hébergement
Désigner un compte d'administrateur pour l'appel des API LCM
Si nécessaire, configurez un hôte du Serveur de connexion pour approuver une autorité de certification tierce

Version 2406 ou ultérieure

Installez ou effectuez la mise à niveau vers au moins une instance d'Horizon Connection Server 2406 ou version ultérieure. Les API LCM ne sont disponibles qu'à partir de la version 2406 d'Horizon Connection Server.

Remarque : pour un nouveau déploiement d'Horizon 8, vous pouvez utiliser un script de ligne de commande pour automatiser l'installation initiale d'Horizon Connection Server, puis utiliser les API LCM pour les installations suivantes.

Configurer WinRM

Configurez WinRM sur les composants suivants :

Machine hôte Horizon Connection Server à partir de laquelle vous appelez les API LCM
Toute machine cible sur laquelle vous effectuerez une installation ou une mise à niveau automatisée

Préparer la méthode d'hébergement

Préparez l'une des méthodes d'hébergement suivantes :

Partage de fichiers SMB

À partir de la version 2503, les REST API LCM prennent en charge les URL de fichier SMB pour l'enregistrement des modules de build du Serveur de connexion. Cela permet aux administrateurs d'héberger des fichiers de build sur des partages SMB et de les enregistrer à l'aide du paramètre fileUrl.

Conditions préalables à l'utilisation d'URL de fichier SMB :

Format de l'URL du fichier : Utilisez le préfixe smb:// dans le paramètre fileUrl. Par exemple, avec un fichier EXE nommé Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225, le format du paramètre fileUrl serait smb://smb-share/share-name/Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225.exe (où smb-share/share-name correspond aux informations uniques de votre partage SMB).
Autorisations d'accès : le compte de machine de la machine du Serveur de connexion et le compte d'utilisateur LCM doivent disposer d'un accès en lecture au partage SMB. - Compte de machine : il s'agit du compte représentant la machine à partir de laquelle est appelée l'API. Elle est représentée par DOMAIN\MACHINE$ (par exemple, example.com\CS$ pour une machine nommée CS dans le example.com domaine). - Compte d'utilisateur LCM : il s'agit du compte utilisé pour appeler les REST API LCM.

Pour accorder l'autorisation d'accès en lecture aux comptes :

Ouvrez les propriétés du partage SMB (Propriétés), accédez à Sécurité et à Modifier pour modifier les autorisations.
Ajoutez le compte de machine (par exemple example.com\CS$) et le compte d'utilisateur LCM (par exemple, example.com\LCMUser)
Attribuez des autorisations de lecture aux deux comptes, puis enregistrez les modifications apportées aux propriétés (Appliquer et OK).

Ensuite, pour utiliser le partage de fichiers SMB afin d'héberger le programme d'installation de build du serveur et le fichier de bundle LCM, préparez le partage de fichiers SMB comme suit :

Téléchargez le programme d'installation .exe du serveur et Horizon Lifecycle Manager Bundle (lcm.zip) à partir d'Omnissa Customer Connect.
Placez le programme d'installation .exe et le fichier lcm.zip ensemble dans le même répertoire sur le partage de fichiers SMB.

Serveur Web

Pour utiliser un serveur Web pour héberger le programme d'installation du build de serveur et le fichier bundle LCM, préparez le serveur Web comme suit :

Téléchargez le programme d'installation .exe du serveur et Horizon Lifecycle Manager Bundle (lcm.zip) à partir d'Omnissa Customer Connect.
Placez le programme d'installation .exe et le fichier lcm.zip ensemble dans le même répertoire sur le serveur Web de l'hôte.

Hôte Horizon Connection Server

Pour utiliser un hôte Horizon Connection Server pour héberger le programme d'installation du build de serveur et le fichier bundle LCM, préparez l'hôte Horizon Connection Server comme suit :

Si nécessaire, configurez l'hôte du serveur pour approuver une autorité de certification tierce dans le magasin d'approbations.
Téléchargez le programme d'installation .exe du serveur et Horizon Lifecycle Manager Bundle (lcm.zip) à partir d'Omnissa Customer Connect.
Placez le programme d'installation .exe et le fichier lcm.zip ensemble dans le même répertoire sur l'hôte du serveur.

Désigner un compte d'administrateur pour l'appel des API LCM

Désignez le compte Horizon Administrator que vous utiliserez pour appeler les API LCM. Assurez-vous que ce compte appartient au groupe d'administrateurs locaux sur chaque machine cible qui recevra l'installation ou la mise à niveau.

Avant la mise à niveau

Avant d'effectuer une mise à niveau, désactivez les instances cibles d'Horizon Connection Server. Une fois la mise à niveau terminée, vous devez activer chaque instance d'Horizon Connection Server pour la rendre à nouveau disponible.

Configurez un hôte du serveur pour approuver une autorité de certification tierce

Si nécessaire, utilisez la procédure suivante pour configurer l'hôte Horizon Connection Server pour approuver une autorité de certification (CA) tierce dans le magasin d'approbations.

Ouvrez l'Invite de commande cmd en tant qu'administrateur.

Accédez au répertoire bin de Java, par exemple :

cd "C:\Program Files\Omnissa\Horizon\Server\jre\bin"

Exécutez la commande keytool pour importer les certificats dans le magasin de confiance :
```
keytool -trustcacerts -keystore "C:\Program Files\Omnissa\Horizon\Server\jre\lib\security\cacerts" -storepass changeit -importcert -alias {YOUR_ALIAS} -file {YOUR_CRT_FILE}
```
Remplacez {YOUR_ALIAS} par un alias unique pour le certificat (par exemple, MyCertAlias).

Remplacez {YOUR_CRT_FILE} par le chemin d'accès complet à votre fichier de certificat (par exemple, C:\path\to\certificate.crt).
Lorsque vous y êtes invité, tapez yes et appuyez sur Entrer pour confirmer et terminer l'importation du certificat.
Ouvrez services.msc et redémarrez tous les composants Omnissa Horizon répertoriés pour appliquer les modifications apportées au certificat.

Vous pouvez également redémarrer le serveur pour appliquer les modifications.

Exemples de workflow

Les sections suivantes illustrent des exemples de demandes d'API LCM utilisées dans un workflow d'installation ou de mise à niveau classique.

1. Créer et attribuer des privilèges LCM

Pour exécuter des API LCM, vous devez créer le rôle LCM_MANAGEMENT et l'attribuer au compte d'utilisateur désigné.

Créez le rôle LCM_MANAGEMENT :

[POST] /config/v1/roles
{
  "description": "Custom LCM role.",
  "name": "LCM",
  "privileges": [
    "LCM_MANAGEMENT"
  ]
}

Attribuez le rôle LCM_MANAGEMENT au compte désigné :

[POST] /config/v1/permissions
[
  {
    "userOrGroup": "UserOrGroup/Uy0xLTUtMjEtMjMzNzczOTMxMC0yNjQ3NjI3MzY0LTE3NzczMzI0NzktNTAw",
    "role": "Role/NmU4MjgwMmYtMDc4Yi00NGI0LWJiYmEtNGU1MWIxYzNhZWRj/TENN",
    "accessGroup": "AccessGroup/NmU4MjgwMmYtMDc4Yi00NGI0LWJiYmEtNGU1MWIxYzNhZWRj/Um9vdA"
  }
]

Remarque : vous pouvez également créer et attribuer le rôle LCM_VIEW aux comptes d'utilisateurs qui doivent uniquement récupérer des informations d'état pour les workflows LCM. Les utilisateurs disposant de privilèges LCM_VIEW disposent d'un accès en lecture seule et ne peuvent pas envoyer de demandes POST.

2. Enregistrer la build du programme d'installation

Les utilisateurs disposant du rôle LCM_MANAGEMENT peuvent enregistrer la build du serveur qui sera installée sur les machines cibles.

Remarque : si vous effectuez une mise à niveau vers une version ultérieure d'Horizon 8, vous devez réenregistrer la nouvelle build de serveur pour cette version ultérieure.

Pour le paramètre de demande, spécifiez l'URL du fichier du programme d'installation de build .exe sur l'emplacement d'hébergement. Assurez-vous qu'Horizon Lifecycle Manager Bundle (lcm.zip) se trouve dans le même répertoire que le programme d'installation de build .exe, comme décrit dans la section Conditions préalables.
Pour le corps de la demande, incluez les métadonnées de build.

Remarque : dans les exemples ci-dessous, les fichiers EXE sont des fichiers de build du programme d'installation d'Horizon Connection Server spécifiques et les éléments entre accolades ({}) représentent les valeurs que vous fournissez à partir de votre configuration spécifique. Lorsque vous exécutez ces commandes dans votre déploiement, remplacez le nom de fichier du programme d'installation spécifique dont vous disposez et vos informations spécifiques de partage SMB et de serveur Web.

Exemple - partage SMB

[POST] /rest/config/v1/server-installer-packages/action/register?fileUrl=smb://{smb-share}/{share-name}/Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225.exe

{
  "file_size_in_bytes": 401860608,
  "version": "8.15.0",
  "checksum": "d814d56a30477d07e8128a18c5ec09ba38984129f40911ad332e96c143e4fabb",
  "build_number": "13513405225",
  "filename": "Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225.exe",
  "display_Name": "Omnissa Horizon Connection Server"
}

Exemple - serveur Web

[POST] /config/v1/server-installer-packages/action/register?fileUrl=https://{local-webserver}/installer/Omnissa-Horizon-Connection-Server-x86_64-2406-8.13.0-8565949332.exe

{
  "build_number": "8565949332",
  "checksum": "d2f31e1bc6de212f11a34b502ec16d66d5bf896947de3288a337c10df8c5be67",
  "display_name": "Omnissa Horizon Connection Server",
  "file_size_in_bytes": 365891976,
  "filename": "Omnissa-Horizon-Connection-Server-x86_64-8.13.0-8565949332.exe",
  "version": "2406"
}

Une fois l'opération réussie, l'API d'enregistrement renvoie l'unique server_installer_package_id du module d'installation enregistré.

Vous pouvez également utiliser les API LCM suivantes pour effectuer d'autres tâches d'enregistrement. Pour obtenir des informations détaillées, reportez-vous à la page de référence de chaque API.

Tâche	API
Récupérer la liste de toutes les builds du programme d'installation enregistrées	`[GET] /config/v1/server-installer-packages`
Récupérer les métadonnées de build du programme d'installation avec l'ID spécifié (server_installer_package_id)	`[GET] /config/v1/server-installer-packages/{id}`
Désinscrire la build du programme d'installation avec l'ID spécifié (server_installer_package_id)	`[POST] /config/v1/server-installer-packages/{id}/action/unregister`

3. Vérifier les conditions préalables à l'installation sur la machine cible

Les API de vérification préalable vous permettent de valider que les machines cibles remplissent les bonnes conditions préalables. Vérifiez que vous recevez des réponses favorables aux demandes de vérification préalable suivantes avant d'appeler des commandes d'installation.

Validez la configuration système requise pour la machine cible :

[POST] /config/v1/connection-servers/action/validate-system-requirements

Validez la configuration Active Directory requise pour la machine cible :

[POST] /config/v1/connection-servers/action/validate-ad-requirements

Validez la configuration vCenter Server requise pour la machine cible :

[POST] /config/v1/connection-servers/action/validate-virtual-center-requirements

Validez l'état de réplication du maître de schéma et du serveur pour la machine cible à mettre à niveau :

[POST] /config/v1/connection-servers/action/validate-ldap-requirements

4. Exécuter la commande d'installation

Après avoir validé les conditions préalables pour les machines cibles, vous pouvez appeler l'API d'installation ou de mise à niveau.

Incluez les informations suivantes dans le corps de la demande :

Clé	Valeur/Description
domaine	Nom du domaine Active Directory
server_installer_package_id	ID de build du serveur fourni dans la réponse de l'API d'enregistrement de build
target_server_fqdn	Nom de domaine complet (FQDN) de la machine cible
user_name	Nom du compte d'utilisateur utilisé pour planifier l'installation/la mise à niveau sur la machine cible. L'utilisateur doit disposer de privilèges d'administrateur Horizon et appartenir au groupe d'administrateurs local de la machine cible.
mot de passe	Mot de passe du compte d'utilisateur utilisé pour planifier l'installation/la mise à niveau sur la machine cible.
server_msi_install_spec	Options d'installation spécifiées, requises uniquement pour les demandes d'installation. Pour obtenir des informations complètes, reportez-vous à la section Schéma de la référence [POST] /config/v1/connection-servers/action/install-connection-server.

Mettez à niveau la build du serveur sur la machine cible :

[POST] /config/v1/connection-servers/action/upgrade-connection-server

{
  "domain": "AD-TEST-DOMAIN",
  "password": "<password>",
  "server_installer_package_id": "a3768752-77c6-45d0-8e20-908227bce79f",
  "target_server_fqdn": "server.example.com",
  "user_name": "Administrator"
}

Installez la build du serveur sur la machine cible :

[POST] /config/v1/connection-servers/action/install-connection-server

{
  "domain": "AD-TEST-DOMAIN",
  "password": "<password>",
  "server_installer_package_id": "a3768752-77c6-45d0-8e20-908227bce79f",
  "server_msi_install_spec": {
    "admin_sid": "string",
    "deployment_type": "GENERAL",
    "fips_enabled": false,
    "fw_choice": true,
    "html_access": true,
    "install_directory": "%ProgramFiles%\\Omnissa\\Horizon\\Server",
    "primary_connection_server_fqdn": "server.example.com",
    "server_instance_type": "STANDARD_SERVER",
    "server_recovery_pwd": "<password>",
    "server_recovery_pwd_reminder": "<reminder>",
    "vdm_ipprotocol_usage": "IPv4"
  },
  "target_server_fqdn": "server.example.com",
  "user_name": "Administrator"
}

Surveiller la tâche d'installation/de mise à niveau

Après avoir planifié une tâche d'installation ou de mise à niveau sur une machine cible, vous pouvez vérifier l'état de la tâche avec la demande suivante. Incluez le FQDN de la machine cible en tant que paramètre de demande.

[POST] /config/v1/connection-servers/action/retrieve-installer-status?{fqdn}

Cette page vous a-t-elle été utile ?