Scripts de Orchestrator

Publicar en Orchestrator

La siguiente tabla describe todos los parámetros que se pueden utilizar con Publish-Orchestrator.ps1.

Parámetro	Descripción
-action	Obligatorio.Indica el tipo de escenario que quieres iniciar. Las siguientes opciones están disponibles: Deploy - especifica que se trata de una instalación limpia; Update - especifica que actualizas tu instancia de Orchestrator.
-azureAccountApplicationId	Obligatorio. El ID principal del servicio de Azure. Ten en cuenta que a la entidad de servicio utilizada debe asignarse el perfil de colaborador al App Service en el ámbito de la suscripción.
-azureAccountPassword	Obligatorio.La contraseña de token de Azure para el ID principal de servicio.
-azureSubscriptionId	Obligatorio.El ID de suscripción de Azure para el App Service que aloja Orchestrator.
-azureAccountTenantId	Obligatorio. El ID de tenant de Azure.
-resourceGroupName	Obligatorio.El nombre del grupo de recursos de Azure que contiene Orchestrator App Service.
-appServiceName	Obligatorio.El nombre de Orchestrator Azure App Service.
-package	Obligatorio.Indica la ruta completa del archivo UiPath.Orchestrator.Web.zip.
-activitiesPackagePath	Opcional.Especifica la ruta completa del archivo UiPathActivities.zip, incluido de forma predeterminada, a partir de la versión v2018.4.4, en UiPathOrchestrator.zip. Esto te permite instalar la fuente de actividad local en Azure en el momento de la instalación.Ten en cuenta que este parámetro solo puede utilizarse con el tipo de repositorio Legacy. De lo contrario, tendrá que configurarse manualmente.
-testAutomationFeatureEnabled	Opcional.Este parámetro habilita el módulo Probar automatización para las colas de datos de prueba, la ejecución de pruebas y la programación. Puedes habilitar esta característica en función de uno de los siguientes escenarios: Comenzar de cero con una instalación de Orchestrator limpia Realiza la siguiente configuración para tu App Service antes de ejecutar el Publish-Orchestrator.ps1script usando el -testAutomationFeatureEnabledparámetro : AppSettings: TestAutomation.ModuleEnabledKey=: establecer en pTrueara habilitar el módulo Probar automatización. AppSettings: Key=TestAutomation.FeatureEnabledByDefault: establecer en True para habilitar el módulo Probar automatización de forma predeterminada.De forma predeterminada, esta característica está deshabilitada a menos que se habilite de forma explícita. ConnectionString: Name=TestAutomation: establece la cadena de conexión de la base de datos de Probar automatización. Puedes utilizar una cadena de conexión similar a la utilizada para Orchestrator o una completamente diferente.Por ejemplo: Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True :fa-exclamation-circle: Asegúrate de marcar esta configuración como Deployment slot setting, especialmente, si utilizas ranuras del tipo intercambio en caliente (hotswap). Habilitar Probar automatización después de la instalación de Orchestrator Si ya has implementado Orchestrator sin habilitar el módulo Probar automatización, ejecuta el script Publish-Orchestrator.ps1 con los mismos parámetros que para una actualización, y añade el parámetro -testAutomationFeatureEnabled. Actualizar Orchestrator Si actualizas tu instancia de Orchestrator, añade el parámetro -testAutomationFeatureEnabled al script Publish-Orchestrator.ps1 antes de ejecutarlo.
-insightsFeatureEnabled	Opcional. Este parámetro habilita el módulo y la característica de Insights. Puedes habilitar esta característica en función de uno de los siguientes escenarios: Empezar de nuevo con una instalación limpia de Orchestrator Realiza la siguiente configuración para tu Servicio de aplicaciones antes de ejecutar el script Publish-Orchestrator.ps1 usando el parámetro -insightsFeatureEnabled: AppSettings: Key= Insights.ModuleEnabled: establécela como Truepara habilitar el módulo de Insights. AppSettings: Key= Insights.FeatureEnabledByDefault: establécela como Truepara habilitar el módulo de Insights predeterminado.De forma predeterminada, esta característica está deshabilitada a menos que se habilite de forma explícita. ConnectionString: Name= Insights: establece la cadena de conexión a la base de datos de Insights.Puedes utilizar una cadena de conexión similar a la utilizada para Orchestrator o una completamente diferente.Por ejemplo: Server=13.13.13.13;Initial Catalog=Insights;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True Habilitación de Insights tras la instalación de Orchestrator Si ya has implementado Orchestrator sin habilitar el módulo de Insights, ejecuta el script Publish-Orchestrator.ps1 con los mismos parámetros que para una actualización, y añade el parámetro -insightsFeatureEnabled. Actualizar Orchestrator Si actualizas tu instancia de Orchestrator, añade el parámetro -insightsFeatureEnabled al script Publish-Orchestrator.ps1 antes de ejecutarlo.
-updateServerFeatureEnabled	Opcional. Este parámetro habilita el módulo Actualizar servidor. Puedes habilitar esta característica en función de uno de los siguientes escenarios: Empezar de nuevo con una instalación limpia de Orchestrator Realiza la siguiente configuración para tu App Service antes de ejecutar el Publish-Orchestrator.ps1script usando el -updateServerFeatureEnabledparámetro : AppSettings: UpdateServer.ModuleEnabledKey=: establecer en True para habilitar el módulo Actualizar servidor. AppSettings: Key=UpdateServer.FeatureEnabledByDefault: establecer en True para habilitar el módulo Actualizar servidor de manera predeterminada. De forma predeterminada, esta característica está deshabilitada a menos que se habilite de forma explícita. ConnectionString: Name=UpdateServer: establece la cadena de conexión a la base de datos de Actualizar servidor. Puedes utilizar una cadena de conexión similar a la utilizada para Orchestrator o una completamente diferente.Por ejemplo: Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True Habilitar Actualizar servidor tras la instalación de Orchestrator Si ya has implementado Orchestrator sin habilitar el módulo Actualizar servidor, ejecuta el script Publish-Orchestrator.ps1 con los mismos parámetros que para una actualización, y añade el parámetro -updateServerFeatureEnabled. Actualizar Orchestrator Si actualizas tu instancia de Orchestrator, añade el parámetro -updateServerFeatureEnabled al script Publish-Orchestrator.ps1 antes de ejecutarlo.
-robotsElasticSearchUrl	Opcional.Esto solo se debe utilizar si quieres utilizar Elasticsearch para los registros. Facilita la URL de Elasticsearch como el valor, por ejemplo "http://elasticserver:9200".Si tu instancia de Orchestrator requiere autenticación, facilita los parámetros ElasticSearchUsername, ElasticSearchPassword, elasticSearchDiagnosticsUsername y elasticSearchDiagnosticsPassword.
-robotsElasticSearchTargets	Opcional. Este parámetro te permite enviar registros de UiPath Robot solo al servidor de Elasticsearch configurado. Facilita la URL de ElasticSearch como el valor, por ejemplo "http://elasticserver:9200". Ten en cuenta que solo puede utilizarse junto con el parámetro -robotsElasticSearchUrl. Si no facilitas este parámetro, los registros de UiPath Robot se envían a la base de datos SQL configurada y ElasticSearch.
-robotsElasticSearchUsername	Opcional.Este parámetro te permite indicar el nombre de usuario de tu instancia de Elasticsearch si está habilitada su autenticación.
-robotsElasticSearchPassword	Opcional.Este parámetro te permite indicar la contraseña de tu instancia de Elasticsearch si está habilitada su autenticación.
-serverElasticSearchDiagnosticsUsername	Opcional.Este parámetro te permite indicar el nombre de usuario de tu instancia de Elasticsearch si está habilitada su autenticación. Este parámetro, junto con elasticSearchDiagnosticsPassword "Password", es obligatorio para los registros internos de Orchestrator.
-serverElasticSearchDiagnosticsPassword	Opcional.Este parámetro te permite indicar la contraseña de tu instancia de Elasticsearch si está habilitada su autenticación.Este parámetro, junto con elasticSearchDiagnosticsUsername "Username", es obligatorio para los registros internos de Orchestrator.
-loadBalancerUseRedis	Opcional.Utiliza Redis como base de datos para distribuir mensajes y caché a y desde todos los equipos conectados a través de tu equilibrador de carga. Si -redisConnectionString está especificado, se establecerá automáticamente en true, de lo contrario, se establecerá en false.
-redisConnectionString	Opcional. Solo se puede utilizar si loadBalancerUseRedisestá establecido en .true Una cadena de conexión que te permite configurar tu servidor Redis, que contiene la URL del servidor, la contraseña y el puerto utilizado con Redis. También es posible habilitar las conexiones cifradas de SSL entre los nodos de Orchestrator y el servicio Redis. Para obtener más información, haz clic aquí. Ejemplos: con SSL habilitado:n -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=True" sin SSL habilitado: -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=False"
-azureSignalRConnectionString	Opcional.Te ayuda a habilitar el servicio de Azure SignalR, lo que facilita la comunicación directa entre tu flota de UiPath Robots y el servicio SignalR (Orchestrator ya no mediará). Ten en cuenta que, si está habilitado, los UiPath Robots con una versión anterior a 2019.2 dependerán solo del protocolo de latidos para comunicarse con Orchestrator, lo que significa que cualquier comando que provenga de Orchestrator será recogido por un UiPath Robot cada 30 segundos.Ejemplo:-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;"
-storageType	Opcional. Define el destino en el que se guardarán los medios de ejecución y los paquetes.Puede cumplimentarse con los siguientes destinos: FileSystem: como storageType "FileSystem". Este es el valor predeterminado en los escenarios de actualización y en las instalaciones limpias, incluso si el parámetro no está especificado. Azure: como storageType "Azure". Amazon: como storageType "Amazon". Minio: como storageType "Minio". Si has invalidado el parámetro UiPath.Orchestrator.dll.config Storage.Type en la sección Configuración de Azure App Service, al actualizar tendrás que traspasar este valor como un parámetro de script a Publish-Orchestrator.ps1.
-storageLocation	Opcional.Define la ubicación real en la que se guardarán los medios de ejecución y los paquetes. Particularidades: FileSystem: proporciona una ruta absoluta en el formato RootPath=.\Storage, como storageLocation "RootPath=C:\FolderName\AnotherFolderName". Este es el valor predeterminado en los escenarios de actualización y en las instalaciones limpias, incluso si el parámetro no está especificado. Azure: proporciona una cadena de conexión, como storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net". Amazon: proporciona una cadena de conexión, como storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false". Minio: proporciona una cadena de conexión, como storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1". Aquí tiene más información sobre estos tipos de implementaciones. Si has invalidado el parámetro UiPath.Orchestrator.dll.config Storage.Location en la sección Configuración de Azure App Service, al actualizar tendrás que traspasar este valor como un parámetro de script a Publish-Orchestrator.ps1.
-standbyslotname	Opcional.Solo puede utilizarse en escenarios de actualización.Si se especifica, el script implementa Orchestrator en la ranura del App Service indicada en lugar de la de producción. Además, se realizará una ranura de intercambio con la ranura de producción, sin tiempo de inactividad. Prerrequisitos: la ranura del servicio de aplicaciones en espera debe apuntar a una base de datos SQL diferente. la Cadena de conexión de la ranura en espera debe hacerse sticky (seleccionando el cuadro Configuración de ranura en Azure Portal). el archivo UiPath.Orchestrator.dll.config de la ranura de producción debe copiarse a la ranura en espera desde la ranura de producción.
-productionSlotName	Opcional.Solo puede utilizarse si la ranura de la implementación de Orchestrator App Service es diferente a la ranura del servicio de aplicaciones predeterminada de producción establecida por Azure.
-appSettings	Opcional. Pares de valores clave de la configuración de la aplicación que se insertan en la sección de la configuración de Azure App Service después de la implementación. Ten en cuenta que esto solo se aplica a la configuración en la sección Configuración de aplicaciones del archivo UiPath.Orchestrator.dll.config. Puedes utilizar este parámetro para cambiar la configuración específica que no se muestra a través del script Publish-Orchestrator.ps1. Para el resto, utiliza su parámetro dedicado al implementar el script. Ten en cuenta que la configuración existente se combinará con la nueva.
-stopApplicationBeforePublish	Opcional.Si está presente, detiene la aplicación antes de su implementación y la inicia después de que esta finalice.
-unattended	Opcional.Si está presente, la implementación continúa sin confirmación del usuario.
-bucketsAvailableProviders	Opcional.Una cadena que contiene una lista de proveedores de depósitos separados por comas que quieres habilitar.Si no se especifica, se establece el valor predeterminado en Orchestrator,Amazon,Azure,Minio.También tienes la posibilidad de habilitar el proveedor FileSystem añadiéndolo a esa lista. Precaución: si utilizas el proveedor FileSystem y actualizas a la versión 20.10.7 o posteriores, deberás traspasar un valor que incluya FileSystem para este parámetro.Si no lo haces, este proveedor estará deshabilitado y ya no podrás utilizar esos depósitos.
-bucketsFileSystemAllowlist	Obligatorio solo cuando se selecciona FileSystem como proveedor de depósitos.La lista de ubicaciones en la que quieres permitir que se creen depósitos para el proveedor FileSystem. Si habilitas el proveedor FileSystem, también deberás traspasar un valor para este parámetro. Los valores son una lista de rutas de acceso UNC, separadas por el símbolo de la pleca | (p. ej., \mysharedstorage\mybyckets\myotherserver\myotherbuckets).
-noAzureAuthentication	Opcional.Te permite publicar en el Servicio de aplicaciones de Azure confiando en tu propia identidad de usuario sin tener que crear un director de servicio. Si se usa este parámetro, el conjunto de parámetros UseServicePrincipal (que incluye elementos como la ID de aplicación de Azure, la contraseña, la ID de suscripción y la ID de tenant) ya no es necesario.
-OrchestratorRootUrl	Opcional Te permite incluir la URL externa del servicio de la aplicación Orchestrator en los casos en que se utiliza una URL personalizada. Si no se rellena este parámetro, se usa la URL predeterminada del servicio de aplicaciones.
-azureUSGovernmentLogin	Opcional. Este parámetro solo se utiliza para las implementaciones del gobierno de los Estados Unidos.

Parámetros que persisten en la actualización

Los siguientes valores del parámetro UiPath.Orchestrator.dll.config migrarán automáticamente y persistirán al llevar a cabo una actualización. Para cambiarlos, suministra nuevos valores al llamar al script Publish-Orchestrator.ps1.

-NuGet.Packages.ApiKey
-NuGet.Activities.ApiKey
-NuGet.Packages.Path
-NuGet.Activities.Path
-machineKey/@decryption
-machineKey/@decryptionKey
-machineKey/@validationKey
-EncryptionKey
-NuGet.Repository.Type
-Storage.Type
-Storage.Location
-LoadBalancer.Redis.ConnectionString
-LoadBalancer.UseRedis
-Scalability.AzureSignalR.ConnectionString
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@uri
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@username
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@password
-nlog/rules/logger/@name=Robot.*/@writeTo
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@uri
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@username
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@password
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@index
-nlog/rules/logger/@name=*/@writeTo

Ejemplos

Instalación de nodo único

El siguiente ejemplo te permite llevar a cabo una instalación limpia de Orchestrator en un nodo, utilizar Elasticsearch para los registros y guardar paquetes en Azure Blob Storage y sus metadatos en la base de datos SQL. El procedimiento tiene lugar de forma -unattended y registra sus pasos en el nivel -verbose.

.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-testAutomationFeatureEnabled 
-updateServerFeatureEnabled 
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-verbose

Instalación multinodo

El siguiente ejemplo te permite llevar a cabo una instalación limpia de Orchestrator en múltiples nodos y utilizar Elasticsearch para los registros y Redis para la distribución de mensajes y la caché. Los paquetes se guardan en Azure Blob Storage y sus metadatos en la base de datos SQL. El procedimiento tiene lugar de forma -unattended y registra sus pasos en el nivel -verbose.

.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-redisConnectionString "docs123.redis.cache.windows.net:6380,passwprd=******,ssl=True" `
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=*****;Version=1.0;" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-verbose

Actualización multinodo

El siguiente ejemplo te permite actualizar un Orchestrator multinodo existente a la versión más reciente disponible sin cambiar ninguna configuración preexistente. El procedimiento tiene lugar de forma -unattended y registra sus pasos en el nivel -verbose.

Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-verbose

El siguiente ejemplo te permite actualizar un Orchestrator multinodo existente a la versión más reciente disponible y cambiar solo el valor de los parámetros Webhooks.Enabled y Telemetry.Enabled a false. El procedimiento tiene lugar de forma -unattended y registra sus pasos en el nivel -verbose.

Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-appSettings @{"Webhooks.Enabled"="false"; "Telemetry.Enabled"="false"} `
-verbose