Lanzamiento de una plantilla de trabajo de Ansible

Esta página proporciona una referencia de la acción ansible.job.launch disponible en el catálogo de acciones de automatización de flujos de trabajo. Utilice esta acción para lanzar una plantilla de trabajo de Ansible Automation Platform (Automation Controller) desde un paso del flujo de trabajo.

Para conocer los requisitos previos, consulte las acciones de trabajo de Ansible.

Lanzamiento de una plantilla de trabajo de Ansible

El identificador de la acción es ansible.job.launch.

Realiza el lanzamiento de una plantilla de trabajo de la plataforma Ansible Automation (Automation Controller) y devuelve el trabajo creado. En caso de éxito, devuelve un trabajo id que puede usar con ansible.job.getStatus para consultar el trabajo hasta que alcance un estado terminal. El extremo es POST https://{host}/api/controller/v2/job_templates/{jobTemplateId}/launch/.

La siguiente tabla describe todos los campos de entrada disponibles para esta acción.

Aporte	Tipo	Descripción	Ejemplo
anfitrión	Cadena	Requerido. Nombre de host (y puerto opcional) de Automation Controller, sin esquema.	`${{ :secrets:host }}`
authToken	Cadena	Requerido. Token OAuth2 enviado como `Authorization: Bearer <token>` . Cree en Automation Controller > Users > Tokens con ámbito de escritura.	`${{ :secrets:ansibleControllerToken }}`
jobTemplateId	En t	Requerido. ID numérico de la plantilla de trabajo para el lanzamiento.	`42`
extraVars	Mapa	Opcional. Variables adicionales pasadas como `extra_vars` . Requiere `ask_variables_on_launch` habilitado en la plantilla.	`{"target_env": "staging", "app_version": "1.2.3"}`
limit	Cadena	Opcional. Patrón de host de Ansible pasado como `limit` . Requiere `ask_limit_on_launch` .	`web-servers`
inventario	Cadena	Opcional. ID numérico de inventario que reemplaza el valor predeterminado de la plantilla. Requiere `ask_inventory_on_launch` .	`7`
jobTags	Cadena	Opcional. Etiquetas separadas por comas pasadas como `job_tags` . Requiere `ask_tags_on_launch` .	`deploy,restart`
skipTags	Cadena	Opcional. Etiquetas separadas por comas para omitir, pasadas como `skip_tags` . Requiere `ask_skip_tags_on_launch` .	`notifications`
selectors	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "jobId", "expression": ".id"}, {"name": "status", "expression": ".status"}]`

La siguiente tabla describe todos los campos de salida devueltos por esta acción.

Producción	Tipo	Descripción
success	Booleano	`true` en caso de éxito, `false` en caso de falla.
response	Objeto	El objeto de trabajo creado. Use el campo `id` con `ansible.job.getStatus` para consultar el estado. `{ "id": 128, "status": "pending", "job_template": 42, "url": "/api/controller/v2/jobs/128/" }`
errorMessage	Cadena	Mensaje de error en caso de falla. `null` en caso de éxito.

Producción

Tipo

Descripción

success

Booleano

true

en caso de éxito,

false

en caso de falla.

response

Objeto

El objeto de trabajo creado. Use el campo id con ansible.job.getStatus para consultar el estado.

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

errorMessage

Cadena

Mensaje de error en caso de falla.

null

en caso de éxito.

El siguiente ejemplo realiza el lanzamiento de una plantilla de trabajo de Ansible y captura el ID del trabajo para consultarlo.

Ejemplo de flujo de trabajo
`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`

Ejemplo de flujo de trabajo

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

Te ofrecemos esta traducción automática para facilitar la lectura.

Lanzamiento de una plantilla de trabajo de Ansible

Lanzamiento de una plantilla de trabajo de Ansible.css-21sua1{background:none;border:none;width:0;padding:0;}

Lanzamiento de una plantilla de trabajo de Ansible