Модуль theforeman.foreman.job_invocation – Вызов задач удалённого выполнения

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.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 строка	Закладка для вывода запроса поиска
command строка	Команда для выполнения на узле. Требуется для шаблонов команд
concurrency_control словарь	Управление уровнем одновременности и распределением во времени
concurrency_level целое число	Максимальное количество задач для одновременного выполнения
time_span целое число	Распределение задач на заданное количество секунд Удалено начиная с foreman_remote_execution-11.0.0
description_format строка	Переопределить формат описания из шаблона только для данного вызова
execution_timeout_interval целое число	Переопределить интервал таймаута из шаблона только для данного вызова
inputs словарь	Используемые входные данные
job_template строка / требуется	Исполняемый шаблон задачи
password строка / требуется	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
randomized_ordering логический тип	Определяет, следует ли случайным образом упорядочить выбранные узлы Варианты: `false` `true`
recurrence словарь	Планирование повторяющейся задачи
cron_line строка	Как часто должна выполняться задача в формате cron
end_time строка	Не выполнять больше исполнений после этого времени
max_iteration целое число	Повторить максимум N раз
purpose строка	Определение специального назначения
scheduling словарь	Запланировать выполнение задачи на более позднее время
start_at строка	Запланировать выполнение задачи на будущее время
start_before строка	Указывает, что действие должно быть отменено, если его нельзя начать до этого времени.
search_query строка	Запрос поиска для идентификации узлов
server_url строка / требуется	URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
ssh словарь	Параметры, связанные с SSH
effective_user строка	Пользователь, который должен использоваться для запуска скрипта (с помощью механизмов типа sudo) По умолчанию используется параметр шаблона или глобальная настройка
targeting_type строка	Динамическое обновление запроса поиска обновляет результаты поиска перед выполнением (полезно для планируемых задач) Варианты: `"static_query"` ← (по умолчанию) `"dynamic_query"`
username строка / требуется	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_USERNAME`.

validate_certs

boolean

Проверять ли сертификаты TLS сервера Foreman.

Если значение не указано в задании, будет использовано значение переменной среды FOREMAN_VALIDATE_CERTS.

Выбор:

false
true ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать прогноз изменения статуса без модификации сущности
diff_mode	Поддержка: полная	Вернёт подробную информацию о том, что изменилось (или, возможно, требует изменения в режиме check_mode), при включенном режиме diff

Примеры

- 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

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
entity словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращено: успех
job_invocations список / элементы=словарь	Список вызовов задач Возвращено: успех

Авторы

Peter Ondrejka (@pondrejk)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/job_invocation_module.html