Class: Ansible::Ruby::Modules::Jenkins_plugin

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

Overview

Ansible module which helps to manage Jenkins plugins.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#group ⇒ String?

Returns Name of the Jenkins group on the OS.

Returns:

  • (String, nil) —

    Name of the Jenkins group on the OS.



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

attribute :group

#jenkins_home ⇒ String?

Returns Home directory of the Jenkins user.

Returns:

  • (String, nil) —

    Home directory of the Jenkins user.



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

attribute :jenkins_home

#mode ⇒ Object?

Returns File mode applied on versioned plugins.

Returns:

  • (Object, nil) —

    File mode applied on versioned plugins.



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

attribute :mode

#name ⇒ String?

Returns Plugin name.

Returns:

  • (String, nil) —

    Plugin name.



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

attribute :name

#owner ⇒ String?

Returns Name of the Jenkins user on the OS.

Returns:

  • (String, nil) —

    Name of the Jenkins user on the OS.



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

attribute :owner

#state ⇒ :absent, ...

Returns Desired plugin state.,If the C(latest) is set, the check for new version will be performed every time. This is suitable to keep the plugin up-to-date.

Returns:

  • (:absent, :present, :pinned, :unpinned, :enabled, :disabled, :latest, nil) —

    Desired plugin state.,If the C(latest) is set, the check for new version will be performed every time. This is suitable to keep the plugin up-to-date.



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

attribute :state

#timeout ⇒ Integer?

Returns Server connection timeout in secs.

Returns:

  • (Integer, nil) —

    Server connection timeout in secs.



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

attribute :timeout

#updates_expiration ⇒ Integer?

Returns Number of seconds after which a new copy of the I(update-center.json) file is downloaded. This is used to avoid the need to download the plugin to calculate its checksum when C(latest) is specified.,Set it to C(0) if no cache file should be used. In that case, the plugin file will always be downloaded to calculate its checksum when C(latest) is specified.

Returns:

  • (Integer, nil) —

    Number of seconds after which a new copy of the I(update-center.json) file is downloaded. This is used to avoid the need to download the plugin to calculate its checksum when C(latest) is specified.,Set it to C(0) if no cache file should be used. In that case, the plugin file will always be downloaded to calculate its checksum when C(latest) is specified.



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

attribute :updates_expiration

#updates_url ⇒ String?

Returns URL of the Update Centre.,Used as the base URL to download the plugins and the I(update-center.json) JSON file.

Returns:

  • (String, nil) —

    URL of the Update Centre.,Used as the base URL to download the plugins and the I(update-center.json) JSON file.



43
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_plugin.rb', line 43

attribute :updates_url

#url ⇒ String?

Returns URL of the Jenkins server.

Returns:

  • (String, nil) —

    URL of the Jenkins server.



47
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_plugin.rb', line 47

attribute :url

#version ⇒ String?

Returns Plugin version number.,If this option is specified, all plugin dependencies must be installed manually.,It might take longer to verify that the correct version is installed. This is especially true if a specific version number is specified.,Quote the version to prevent the value to be interpreted as float. For example if C(1.20) would be unquoted, it would become C(1.2).

Returns:

  • (String, nil) —

    Plugin version number.,If this option is specified, all plugin dependencies must be installed manually.,It might take longer to verify that the correct version is installed. This is especially true if a specific version number is specified.,Quote the version to prevent the value to be interpreted as float. For example if C(1.20) would be unquoted, it would become C(1.2).



51
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_plugin.rb', line 51

attribute :version

#with_dependencies ⇒ :yes, ...

Returns Defines whether to install plugin dependencies.,This option takes effect only if the I(version) is not defined.

Returns:

  • (:yes, :no, nil) —

    Defines whether to install plugin dependencies.,This option takes effect only if the I(version) is not defined.



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

attribute :with_dependencies