Partilhar via

Runbooks de automação do gerenciamento de serviços para autores

  • Artigo

Os runbooks na Automação do Gerenciamento de Serviços e na Automação do Microsoft Azure são fluxos de trabalho do Windows PowerShell ou scripts do PowerShell. Eles fornecem a capacidade de automatizar processos administrativos para gerenciar e implantar servidores em nuvem ou qualquer outra função que um script do Windows PowerShell possa executar.

Não há diferença nos runbooks entre os dois sistemas, e o mesmo runbook pode ser executado em qualquer um deles com funcionalidade idêntica. Quando o termo Automation é usado neste artigo, ele se refere à Automação do Gerenciamento de Serviços e à Automação do Microsoft Azure.

Os serviços adicionais fornecidos pela Automação para trabalhar com Fluxos de Trabalho do Windows PowerShell incluem o seguinte:

  • Armazenamento e gerenciamento centralizados de runbooks.

  • Arquitetura escalável para agendamento e execução de runbooks.

  • Recursos globais que são gerenciados centralmente e estão disponíveis para todos os runbooks.

  • Interface de usuário para criação e teste de runbooks.

  • Conjunto de cmdlets para gerenciar e iniciar runbooks.

Criar ou importar um runbook

Você pode adicionar um runbook à Automação de Gerenciamento de Serviços criando-o no portal de gerenciamento ou importando-o de um arquivo.

Criar um runbook no Portal de Gestão

  1. No Portal de Gerenciamento, selecione Novo, Serviços de Aplicações, Automação, Runbook, Criação Rápida.

  2. Insira as informações necessárias e selecione Criar. O nome do runbook deve começar com uma letra e pode ter letras, números, sublinhados e hífens.

  3. Se quiser editar o Runbook agora, então selecionar Editar Runbook. Caso contrário, selecione OK.

  4. O seu novo runbook aparecerá no separador Runbooks.

Importar um runbook de um arquivo

  1. No Portal de Gerenciamento, selecione Automação e, em seguida, selecione uma Conta de Automação.

  2. Selecione Importar.

  3. Selecione 'Procurar por Arquivo' e localize o ficheiro de script a importar.

  4. Se quiser editar o Runbook agora, selecione Editar Runbook. Caso contrário, selecione OK.

  5. O seu novo runbook aparecerá no separador Runbooks da conta de Automação.

Importar um runbook de um ficheiro de script com Windows PowerShell

Você pode usar o cmdlet Import-SmaRunbook para criar um novo runbook a partir de um arquivo de script que contém um fluxo de trabalho.

Os comandos de exemplo a seguir mostram como importar um arquivo de script para um runbook existente e, em seguida, publicá-lo.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

Import-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Path $scriptPath
Publish-SMARunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName

Editar um runbook

Cada runbook no Service Management Automation tem duas versões: Draft e Published. Edite a versão de rascunho do fluxo de trabalho e, em seguida, publique-a para que possa ser executada. A versão publicada não pode ser editada.

Editar um runbook com o Portal de Gestão

O Portal de Gerenciamento inclui um editor que você pode usar para exibir e editar runbooks. Além de fornecer recursos básicos de edição de texto, o editor oferece a possibilidade de inserir automaticamente código para runbooks, ativos globais e atividades.

  1. No Portal de Gerenciamento, selecione Automação.

  2. Selecione a guia Runbooks.

  3. Selecione o nome do runbook que deseja editar.

  4. Selecione o separador Autor .

  5. Selecione Rascunho na parte superior do ecrã ou o botão Editar na parte inferior do ecrã.

  6. Execute a edição necessária.

  7. Selecione Salvar quando as edições forem concluídas.

  8. Selecione Publicar se quiser que a versão de rascunho mais recente do runbook seja publicada.

Selecione o separador necessário para os passos de inserir código para runbooks, ativos globais e atividades:

Siga estas etapas para inserir código em um runbook:

  1. Abra o runbook no editor do Portal de Gestão.

  2. Na parte inferior do ecrã, selecione Inserir e, em seguida, selecione Runbook.

  3. Selecione o runbook para inserir na coluna central e selecione a seta para a direita.

  4. Se o runbook contiver parâmetros, eles serão listados para sua informação.

  5. Selecione o botão de verificação.

  6. O código para executar o runbook selecionado será inserido no runbook atual.

  7. Se o runbook exigir parâmetros, forneça um valor apropriado no lugar do tipo de dados cercado por chaves <>.

Editar um guia de automação com o PowerShell

Para editar um runbook com o Windows PowerShell, edite o fluxo de trabalho usando o editor de sua escolha e salve-o em um arquivo .ps1. Você pode usar o cmdlet Get-SMARunbookDefinition para recuperar o conteúdo do runbook e, em seguida, cmdlet Edit-SMARunbook para substituir o fluxo de trabalho de rascunho existente pelo modificado.

Para recuperar o conteúdo de um runbook usando o Windows PowerShell

Os comandos de exemplo a seguir mostram como recuperar o script para um runbook e salvá-lo em um arquivo de script. Neste exemplo, a versão Draft é recuperada. Também é possível recuperar a versão publicada do runbook, embora esta versão não possa ser alterada.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

$runbookDefinition = Get-SMARunbookDefinition -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Type Draft
$runbookContent = $runbookDefinition.Content

Out-File -InputObject $runbookContent -FilePath $scriptPath

Para alterar o conteúdo de um runbook usando o Windows PowerShell

Os comandos de exemplo a seguir mostram como substituir o conteúdo existente de um runbook pelo conteúdo de um arquivo de script que contém um fluxo de trabalho.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

Edit-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Path $scriptPath -Overwrite
Publish-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Path $scriptPath

Editar um runbook de automação com o PowerShell ISE

O ISE (Ambiente de Script Integrado) do Windows PowerShell é um aplicativo que permite executar comandos e escrever, testar e depurar scripts. O complemento SMA PowerShell ISE permite que utilize esta ferramenta para escrever e testar runbooks de automação.

  1. Abra o Windows PowerShell ISE.

  2. Se o complemento SMA ISE não for exibido no lado direito do ISE, abra o menu Complementos e habilite o complemento SMA ISE .

  3. Entre no SMA no separador Configuração.

  4. Selecione a guia Runbook. Deverá ver uma lista de runbooks SMA.

  5. Selecione o runbook que pretende editar e clique em Download. Isso faz o download de uma cópia local do runbook do SMA.

  6. Selecione Abrir. Isso cria um novo separador com o runbook.

  7. Faça as alterações necessárias no manual de execução.

  8. Selecione Carregar rascunho para enviar o runbook para SMA. Isso substituirá a versão de rascunho existente do runbook.

  9. Selecione Publicar rascunho se quiser publicar a versão de rascunho mais recente do runbook.

Publique o seu runbook

Depois de criar seu runbook, você precisa publicá-lo para que o runbook worker possa executá-lo. Cada runbook do Service Management Automation tem uma versão de rascunho e uma versão publicada. Apenas a versão publicada está disponível para ser executada e apenas a versão de rascunho pode ser editada. A versão publicada não é afetada por quaisquer alterações à versão de rascunho. Quando estiver pronto para disponibilizar a versão de rascunho, publique-a, o que substitui a versão publicada pela versão de rascunho.

Publicar um manual de operações usando o portal de gestão

  1. Selecione o espaço de trabalho Automação.

  2. Na parte superior da tela, selecione Runbooks.

  3. Localize o runbook para editar e clique no seu nome.

  4. Na parte superior do ecrã, selecione Autor.

  5. Selecione Rascunho.

  6. Na parte inferior do ecrã, selecione Publicar.

  7. Selecione Sim à mensagem de verificação.

Publicar um runbook usando o PowerShell

Você pode usar o Publish-SmaRunbook para publicar um runbook com o Windows PowerShell. Os comandos de exemplo a seguir mostram como publicar um runbook.

$webServer = 'https://MyServer'
$port = 9090
$runbookPath = 'c:\runbooks\Sample-TestRunbook.ps1'
$runbookName = 'Test-Runbook'

Publish-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName

Publicar um runbook usando o PowerShell ISE

O ISE (Ambiente de Script Integrado) do Windows PowerShell é um aplicativo que permite executar comandos e escrever, testar e depurar scripts. O suplemento ISE do SMA PowerShell permite utilizar esta ferramenta para escrever e testar runbooks de automação.

  1. Abra o Windows PowerShell ISE.

  2. Se o suplemento SMA ISE não for exibido no lado direito do ISE, abra o menu Complementos e habilite o suplemento SMA ISE.

  3. Entre no SMA no separador Configuração.

  4. Selecione a guia Runbook . Deve ver uma lista de runbooks SMA.

  5. Selecione o runbook e selecione Publicar Rascunho para publicar a versão mais recente do rascunho do runbook.

Teste o seu runbook

Você pode testar a versão de rascunho de um runbook no Service Management Automation deixando a versão publicada do runbook inalterada. Isto permite que verifiques se o runbook está a funcionar corretamente antes de substituíres a versão publicada.

Quando se testa um runbook, o runbook de rascunho é executado e todas as ações realizadas são concluídas. Nenhum histórico de trabalho é criado, mas os fluxos de saída e de aviso e erro são exibidos no Painel de Saída de Teste. As mensagens para o de Fluxo Detalhado do são exibidas no Painel de Saída somente se a variável $VerbosePreference estiver definida como Continuar.

Quando se testa um runbook, este ainda executa o fluxo de trabalho normalmente e realiza quaisquer ações em relação aos recursos no ambiente. Por esse motivo, você só deve testar runbooks em recursos que não sejam de produção.

Testar um runbook no Service Management Automation

Para testar um runbook, abrir a versão Draft do runbook no Portal de Gestão. Selecione o botão Test na parte inferior da tela para iniciar o teste.

Você pode parar ou suspender o runbook enquanto ele está sendo testado com os botões abaixo do Painel de Saída. Ao suspender o runbook, este conclui a atividade atual antes de ser suspenso. Uma vez que o runbook é suspenso, você pode pará-lo ou reiniciá-lo.

Testar um runbook usando o PowerShell ISE

O complemento ISE do PowerShell fornece cmdlets que emulam as atividades padrão, como Get-SMACredential e Set-SMAVariable, para que você possa testar o runbook no computador local como faria com qualquer outro script.

Os ativos globais e seus valores são baixados do grupo de automação para uso em testes locais. Você pode inspecionar ou alterar esses valores no separador Ativos. Os valores criptografados são mostrados em laranja, e os seus valores não são baixados. Se você quiser usar esses ativos em testes locais, deverá definir seu valor localmente.

Para testar o runbook no SMA, selecione Rascunho de teste no SMA. Será aberta uma nova janela. Selecione Iniciar Novo Trabalho para iniciar o teste. A saída será exibida na janela.

Exemplos de manuais de automação

Os runbooks a seguir são fornecidos com a Automação do Gerenciamento de Serviços como runbooks de exemplo para ilustrar técnicas e práticas recomendadas. Eles estão disponíveis para serem usados na extensão de automação no Microsoft Azure Pack para Windows Server.

Nome do runbook Descrição
Exemplo-Eliminação-VMCloud-Subscription Demonstra um cenário útil para acionar um runbook quando um usuário exclui uma assinatura do VM Clouds.
Amostra-Managing-Azure Mostra como se conectar a uma assinatura do Microsoft Azure e executar operações básicas usando o módulo PowerShell do Microsoft Azure.
Amostra-Managing-ConfigurationManager Demonstra a capacidade da Automação do Gerenciamento de Serviços de se conectar ao Configuration Manager.
Amostra-Managing-DataProtectionManager Demonstra como se conectar a um servidor do Data Protection Manager (DPM) e exibir informações sobre os discos encontrados no servidor DPM.
Amostra-Managing-MySQLServers Demonstra como recuperar um token de segurança que será usado para recuperar uma lista de servidores host.
Amostra-Managing-OperationsManager Demonstra a capacidade da Automação de Gerenciamento de Serviços de se conectar ao System Center Operations Manager.
Amostra-Managing-Orchestrator Mostra como se conectar ao System Center Orchestrator e iniciar um runbook do Orchestrator para usar sua infraestrutura existente.
Amostra-Managing-Plans Demonstra como criar um novo plano e adicionar o serviço SQL Server com uma cota definida para o novo plano.
Amostra-Managing-ServiceBusClouds Demonstra como se conectar a um servidor do Service Bus Cloud e exibir informações sobre os namespaces criados.
Amostra -Managing-SQLServers Demonstra como criar um novo grupo de servidores e adicionar um servidor de hospedagem SQL.
Amostra-Managing-UserAccounts Demonstra como criar um utilizador no Microsoft Azure Pack para Windows Server, que será criado no Microsoft Azure Pack e aparecerá no portal de gerenciamento para administradores extensão Utilizadores. No entanto, esse usuário também deve ser integrado ao provedor de autenticação (por exemplo, AuthSite) para acessar o portal de gerenciamento para locatários, que não está incluído neste exemplo.
Amostra-Managing-VirtualMachineManager Demonstra como se conectar a um servidor Virtual Machine Manager (VMM) e exibir informações sobre a licença do servidor VMM.
Amostra-Managing-VMClouds Demonstra como acessar informações sobre a conexão de banco de dados de um servidor do Service Provider Foundation e informações sobre os objetos do servidor VMM gerenciados pelo Service Provider Foundation.
Amostra-Managing-WebSiteCloud Demonstra como se conectar a um servidor controlador de Nuvens de Site e exibir informações sobre os servidores implantados de Nuvens de Site.
Modificar Exemplo -VMCloud-Subscription Demonstra um cenário útil para acionar um runbook quando o locatário ou administrador suspende ou ativa uma assinatura do VM Clouds.
Amostra-Using-Activities Demonstra a capacidade da Automação de Gestão de Serviços para utilizar atividades
Amostra -Using-Checkpoints Demonstra a capacidade de usar pontos de verificação na Automação do Gerenciamento de Serviços.
Amostra-Using-Connections Demonstra a capacidade da Automação de Gerenciamento de Serviços de usar conexões para se conectar a sistemas remotos.
Amostra-Using-Credentials Demonstra a capacidade da Automatização da Gestão de Serviços de usar credenciais e apresenta o utilizador sob o qual o runbook da Automatização da Gestão de Serviços está a ser executado. Em seguida, ele conecta-se ao servidor 'ServerName' e mostra o utilizador especificado por 'SampleCredential' que está a aceder ao servidor.
Amostra-Using-Modules Demonstra a importação de módulos em runbooks e gera o número de módulos já importados no servidor 'ServerName'. Em seguida, ele importa o módulo especificado por 'ModulePath' e gera a nova contagem de módulos e as informações correspondentes ao módulo recém-importado.
Amostra-Using-RunbookParameters Demonstra como usar parâmetros de entrada para runbooks e também especificar se os parâmetros são necessários, fornecer valores de parâmetros padrão e usar valores de parâmetro posteriormente no fluxo de trabalho.
Amostra-Using-Runbooks Demonstra como chamar um runbook de dentro de outro runbook.
Amostra-Using-SuspendWorkflow Demonstra como forçar um runbook a interromper. Isso pode ser útil se uma etapa manual for necessária antes que um runbook continue, como receber a aprovação de saída de uma pessoa específica. Após ser concluída a etapa manual, o runbook suspenso será retomado manualmente para continuar.
Amostra-Using-Variables Demonstra a capacidade da Automação do Gerenciamento de Serviços de usar variáveis.
Utilização de amostrasVMCloud-Automation Demonstra um cenário útil para acionar um runbook no início de um evento do Service Provider Foundation.

Próximos passos

  • Leia sobre como chamar um runbook a partir de outro runbook.
  • Leia sobre como trabalhar com módulos de integração.