Class: Ansible::Ruby::Modules::Tower_job_template

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb

Overview

Create, update, or destroy Ansible Tower job templates. See U(www.ansible.com/tower) for an overview.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#ask_credential ⇒ :yes, ...

Returns Prompt user for credential on launch.

Returns:

  • (:yes, :no, nil) —

    Prompt user for credential on launch.



107
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 107

attribute :ask_credential

#ask_diff_mode ⇒ :yes, ...

Returns Prompt user to enable diff mode (show changes) to files when supported by modules.

Returns:

  • (:yes, :no, nil) —

    Prompt user to enable diff mode (show changes) to files when supported by modules.



75
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 75

attribute :ask_diff_mode

#ask_extra_vars ⇒ :yes, ...

Returns Prompt user for (extra_vars) on launch.

Returns:

  • (:yes, :no, nil) —

    Prompt user for (extra_vars) on launch.



79
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 79

attribute :ask_extra_vars

#ask_inventory ⇒ :yes, ...

Returns Propmt user for inventory on launch.

Returns:

  • (:yes, :no, nil) —

    Propmt user for inventory on launch.



103
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 103

attribute :ask_inventory

#ask_job_type ⇒ :yes, ...

Returns Prompt user for job type on launch.

Returns:

  • (:yes, :no, nil) —

    Prompt user for job type on launch.



95
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 95

attribute :ask_job_type

#ask_limit ⇒ :yes, ...

Returns Prompt user for a limit on launch.

Returns:

  • (:yes, :no, nil) —

    Prompt user for a limit on launch.



83
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 83

attribute :ask_limit

#ask_skip_tags ⇒ :yes, ...

Returns Prompt user for job tags to skip on launch.

Returns:

  • (:yes, :no, nil) —

    Prompt user for job tags to skip on launch.



91
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 91

attribute :ask_skip_tags

#ask_tags ⇒ :yes, ...

Returns Prompt user for job tags on launch.

Returns:

  • (:yes, :no, nil) —

    Prompt user for job tags on launch.



87
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 87

attribute :ask_tags

#ask_verbosity ⇒ :yes, ...

Returns Prompt user to choose a verbosity level on launch.

Returns:

  • (:yes, :no, nil) —

    Prompt user to choose a verbosity level on launch.



99
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 99

attribute :ask_verbosity

#become_enabled ⇒ :yes, ...

Returns Activate privilege escalation.

Returns:

  • (:yes, :no, nil) —

    Activate privilege escalation.



115
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 115

attribute :become_enabled

#concurrent_jobs_enabled ⇒ :yes, ...

Returns Allow simultaneous runs of the job template.

Returns:

  • (:yes, :no, nil) —

    Allow simultaneous runs of the job template.



119
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 119

attribute :concurrent_jobs_enabled

#credential ⇒ String?

Returns Name of the credential to use for the job template.

Returns:

  • (String, nil) —

    Name of the credential to use for the job template.



35
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 35

attribute :credential

#description ⇒ Object?

Returns Description to use for the job template.

Returns:

  • (Object, nil) —

    Description to use for the job template.



16
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 16

attribute :description

#extra_vars_path ⇒ Object?

Returns Path to the C(extra_vars) YAML file.

Returns:

  • (Object, nil) —

    Path to the C(extra_vars) YAML file.



52
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 52

attribute :extra_vars_path

#fact_caching_enabled ⇒ :yes, ...

Returns Enable use of fact caching for the job template.

Returns:

  • (:yes, :no, nil) —

    Enable use of fact caching for the job template.



68
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 68

attribute :fact_caching_enabled

#force_handlers_enabled ⇒ :yes, ...

Returns Enable forcing playbook handlers to run even if a task fails.

Returns:

  • (:yes, :no, nil) —

    Enable forcing playbook handlers to run even if a task fails.



58
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 58

attribute :force_handlers_enabled

#forks ⇒ Object?

Returns The number of parallel or simultaneous processes to use while executing the playbook.

Returns:

  • (Object, nil) —

    The number of parallel or simultaneous processes to use while executing the playbook.



42
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 42

attribute :forks

#host_config_key ⇒ Object?

Returns Allow provisioning callbacks using this host config key.

Returns:

  • (Object, nil) —

    Allow provisioning callbacks using this host config key.



72
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 72

attribute :host_config_key

#inventory ⇒ String?

Returns Name of the inventory to use for the job template.

Returns:

  • (String, nil) —

    Name of the inventory to use for the job template.



23
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 23

attribute :inventory

#job_tags ⇒ Object?

Returns Comma separated list of the tags to use for the job template.

Returns:

  • (Object, nil) —

    Comma separated list of the tags to use for the job template.



55
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 55

attribute :job_tags

#job_type ⇒ :run, ...

Returns The job type to use for the job template.

Returns:

  • (:run, :check, :scan) —

    The job type to use for the job template.



19
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 19

attribute :job_type

#limit ⇒ Object?

Returns A host pattern to further constrain the list of hosts managed or affected by the playbook.

Returns:

  • (Object, nil) —

    A host pattern to further constrain the list of hosts managed or affected by the playbook



45
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 45

attribute :limit

#name ⇒ String

Returns Name to use for the job template.

Returns:

  • (String) —

    Name to use for the job template.



12
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 12

attribute :name

#playbook ⇒ String

Returns Path to the playbook to use for the job template within the project provided.

Returns:

  • (String) —

    Path to the playbook to use for the job template within the project provided.



31
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 31

attribute :playbook

#project ⇒ String

Returns Name of the project to use for the job template.

Returns:

  • (String) —

    Name of the project to use for the job template.



27
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 27

attribute :project

#skip_tags ⇒ Object?

Returns Comma separated list of the tags to skip for the job template.

Returns:

  • (Object, nil) —

    Comma separated list of the tags to skip for the job template.



62
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 62

attribute :skip_tags

#start_at_task ⇒ Object?

Returns Start the playbook at the task matching this name.

Returns:

  • (Object, nil) —

    Start the playbook at the task matching this name.



65
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 65

attribute :start_at_task

#state ⇒ :present, ...

Returns Desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Desired state of the resource.



123
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 123

attribute :state

#survey_enabled ⇒ :yes, ...

Returns Enable a survey on the job template.

Returns:

  • (:yes, :no, nil) —

    Enable a survey on the job template.



111
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 111

attribute :survey_enabled

#vault_credential ⇒ Object?

Returns Name of the vault credential to use for the job template.

Returns:

  • (Object, nil) —

    Name of the vault credential to use for the job template.



39
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 39

attribute :vault_credential

#verbosity ⇒ 0, ...

Returns Control the output level Ansible produces as the playbook runs. 0 - Normal, 1 - Verbose, 2 - More Verbose, 3 - Debug, 4 - Connection Debug.

Returns:

  • (0, 1, 2, 3, 4, nil) —

    Control the output level Ansible produces as the playbook runs. 0 - Normal, 1 - Verbose, 2 - More Verbose, 3 - Debug, 4 - Connection Debug.



48
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_template.rb', line 48

attribute :verbosity