Class: Ansible::Ruby::Modules::Elasticsearch_plugin

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb

Overview

Manages Elasticsearch 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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#force ⇒ Boolean?

Returns Force batch mode when installing plugins. This is only necessary if a plugin requires additional permissions and console detection fails.

Returns:

  • (Boolean, nil) —

    Force batch mode when installing plugins. This is only necessary if a plugin requires additional permissions and console detection fails.



30
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 30

attribute :force

#name ⇒ String

Returns Name of the plugin to install.

Returns:

  • (String) —

    Name of the plugin to install.



12
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 12

attribute :name

#plugin_bin ⇒ Object?

Returns Location of the plugin binary. If this file is not found, the default plugin binaries will be used.,The default changed in Ansible 2.4 to None.

Returns:

  • (Object, nil) —

    Location of the plugin binary. If this file is not found, the default plugin binaries will be used.,The default changed in Ansible 2.4 to None.



34
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 34

attribute :plugin_bin

#plugin_dir ⇒ String?

Returns Your configured plugin directory specified in Elasticsearch.

Returns:

  • (String, nil) —

    Your configured plugin directory specified in Elasticsearch



37
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 37

attribute :plugin_dir

#proxy_host ⇒ Object?

Returns Proxy host to use during plugin installation.

Returns:

  • (Object, nil) —

    Proxy host to use during plugin installation



41
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 41

attribute :proxy_host

#proxy_port ⇒ Object?

Returns Proxy port to use during plugin installation.

Returns:

  • (Object, nil) —

    Proxy port to use during plugin installation



44
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 44

attribute :proxy_port

#src ⇒ Object?

Returns Optionally set the source location to retrieve the plugin from. This can be a file:// URL to install from a local file, or a remote URL. If this is not set, the plugin location is just based on the name.,The name parameter must match the descriptor in the plugin ZIP specified.,Is only used if the state would change, which is solely checked based on the name parameter. If, for example, the plugin is already installed, changing this has no effect.,For ES 1.x use url.

Returns:

  • (Object, nil) —

    Optionally set the source location to retrieve the plugin from. This can be a file:// URL to install from a local file, or a remote URL. If this is not set, the plugin location is just based on the name.,The name parameter must match the descriptor in the plugin ZIP specified.,Is only used if the state would change, which is solely checked based on the name parameter. If, for example, the plugin is already installed, changing this has no effect.,For ES 1.x use url.



20
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 20

attribute :src

#state ⇒ :present, ...

Returns Desired state of a plugin.

Returns:

  • (:present, :absent, nil) —

    Desired state of a plugin.



16
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 16

attribute :state

#timeout ⇒ String?

Returns Timeout setting: 30s, 1m, 1h…,Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0.

Returns:

  • (String, nil) —

    Timeout setting: 30s, 1m, 1h…,Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0.



26
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 26

attribute :timeout

#url ⇒ Object?

Returns Set exact URL to download the plugin from (Only works for ES 1.x).,For ES 2.x and higher, use src.

Returns:

  • (Object, nil) —

    Set exact URL to download the plugin from (Only works for ES 1.x).,For ES 2.x and higher, use src.



23
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 23

attribute :url

#version ⇒ String?

Returns Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated.

Returns:

  • (String, nil) —

    Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated



47
 
# File 'lib/ansible/ruby/modules/generated/database/misc/elasticsearch_plugin.rb', line 47

attribute :version