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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb

Overview

Manages Elasticsearch plugins.

Instance Method Summary

• #name ⇒ String

  Name of the plugin to install.

• #plugin_bin ⇒ String^?

  Location of the plugin binary.

• #plugin_dir ⇒ String^?

  Your configured plugin directory specified in Elasticsearch.

• #proxy_host ⇒ Object^?

  Proxy host to use during plugin installation.

• #proxy_port ⇒ Object^?

  Proxy port to use during plugin installation.

• #state ⇒ :present, ...

  Desired state of a plugin.

• #timeout ⇒ String^?

  Timeout setting: 30s, 1m, 1h…

• #url ⇒ Object^?

  Set exact URL to download the plugin from (Only works for ES 1.x).

• #version ⇒ String^?

  Version of the plugin to be installed.

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

#name ⇒ String

Returns Name of the plugin to install. In ES 2.x, the name can be an url or file location.

Returns:

• (String) —

  Name of the plugin to install. In ES 2.x, the name can be an url or file location

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 11

attribute :name

#plugin_bin ⇒ String^?

Returns Location of the plugin binary.

Returns:

• (String, nil) —

  Location of the plugin binary

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 26

attribute :plugin_bin

#plugin_dir ⇒ String^?

Returns Your configured plugin directory specified in Elasticsearch.

Returns:

• (String, nil) —

  Your configured plugin directory specified in Elasticsearch

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 30

attribute :plugin_dir

#proxy_host ⇒ Object^?

Returns Proxy host to use during plugin installation.

Returns:

• (Object, nil) —

  Proxy host to use during plugin installation

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 34

attribute :proxy_host

#proxy_port ⇒ Object^?

Returns Proxy port to use during plugin installation.

Returns:

• (Object, nil) —

  Proxy port to use during plugin installation

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 37

attribute :proxy_port

#state ⇒ :present, ...

Returns Desired state of a plugin.

Returns:

• (:present, :absent, nil) —

  Desired state of a plugin.

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 15

attribute :state

#timeout ⇒ String^?

Returns Timeout setting: 30s, 1m, 1h…

Returns:

• (String, nil) —

  Timeout setting: 30s, 1m, 1h…

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 22

attribute :timeout

#url ⇒ Object^?

Returns Set exact URL to download the plugin from (Only works for ES 1.x).

Returns:

• (Object, nil) —

  Set exact URL to download the plugin from (Only works for ES 1.x)

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 19

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

# File 'lib/ansible/ruby/modules/generated/extras/packaging/elasticsearch_plugin.rb', line 40

attribute :version