A partir de Horizon 8 versión 2406, puede usar las API de Lifecycle Management (LCM) de Horizon para automatizar y simplificar las instalaciones de Omnissa Horizon Connection Server y las instancias del servidor de inscripciones. En esta página se incluyen ejemplos de alto nivel de solicitudes de API de LCM que le permitirán implementar un flujo de trabajo de instalación o actualización automatizado.
Acerca de las API de LCM
Las API de LCM forman parte de las API de Horizon Server. Puede consultar más información en la documentación incluida en https://developer.omnissa.com:
-
En la Guía de introducción a la API de Horizon Server se explica cómo invocar las API usando la ruta de URL base de Horizon Connection Server.
-
El documento REST API de LCM incluye directrices para usar las API de LCM.
-
La Referencia de la API de Horizon Server proporciona información de referencia completa de cada API.
Usar las API de LCM en un entorno Terraform
Omnissa también ha desarrollado un proveedor de Terraform para Horizon 8. Puede utilizar las API de LCM con este proveedor de Terraform para automatizar la administración del ciclo de vida de las implementaciones de Horizon 8.
Cuando se utilicen las API de LCM con el proveedor de Terraform, se aplicarán los requisitos estándar.
El proveedor de Terraform para Horizon 8 está disponible en https://github.com/euc-dev/horizon-terraform.
Requisitos
Antes de utilizar las API de LCM, debe cumplir estos requisitos. En las secciones de esta página se incluye información detallada sobre cada uno de ellos.
- Versión 2406 o posterior de Horizon Connection Server
- Configurar WinRM
- Preparar un método de alojamiento
- Designar una cuenta de administrador para invocar las API de LCM
- Si es necesario, configure un host de Connection Server para que confíe en una CA de terceros
Versión 2406 o posterior
Instale o actualice al menos una instancia de Horizon Connection Server 2406 o versiones posteriores. Las API de LCM solo están disponibles en Horizon Connection Server a partir de la versión 2406.
Nota: Para instalar una nueva implementación de Horizon 8, puede utilizar un script de línea de comandos para automatizar la instalación inicial de Horizon Connection Server y, a continuación, utilizar las API de LCM para instalaciones posteriores.
Configurar WinRM
Configure WinRM en estos componentes:
- Máquina host de Horizon Connection Server desde la que se invocan las API de LCM
- Cada máquina de destino en la que realizará una instalación o actualización automatizada
Preparar método de alojamiento
Prepare uno de los siguientes métodos de alojamiento:
Recurso compartido de archivos SMB
A partir de la versión 2503, las REST API de LCM admiten direcciones URL de archivos SMB para registrar paquetes de compilación de Connection Server. Esto permite a los administradores alojar archivos de compilación en recursos compartidos SMB y registrarlos con el parámetro fileUrl.
Requisitos para usar direcciones URL de archivos SMB:
- Formato de URL de archivo: Utilice el prefijo
smb://en el parámetrofileUrl. Por ejemplo, con un archivo EXE llamadoOmnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225, el formato del parámetrofileUrlseríasmb://smb-share/share-name/Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225.exe(dondesmb-share/share-namees la información única del recurso compartido SMB). - Permisos de acceso: Tanto la cuenta de la máquina de Connection Server como la cuenta del usuario de LCM deben tener acceso de lectura al recurso compartido SMB.
- Cuenta de la máquina: Cuenta que representa la máquina desde la que se invoca la API. Se representa como
DOMAIN\MACHINE$(por ejemplo,example.com\CS$para una máquina llamada CS en el dominioexample.com). - Cuenta del usuario de LCM: Cuenta utilizada para invocar las REST API de LCM.
Para conceder el permiso de acceso de lectura a las cuentas:
- Abra las propiedades del recurso compartido SMB (Propiedades), vaya a Seguridad y seleccione Editar para modificar los permisos.
- Agregue la cuenta de la máquina (por ejemplo,
example.com\CS$) y la cuenta del usuario de LCM (por ejemplo,example.com\LCMUser). - Asigne el permiso Lectura a ambas cuentas y guarde los cambios en las propiedades (Aplicar y Aceptar).
A continuación, para usar el recurso compartido de archivos SMB para alojar el instalador de compilación del servidor y el archivo de paquete de LCM, prepare el recurso compartido de archivos SMB de la siguiente forma:
- Descargue el instalador .exe del servidor y el paquete de Horizon Lifecycle Manager (lcm.zip) de Omnissa Customer Connect.
- Coloque el instalador .exe y el lcm.zip juntos en el mismo directorio del recurso compartido de archivos SMB.
Servidor web
Para usar un servidor web para alojar el instalador de compilación del servidor y el archivo de paquete de LCM, prepare el servidor web de la siguiente forma:
- Descargue el instalador .exe del servidor y el paquete de Horizon Lifecycle Manager (lcm.zip) de Omnissa Customer Connect.
- Coloque el instalador .exe y el lcm.zip juntos en el mismo directorio del servidor web.
Host de Horizon Connection Server
Para usar un host de Horizon Connection Server para alojar el instalador de compilación del servidor y el archivo de paquete de LCM, prepare el host de Horizon Connection Server de la siguiente forma:
- Si es necesario, configure el host del servidor para que confíe en una entidad de certificación de terceros en el almacén de confianza.
- Descargue el instalador .exe del servidor y el paquete de Horizon Lifecycle Manager (lcm.zip) de Omnissa Customer Connect.
- Coloque el instalador .exe y el lcm.zip juntos en el mismo directorio del host del servidor.
Designar una cuenta de administrador para invocar las API de LCM
Designe la cuenta de administrador de Horizon que utilizará para invocar las API de LCM. Asegúrese de que esta cuenta pertenece al grupo de administradores locales en cada máquina de destino que recibirá la instalación o la actualización.
Antes de actualizar
Antes de realizar una actualización, desactive las instancias de Horizon Connection Server de destino. Una vez completada la actualización, deberá activar cada instancia de Horizon Connection Server para que pueda volver a utilizarse.
Configurar un host de servidor para que confíe en una CA de terceros
Si es necesario, utilice el siguiente procedimiento para configurar un host de Horizon Connection Server para que confíe en una entidad de certificación (CA) de terceros en el almacén de confianza.
-
Abra una ventana de símbolo del sistema (
cmd) como administrador. -
Desplácese hasta el directorio bin de Java, por ejemplo:
cd "C:\Program Files\Omnissa\Horizon\Server\jre\bin" -
Ejecute el comando
keytoolpara importar el certificado al almacén de confianza:keytool -trustcacerts -keystore "C:\Program Files\Omnissa\Horizon\Server\jre\lib\security\cacerts" -storepass changeit -importcert -alias {YOUR_ALIAS} -file {YOUR_CRT_FILE}Reemplace {YOUR_ALIAS} por un alias único para el certificado (por ejemplo,
MyCertAlias).Reemplace {YOUR_CRT_FILE} por la ruta completa al su archivo de certificado (por ejemplo,
C:\path\to\certificate.crt). -
Cuando se le solicite, escriba
yesy pulse Intro para confirmar y completar la importación del certificado. -
Abra
services.mscy reinicie todos los componentes de Omnissa Horizon indicados para aplicar los cambios realizados en el certificado.También puede reiniciar el servidor para que se apliquen los cambios.
Ejemplos de flujos de trabajo
En las siguientes secciones se muestran ejemplos de solicitudes de API de LCM utilizadas en un flujo de trabajo típico de instalación o actualización.
1. Crear y asignar privilegios de LCM
Para ejecutar las API de LCM, debe crear el rol LCM_MANAGEMENT y asignar este rol a la cuenta de usuario designada.
Cree el rol LCM_MANAGEMENT:
[POST] /config/v1/roles
{
"description": "Custom LCM role.",
"name": "LCM",
"privileges": [
"LCM_MANAGEMENT"
]
}
Asigne el rol LCM_MANAGEMENT a la cuenta designada:
[POST] /config/v1/permissions
[
{
"userOrGroup": "UserOrGroup/Uy0xLTUtMjEtMjMzNzczOTMxMC0yNjQ3NjI3MzY0LTE3NzczMzI0NzktNTAw",
"role": "Role/NmU4MjgwMmYtMDc4Yi00NGI0LWJiYmEtNGU1MWIxYzNhZWRj/TENN",
"accessGroup": "AccessGroup/NmU4MjgwMmYtMDc4Yi00NGI0LWJiYmEtNGU1MWIxYzNhZWRj/Um9vdA"
}
]
Nota: También puede crear y asignar el rol LCM_VIEW a las cuentas de usuario que solo necesitan recuperar información de estado para los flujos de trabajo de LCM. Los usuarios con privilegios LCM_VIEW tienen acceso de solo lectura y no pueden emitir solicitudes POST.
2. Registrar la compilación del instalador
Los usuarios con el rol LCM_MANAGEMENT pueden registrar la compilación del servidor que se instalará en las máquinas de destino.
Nota: Si actualiza a una versión posterior de Horizon 8, deberá volver a registrar la nueva compilación del servidor para esa versión.
- En el parámetro de solicitud, especifique la URL de archivo del instalador de compilación .exe en la ubicación de alojamiento. Asegúrese de que el paquete de Horizon Lifecycle Manager (lcm.zip) se encuentra en el mismo directorio que el instalador de compilación .exe, como se describe en la sección Requisitos.
- En el cuerpo de la solicitud, incluya los metadatos de compilación.
Nota: En los siguientes ejemplos, los archivos EXE son archivos de compilación específicos del instalador de Horizon Connection Server, mientras que los elementos entre llaves ({}) representan los valores proporcionados por usted desde su configuración. Cuando ejecute estos comandos en su implementación, sustituya estos valores por el nombre de archivo del instalador que tenga y la información específica de su recurso compartido SMB y su servidor web.
Ejemplo de recurso compartido 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"
}
Ejemplo de servidor 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"
}
Si es correcto, la API de registro devolverá el identificador server_installer_package_id único del paquete de instalación registrado.
También puede utilizar las siguientes API de LCM para realizar otras tareas de registro. Para obtener información detallada, consulte la página de referencia de cada API.
| Tarea | API |
| Recuperar la lista de todas las compilaciones del programa de instalación registradas | [GET] /config/v1/server-installer-packages |
| Recuperar metadatos de la compilación del instalador con el identificador especificado (server_installer_package_id) | [GET] /config/v1/server-installer-packages/{id} |
| Anular el registro de la compilación del instalador con el identificador especificado (server_installer_package_id) | [POST] /config/v1/server-installer-packages/{id}/action/unregister |
3. Comprobar los requisitos de instalación en la máquina de destino
Las API de comprobación previa permiten validar que las máquinas de destino cumplen los requisitos necesarios. Compruebe que recibe respuestas favorables a las siguientes solicitudes de comprobación previa antes de invocar cualquier comando de instalación.
Valide los requisitos del sistema para la máquina de destino:
[POST] /config/v1/connection-servers/action/validate-system-requirements
Valide los requisitos de Active Directory para la máquina de destino:
[POST] /config/v1/connection-servers/action/validate-ad-requirements
Valide los requisitos de vCenter Server para la máquina de destino:
[POST] /config/v1/connection-servers/action/validate-virtual-center-requirements
Compruebe el estado de replicación del servidor y del maestro de esquema de la máquina de destino que se va a actualizar:
[POST] /config/v1/connection-servers/action/validate-ldap-requirements
4. Ejecutar el comando de instalación
Después de validar los requisitos de las máquinas de destino, podrá invocar la API de instalación o actualización.
Incluya la siguiente información en el cuerpo de la solicitud:
| Clave | Valor/Descripción |
| domain | Nombre del dominio de Active Directory |
| server_installer_package_id | Identificador de compilación del servidor que se proporcionó en la respuesta de la API de registro de compilación |
| target_server_fqdn | Nombre de dominio completo (FQDN) de la máquina de destino |
| user_name | Nombre de la cuenta de usuario utilizada para programar la instalación o actualización en la máquina de destino. El usuario debe tener privilegios de administrador de Horizon y pertenecer al grupo de administradores locales de la máquina de destino. |
| password | Contraseña de la cuenta de usuario utilizada para programar la instalación o actualización en la máquina de destino |
| server_msi_install_spec | Opciones de instalación especificadas (necesarias solo para las solicitudes de instalación). Para obtener más información, consulte la sección Esquema de [POST] /config/v1/connection-servers/action/install-connection-server reference. |
Actualice la compilación del servidor en la máquina de destino:
[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"
}
Instale la compilación del servidor en la máquina de destino:
[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"
}
Supervisar el trabajo de instalación/actualización
Después de programar un trabajo de instalación o actualización en una máquina de destino, puede comprobar el estado del trabajo con la siguiente solicitud. Incluya el FQDN de la máquina de destino como parámetro de solicitud.
[POST] /config/v1/connection-servers/action/retrieve-installer-status?{fqdn}
¿Le resultó útil esta página?