Assistente de atividade de linha de comando

Artigo
04/28/2023

Importante

Esta versão do Orchestrator chegou ao fim do suporte. Recomendamos que você atualize para o Orchestrator 2019.

O Assistente de Atividade do Command-Line permite que você crie rapidamente novas atividades no Orchestrator encapsulando comandos, argumentos e parâmetros em um assembly do Microsoft .NET (.DLL). O assistente cria automaticamente o código-fonte em C# usando o Orchestrator SDK e o compila para você. Usando esse assembly, você pode utilizar o Pacote de Integração do .NET (parte do Integration Toolkit) para testar suas atividades e, em seguida, usar o Assistente de Pacote de Integração para empacotar o assembly em um Pacote de Integração personalizado que pode ser distribuído e implantado como outros Pacotes de Integração.

Um assembly pode conter uma ou mais atividades (comandos) e as atividades podem ser um ou mais dos tipos de comando disponíveis (comando Command, Command, Command Line, PowerShell ou SSH). Você define o nome da atividade, a estrutura de comandos, os parâmetros de entrada e até mesmo os dados publicados (saída).

Visão geral das atividades no Orchestrator

Uma atividade é uma única parte funcional de um runbook do Orchestrator. As atividades são o que fazem o trabalho real em runbooks e são unidas usando links que podem ser definidos com condições para criar branches de fluxo de trabalho. Ao criar um runbook usando o Runbook Designer, você arrasta e solta atividades do painel Atividades no runbook e as vincula para formar o fluxo de trabalho. À medida que o runbook é executado, ele invoca cada atividade em sequência de acordo com a maneira como elas foram vinculadas. Cada atividade executa um dever específico e pode coletar dados de entrada do barramento de dados do Orchestrator e publicar sua saída no mesmo barramento de dados. Cada atividade tem a capacidade de desenhar dados publicados de qualquer uma das atividades executadas antes dele no runbook, e a publicação de dados de saída permite que as atividades a seguir os acessem.

As atividades variam de simples a complexas. Você pode criar uma atividade usando o Assistente de Atividade do Command-Line que não faz nada além de ecoar texto para uma propriedade de saída. Você também pode criar uma única atividade que executa uma ação complexa de várias etapas, como a implantação de máquina virtual. Cabe a você definir o que cada atividade fará. No entanto, sua meta deve ser definir atividades que encapsulam conjuntos únicos de funcionalidades que permitem a reutilização fácil em muitos tipos diferentes de situações. A chave é a flexibilidade. É melhor criar um conjunto de 10 atividades diferentes que cada uma faça algo específico e possa usar essas atividades de 20 maneiras diferentes, em vez de criar 20 atividades diferentes para resolver cenários individuais específicos. Mais informações sobre as práticas recomendadas serão abordadas posteriormente neste documento.

Criar um novo assembly de atividade

Criar um novo assembly de atividade de linha de comando

Siga estas etapas para criar um novo assembly de atividade de linha de comando:

Selecione Iniciar > Todos os Programas > Microsoft System Center 2012 > Orchestrator > Integration Toolkit > Orchestrator Command-Line Activity Wizard
Selecione Avançar.
Na página Detalhes do Assembly , insira um valor para Nome que começa com uma letra e é seguido por zero ou mais caracteres alfanuméricos. Esse nome é usado como um identificador de namespace C# para o assembly e suas atividades.
No arquivo assembly, insira um caminho e um nome de arquivo do arquivo de assembly que será criado por esse assistente. Se esse arquivo já existir, você será solicitado a substituir o arquivo.

Selecione Informações do assembly. Você pode inserir informações aqui que se tornarão as propriedades do arquivo de assembly, visíveis no Windows Explorer por meio de propriedades de arquivo. Os valores de propriedade são definidos na tabela abaixo. Essas informações são opcionais e não são necessárias para criar um assembly.

Propriedade	Descrição
Título	Especifica um título para o assembly, que aparece como a propriedade Descrição do arquivo nas propriedades do Windows Explorer
Descrição	Especifica uma descrição opcional para o assembly, que não aparece nas propriedades do Windows Explorer
Produto	Especifica um nome de produto para o assembly, que aparece como a propriedade Nome do produto no Windows Explorer propriedades
Empresa	Especifica um nome de empresa para o assembly, que não aparece nas propriedades do Windows Explorer
Direitos autorais	Especifica um aviso de direitos autorais para o assembly, que aparece como Copyright nas propriedades do Windows Explorer
Marca Registrada	Especifica uma marca registrada para o assembly, que aparece como Marcas comerciais legais no Windows Explorer propriedades
Versão	Especifica a versão do assembly e a versão do arquivo. Elas aparecem nas propriedades do Windows Explorer como Versão do arquivo e Versão do produto. O número de versão tem quatro partes da seguinte maneira: <versão> principal.< versão> secundária.< número de build>.< Revisão>

Selecione OK quando terminar de inserir informações do assembly.
Selecione Avançar. A página Comandos é exibida.
Adicione um ou mais comandos seguindo as instruções fornecidas em Adicionar comandos a um assembly.
Quando concluir a definição de sua atividade, selecione OK. A caixa de diálogo é fechada e sua nova atividade é adicionada à lista na página Comandos . Se você precisar voltar e editar um comando, selecione o comando na lista e selecione Editar. Se você precisar excluir um comando, selecione o comando na lista e selecione Remover.
Quando terminar de adicionar e modificar comandos, selecione Avançar. O arquivo de assembly especificado no início do assistente é compilado e, quando o processo é concluído, a página final do assistente é exibida.
Se você quiser compilar imediatamente um Pacote de Integração desse novo assembly, selecione o botão Compilar Pacote de Integração , que inicia o Assistente de Pacote de Integração e pré-carrega as informações do assembly. Em seguida, siga as instruções em Criando um novo pacote de integração para criar o Pacote de Integração.
Se você quiser testar seu assembly usando a atividade Invocar .NET ou simplesmente ignorar o processo de build de IP por enquanto, selecione Concluir.

Adicionar comandos a um assembly

Adicionar um comando a um assembly

Siga estas etapas para adicionar um comando a um assembly:

Na página Comandos , você pode definir um ou mais comandos (que se tornam atividades) que serão adicionados ao assembly. Para adicionar um novo comando, selecione Adicionar.
A caixa de diálogo Adicionar/Editar Comando exibe e contém três guias: Geral, Argumentos e Dados Publicados. Insira um Nome para o comando. Isso se torna o nome exibido no Runbook Designer da atividade. Opcionalmente, você também pode inserir uma Descrição para o comando.
O seletor de propriedades Mode contém quatro opções: Executar Comando, Executar Windows PowerShell, Executar Programa e Executar Comando SSH. Se você selecionou o modo Executar Programa , o campo Programa ficará ativo. Selecione o botão de reticências (...) e procure o programa que você deseja executar.

Observação

O programa selecionado em um comando Executar Programa será invocado no Runbook Server em que o runbook que contém essa atividade está sendo executado. Portanto, esse programa deve existir em todos os Servidores Runbook em que você espera executar o runbook.
Selecione a guia Argumentos .
No campo Linha de Comando , digite os parâmetros de linha de comando ou comando necessários para sua atividade. Se o comando usar parâmetros que você deseja que os usuários especifiquem, você precisará adicioná-los na lista Parâmetros abaixo e, em seguida, usar o botão Inserir para adicioná-los à linha de comando.

Importante

Se você especificou Executar Windows PowerShell para o Modo e estiver fazendo referência a um script do PowerShell incluído no Pacote de Integração, preceda o nome do script com caracteres de ponto e barra para se referir ao diretório local. Por exemplo, .\MyScript.ps1 seria especificado para um script chamado MyScript.ps1. Isso ocorre porque o arquivo de script será copiado para o diretório padrão do Pacote de Integração. Quando Windows PowerShell executa um script do diretório local, ele deve especificar essa notação.
Para fornecer parâmetros para uma linha de comando, selecione Adicionar. A caixa de diálogo Adicionar/Editar Parâmetro é exibida.
No campo Nome, digite um nome para o parâmetro que você está adicionando. Esse é o nome de exibição do parâmetro mostrado na lista Propriedades da atividade.

Na lista suspensa Modo de uso, selecione o modo que você usará para o parâmetro . O modo uso tem duas opções:

Modo de Uso Descrição

Argumento Command Selecione para usar esse argumento como parâmetro dentro da linha de comando (usando o botão Inserir ). Por exemplo, um parâmetro de argumento de comando chamado "Folder" pode ser colocado na linha de comando como esta:

Dir $(folder)Nota: Se os argumentos de linha de comando contiverem espaços (como nomes de pasta), talvez seja necessário colocá-los entre aspas para que o comando funcione corretamente. Por exemplo: Dir "$(folder)"

Variável de ambiente Selecione para usar esse argumento como uma variável de ambiente que será definida antes da execução da linha de comando. Ele pode ser usado como um parâmetro de linha de comando ou como uma variável de ambiente dentro de um script que é executado.

Por exemplo, um parâmetro de variável de ambiente chamado "Folder" pode ser colocado na linha de comando como esta:

Dir %Folder%Importante: O nome da variável de ambiente já existe em ambientes de usuário ou sistema; o comando falhará com uma mensagem de erro semelhante à seguinte: Item já foi adicionado. Chave no dicionário: 'folder' Chave sendo adicionada: 'folder'. Você pode determinar quais variáveis de ambiente existem em um computador local ou remoto selecionando Iniciar > Execução e digitando MSINFO32.EXE. Em seguida, selecione Variáveis de Ambiente de Ambiente > de Software. Para selecionar outro computador, pressione <CTRL+R>, selecione Computador Remoto na Rede, insira o nome do computador e selecione OK.

Modo de Uso	Descrição
Argumento Command	Selecione para usar esse argumento como parâmetro dentro da linha de comando (usando o botão Inserir ). Por exemplo, um parâmetro de argumento de comando chamado "Folder" pode ser colocado na linha de comando como esta: `Dir $(folder)`Nota: Se os argumentos de linha de comando contiverem espaços (como nomes de pasta), talvez seja necessário colocá-los entre aspas para que o comando funcione corretamente. Por exemplo: `Dir "$(folder)"`
Variável de ambiente	Selecione para usar esse argumento como uma variável de ambiente que será definida antes da execução da linha de comando. Ele pode ser usado como um parâmetro de linha de comando ou como uma variável de ambiente dentro de um script que é executado. Por exemplo, um parâmetro de variável de ambiente chamado "Folder" pode ser colocado na linha de comando como esta: `Dir %Folder%`Importante: O nome da variável de ambiente já existe em ambientes de usuário ou sistema; o comando falhará com uma mensagem de erro semelhante à seguinte: Item já foi adicionado. Chave no dicionário: 'folder' Chave sendo adicionada: 'folder'. Você pode determinar quais variáveis de ambiente existem em um computador local ou remoto selecionando Iniciar > Execução e digitando `MSINFO32.EXE`. Em seguida, selecione Variáveis de Ambiente de Ambiente > de Software. Para selecionar outro computador, pressione <CTRL+R>, selecione Computador Remoto na Rede, insira o nome do computador e selecione OK.

Na lista suspensa Estilo de exibição , selecione o estilo que você usará para exibir o parâmetro. O estilo de exibição determina como o usuário interagirá com a entrada quando ela for apresentada a ela. As opções são descritas abaixo:

Estilo de exibição	Descrição
Texto	O usuário será presenteado com uma caixa de texto de forma livre para inserir um valor
Texto criptografado	O usuário será presenteado com uma caixa de texto mascarada. Os dados nesse campo serão criptografados no banco de dados e não serão mostrados em nenhum log
Verdadeiro/Falso	O usuário pode selecionar True ou False em uma caixa de diálogo pop-up
Texto com Seleção	O usuário pode selecionar em um grupo de Opções que você especificar
Date/time	O usuário pode selecionar o valor usando um controle Seletor de Data/Hora
Arquivo	O usuário pode selecionar o valor usando um controle Navegador de Arquivos
Pasta	O usuário pode selecionar o valor usando um controle Navegador de Pastas
Computador	O usuário pode selecionar o valor usando um controle Do Navegador do Computador

Se o parâmetro exigir ou você quiser fornecer um valor padrão, digite-o no campo Valor padrão .
Se você selecionou Texto com Seleção, o campo Opções está habilitado. Para adicionar valores de opção que o usuário pode selecionar, selecione o botão de reticências ao lado do campo Opções e insira-os. Cada opção é listada em uma linha separada. Quando terminar de adicionar opções, selecione OK.
Quando terminar a definição de parâmetro, selecione OK.
Se definido como um Parâmetro de Comando, o parâmetro agora pode ser adicionado à linha de comando colocando o cursor no ponto de inserção desejado na linha de comando e, em seguida, selecionando o botão Inserir e selecionando o nome do parâmetro. Se definida como uma Variável de Ambiente, você deverá digitar manualmente na variável (no formato %variable%) se desejar na linha de comando.
Se você escolher os modos Executar Programa ou Executar Linha de Comando , a caixa de seleção Incluir parâmetro de diretório de trabalho estará habilitada.
Selecione a guia Dados Publicados . As configurações nessa guia permitem que você publique dados de saída no barramento de dados do Orchestrator para que outras atividades possam usar as informações.
Para adicionar uma nova propriedade de dados publicada, selecione Adicionar.

Se você selecionou a opção Executar Comando, Executar Programa ou Executar Comando SSH na lista suspensa Modo na guia Geral da caixa de diálogo Adicionar/Editar Comando , os seguintes itens aparecerão na caixa de diálogo Adicionar/Editar Dados Publicados :

Itens	Descrição
Nome	O nome de exibição do item Dados Publicados que você está criando
Fonte	A origem do item Dados Publicados. Você pode escolher entre o Fluxo de Saída Padrão ou o Fluxo de Erro Padrão na linha de comando
Mode	O modo que você deseja usar para selecionar os dados publicados. Use o Padrão de Correspondência para determinar se um determinado padrão é encontrado na Origem. Isso retornará True ou False. Usar Extrair Grupo para recuperar cada item de dados que corresponde ao Padrão especificado
Padrão	A expressão regular que se aplica à configuração Modo
Descrição	O texto de descrição que é exibido ao lado da propriedade de dados publicada no Runbook Designer. (opcional)

Se você selecionou a opção Executar Windows PowerShell na lista suspensa Modo na guia Geral da caixa de diálogo Adicionar/Editar Comando, os seguintes itens aparecerão na caixa de diálogo Adicionar/Editar Dados Publicados:

Itens	Descrição
Nome	O nome de exibição do item Dados Publicados que você está criando
Propriedade	O nome da propriedade Windows PowerShell que será salva no item Dados Publicados. Essa propriedade deve estar contida em uma saída de objeto para o pipeline do PowerShell durante o script e não deve ser um objeto (deve ser capaz de ser convertido em uma cadeia de caracteres).
Descrição	O texto de descrição que é exibido ao lado da propriedade de dados publicada no Runbook Designer. (opcional)

Selecione OK para concluir a adição do item Dados Publicados. Repita as etapas de 16 a 18 para cada item dados publicados que você deseja adicionar.
Selecione OK para fechar a caixa de diálogo Adicionar/Editar Comando e retornar à caixa de diálogo Comandos.

Testar um assembly de atividade

Depois de criar um assembly, você pode testá-lo usando a atividade Invoke .NET (contida no IP do Integration Toolkit para .NET) para verificar se ele funciona conforme o esperado antes de convertê-lo em um Integration Pack personalizado.

Testar um assembly

Siga estas etapas para testar um assembly:

Abra o Runbook Designer.
Crie um novo runbook.
No painel Atividades , selecione a categoria Kit de Ferramentas de Integração para expandi-la e arraste uma atividade Invoke .NET para o novo runbook.
Clique duas vezes no objeto Invoke .NET para exibir a caixa de diálogo Propriedades .
No campo Assembly , procure o arquivo de assembly que você criou usando o Assistente de Atividade de Command-Line (ou por meio do desenvolvimento personalizado usando o SDK) selecionando o botão de reticências (...) à direita do campo. Selecione o arquivo e selecione Abrir.
Selecione o botão de reticências à direita do campo Classe para exibir uma lista dos comandos individuais no assembly. Selecione uma classe de comando e selecione OK. Os parâmetros dessa classe aparecem na guia Propriedades da caixa de diálogo.
O campo Instalação é usado apenas por classes desenvolvidas personalizadas usando o SDK do Orchestrator com o atributo OrchestratorData. Para obter mais informações sobre o SDK, consulte System Center Orchestrator Integration Toolkit SDK.
Clique na guia Propriedades.
Forneça as informações para cada uma das propriedades conforme necessário.
Selecione Concluir para salvar as configurações e retornar ao runbook.
Selecione Runbook Tester na barra de ferramentas no Runbook Designer. O Runbook Tester é iniciado.
Selecione Executar para Ponto de Interrupção na barra de ferramentas. O runbook é iniciado e sua atividade é executada. Os resultados da atividade são mostrados no painel Executar Log .
Selecione Mostrar Detalhes no nome da atividade no painel Executar Log para ver os resultados detalhados, incluindo as propriedades de entrada e os dados publicados.

Migração da atividade da CLI do QIK

Se você tiver um assembly criado usando o Assistente de CLI do Opalis 6.3 QIK, será necessário convertê-lo para ser compatível com o Orchestrator antes que ele possa ser usado em um Orchestrator Integration Pack ou usado diretamente em runbooks por meio da atividade Invocar .NET. O processo de conversão é simples e leva apenas alguns segundos por assembly.

Importante

A instalação do Orchestrator Integration Toolkit não falhará se o Microsoft .NET Framework 3.5, o Service Pack 1 não estiver instalado, mas operações diferentes no Assistente de Atividade do Command-Line falharão se ele não estiver presente. Verifique se o Microsoft .NET Framework 3.5, Service Pack 1 está instalado antes de usar a CLI.

Converter um assembly da CLI do Opalis QIK

Siga estas etapas para converter um assembly da CLI do Opalis QIK:

Inicie o Assistente de Atividade do Orchestrator Command-Line selecionando Iniciar > Todos os Programas > Microsoft System Center 2012 > Orchestrator > Command-Line Activity Wizard
Quando o assistente for carregado, selecione o botão Carregar assembly existente na primeira página.
Selecione o arquivo de assembly existente e, em seguida, selecione Abrir. O nome e o local do arquivo do assembly são mostrados.
Modifique o caminho do arquivo para que as alterações sejam salvas em um novo arquivo. Você também pode alterar o nome do assembly, se necessário.
Se você precisar fazer mais alterações nos detalhes das informações do assembly, selecione o botão Informações do assembly e faça essas alterações. Selecione OK quando terminar para retornar à página Detalhes do Assembly.
Selecione Avançar para ir para a página Comandos. Você deve ver uma lista de comandos que foram definidos anteriormente no assembly. Examine os comandos, se necessário, e selecione Avançar para continuar na página Compilar Assembly .
Seu novo assembly será criado para você e salvo usando o caminho e o nome do arquivo que você definiu anteriormente.
Agora você pode usar seu novo assembly compatível com Orchestrator em runbooks com a atividade Invocar .NET ou criar um Integration Pack nesse assembly selecionando o botão Criar Pacote de Integração . Se você não quiser criar um IP no momento, selecione Fechar para encerrar o assistente.

Recursos do Orchestrator

Além dessa referência online fornecida para o System Center 2012 Orchestrator, há vários recursos que podem fornecer informações adicionais sobre a criação de runbooks, usando o Integration Toolkit e as práticas recomendadas.