Param name | Description |
---|---|
location_id optional |
Scope by locations Value: Must be Integer |
organization_id optional |
Scope by organizations Value: Must be Integer |
search optional |
filter results Value: Must be String |
order optional |
sort results Value: Must be String |
page optional |
paginate results Value: Must be String |
per_page optional |
number of entries per request Value: Must be String |
Param name | Description |
---|---|
id required |
Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
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 , nil allowed |
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 , nil allowed |
Value: Must be 'true' or 'false' |
job_template[audit_comment] optional , nil allowed |
Value: Must be String |
job_template[locked] optional , nil allowed |
Whether or not the template is locked for editing Value: Must be 'true' or 'false' |
job_template[ssh] optional , nil allowed |
SSH provider specific options Value: Must be a Hash |
job_template[ssh][effective_user] optional , nil allowed |
Effective user options Value: Must be a Hash |
job_template[ssh][effective_user][value] optional , nil allowed |
What user should be used to run the script (using sudo-like mechanisms) Value: Must be String |
job_template[ssh][effective_user][overridable] optional , nil allowed |
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 , nil allowed |
Whether the current user login should be used as the effective user Value: Must be 'true' or 'false' |
job_template[location_ids] optional , nil allowed |
REPLACE locations with given ids Value: Must be an array of any type |
job_template[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Value: Must be an array of any type |
Param name | Description |
---|---|
id required |
Value: 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 |
Value: Must be a Hash |
job_template[name] optional |
Template name Value: Must be String |
job_template[job_category] optional |
Job category Value: Must be String |
job_template[description_format] optional , nil allowed |
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] optional |
Value: Must be String |
job_template[provider_type] optional |
Provider type Value: Must be one of: SSH. |
job_template[snippet] optional , nil allowed |
Value: Must be 'true' or 'false' |
job_template[audit_comment] optional , nil allowed |
Value: Must be String |
job_template[locked] optional , nil allowed |
Whether or not the template is locked for editing Value: Must be 'true' or 'false' |
job_template[ssh] optional , nil allowed |
SSH provider specific options Value: Must be a Hash |
job_template[ssh][effective_user] optional , nil allowed |
Effective user options Value: Must be a Hash |
job_template[ssh][effective_user][value] optional , nil allowed |
What user should be used to run the script (using sudo-like mechanisms) Value: Must be String |
job_template[ssh][effective_user][overridable] optional , nil allowed |
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 , nil allowed |
Whether the current user login should be used as the effective user Value: Must be 'true' or 'false' |
job_template[location_ids] optional , nil allowed |
REPLACE locations with given ids Value: Must be an array of any type |
job_template[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Value: Must be an array of any type |
Param name | Description |
---|---|
version optional |
Template version Value: Must be String |
Param name | Description |
---|---|
id required |
Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
Param name | Description |
---|---|
id required |
Value: 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 |
Value: Must be a Hash |
job_template[name] required |
Template name Value: Must be String |