Scripts do orquestrador

Publicar no Orchestrator

A seguinte tabela descreve todos os parâmetros que podem ser usados com a Publish-Orchestrator.ps1.

Parâmetro	Description
-action	Obrigatório. Indica o tipo de cenário que você deseja iniciar. As seguintes opções estão disponíveis: Deploy - especifica que é uma instalação limpa; Update - especifica que você está atualizando sua instância do Orchestrator.
-azureAccountApplicationId	Mandatory. The Azure service principal ID. Please note that the used service principal needs to be assigned the Contributor role to the app service at the subscription scope.
-azureAccountPassword	Obrigatório. O token de acesso do Azure para o ID principal do serviço.
-azureSubscriptionId	Obrigatório. O ID de assinatura do Azure para o Serviço de Aplicativo que hospeda o Orchestrator.
-azureAccountTenantId	Obrigatório. O ID de tenant do Azure.
-resourceGroupName	Obrigatório. O nome do Grupo de Recursos do Azure que contém o Serviço de Apps do Orchestrator.
-appServiceName	Obrigatório. O nome do Serviço de App do Azure via Orchestrator.
-hostAdminPassword	Obrigatório apenas para novas implantações, quando -action está definido como Deploy. Especifique uma senha personalizada para o administrador do host. Observe que as senhas devem ter pelo menos 8 caracteres e devem ter pelo menos uma letra minúscula e pelo menos um dígito.
-isHostPassOneTime	Opcional. Permite que você imponha uma redefinição de senha no primeiro logon para o administrador do host. Se este parâmetro for omitido, a senha de administrador do host não será uma senha de uma só vez.
-defaultTenantAdminPassword	Obrigatório apenas para novas implantações, quando -action está definido como Deploy. Especifique uma senha personalizada para o administrador de locatário padrão. Observe que as senhas devem ter pelo menos 8 caracteres e devem ter pelo menos uma letra minúscula e pelo menos um dígito.
-isDefaultTenantPassOneTime	Opcional. Permite que você imponha uma redefinição de senha no primeiro logon para o administrador padrão do tenant. Se este parâmetro for omitido, a senha de administrador do tenant não será uma senha de uma só vez.
-package	Obrigatório. Indique o caminho completo do arquivo UiPath.Orchestrator.Web.zip.
-activitiesPackagePath	Opcional. Especifique o caminho completo do arquivo UiPathActivities.zip, que está incluído por padrão, começando com a v2018.4.4, em UiPathOrchestrator.zip. Isso permite que você instale o feed de atividades local no Azure na hora da instalação. Observe que esse parâmetro pode ser usado apenas com o tipo de repositório Legacy. Caso contrário, ele deve ser configurado manualmente.
-testAutomationFeatureEnabled	Opcional. Esse parâmetro habilita o módulo Testar Automação para filas de dados de testes, execução de testes e agendamento. Você pode habilitar essa funcionalidade com base em um dos seguintes cenários: Comece novamente com uma instalação limpa do Orchestrator Configure the following settings for your App Service before running the Publish-Orchestrator.ps1 script using the -testAutomationFeatureEnabled parameter: AppSettings: Key=TestAutomation.ModuleEnabled - Defina como True para habilitar o módulo Testar Automação. AppSettings: Key=TestAutomation.FeatureEnabledByDefault - Defina como True para para habilitar o módulo Testar Automação por padrão. Por padrão, essa funcionalidade está desabilitada a menos que explicitamente habilitada. ConnectionString: Name=TestAutomation - Defina a string de conexão do banco de dados do Testar Automação. Você pode usar uma string de conexão semelhante à usada para o Orchestrator ou uma completamente diferente. Por exemplo: 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 Certifique-se de marcar essas configurações como Deployment slot setting, especialmente, se você estiver usando slots de hotswap. Habilitar o módulo Testar Automação após a instalação do Orchestrator Se você já implantou o Orchestrator sem habilitar o módulo Test Automation, execute o script Publish-Orchestrator.ps1 com os mesmos parâmetros de uma atualização e adicione o parâmetro -testAutomationFeatureEnabled . Atualizar Orchestrator Se você atualizar sua instância do Orchestrator, execute o script Publish-Orchestrator.ps1 com os mesmos parâmetros que para uma atualização e adicione o parâmetro -testAutomationFeatureEnabled.
-robotsElasticSearchUrl	Opcional. Isso deve ser usado apenas se você quiser usar o Elasticsearch para registrar em log. Forneça a URL do Elasticsearch como o valor, como "http://elasticserver:9200". Se sua instância do Orchestrator requer autenticação, forneça os parâmetros ElasticSearchUsername, ElasticSearchPassword, elasticSearchDiagnosticsUsername, e elasticSearchDiagnosticsPassword.
-robotsElasticSearchTargets	Opcional. Esse parâmetro permite que você envie os logs do Robô apenas para o servidor configurado do Elasticsearch. Forneça a URL do Elasticsearch como o valor, como "http://elasticserver:9200". -robotsElasticSearchUrlObserve que ele só pode ser usado em conjunto com o parâmetro. Se você não fornecer esse parâmetro, os logs do Robô são enviados tanto para o banco de dados SQL configurado quanto para o Elasticsearch.
-robotsElasticSearchUsername	Opcional. Esse parâmetro permite que você indique o nome de usuário da sua instância do Elasticsearch se sua autenticação estiver habilitada.
-robotsElasticSearchPassword	Opcional. Esse parâmetro permite que você indique a senha da sua instância do Elasticsearch se sua autenticação estiver habilitada.
-serverElasticSearchDiagnosticsUsername	Optional. This parameter enables you to indicate the username for your Elasticsearch instance if its authentication is enabled. This parameter together with elasticSearchDiagnosticsPassword "Password" are required for internal Orchestrator logs.
-serverElasticSearchDiagnosticsPassword	Optional. This parameter enables you to indicate the password for your Elasticsearch instance if its authentication is enabled. This parameter together with elasticSearchDiagnosticsUsername "Username" are required for internal Orchestrator logs.
-useQuartzClustered	Opcional. Uma chave que indica que esta é uma instalação em cluster.
-loadBalancerUseRedis	Opcional. Use o Redis como um banco de dados para distribuir mensagens e cache para e de todas as máquinas conectadas por meio do seu balanceador de carga. Se -redisConnectionString for especificado, ele será definido como true; se não, como false.
-redisConnectionString	Optional. It can only be used if loadBalancerUseRedis is set to true. A connection string that enables you to set up your Redis server, which contains the URL of the server, the password, and port used with Redis. It is also possible to enable SSL encrypted connections between the Orchestrator nodes and the Redis service. For more information, please click here. Exemplos: com SSL habilitado - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=True" sem SSL habilitado - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=False"
-azureSignalRConnectionString	Optional. Helps you enable Azure SignalR Service, facilitating a direct communication between your Robot fleet and the SignalR Service - Orchestrator no longer intermediates it. Please note that, if enabled, Robots with a version lower than 2019.2 rely only on the Heartbeat protocol to communicate to Orchestrator, meaning that any command given from Orchestrator is picked up by a Robot only every 30 seconds. Example: -azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;"
-storageType	Opcional. Define o destino em que a mídia de execução e os pacotes devem ser salvos. Pode ser preenchido com os seguintes destinos: FileSystem - such as storageType "FileSystem" . This is the default value in both update scenarios and clean installations, even if the parameter is not specified. Azure - such as storageType "Azure" . Amazon - such as storageType "Amazon" . Minio - such as storageType "Minio" . Se você tiver substituído o parâmetro UiPath.Orchestrator.dll.config Storage.Type na seção Configuração do Serviço de Aplicativo do Azure, ao atualizar, você precisa passar esse valor como um parâmetro de script para Publish-Orchestrator.ps1.
-storageLocation	Opcional. Define o local real onde a mídia de execução e os pacotes devem ser salvos. Particularidades: FileSystem - provide an absolute path in the RootPath=.\Storage format, such as storageLocation "RootPath=C:\FolderName\AnotherFolderName" . This is the default value in both update scenarios and clean installations, even if the parameter is not specified. Azure - provide a connection string, such as storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" . Amazon - provide a connection string, such as storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false" . Minio - provide a connection string, such as storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1" . More information on these deployments types is available here. Se você tiver substituído o parâmetro UiPath.Orchestrator.dll.config Storage.Location na seção Configuração do Serviço de Aplicativo do Azure, ao atualizar, você precisa passar esse valor como um parâmetro de script para Publish-Orchestrator.ps1.
-standbyslotname	Opcional. Isso pode ser usado apenas em cenários de atualização. Se especificado, o script implanta o Orchestrator no slot do serviço de app indicado em vez do de Produção. Além disso, um slot de troca é executado com o slot de Produção, sem tempo de inatividade. Pré-requisitos: o slot do Serviço de Aplicativo em espera deve apontar para um banco de dados SQL diferente. the standby slot Connection String must be made slot sticky (by selecting the Slot Setting box in Azure Portal). o arquivo do slot de produção UiPath.Orchestrator.dll.config deve ser copiado para o slot de espera do slot de produção.
-productionSlotName	Opcional. Ele pode ser usado apenas se o slot de implantação do Serviço de Aplicativo do Orchestrator estiver diferente do slot de Serviço de Produção definido pelo Azure.
-appSettings	Optional. Key-value pairs of application settings that are pushed to the Azure App Service Configuration section after deployment. Keep in mind that this only applies to settings from the App Settings section of the UiPath.Orchestrator.dll.config file. You can use this parameter to change specific settings that are not exposed through the Publish-Orchestrator.ps1 script. For the rest, please use their dedicated parameter while deploying the script. Observe que as configurações existentes são mescladas com as novas.
-stopApplicationBeforePublish	Opcional. Se presente, ele interrompe a aplicação antes da implantação e reinicia após a conclusão da implantação.
-unattended	Opcional. Se presente, a implantação continua sem qualquer confirmação do usuário.
-bucketsAvailableProviders	Opcional. Uma string que contém uma lista separada por vírgulas de provedores de bucket que você deseja habilitar. Se não for especificado, ele volta para Orchestrator,Amazon,Azure,Minio. Você também tem a opção de habilitar o provedor do FileSystem, adicionando-o a essa lista. Atenção: se você usar o provedor de FileSystem e atualizar para 20.10.7 ou posterior, você deve passar um valor que inclui FileSystem para este parâmetro. Se você não fizer isso, este provedor está desabilitado e você não poderá mais usar esses buckets.
-bucketsFileSystemAllowlist	Obrigatório apenas quando o FileSystem é selecionado como um provedor de bucket. A lista de locais que você deseja permitir que buckets sejam criados para o provedor FileSystem. Se você habilitar o provedor do FileSystem, você deve passar um valor para este parâmetro também. Os valores são uma lista de caminhos UNC, separados pelo símbolo de tubulação |(por exemplo, \\mysharedstorage\mybyckets\|\\myotherserver\myotherbuckets).

Parâmetros mantidos na atualização

Os seguintes UiPath.Orchestrator.dll.config valores de parâmetro são automaticamente migrados e mantidos ao executar uma atualização. Para alterá-los, forneça novos valores ao chamar o 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

Exemplos

Instalação de Nó Único

O seguinte exemplo permite que você execute uma instalação limpa do Orchestrator em um nó, use o Elasticsearch para registrar em log e salvar pacotes no armazenamento de blob do Azure e seus metadados no banco de dados SQL. O procedimento ocorre de maneira -unattended e registra suas etapas no -verbose nível.

.\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" `
-hostAdminPassword "12345qwert" `
-defaultTenantAdminPassword "12345qwert" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-verbose

Instalação de vários nós

O seguinte exemplo permite que você execute uma instalação limpa do Orchestrator em vários nós e usa o Elasticsearch para registrar em log e o Redis para a distribuição de mensagens e armazenamento em cache. Os pacotes são salvos no armazenamento de blobs do Azure e seus metadados no banco de dados SQL. O procedimento ocorre de maneira -unattended e registra suas etapas no -verbose nível.

.\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" `
-useQuartzClustered `
-redisConnectionString "docs123.redis.cache.windows.net:6380,passwprd=******,ssl=True" `
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=*****;Version=1.0;" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-hostAdminPassword "12345qwert" `
-defaultTenantAdminPassword "12345qwert" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-verbose

Atualização de vários nós

O seguinte exemplo permite que você atualize um Orchestrator de vários nós existente para a versão mais recente disponível, sem alterar qualquer configuração pré-existente. O procedimento ocorre de maneira -unattended e registra suas etapas no -verbose nível.

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

O seguinte exemplo permite que você atualize um Orchestrator de vários nós existente para a versão mais recente disponível enquanto altera apenas o valor dos parâmetros Webhooks.Enabled e Telemetry.Enabled para false. O procedimento ocorre de maneira -unattended e registra suas etapas no -verbose nível.

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