tower_job_cancel - Отмена задания Ansible Tower.
Новое в версии 2.3.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Отмена заданий Ansible Tower. Для общего обзора см. https://www.ansible.com/tower.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- ansible-tower-cli >= 3.0.2
Параметры
| параметр | обязательный | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| fail_if_not_running | нет | Вызвать ошибку, если job_id не ссылается на запущенное задание. | ||
| job_id | да | ID задания, которое нужно отменить | ||
| tower_config_file | нет | Путь к файлу конфигурации Tower. См. примечания. | ||
| tower_host | нет | URL вашего экземпляра Tower. | ||
| tower_password | нет | Пароль для вашего экземпляра Tower. | ||
| tower_username | нет | Имя пользователя для вашего экземпляра Tower. | ||
| tower_verify_ssl | нет | True | Разрешить/запретить небезопасные подключения к Tower. Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. |
Примеры
- name: Cancel job
tower_job_cancel:
job_id: job.id
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| название | описание | возвращается | тип | пример |
|---|---|---|---|---|
| id | id задания, которое требуется отменить | успех | int | 94 |
| 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_cancel_module.html