Lançamento de um modelo de job do Ansible

Esta página fornece uma referência para a ação ansible.job.launch disponível no catálogo de ações de automação de fluxo de trabalho. Use esta ação para lançar um modelo de job da plataforma Ansible Automation (Automation Controller) a partir de uma etapa de fluxo de trabalho.

Para os pré-requisitos, consulte Ações de job do Ansible.

Lançamento de um modelo de job do Ansible

O identificador da ação é ansible.job.launch.

Realiza o lançamento de um modelo de job da plataforma Ansible Automation (Automation Controller) e retorna o job criado. Em caso de sucesso, retorna um job id que pode ser usado com ansible.job.getStatus para consultar o job até que ele alcance um estado terminal. O endpoint é POST https://{host}/api/controller/v2/job_templates/{jobTemplateId}/launch/.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
hospedar	Corda	Obrigatório. Nome do host (e porta opcional) do Automation Controller, sem esquema.	`${{ :secrets:host }}`
authToken	Corda	Obrigatório. Token OAuth2 enviado como `Authorization: Bearer <token>` . Crie em Automation Controller > Users > Tokens com escopo de gravação.	`${{ :secrets:ansibleControllerToken }}`
jobTemplateId	Interno	Obrigatório. ID numérico do modelo de job para lançamento.	`42`
extraVars	Mapa	Opcional. Variáveis extras passadas como `extra_vars` . Requer `ask_variables_on_launch` habilitado no template.	`{"target_env": "staging", "app_version": "1.2.3"}`
limit	Corda	Opcional. Padrão de host do Ansible passado como `limit` . Requer `ask_limit_on_launch` .	`web-servers`
inventário	Corda	Opcional. ID numérico de inventário que substitui o padrão do modelo. Requer `ask_inventory_on_launch` .	`7`
jobTags	Corda	Opcional. Tags separadas por vírgula passadas como `job_tags` . Requer `ask_tags_on_launch` .	`deploy,restart`
skipTags	Corda	Opcional. Tags separadas por vírgula para ignorar, passadas como `skip_tags` . Requer `ask_skip_tags_on_launch` .	`notifications`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "jobId", "expression": ".id"}, {"name": "status", "expression": ".status"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
response	Objeto	O objeto de job criado. Use o campo `id` com `ansible.job.getStatus` para consultar o status. `{ "id": 128, "status": "pending", "job_template": 42, "url": "/api/controller/v2/jobs/128/" }`
errorMessage	Corda	Mensagem de erro em caso de falha. `null` em caso de sucesso.

Saída

Tipo

Descrição

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

response

Objeto

O objeto de job criado. Use o campo id com ansible.job.getStatus para consultar o status.

{
  "id": 128,
  "status": "pending",
  "job_template": 42,
  "url": "/api/controller/v2/jobs/128/"
}

errorMessage

Corda

Mensagem de erro em caso de falha.

null

em caso de sucesso.

O exemplo a seguir realiza o lançamento de um modelo de job do Ansible e captura o ID do job para sondagem.

Exemplo de fluxo de trabalho
`name: launch-ansible-remediation description: Launch an Ansible job template to remediate an incident steps: - name: launch_job type: action action: ansible.job.launch version: 1 inputs: host: ${{ :secrets:host }} authToken: ${{ :secrets:ansibleControllerToken }} jobTemplateId: "42" extraVars: target_env: staging app_version: "1.2.3" selectors: - name: jobId expression: ".id" next: end`

Exemplo de fluxo de trabalho

name: launch-ansible-remediation
description: Launch an Ansible job template to remediate an incident
steps:
  - name: launch_job
    type: action
    action: ansible.job.launch
    version: 1
    inputs:
      host: ${{ :secrets:host }}
      authToken: ${{ :secrets:ansibleControllerToken }}
      jobTemplateId: "42"
      extraVars:
        target_env: staging
        app_version: "1.2.3"
      selectors:
        - name: jobId
          expression: ".id"
    next: end

Esta tradução de máquina é fornecida para sua comodidade.

Lançamento de um modelo de job do Ansible

Lançamento de um modelo de job do Ansible.css-21sua1{background:none;border:none;width:0;padding:0;}

Lançamento de um modelo de job do Ansible