> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# GoreloAction CLI (via PowerShell)

> Use a CLI GoreloAction do PowerShell para gerar alertas e escrever em campos personalizados de ativos a partir dos seus scripts, com parâmetros de severidade, nome e supressão.

O GoreloAction é um utilitário de linha de comando que permite que scripts PowerShell interajam com o Gorelo. Atualmente, ele suporta:

* Gerar alertas.
* Escrever em campos personalizados de ativos.

## Usar o GoreloAction

<Tabs>
  <Tab title="Gerar alertas">
    Execute o seguinte comando no seu terminal e substitua `<String>` pelos valores dos parâmetros:

    ```powershell theme={null}
    GoreloAction -Alert -Severity <Int> -Name <String> -Description <String> -Suppress <Int>
    ```

    ### Parâmetros

    | Opção          | Descrição                                                                                            |
    | -------------- | ---------------------------------------------------------------------------------------------------- |
    | `-Alert`       | Especifica o modo de criação de alerta.                                                              |
    | `-Severity`    | Define o nível de severidade (Inteiro) <ul><li>1: Crítico</li><li>2: Erro</li><li>3: Aviso</li></ul> |
    | `-Name`        | Título/nome do alerta no Gorelo.                                                                     |
    | `-Description` | Descrição detalhada do alerta no Gorelo (opcional).                                                  |
    | `-Suppress`    | Duração da supressão do alerta em horas (opcional, padrão 4; use 0 para sem supressão).              |
    |                |                                                                                                      |

    #### Exemplo

    ```powershell theme={null}
    GoreloAction -Alert -Severity 1 -Name "NameHere" -Description "DescriptionHere" -Suppress 0
    ```
  </Tab>

  <Tab title="Escrever em campo personalizado de ativo">
    Execute o seguinte comando no seu terminal e substitua `<String>` pelos valores dos parâmetros:

    ```powershell theme={null}
    GoreloAction -SetCustomField -Name <String> -Value <String>
    ```

    #### Parâmetros

    | Opção             | Descrição                                                                                                    |
    | ----------------- | ------------------------------------------------------------------------------------------------------------ |
    | `-SetCustomField` | Especifica o modo de escrita em campo personalizado.                                                         |
    | `-Name`           | Identificador do campo: <ul><li>Formato: `'asset.fieldname'`</li><li>Remova `$gorelo`: da variável</li></ul> |
    | `-Value`          | Dado a ser armazenado no campo.                                                                              |

    #### Exemplo

    ```powershell theme={null}
    GoreloAction -SetCustomField -Name 'asset.rustdeskPassword' -Value "SecurePassword123"
    ```
  </Tab>
</Tabs>