Lancement d'un modèle de tâche Ansible

Cette page fournit une référence pour l’action ansible.job.launch disponible dans le catalogue d’actions d’automatisation de workflow. Utilisez cette action pour le lancement d’un modèle de tâche de la plateforme Ansible Automation (Automation Controller) à partir d’une étape de workflow.

Pour les prérequis, voir Actions de tâche Ansible.

Lancement d'un modèle de tâche Ansible

L’identifiant de l’action est ansible.job.launch.

Lancement d’un modèle de tâche de la plateforme Ansible Automation (Automation Controller) et renvoi de la tâche créée. En cas de réussite, renvoie une tâche id que vous pouvez utiliser avec ansible.job.getStatus pour interroger la tâche jusqu’à ce qu’elle atteigne un état terminal. Le point de terminaison est POST https://{host}/api/controller/v2/job_templates/{jobTemplateId}/launch/.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir	Type	Description	Exemple
host	Chaîne	Obligatoire. Nom d’hôte (et port facultatif) de l'Automation Controller, sans schéma.	`${{ :secrets:host }}`
authToken	Chaîne	Obligatoire. Jeton OAuth2 envoyé en tant que `Authorization: Bearer <token>` . Créez sous Automation Controller > Users > Tokens avec la portée d’écriture.	`${{ :secrets:ansibleControllerToken }}`
jobTemplateId	Int	Obligatoire. ID numérique du modèle de tâche pour le lancement.	`42`
extraVars	Carte	Facultatif. Variables supplémentaires passées en tant que `extra_vars` . Nécessite `ask_variables_on_launch` activé sur le modèle.	`{"target_env": "staging", "app_version": "1.2.3"}`
limit	Chaîne	Facultatif. Modèle d’hôte Ansible passé en tant que `limit` . Nécessite `ask_limit_on_launch` .	`web-servers`
inventaire	Chaîne	Facultatif. ID d’inventaire numérique remplaçant la valeur par défaut du modèle. Nécessite `ask_inventory_on_launch` .	`7`
jobTags	Chaîne	Facultatif. Tags séparés par des virgules passés en tant que `job_tags` . Nécessite `ask_tags_on_launch` .	`deploy,restart`
skipTags	Chaîne	Facultatif. Tags à ignorer séparés par des virgules, passés en tant que `skip_tags` . Nécessite `ask_skip_tags_on_launch` .	`notifications`
selectors	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "jobId", "expression": ".id"}, {"name": "status", "expression": ".status"}]`

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir	Type	Description
success	Booléen	`true` en cas de succès, `false` en cas d’échec.
response	Objet	L’objet de tâche créé. Utilisez le champ `id` avec `ansible.job.getStatus` pour interroger le statut. `{ "id": 128, "status": "pending", "job_template": 42, "url": "/api/controller/v2/jobs/128/" }`
errorMessage	Chaîne	Message d’erreur en cas d'échec. `null` en cas de succès.

Sortir

Type

Description

success

Booléen

true

en cas de succès,

false

en cas d’échec.

response

Objet

L’objet de tâche créé. Utilisez le champ id avec ansible.job.getStatus pour interroger le statut.

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

errorMessage

Chaîne

Message d’erreur en cas d'échec.

null

en cas de succès.

L’exemple suivant déclenche le lancement d’un modèle de tâche Ansible et capture l’ID de la tâche pour l’interrogation.

Exemple de workflow
`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`

Exemple de workflow

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

Cette traduction automatique est fournie pour votre commodité.

Lancement d'un modèle de tâche Ansible

Lancement d'un modèle de tâche Ansible.css-21sua1{background:none;border:none;width:0;padding:0;}

Lancement d'un modèle de tâche Ansible