Compartilhar via

Assistente de atividade de linha de comando

  • Artigo

O Assistente de Atividade de Linha de Comando 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 C# usando o SDK do Orchestrator e o compila para você. Usando esse assembly, você pode utilizar o Pacote de Integração do .NET (parte do Kit de Ferramentas de Integração) para testar suas atividades e, em seguida, usar o Assistente do 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, linha de comando, PowerShell ou comando SSH). Você define o nome da atividade, a estrutura do comando, 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 nos runbooks e são unidas usando links que podem ser definidos com condições para criar ramificações de fluxo de trabalho. Ao criar um runbook usando o Runbook Designer, você arrasta e solta atividades do painel Atividades para o 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 uma tarefa específica 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 extrair dados publicados de qualquer uma das atividades que foram executadas antes dela 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 de Linha de Comando que não faz nada além de ecoar o 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, seu objetivo deve ser definir atividades que encapsulem conjuntos únicos de funcionalidades que permitam fácil reutilização em muitos tipos diferentes de situações. A chave é a flexibilidade. É melhor criar um conjunto de 10 atividades diferentes, cada uma fazendo algo específico e ser capaz de usar essas atividades de 20 maneiras diferentes, em vez de criar 20 atividades diferentes para resolver os cenários individuais específicos. Mais informações sobre as práticas recomendadas são abordadas posteriormente neste documento.

Criar um novo assembly de atividades

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

  1. Selecione Iniciar > todos os programas > Microsoft System Center 2012 > Orchestrator > Integration Toolkit > Orchestrator Assistente de atividade de linha de comando

  2. Selecione Avançar.

  3. Na página Detalhes do assembly, insira um valor para Nome que comece com uma letra e seja seguido por zero ou mais caracteres alfanuméricos. Esse nome é usado como um identificador de namespace C# para o assembly e suas atividades.

  4. Em Arquivo de montagem, insira um caminho e um nome de arquivo do arquivo de montagem que será criado por esse assistente. Se esse arquivo já existir, você será solicitado a substituí-lo.

  5. 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 das propriedades do arquivo. Os valores das propriedades 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
    Product Especifica um nome de produto para o assembly, que aparece como a propriedade Nome do produto nas propriedades do Windows Explorer
    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 Direitos autorais nas propriedades do Windows Explorer
    Marca Registrada Especifica uma marca registrada para o assembly, que aparece como Marcas registradas legais nas propriedades do Windows Explorer
    Versão Especifica a versão do assembly e a versão do arquivo. Eles aparecem nas propriedades do Windows Explorer como Versão do arquivo e Versão do produto.

    O número da versão tem quatro partes, como segue:

    <versão principal>.<versão secundária>.<número de build>.<revisão>

  6. Selecione OK quando terminar de inserir as informações do assembly.

  7. Selecione Avançar. A página Comandos é exibida.

  8. Adicione um ou mais comandos seguindo as instruções fornecidas em Adicionar comandos a um assembly.

  9. Quando você tiver concluído 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 na lista e selecione Remover.

  10. Quando terminar de adicionar e modificar comandos, selecione Avançar. O arquivo de montagem especificado no início do assistente é compilado e, quando o processo é concluído, a página final do assistente é exibida.

  11. Se você quiser criar imediatamente um Pacote de Integração a partir desse novo assembly, selecione o botão Criar 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.

  12. Se você quiser testar seu assembly usando a atividade Invocar .NET ou apenas ignorar o processo de build de IP por enquanto, selecione Concluir.

Adicionar comandos a um assembly

Siga estas etapas para adicionar um comando a um assembly:

  1. 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.

  2. 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 para a atividade. Opcionalmente, você também pode inserir uma Descrição para o comando.

  3. O seletor de propriedade 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 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.

  4. Selecione a guia Argumentos .

  5. No campo Linha de comando, digite o comando ou os parâmetros de linha de comando necessários para sua atividade. Se o comando usar os parâmetros que você deseja que os usuários especifiquem, você precisará adicioná-los à lista Parâmetros abaixo e 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, deverá preceder 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 o Windows PowerShell executa um script do diretório local, ele deve especificar essa notação.

  6. Para fornecer parâmetros para uma linha de comando, selecione Adicionar. A caixa de diálogo Adicionar/Editar parâmetro é exibida.

  7. 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.

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

    Modo de Utilização Descrição
    Argumento de comando Selecione para usar esse argumento como parâmetro na linha de comando (usando o botão Inserir ). Por exemplo, um parâmetro de argumento de comando chamado "Pasta" pode ser colocado na linha de comando assim:

    Dir $(folder)Nota: Se os argumentos da linha de comando contiverem espaços (como nomes de pastas), 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 que a linha de comando seja executada. Ele pode ser usado como um parâmetro de linha de comando ou como uma variável de ambiente em um script que é executado.

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

    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: O item já foi adicionado. Chave no dicionário: 'pasta' Chave sendo adicionada: 'pasta'. 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 do ambiente > de software. Para selecionar outro computador, pressione <CTRL+R>, selecione Computador remoto na rede, digite o nome do computador e selecione OK.

  9. 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 ele. As opções são descritas abaixo:

    Estilo de exibição Descrição
    Text O usuário verá uma caixa de texto de formato livre para inserir um valor
    Texto criptografado O usuário verá uma caixa de texto mascarada. Os dados neste campo serão criptografados no banco de dados e não serão mostrados em nenhum registro
    Verdadeiro/Falso O usuário pode selecionar Verdadeiro ou Falso 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 Navegador de Computador

  10. Se o parâmetro exigir ou você quiser fornecer um valor padrão, digite-o no campo Valor padrão.

  11. Se você selecionou Texto com seleção, o campo Opções será ativado. 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.

  12. Quando terminar a definição do parâmetro, selecione OK.

  13. 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, selecionando o botão Inserir e selecionando o nome do parâmetro. Se definida como uma variável de ambiente, você deve digitar manualmente a variável (no formato %variable%) se desejar na linha de comando.

  14. Se você escolheu os modos Executar programa ou Executar linha de comando, a caixa de seleção para Incluir parâmetro de diretório de trabalho será ativada.

  15. Selecione o separador Dados publicados . As definições deste separador permitem-lhe publicar dados de saída no barramento de dados do Orchestrator para que outras atividades possam utilizar as informações.

  16. Para adicionar uma nova propriedade de dados publicados, selecione Adicionar.

  17. 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 serão exibidos na caixa de diálogo Adicionar/editar dados publicados :

    Itens Descrição
    Nome O nome de exibição do item de Dados Publicados que você está criando
    Origem A origem do item de Dados Publicados. Você pode escolher entre Fluxo de Saída Padrão ou 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.

    Use o Grupo de Extração para recuperar cada item de dados que corresponda ao Padrão especificado
    Padrão A expressão regular que se aplica à configuração Modo
    Descrição O texto de descrição exibido ao lado da propriedade de dados publicados no Runbook Designer. (opcional)

  18. 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 serão exibidos na caixa de diálogo Adicionar/Editar Dados Publicados:

    Itens Descrição
    Nome O nome de exibição do item de Dados Publicados que você está criando
    Propriedade O nome da propriedade do Windows PowerShell que será salva no item de 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 poder ser convertido em uma cadeia de caracteres).
    Descrição O texto de descrição exibido ao lado da propriedade de dados publicados no Runbook Designer. (opcional)

  19. Selecione OK para concluir a adição do item Dados Publicados. Repita as etapas 16 a 18 para cada item de Dados Publicados que você deseja adicionar.

  20. 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 Invocar .NET (contida no IP do Kit de Ferramentas de Integração para .NET) para verificar se ele funciona conforme o esperado antes de convertê-lo em um Pacote de Integração personalizado.

Testar um assembly

Siga estas etapas para testar um assembly:

  1. Abra o Runbook Designer.

  2. Crie um novo runbook.

  3. No painel Atividades, selecione a categoria Kit de Ferramentas de Integração para expandi-la e arraste uma atividade Invocar .NET para o novo runbook.

  4. Clique duas vezes no objeto Invocar .NET para exibir a caixa de diálogo Propriedades .

  5. No campo Assembly, procure o arquivo de assembly que você criou usando o Assistente de Atividade de Linha de Comando (ou por meio de desenvolvimento personalizado usando o SDK) selecionando o botão de reticências (...) à direita do campo. Selecione o arquivo e selecione Abrir.

  6. Selecione o botão de reticências à direita do campo Classe para exibir uma lista dos comandos individuais na montagem. Selecione uma classe de comando e selecione OK. Os parâmetros para essa classe aparecem na guia Propriedades da caixa de diálogo.

  7. O campo Configuração é usado somente por classes desenvolvidas sob medida usando o SDK do Orchestrator com o atributo OrchestratorData. Para obter mais informações sobre o SDK, consulte SDK do System Center Orchestrator Integration Toolkit.

  8. Clique na guia Propriedades.

  9. Forneça as informações para cada uma das propriedades, conforme necessário.

  10. Selecione Concluir para salvar as configurações e retornar ao runbook.

  11. Selecione Runbook Tester na barra de ferramentas do Runbook Designer. O Runbook Tester é iniciado.

  12. Selecione Executar até o 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 .

  13. Selecione Mostrar Detalhes sob o nome da atividade no painel Executar Log para ver os resultados detalhados, incluindo as propriedades de entrada e os dados publicados.

Migração de atividade da CLI do QIK

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

Importante

A instalação do Kit de Ferramentas de Integração do Orchestrator não falhará se o Microsoft .NET Framework 3.5, Service Pack 1 não estiver instalado, mas operações diferentes no Assistente de Atividade de Linha de Comando falharão se ele não estiver presente. Certifique-se de que o Microsoft .NET Framework 3.5, Service Pack 1 esteja instalado antes de usar a CLI.

Converter um assembly CLI do Opalis QIK

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

  1. Inicie o Assistente de Atividade de Linha de Comando do Orchestrator selecionando Iniciar > Todos os Programas > Assistente de Atividade de Linha de Comando do Microsoft System Center 2012 > Orchestrator >

  2. Quando o assistente for carregado, selecione o botão Carregar montagem existente na primeira página.

  3. Selecione o arquivo de assembly existente e, em seguida, selecione Abrir. O nome e o local do arquivo do assembly são mostrados.

  4. 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.

  5. Se você precisar fazer mais alterações nos detalhes das informações da montagem, selecione o botão Informações da montagem e faça essas alterações. Selecione OK quando terminar para retornar à página Detalhes da montagem.

  6. Selecione Avançar para ir para a página Comandos. Você deve ver uma lista de comandos que foram definidos anteriormente no assembly. Revise os comandos, se necessário, e selecione Avançar para continuar na página Montagem de edifícios.

  7. Seu novo assembly será criado para você e salvo usando o caminho e o nome do arquivo que você definiu anteriormente.

  8. Agora você pode usar seu novo assembly compatível com o Orchestrator em runbooks com a atividade Invocar .NET ou pode criar um Pacote de Integração desse assembly selecionando o botão Compilar 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, o uso do Kit de Ferramentas de Integração e as práticas recomendadas.