> For the complete documentation index, see [llms.txt](https://docs.linuxcontrolcenter.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.linuxcontrolcenter.com.br/customizable-playbooks.md).

# Playbooks Customizados

## Requisitos

Linux Control Center = 2.10.X ou superior

## Objetivo

Este manual tem como objetivo apresentar todos os recursos que o módulo Playbooks do LCC oferece.

## Overview

No Linux Control Center (LCC), o módulo Playbooks desempenha um papel importante na administração, oferecendo aos usuários a capacidade de executar playbooks personalizados em hosts gerenciados pelo LCC.

A execução de um playbook pelo LCC oferece uma visão completa do processo, permitindo monitorar o andamento em tempo real e gerar relatórios detalhados. Além disso, a execução pode ser realizado pelo Workflow, que permite tomar decisões dinâmicas com base nos resultados de cada etapa.

## Upload e Configuração de Playbooks

1. Para iniciar, acesse o LCC e clique em **Playbooks** no menu lateral esquerdo.

   ![](/files/7v0lPKzM8rnS2M0Rb2P8)
2. Clique em **Create**

   ![](/files/N2D5CXJrIhdWiD4MzYRQ)
3. Insira um nome para identificar o playbook no campo **Name**.
4. Clique em **Upload File** e escolha o playbook desejado em seu computador.

   ![](/files/bb8X2N6NDM7KCxkn0JpZ)
5. Veja que o nome do playbook será exibido no campo **Current File**
6. Clique em **Save** e logo em seguida o playbook estará salvo no banco de dados do LCC.

   ![](/files/MELozzoUOy9m6sxuPV8A)
7. Clique no Playbook que foi criado e sera possível ver as seguintes telas:

### Informações Gerais

1. Tela que exibe a data e hora em que o playbook foi criado, data e hora da ultima alteração e também é possível alterar as informações do campo **Name** e **Descrição**. Também é possível baixar o arquivo ao clicar em **Download**, deletar ao clicar em **Delete** e realizar o upload de um novo arquivo ao clicar em **Change File**

   ![](/files/1cFGPlCcMTo6cgabWw1m)

### Variáveis Dinâmicas no Playbook

Semelhante aos *Scripts Customizáveis* os playbooks também possuem a capacidade de inserir variáveis. Isso permite a execução do mesmo playbook em momentos diferentes com valores distintos, oferecendo adaptabilidade conforme necessário. O formato da variável é **${:::Nome da variável:::}**, sendo o *Nome da variável* o identificador daquela variável.

Após criar o playbook com a variável nesse formato e realizar o upload do arquivo para a console, será possível alterar seu valor diretamente pela interface web do LCC sempre que necessário. O valor atualizado será salvo automaticamente no arquivo do playbook salvo no banco de dados.

1. Veja um exemplo de implementação deste formato de variável

   *var\_name: **${:::var\_name:::}***

   ![](/files/hrdoMNp754EvV39oRt1o)

{% hint style="warning" %}
É importante notar que caso sejam escritas variáveis com o mesmo *identificador*/*nome* o LCC irá substituir o valor da ultima variável inserida pelo usuário em todas as outras. Logo é recomendado utilizar nomes diferentes caso os valores desejados de execução sejam distintos.
{% endhint %}

### Conteúdo do Playbook

1. A tela Content exibe todo o conteúdo do playbook. Na imagem abaixo está a variável citada no tópico anterior.

   ![](/files/vqcsAn1bMdorHI0JSTcB)

### Credenciais de execução

1. Na tela **Credentials** O LCC permite que o Playbook seja executado com uma credencial diferente da padrão *lcc.local*. É possível utilizar Credenciais Linux que estão cadastradas na console do LCC, Credenciais do cofre de senha Password Safe da BeyondTrust por meio de integração e por meio da funcionalidade Hook Bridge Params do LCC.

   ![](/files/NvmaQtWEkr4cjR2mVEEy)

### OS Release

1. Esta funcionalidade permite que o Playbook seja executado em somente em uma determinada Distribuição Linux.
2. Clique em **Create**

   ![](/files/Vox9Jo7jgI8cK8vImz5J)
3. Clique em **Release**, escolha a Distribuição Linux que o playbook será executado e clique em **Save**.

   ![](/files/gXRtImwAdRgEnrbcmqQC)

## Execução de Playbooks

1. Para executar o playbook, basta acessar a tela **Playbooks** e clicar em **Actions** do playbook desejado.

   ![](/files/OMbaVW2ZvBaqYmw0kDzB)
2. Clique em **Run**

   ![](/files/6KSe2TeJTWyVCrDdzpQv)
3. Escolha em qual **Host** ou **Grupo Host** o playbook será executado
4. Clique em **Yes** e o playbook será executado logo em seguida.

   ![](/files/q6ePiXkk7hV8Gp5SZ4T2)
