Модуль theforeman.foreman.job_invocation — вызов заданий удалённого выполнения
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.job_invocation.
Добавлено в theforeman.foreman 1.4.0
Краткое описание
- Вызов и планирование заданий удалённого выполнения
Требования
Следующие компоненты должны быть установлены на узле, выполняющем этот модуль.
- requests
Параметры
Параметр | Комментарии |
|---|---|
bookmark string | Закладка, из которой следует получить поисковый запрос |
ca_path path | Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
command string | Команда для выполнения на узле. Обязательна для шаблонов команд |
concurrency_control dictionary | Управление уровнем параллелизма и распределением задач во времени |
|
concurrency_level integer |
Максимальное количество заданий, выполняемых одновременно |
|
time_span integer |
Распределить задачи на указанное количество секунд Удалено начиная с foreman_remote_execution-11.0.0 |
description_format string | Переопределить формат описания из шаблона только для этого вызова |
execution_timeout_interval integer | Переопределить интервал ожидания из шаблона только для этого вызова |
feature string добавлено в theforeman.foreman 5.8.0 | Метка функции, которую необходимо запустить Будет использован шаблон задания, назначенный этой функции |
inputs dictionary | Используемые входные данные |
job_template string | Шаблон задания для выполнения |
oauth1_consumer_key string | Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
oauth1_consumer_secret string | Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
password string | Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
randomized_ordering boolean | Следует ли случайным образом упорядочить выбранные узлы Варианты:
|
recurrence dictionary | Запланировать повторяющееся задание |
|
cron_line string |
Периодичность выполнения задания в формате cron |
|
end_time string |
Не выполнять задания после этого времени |
|
max_iteration integer |
Повторить не более N раз |
|
purpose string |
Назначение специального типа |
scheduling dictionary | Запланировать запуск задания на более позднее время |
|
start_at string |
Запланировать задание на будущее время |
|
start_before string |
Указывает, что действие следует отменить, если его не удастся начать до этого времени. |
search_query string | Поисковый запрос для определения узлов |
server_url string / обязательный | URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
ssh dictionary | Параметры SSH |
|
effective_user string |
Пользователь, от имени которого следует запустить скрипт (с помощью механизмов типа sudo) По умолчанию используется параметр шаблона или глобальная настройка |
targeting_type string | Динамический запрос обновляет результаты поиска перед выполнением (полезно для запланированных заданий) Варианты:
|
use_gssapi boolean | Использовать GSSAPI для аутентификации. Обычно это требуется для Kerberos или Kerberos через аутентификацию Negotiate. Необходимо установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
username string | Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
validate_certs boolean | Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя сущность |
diff_mode | Поддержка: полная | В режиме diff возвращает сведения об изменениях (или о предполагаемых изменениях в режиме check_mode) |
Примеры
- name: "Run remote command on a single host once"
theforeman.foreman.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"
theforeman.foreman.job_invocation:
bookmark: 'active'
command: 'pwd'
job_template: "Run Command - Ansible Default"
recurrence:
cron_line: "30 2 * * *"
concurrency_control:
concurrency_level: 2
- name: "Run the katello_package_install feature to install a package on a single host"
theforeman.foreman.job_invocation:
search_query: "name ^ (foreman.example.com)"
feature: 'katello_package_install'
inputs: 'package=podman'
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
entity dictionary | Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: success |
|
job_invocations list / elements=dictionary |
Список вызовов заданий Возвращается: success |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/theforeman/foreman/job_invocation_module.html
