Class: Ansible::Ruby::Modules::Jenkins_script

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

Overview

The C(jenkins_script) module takes a script plus a dict of values to use within the script and returns the result of the script being run.

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

#args ⇒ Hash?

Returns A dict of key-value pairs used in formatting the script using string.Template (see docs.python.org/2/library/string.html#template-strings).

Returns:



36
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_script.rb', line 36

attribute :args

#password ⇒ String?

Returns The password to connect to the jenkins server with.

Returns:

  • (String, nil) —

    The password to connect to the jenkins server with.



28
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_script.rb', line 28

attribute :password

#script ⇒ String

Returns The groovy script to be executed. This gets passed as a string Template if args is defined.

Returns:

  • (String) —

    The groovy script to be executed. This gets passed as a string Template if args is defined.



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

attribute :script

#timeout ⇒ Integer?

Returns The request timeout in seconds.

Returns:

  • (Integer, nil) —

    The request timeout in seconds



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

attribute :timeout

#url ⇒ String?

Returns The jenkins server to execute the script against. The default is a local jenkins instance that is not being proxied through a webserver.

Returns:

  • (String, nil) —

    The jenkins server to execute the script against. The default is a local jenkins instance that is not being proxied through a webserver.



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

attribute :url

#user ⇒ String?

Returns The username to connect to the jenkins server with.

Returns:

  • (String, nil) —

    The username to connect to the jenkins server with.



24
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_script.rb', line 24

attribute :user

#validate_certs ⇒ :yes, ...

Returns If set to C(no), the SSL certificates will not be validated. This should only set to C(no) used on personally controlled sites using self-signed certificates as it avoids verifying the source site.

Returns:

  • (:yes, :no, nil) —

    If set to C(no), the SSL certificates will not be validated. This should only set to C(no) used on personally controlled sites using self-signed certificates as it avoids verifying the source site.



20
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_script.rb', line 20

attribute :validate_certs