Herramienta de configuración de la plataforma

Importante: la herramienta de configuración de la plataforma funciona para actualizaciones de una versión lanzada en los últimos tres años en relación con la versión principal actual. Las verificaciones y operaciones posteriores a la instalación funcionan después de instalar Orchestrator.

Información general

La herramienta de configuración de la plataforma UiPath es un script de PowerShell que se utiliza para ayudarte a instalar/actualizar Orchestrator con éxito. Te ayuda a comprobar la estabilidad y la predisposición de tu entorno antes de una actualización, y te ayuda a realizar varias operaciones tras la instalación.

La herramienta está disponible para su descarga a continuación y también se incluye con el instalador UiPathOrchestrator.msi. El script agrupado se puede encontrar en la carpeta Tools del directorio de instalación de Orchestrator, C:\Program Files (x86)\UiPath\Orchestrator\ de forma predeterminada. El script comprueba la máquina de Orchestrator. En caso de una instalación multinodo, es suficiente con ejecutar la herramienta en un solo nodo.

La Herramienta de configuración de la plataforma no sigue el mismo esquema de versiones que el instalador UiPathOrchestrator.msi, y puede actualizarse fuera del ciclo de lanzamiento del producto. Recomendamos que descargues y utilices siempre la última versión de la herramienta, disponible a continuación.

Descarga la herramienta

Requisitos previos

Software	Versión compatible
PowerShell	5.1
Módulo de WebAdministration	N/D
Módulo pki	N/D

Cmdlets del script

El script consiste en tres cmdlets diseñados para realizar funciones específicas. Puede introducirse un comando de invocación de cmdlet junto a sus correspondientes parámetros en la línea de comandos para su ejecución inmediata.

Cmdlet	Descripción
Test-PlatformReadiness	Se invoca usando el comando -Readiness Comprueba la estabilidad y la predisposición de tu entorno antes de una actualización, y los requisitos del certificado tras la instalación.
Update-UiPathUrl	Se invoca usando el comando UpdateUiPathUrl Actualiza la dirección pública de Orchestrator y comprueba si la nueva dirección es válida con el certificado actual.
Update-UiPathCertificate	Se invoca usando el comando UpdateUiPathCertificate Actualiza el certificado SSL de Orchestrator o el certificado de firma por token de Identity Server.
AddHostAdmin	Se invoca usando el comando AddHostAdmin Añade un administrador del sistema al tenant del host.

Comprobaciones previas a la instalación

Asp.Net Core

Comprueba si el módulo IIS v3.1.x+ de ASP.NET Core está instalado y funciona. Si no lo está, se te insta a desinstalar y volver a instalar el ASP.Net Core Hosting Bundle.

CyberArk AIM

Comprueba si el agente CyberArk AIM está instalado en la carpeta C:\Program Files (x86)\CyberArk. Si no lo está, se insta al usuario a añadir CLIPasswordSdk.exe en el archivo UiPath.Orchestrator.dll.config utilizando la clave Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath después de la instalación.

Esta comprobación no se lleva a cabo si CyberArk no se encuentra en UiPath.Orchestrator.dll.config.

Cifrado de web.config

Comprueba si el archivo web.config está descifrado. Si lo está, deberás descifrarlo manualmente antes de actualizar. Tras la actualización, la mayoría de los ajustes de configuración de Orchestrator se trasladarán a UiPath.Orchestrator.dll.config.

Más información sobre cómo cifrar el archivo UiPath.Orchestrator.dll.config.

Secciones bloqueadas en web.config

Comprueba si el elemento <system.webServer> contiene alguna sección bloqueada. Si tales secciones existen, deberás desbloquearlas manualmente en IIS.

Scaleout de SQL Server

Comprueba si se utiliza el Scaleout de SQL Server. Debes saber que, durante la instalación, se habilita el Scaleout de Redis.

Complementos del almacén de credenciales

Comprueba que los complementos de almacén de credenciales externos apuntan a un marco compatible.

Complementos de NLog

Comprueba que los complementos de NLog se dirigen a un marco compatible.

Depósitos del Sistema de archivos

Esta comprobación valida que el ajuste Buckets.FileSystem.Allowlist de la aplicación está presente en las versiones de Orchestrator a partir de la 2020.4. Esto cubre tanto las verificaciones previas a la instalación (Orchestrator 2020.4) como las posteriores a ella (Orchestrator 2020.10+). Las versiones de Orchestrator anteriores a la v2020.4 omiten esta comprobación.

• Para realizar las siguientes comprobaciones, deberás desencriptar las secciones de configuración connectionStrings y appSettings. Si alguna de estas secciones de configuración está cifrada, recibirás un aviso en el terminal y se omitirán las demás validaciones de depósito.

  Could not determine if any buckets with file system provider are in use. Config section 'connectionString' is encrypted, could not find the sql connection string to the UiPath database.

• Si por cualquier razón, los depósitos no pudieran ser recuperados de la base de datos, aparecerá una advertencia en el terminal, y se omitirán también el resto de validaciones.

  Could not determine if any buckets with file system provider are in use. Could not connect to the UiPath Database.

• Esta validación se realiza en las rutas raíz de los depósitos recuperados de la tabla de depósitos de la base de datos de Orchestrator. Si hubiera alguna ruta descalificada, te aparecería una alerta en el terminal. Se realiza una comprobación similar para las rutas no cualificadas en las rutas de los ajustes de la aplicación Buckets.FileSystem.Allowlist en el archivo de configuración.
• Si alguna de las rutas en las dos fuentes no fuera válida o resultara descalificada, no se tendrá en cuenta para el resto de las validaciones descritas a continuación.
• Si la configuración de la aplicación Buckets.FileSystem.Allowlist no está establecida en el archivo de configuración, el terminal indicará error pidiéndote que la añadas al listado de permisos en el archivo de configuración. Las rutas sugeridas son la ruta raíz de los depósitos que hacen uso del proveedor del sistema de archivos.

  All storage buckets using the file system provider are not on the allowed list. Add the following setting in the configuration file to allow all exiting buckets root paths: <add key="Buckets.FileSystem.Allowlist" value="C:\work\stuff\Bucket\|C:\work\stuff\Bucket1\" />

• Si la configuración de la aplicación Buckets.FileSystem.Allowlist está establecida en el archivo de configuración, se realiza una validación en la ruta raíz de los depósitos que hacen uso del proveedor del sistema de archivos. Si la ruta raíz de un depósito no es una subruta de ninguna de las rutas definidas en la lista de permisos, una alerta te instará en el terminal a que añadas la ruta raíz del depósito a Buckets.FileSystem.Allowlist.

  There are some storage buckets using the file system provider that are not on the allowed list. The buckets feature will not work for buckets with root paths that are not on the allowed list. Check if any of the following paths are required to be on the allowed list and add them to the 'Buckets.FileSystem.Allowlist' key in configuration file: |C:\work\stuff\Buckets\|C:\work\stuff\Bucket1\

• De lo contrario, si cada ruta raíz del depósito es una subruta de cualquiera de las rutas en el listado de permisos, el terminal mostrará un mensaje de confirmación.

  All storage buckets using file system provider have the root path on the allow list in the configuration file.

Comprobaciones posteriores a la instalación

Requisitos de los certificados

Comprueba que tu instancia de Orchestrator cumple con todos los requisitos de los certificados tras cualquier actualización.

Comprobaciones de los certificados SSL

• el hostname del sitio de Orchestrator coincide con el Sujeto o con un Nombre Alternativo del Sujeto (incluyendo comodines) en el certificado.
• tiene una cadena de confianza válida, y
• no ha caducado.

Comprobaciones de los certificados de firma por token de Identity Server

• El certificado tiene el tamaño de clave adecuado (2048 bits o más),
• tiene una clave privada accesible por el usuario de AppPool, y
• no ha caducado.

Otras consideraciones

Consulta la documentación sobre las consideraciones acerca de la instalación para conocer las demás áreas afectadas por cualquier actualización a la versión 2020.10+ que debas tener en cuenta.

Ejecutar el script

Referencia de los comandos

Comandos y parámetros	Descripción
-Readiness	Comprueba la estabilidad y la predisposición de tu entorno antes de una actualización, y los requisitos del certificado tras la instalación. Parámetros: -SiteName -Ayuda -InstallationDirectory
-UpdateUiPathUrl	Actualiza la dirección pública de Orchestrator. Parámetros: -SiteName -URLdeOrchestrator -SqlConnectionString Importante: Para utilizar este comando se necesita el módulo PowerShell de SQL Server. El módulo se instala de forma predeterminada con SQL Server. Si trabajas en una máquina que no tenga el módulo instalado, consulta aquí cómo instalarlo. Utiliza este comando con precaución, ya que no hay forma de revertirlo si das un paso en falso durante su ejecución.
-UpdateUiPathCertificate	Actualiza el certificado SSL de Orchestrator o el certificado de firma por token de Identity Server. Utilízalo en combinación con el comando -readiness para comprobar la validez de los nuevos certificados. Parámetros: -SiteName -NewTokenSigningThumbprint -NewSSLThumbprint -KeepOldCertificate
-AddHostAdmin	Si se pierde el acceso a la organización del host (por ejemplo, si perdemos la contraseña para el administrador del sistema o los únicos usuarios con cuentas de administrador del sistema abandonan la empresa), puedes utilizar este comando para añadir o restaurar un administrador del sistema. Parámetros: -SiteName -HostAdminUsername -HostAdminPassword -HostAdminEmail

Parámetros de los scripts

Parámetro	Descripción
-SiteName	Opcional. El nombre del sitio web de Orchestrator en la máquina de destino. Será "UiPath Orchestrator" de forma predeterminada. -InstallationDirectory y SiteName son mutuamente excluyentes.
-Help	Opcional. Muestra información sobre las opciones de la herramienta o los comandos disponibles, tales como la sintaxis de los comandos o las comprobaciones que realiza.
-InstallationDirectory	Opcional. La ruta del directorio de instalación de Orchestrator. Por lo general C:\Program Files (x86)\UiPath\Orchestrator\. -InstallationDirectory y SiteName son mutuamente excluyentes. Nota: asegúrate de que la ruta del directorio de instalación finaliza con una barra final (\).
-OrchestratorUrl	Obligatorio. La nueva dirección pública de Orchestrator.
-SqlConnectionString	Opcional. Cadena de conexión de la base de datos de UiPath. Si se deja vacío, el valor se lee desde el archivo appsettings.Production.json.
-NewTokenSigningThumbprint	Opcional. La huella digital del nuevo certificado de firma de token utilizado por Orchestrator Identity Server.
-NewSSLThumbprint	Opcional. La huella digital del nuevo certificado SSL utilizado por la aplicación web de Orchestrator.
-HostAdminUsername	Solo es obligatorio cuando utilices el comando -AddHostAdmin. Nombre de usuario del usuario administrador del host a crear o restaurar.
-HostAdminPassword	Correo electrónico del usuario administrador del host a crear o restaurar cuando utilices el comando -AddHostAdmin. Solo es obligatorio si utilizas estos proveedores de identidades externos: Google Azure Active Directory SAML con estrategia de asignación de usuarios de correo electrónico
-HostAdminEmail	Contraseña del usuario administrador del host a crear cuando utilices el comando -AddHostAdmin. La contraseña solo es obligatoria si el usuario es un usuario de autenticación básico. La contraseña deberá cambiarse en el primer inicio de sesión.

Ejemplos

Para trabajar con el script de la herramienta de configuración de la plataforma, abre un script PowerShell de administrador.

Localiza el directorio donde hayas descomprimido el archivo de la herramienta de configuración de la plataforma y cambia el directorio a esa ubicación:

cd "C:\Program Files (x86)\UiPath\Orchestrator\Tools\PlatformConfiguration"

Realizar una comprobación de la predisposición

El siguiente ejemplo te permite realizar una validación de los requisitos previos a la instalación de Orchestrator. El procedimiento registra sus propios pasos y la información extra de salida a nivel -verbose.

.\Platform.Configuration.Tool.ps1 ` -Readiness ` -SiteName "UiPath Orchestrator"

La instalación previa comprueba que haya una salida con éxito (para actualizaciones desde la versión 2020.4).

Validating 22.10 pre-installation requirements... Checking AspNetCore hosting module... AspNetCore hosting module is installed. Checking CyberArk CLIPasswordSDK.exe path... CyberArk CLIPasswordSDK.exe was found at the default installation path 'C:\Program Files (x86)\CyberArk\ApplicationPasswordSdk\CLIPasswordSDK.exe'. Checking Web.config sections encryption... Web.config sections are not encrypted. Checking IIS configuration locked sections... Configuration sections are not locked. Checking Orchestrator ssl certificate subject alternative names... Orchestrator host name is valid for the ssl certificate subject alternative names. Checking sql server scaleout use... Sql server scaleout is not used. Checking external credential store plugins target framework... Credential stores plugins validation is finished. Checking external NLog plugins target framework... NLog plugins validation is finished. Checking buckets with file system storage provider... All storage buckets using file system provider have the root path on the allowed list in the configuration file. Checking platform certificates... Platform certificates validation is finished. All 22.10 pre-installation checks are done. Platform readiness validations: 10 succeeded, 0 failed and 0 warning(s).

Cambiar los certificados después de la instalación

El siguiente ejemplo te permite actualizar los certificados SSL de Orchestrator y los certificados de firma por token de Identity Server.

.\Platform.Configuration.Tool.ps1 ` -UpdateUiPathCertificate ` -KeepOldCertificate $false -SiteName "UiPath Orchestrator" ` -NewSSLThumbprint "a1b2c3d4" ` -NewTokenSigningThumbprint "z6y5x4v3"

Nota:

• Cualquier archivo appsettings debe descifrarse antes de utilizar el script.
• Asegúrate de que los certificados tengan los permisos apropiados para evitar un error interno del servidor. Para obtener más detalles consulta Resolución de problemas con los certificados.
• El parámetro KeepOldCertificate indica si el certificado actual debe seguir utilizándose como clave de validación para los tokens que se firmaron con él.

Si la clave privada no se ha añadido al certificado, puedes añadirla de forma manual realizando los siguientes pasos:

1. Para localizar la clave privada, inicia el gestor de Internet Information Service (IIS) y selecciona Grupo de aplicación. Debes encontrar la clave privada para cada servicio bajo la columna Identidad.
2. Ve a Gestionar certificados del equipo bajo el Panel de control.
3. Ve a Personal/Certificados.
4. Haz clic con el botón derecho en Nuevo certificado y luego ve a Todas las tareas > Gestionar PrivateKey para añadir la clave privada.

Nota: si tienes varios nodos de Orchestrator, asegúrate de actualizar el certificado en todos los nodos del servidor.

Cambiar la URL de Orchestrator

El siguiente ejemplo te permite actualizar la URL de Orchestrator.

.\Platform.Configuration.Tool.ps1 ` -UpdateUiPathUrl ` -OrchestratorUrl "https://mydomainname" ` -SiteName "UiPath Orchestrator" ` -SqlConnectionString "Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"

Nota: aunque recomendamos utilizar minúsculas para la URL de Orchestrator, la herramienta convierte de forma automática cualquier cadena en mayúsculas a minúsculas.

Crear un nuevo administrador del sistema

El siguiente ejemplo crea un nuevo administrador del sistema en el tenant del host utilizando autenticación básica. Tenga en cuenta que si un proveedor de identidad externo se establece como exclusivo, la autenticación básica solo es accesible a través de la URL hostlogin documentada en Acceder al portal de gestión de identidades .

.\Platform.Configuration.Tool.ps1 ` -AddHostAdmin ` -SiteName "UiPath Orchestrator" ` -HostAdminUsername someuser ` -HostAdminPassword som3pwd! ` -HostAdminEmail [e-mail]

Salida

Los valores de salida están codificados por colores.

Color	Descripción
Rojo	Bloqueadores Los elementos no están configurados y esto evitará la instalación.
Amarillo	Advertencias Puedes instalar Orchestrator, pero no se podrán proporcionar beneficios adicionales.
Verde	Mensajes El entorno está listo para la instalación.