theforeman.foreman.job_invocation – Вызов задач удалённого выполнения
Примечание
Этот плагин является частью коллекции theforeman.foreman (версия 1.5.1).
Для его установки используйте: ansible-galaxy collection install theforeman.foreman.
Для использования в книге задач укажите: theforeman.foreman.job_invocation.
Добавлен в версии 1.4.0: of theforeman.foreman
Описание
- Вызов и планирование задач удалённого выполнения
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bookmark строка | Закладка для вывода запроса поиска | ||
| command строка | Команда для выполнения на хосте. Требуется для шаблонов команд | ||
| concurrency_control словарь | Управление уровнем параллельности и распределением во времени | ||
| concurrency_level целое число | Максимальное количество задач, выполняемых одновременно | ||
| time_span целое число | Распределение задач за заданное количество секунд | ||
| execution_timeout_interval целое число | Переопределение интервала ожидания из шаблона только для этого вызова | ||
| inputs словарь | Используемые входные данные | ||
| job_template строка / обязательно | Шаблон задачи для выполнения | ||
| password строка / обязательно | Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды FOREMAN_PASSWORD. | ||
| randomized_ordering логическое значение |
| Случайный порядок выбранных хостов | |
| recurrence словарь | Планирование периодической задачи | ||
| cron_line строка | Частота выполнения задачи в формате cron | ||
| end_time строка | Больше нет запусков после указанного времени | ||
| max_iteration целое число | Повторить не более N раз | ||
| scheduling словарь | Планирование начала задачи в будущем | ||
| start_at строка | Планирование задачи на будущее время | ||
| start_before строка | Указывает, что действие должно быть отменено, если его нельзя начать до этого времени. | ||
| search_query строка | Запрос поиска для определения хостов | ||
| server_url строка / обязательно | URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды FOREMAN_SERVER_URL. | ||
| ssh словарь | Параметры, связанные с ssh | ||
| effective_user строка | Пользователь, который должен использоваться для запуска скрипта (используя механизмы типа sudo) По умолчанию используется параметр шаблона или глобальное значение | ||
| targeting_type строка |
| Динамический запрос обновляет результаты поиска перед выполнением (полезно для запланированных задач) | |
| username строка / обязательно | Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды FOREMAN_USERNAME. | ||
| validate_certs логическое значение |
| Верификация TLS-сертификатов сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды FOREMAN_VALIDATE_CERTS. | |
Примеры
- name: "Run remote command on a single host once"
job_invocation:
search_query: "name ^ (foreman.example.com)"
command: 'ls'
job_template: "Run Command - SSH Default"
ssh:
effective_user: "tester"
- name: "Run ansible command on active hosts once a day"
job_invocation:
bookmark: 'active'
command: 'pwd'
job_template: "Run Command - Ansible Default"
recurrence:
cron_line: "30 2 * * *"
concurrency_control:
concurrency_level: 2
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| entity словарь | успех | Конечное состояние затронутых сущностей, сгруппированных по типу. | |
| job_invocations список / элементы=словарь | успех | Список вызовов задач | |
Авторы
- Peter Ondrejka (@pondrejk)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/job_invocation_module.html
