Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

job_template
Required

Validations:

  • Must be a Hash

job_template[name]
Optional

Template name

Validations:

  • Must be a String

job_template[job_category]
Optional

Job category

Validations:

  • Must be a String

job_template[description_format]
Optional , <span class="translation_missing" title="translation missing: sv-SE.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}.

Validations:

  • Must be a String

job_template[template]
Optional

Validations:

  • Must be a String

job_template[provider_type]
Optional

Provider type

Validations:

  • Must be one of: SSH, Ansible.

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

Validations:

  • Must be one of: true, false, 1, 0.

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

Validations:

  • Must be a String

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

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0.

job_template[effective_user_attributes]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Effective user options

Validations:

  • Must be a Hash

job_template[effective_user_attributes][value]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String

job_template[effective_user_attributes][overridable]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be one of: true, false, 1, 0.

job_template[effective_user_attributes][current_user]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be one of: true, false, 1, 0.

job_template[location_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

job_template[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type