:source: job_template.py :orphan: .. _job_template_module: job_template -- Manage Job Templates ++++++++++++++++++++++++++++++++++++ .. contents:: :local: :depth: 1 Synopsis -------- - Manage Remote Execution Job Templates Requirements ------------ The below requirements are needed on the host that executes this module. - apypie Parameters ---------- .. raw:: html
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
audit_comment
string
|
Content of the audit comment field
|
||
description_format
string
|
description of the job template. Template inputs can be referenced.
|
||
file_name
path
|
The path of a template file, that shall be imported.
Either this or template is required as a source for the Job Template "content".
|
||
job_category
string
|
The category the template should be assigend to
|
||
locations
list
/ elements=string
|
List of locations the entity should be assigned to
|
||
locked
boolean
|
|
Determines whether the template shall be locked
|
|
name
string
|
The name of the Job Template.
If omited, will be determined from the
name header of the template or the filename (in that order).The special value "*" can be used to perform bulk actions (modify, delete) on all existing templates.
|
||
organizations
list
/ elements=string
|
List of organizations the entity should be assigned to
|
||
password
string
/ required
|
Password of the user accessing the Foreman server
|
||
provider_type
string
|
Determines via which provider the template shall be executed
|
||
server_url
string
/ required
|
URL of the Foreman server
|
||
snippet
boolean
|
|
Determines whether the template shall be a snippet
|
|
state
string
|
|
State of the entity
present_with_defaults will ensure the entity exists, but won't update existing ones |
|
template
string
|
The content of the Job Template.
Either this or file_name is required as a source for the Job Template "content".
|
||
template_inputs
list
/ elements=dictionary
|
The template inputs used in the Job Template
|
||
advanced
boolean
|
|
Template Input is advanced
|
|
description
string
|
description of the Template Input
|
||
fact_name
string
|
Fact name, used when input type is fact
|
||
input_type
string
/ required
|
|
input type
|
|
name
string
/ required
|
name of the Template Input
|
||
options
list
/ elements=raw
|
Template values for user inputs. Must be an array of any type.
|
||
puppet_class_name
string
|
Puppet class name, used when input type is puppet_parameter
|
||
puppet_parameter_name
string
|
Puppet parameter name, used when input type is puppet_parameter
|
||
required
boolean
|
|
Is the input required
|
|
resource_type
string
|
Type of the resource
|
||
value_type
string
|
|
Type of the value
|
|
variable_name
string
|
Variable name, used when input type is variable
|
||
username
string
/ required
|
Username accessing the Foreman server
|
||
validate_certs
boolean
|
|
Whether or not to verify the TLS certificates of the Foreman server
|