Params

Param Name Description
job_template
Required

Value:

Must be a Hash

job_template[name]
Required

Template name


Value:

Must be String

job_template[job_category]
Required

Job category


Value:

Must be String

job_template[description_format]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.


Value:

Must be String

job_template[template]
Required

Value:

Must be String

job_template[provider_type]
Required

Provider type


Value:

Must be one of: SSH.

job_template[snippet]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be ‘true’ or ‘false’

job_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

job_template[locked]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Whether or not the template is locked for editing


Value:

Must be ‘true’ or ‘false’

job_template[ssh]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

SSH provider specific options


Value:

Must be a Hash

job_template[ssh][effective_user]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Effective user options


Value:

Must be a Hash

job_template[ssh][effective_user][value]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

What user should be used to run the script (using sudo-like mechanisms)


Value:

Must be String

job_template[ssh][effective_user][overridable]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Whether it should be allowed to override the effective user from the invocation form.


Value:

Must be ‘true’ or ‘false’

job_template[ssh][effective_user][current_user]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Whether the current user login should be used as the effective user


Value:

Must be ‘true’ or ‘false’