Class: Ansible::Ruby::Modules::Tower_job_launch

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Tower_job_launch

Defined in:

lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_launch.rb

Overview

Launch an Ansible Tower jobs. See U(www.ansible.com/tower) for an overview.

Instance Method Summary

• #credential ⇒ Object^?

  Credential to use for job, only used if prompt for credential is set.

• #extra_vars ⇒ Object^?

  Extra_vars to use for the job_template.

• #inventory ⇒ Object^?

  Inventory to use for the job, only used if prompt for inventory is set.

• #job_explanation ⇒ Object^?

  Job explanation field.

• #job_template ⇒ String

  Name of the job template to use.

• #job_type ⇒ :run, ...

  Job_type to use for the job, only used if prompt for job_type is set.

• #limit ⇒ Object^?

  Limit to use for the I(job_template).

• #tags ⇒ Object^?

  Specific tags to use for from playbook.

• #use_job_endpoint ⇒ :yes, ...

  Disable launching jobs from job template.

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

#credential ⇒ Object^?

Returns Credential to use for job, only used if prompt for credential is set.

Returns:

• (Object, nil) —

  Credential to use for job, only used if prompt for credential is set.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_launch.rb', line 26

attribute :credential

#extra_vars ⇒ Object^?

Returns Extra_vars to use for the job_template. Prepend C(@) if a file.

Returns:

• (Object, nil) —

  Extra_vars to use for the job_template. Prepend C(@) if a file.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_launch.rb', line 29

attribute :extra_vars

#inventory ⇒ Object^?

Returns Inventory to use for the job, only used if prompt for inventory is set.

Returns:

• (Object, nil) —

  Inventory to use for the job, only used if prompt for inventory is set.

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

attribute :inventory

#job_explanation ⇒ Object^?

Returns Job explanation field.

Returns:

• (Object, nil) —

  Job explanation field.

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

attribute :job_explanation

#job_template ⇒ String

Returns Name of the job template to use.

Returns:

• (String) —

  Name of the job template to use.

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

attribute :job_template

#job_type ⇒ :run, ...

Returns Job_type to use for the job, only used if prompt for job_type is set.

Returns:

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

  Job_type to use for the job, only used if prompt for job_type is set.

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

attribute :job_type

#limit ⇒ Object^?

Returns Limit to use for the I(job_template).

Returns:

• (Object, nil) —

  Limit to use for the I(job_template).

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_launch.rb', line 32

attribute :limit

#tags ⇒ Object^?

Returns Specific tags to use for from playbook.

Returns:

• (Object, nil) —

  Specific tags to use for from playbook.

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

attribute :tags

#use_job_endpoint ⇒ :yes, ...

Returns Disable launching jobs from job template.

Returns:

• (:yes, :no, nil) —

  Disable launching jobs from job template.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_launch.rb', line 38

attribute :use_job_endpoint