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	Obrigatório. O ID principal do serviço do Azure. Observe que o principal de serviço usado precisa ser atribuído à função Colaborador para o serviço do aplicativo no escopo de assinatura.
-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.
-package	Obrigatório. Indique o caminho completo do arquivo UiPath.Orchestrator.Web.zip.
-confirmBlockClassicExecutions	Obrigatório. Definição desse parâmetro como execução de trabalho de 1 bloco em pastas clássicas após a atualização.
-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 Defina as seguintes configurações para seu Serviço de aplicativo antes de executar o script Publish-Orchestrator.ps1 usando o parâmetro -testAutomationFeatureEnabled: 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á habilitada, a menos que explicitamente desabilitada 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á tiver implantado o Orchestrator sem habilitar o módulo de Testar Automação, execute o Publish-Orchestrator.ps1 script com os mesmos parâmetros que para uma atualização e adicione o parâmetro -testAutomationFeatureEnabled. Atualizar Orchestrator Se você atualizar sua instância do Orchestrator, adicione o parâmetro -testAutomationFeatureEnabled ao script Publish-Orchestrator.ps1 antes de executá-lo. Para obter mais detalhes sobre a atualização do Orchestrator, consulte Atualização do Publish-Orchestrator.ps1.
-insightsFeatureEnabled	Opcional. Este parâmetro habilita o módulo e as funcionalidades do Insights. Você pode habilitar esse recurso em um dos seguintes cenários: Comece do zero com uma instalação limpa do Orchestrator Defina as seguintes configurações para seu Serviço de aplicativo antes de executar o script Publish-Orchestrator.ps1 usando o parâmetro -insightsFeatureEnabled: AppSettings: Key= Insights.ModuleEnabled — defina como True para habilitar o módulo do Insights. AppSettings: Key= Insights.FeatureEnabledByDefault — defina como True para habilitar o módulo do Insights como padrão. Por padrão, essa funcionalidade está desabilitada a menos que explicitamente habilitada. StringDeConexão: Name= Insights — defina a string de conexão com o banco de dados do Insights. 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=Insights;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True Habilitar Insights após instalação do Orchestrator Se você já implantou o Orchestrator sem habilitar o módulo do Insights, execute o script Publish-Orchestrator.ps1 com os mesmos parâmetros que para uma atualização e adicione o parâmetro -insightsFeatureEnabled. Atualizar Orchestrator Se você atualizar sua instância do Orchestrator, adicione o parâmetro -insightsFeatureEnabled ao script Publish-Orchestrator.ps1 antes de executá-lo. Para obter mais detalhes sobre a atualização do Orchestrator, consulte Atualização do Publish-Orchestrator.ps1.
-updateServerFeatureEnabled	Opcional. Este parâmetro habilita o módulo Atualizar servidor. Você pode habilitar esse recurso em um dos seguintes cenários: Comece do zero com uma instalação limpa do Orchestrator Defina as seguintes configurações para seu Serviço de aplicativo antes de executar o script Publish-Orchestrator.ps1 usando o parâmetro -updateServerFeatureEnabled: AppSettings: Chave= UpdateServer.ModuleEnabled- Definido como True para habilitar o módulo Servidor de atualização. AppSettings: Chave=UpdateServer.FeatureEnabledByDefault - Definido como True para habilitar o módulo Servidor de atualização por padrão. Por padrão, essa funcionalidade está desabilitada a menos que explicitamente habilitada. StringDeConexão: Nome=UpdateServer - Defina a string de conexão do banco de dados do Servidor de Atualizaçã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 Habilitar a instalação do servidor de atualização após a instalação do Orchestrator Se você já tiver implantado o Orchestrator sem habilitar o módulo de Atualizar servidor, execute o Publish-Orchestrator.ps1 script com os mesmos parâmetros que para uma atualização e adicione o parâmetro -updateServerFeatureEnabled. Atualizar Orchestrator Se você atualizar sua instância do Orchestrator, adicione o parâmetro -updateServerFeatureEnabled ao script Publish-Orchestrator.ps1 antes de executá-lo. Para obter mais detalhes sobre a atualização do Orchestrator, consulte Atualização do Publish-Orchestrator.ps1.
-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". Observe que ele só pode ser usado em conjunto com o parâmetro -robotsElasticSearchUrl. 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	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. Esse parâmetro junto com elasticSearchDiagnosticsPassword "Password" são necessários para os logs internos do Orchestrator.
-serverElasticSearchDiagnosticsPassword	Opcional. Esse parâmetro permite que você indique a senha da sua instância do Elasticsearch se sua autenticação estiver habilitada. Esse parâmetro junto com elasticSearchDiagnosticsUsername "Username" são necessários para os logs internos do Orchestrator.
-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	Opcional. Pode ser usado apenas se loadBalancerUseRedis estiver definido como true. Uma string de conexão que permite que você configure seu servidor do Redis, que contém o URL do servidor, a senha e a porta usada com o Redis. Também é possível habilitar as conexões criptografadas por SSL entre os nós do Orchestrator e o serviço do Redis. Para obter mais informações, clique aqui. 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	Opcional. Ajuda você a habilitar o serviço do Azure SignalR, facilitando a comunicação direta entre sua frota de Robôs e o serviço do SignalR - O Orchestrator não faz mais essa intermediação. Observe que, se habilitado, Robôs com uma versão inferior à 2019.2 dependem apenas do protocolo de pulsação para se comunicar com o Orchestrator, o que significa que qualquer comando fornecido pelo Orchestrator é coletado por um Robô apenas a cada 30 segundos. Exemplo: -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 - como storageType "FileSystem". Esse é o valor padrão em cenários de atualização e instalações limpas mesmo que o parâmetro não esteja especificado. Azure - como storageType "Azure". Amazon - como storageType "Amazon". Minio - como 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 - forneça um caminho absoluto no formato RootPath=.\Storage, como storageLocation "RootPath=C:\FolderName\AnotherFolderName". Esse é o valor padrão em cenários de atualização e instalações limpas mesmo que o parâmetro não esteja especificado. Azure - forneça uma string de conexão, como storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net". Amazon - forneça uma string de conexão, como storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false". Minio - forneça uma string de conexão, como storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1". Outras informações sobre esses tipos de implantações estão disponíveis aqui. 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. o slot standby da String de Conexão deve ser trocado para o slot sticky (selecionando a caixa Configuração de Slot no Portal do Azure). 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	Opcional. Pares de valor chave de configurações de aplicativo que são enviadas para a seção Configuração de Serviço de Aplicativo do Azure após a implantação. Lembre-se de que isso se aplica apenas às configurações da seção de Configurações do Aplicativo do arquivo UiPath.Orchestrator.dll.config. Você pode usar esse parâmetro para alterar configurações específicas que não estão expostas por meio do script Publish-Orchestrator.ps1. Para os demais, use o parâmetro dedicado ao implantar o 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).
-noAzureAuthentication	Opcional. Permite publicar no Serviço de aplicativo do Azure usando sua própria identidade de usuário, sem ter que criar uma entidade de serviço. Se esse parâmetro for usado, o conjunto de parâmetros UseServicePrincipal (que inclui itens como a ID do aplicativo do Azure, senha, ID de assinatura e ID de tenant) não é mais necessário.
-OrchestratorRootUrl	Opcional. Permite incluir a URL externa do serviço de aplicativo Orchestrator nos casos em que uma URL personalizada é usada. Se esse parâmetro não for preenchido, a URL padrão do serviço de aplicativo será usada.
-azureUSGovernmentLogin	Opcional. Este parâmetro é usado apenas para implantações do Governo dos EUA.

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" `
-testAutomationFeatureEnabled 
-updateServerFeatureEnabled 
-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" `
-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

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