tower_job_launch - Запуск задания Ansible.
Новое в версии 2.3.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Запуск заданий Ansible Tower. Смотрите https://www.ansible.com/tower для обзора.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- ansible-tower-cli >= 3.0.2
Параметры
| параметр | обязателен | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| credential | нет | Используемый ключ доступа к заданию, используется только если задан запрос ключа доступа. | ||
| extra_vars | нет | Дополнительные переменные для использования в job_template. Представьте '@', если это файл. | ||
| inventory | нет | Используемый инвентарь для задания, используется только если задан запрос инвентаря. | ||
| job_explanation | нет | Поле объяснения задания. | ||
| job_template | да | Имя используемого job_template. | ||
| job_type | нет |
| Тип задания для использования в задании, используется только если задан запрос типа задания. | |
| limit | нет | Ограничение для использования в job_template. | ||
| tags | нет | Конкретные теги для использования из playbook. | ||
| tower_config_file | нет | Путь к файлу конфигурации Tower. См. примечания. | ||
| tower_host | нет | URL вашего экземпляра Tower. | ||
| tower_password | нет | Пароль для вашего экземпляра Tower. | ||
| tower_username | нет | Имя пользователя для вашего экземпляра Tower. | ||
| tower_verify_ssl | нет | True | Разрешить/запретить небезопасные подключения к Tower. Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. | |
| use_job_endpoint | нет | Отключить запуск заданий из шаблона задания. |
Примеры
- name: Launch a job
tower_job_launch:
job_template: "My Job Template"
register: job
- name: Wait for job max 120s
tower_job_wait:
job_id: job.id
timeout: 120
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращено | тип | пример |
|---|---|---|---|---|
| id | ID задания только что запущенного задания | успех | int | 86 |
| status | статус только что запущенного задания | успех | строка | ожидание |
Примечания
Примечание
- Если не указан параметр config_file, мы попробуем использовать значения по умолчанию библиотеки tower-cli, чтобы найти информацию о хосте Tower.
- config_file должен содержать конфигурацию Tower в следующем формате host=hostname username=username password=password
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы так захотите, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/tower_job_launch_module.html
