theforeman.foreman.job_invocation module – Invoke Remote Execution Jobs

Note

This module is part of the theforeman.foreman collection (version 3.14.0).

To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.job_invocation.

New in theforeman.foreman 1.4.0

Synopsis

• Invoke and schedule Remote Execution Jobs

Requirements

The below requirements are needed on the host that executes this module.

• requests

Parameters

Parameter	Comments
bookmark string	Bookmark to infer the search query from
command string	Command to be executed on host. Required for command templates
concurrency_control dictionary	Control concurrency level and distribution over time
concurrency_level integer	Maximum jobs to be executed at once
time_span integer	Distribute tasks over given number of seconds This is removed since foreman_remote_execution-11.0.0
description_format string	Override the description format from the template for this invocation only
execution_timeout_interval integer	Override the timeout interval from the template for this invocation only
inputs dictionary	Inputs to use
job_template string / required	Job template to execute
password string / required	Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
randomized_ordering boolean	Whether to order the selected hosts randomly Choices: false true
recurrence dictionary	Schedule a recurring job
cron_line string	How often the job should occur, in the cron format
end_time string	Perform no more executions after this time
max_iteration integer	Repeat a maximum of N times
purpose string	Designation of a special purpose
scheduling dictionary	Schedule the job to start at a later time
start_at string	Schedule the job for a future time
start_before string	Indicates that the action should be cancelled if it cannot be started before this time.
search_query string	Search query to identify hosts
server_url string / required	URL of the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.
ssh dictionary	ssh related options
effective_user string	What user should be used to run the script (using sudo-like mechanisms) Defaults to a template parameter or global setting
targeting_type string	Dynamic query updates the search results before execution (useful for scheduled jobs) Choices: "static_query" ← (default) "dynamic_query"
username string / required	Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.
validate_certs boolean	Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_VALIDATE_CERTS will be used instead. Choices: false true ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying the entity
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
entity dictionary	Final state of the affected entities grouped by their type. Returned: success
job_invocations list / elements=dictionary	List of job invocations Returned: success

Authors

• Peter Ondrejka (@pondrejk)

Collection links

Issue Tracker Homepage Repository (Sources)