Execução do Hook Bridge

O Hook Bridge é utilizado para facilitar integrações com o Linux Control Center. Servindo como um ponto de acesso, esta funcionalidade permite que o usuário execute ações pré configuradas no sistema sem necessáriamente estar logado na Console mas ainda sim garantindo alta rastreabilidade do fluxo e múltiplas opções de acompanhamento da execução.

1. Veja o fluxo de funcionamento do Hook Bridge

   

1. Acesse o Linux Control Center.

2. No menu lateral, selecione Hook Bridge e clique em ADICIONAR.

Acessando Hook Bridge

3. Em Hook Bridge, preencha os campos a seguir.

Criando um Hook Bridge no sistema

- Name: Identificador da tarefa.
- Redes Permitidas: Faixa de rede a qual o host alvo.
- Action: Ação a ser executada.
- Login Type: Tipo de login que será utilizado no host.
- Description (opcional): Detalhes adicionais.

Ao selecionar Request Credentials como tipo de login, o usuário deve obrigatoriamente passar como query param na requisição as credenciais de usuário e senha.

4. Após criar o Hook Bridge, clique nele para visualizar as informações.

Hook Bridge

Enviando requisição

Para enviar uma requisição utiliza-se o método http GET para o seguinte endpoint /api/v2/hook_bridge/request/action. Há dois tipos de requisição para o Hook Bridge, sendo a forma de acessar a máquina o que difere entre elas.

1. Login Type: Request Credential

• Kwargs

Id: Id do Hook Bridge

Id do Hook Bridge

• Args

- Token: Identificador para dupla autenticação da requisição.
- Username: Usuário utilizado para fazer login no host.
- Password: Senha utilizada para fazer login no host.
- Host: IPV4 do host utilizado para localização.*
- Hostname: Hostname do host utilizado para localização.*

Token do Hook Bridge

Na url da requisição deve conter Host e/ou Hostname. Quando enviado apenas um deles, a busca será feita pelo parâmetro informado. Caso seja passado ambos os parâmetros, a busca será feita utilizando os dois, ou seja, caso o Hostname não esteja atribuído ao Host informado, o match não será feito e a requisição retornará um erro informando o ocorrido.

Exemplo de requisição curl utilizando o argumento host

curl -X GET "https://ipaddress:port/api/v2/hook_bridge/request/action/1?host=10.15.88.4&username=hook123&password=hook123&token=YfNa1UKBlMV7nLpa"

Exemplo de requisição curl utilizando ambos os argumentos host e hostname

curl -X GET "https://ipaddress:port/api/v2/hook_bridge/request/action/1?hostname=lcc-ubuntu-22&host=10.15.88.4&username=hook123&password=hook123&token=YfNa1UKBlMV7nLpa"

2. Login Type: Script Configuration

• Kwargs

- Id: Id do Hook Bridge

Id do Hook Bridge

Token do Hook Bridge

• Args

• Token: Identificador para dupla autenticação da requisição.

• Host: IPV4 do host utilizado para localização.*

• Hostname: Hostname do host utilizado para localização.*

Ao selecionar a opção Script Configuration, o login será efetuado na máquina de acordo com as configurações registradas na aba Credential presente no Menu lateral -> Custom Script -> Credential, não sendo necessário informar o parâmetro Username ou Password como arg da requisição.

Exemplo de uma requisição curl utilizando as credenciais configuradas no script.

curl -X GET "https://ipaddress:port/api/v2/hook_bridge/request/action/1?&host=10.15.88.4&username=hook123&password=hook123&token=YfNa1UKBlMV7nLpa"

3. Analisando execução

Há múltiplas formas de verificar a execução de uma ação enviada ao Hook Bridge, sendo elas:

1. Hook Bridge Request

Acesse o Hook Bridge Request

Histórico Hook Bridge

Nesta página é possível ver todo o histórico de execuções para aquele Hook Bridge, assim como outras informações como

• Host

• Status

• Criação

• Logs e outras informações

O campo STATUS conta com um identificador para cada etapa do processo como:

• Solicitado,

• Em fila,

• Executando,

• Sucesso,

• Erro,

• Sem licença,

• Cancelado,

onde Erro indica que houve um problema durante a execução e Cancelado indica que o usuário cancelou a operação