Class: Ansible::Ruby::Modules::Oneandone_load_balancer

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb

Overview

Create, remove, update load balancers. This module has a dependency on 1and1 >= 1.0

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

#add_rules ⇒ Array<Hash>, ...

Returns A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules parameter. Used in combination with update state.

Returns:

  • (Array<Hash>, Hash, nil) —

    A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules parameter. Used in combination with update state.



77
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 77

attribute :add_rules

#add_server_ips ⇒ Array<String>, ...

Returns A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with update state.

Returns:

  • (Array<String>, String, nil) —

    A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with update state.



69
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 69

attribute :add_server_ips

#api_url ⇒ Object?

Returns Custom API URL. Overrides the ONEANDONE_API_URL environement variable.

Returns:

  • (Object, nil) —

    Custom API URL. Overrides the ONEANDONE_API_URL environement variable.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 24

attribute :api_url

#auth_token ⇒ String

Returns Authenticating API token provided by 1&1.

Returns:

  • (String) —

    Authenticating API token provided by 1&1.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 16

attribute :auth_token

#datacenter ⇒ :US, ...

Returns ID or country code of the datacenter where the load balancer will be created.

Returns:

  • (:US, :ES, :DE, :GB, nil) —

    ID or country code of the datacenter where the load balancer will be created.



57
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 57

attribute :datacenter

#description ⇒ String?

Returns Description of the load balancer. maxLength=256.

Returns:

  • (String, nil) —

    Description of the load balancer. maxLength=256



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 65

attribute :description

#health_check_interval ⇒ Integer

Returns Health check period in seconds. minimum=5, maximum=300, multipleOf=1.

Returns:

  • (Integer) —

    Health check period in seconds. minimum=5, maximum=300, multipleOf=1



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 35

attribute :health_check_interval

#health_check_parse ⇒ Object?

Returns Regular expression to check. Required for HTTP health check. maxLength=64.

Returns:

  • (Object, nil) —

    Regular expression to check. Required for HTTP health check. maxLength=64



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 42

attribute :health_check_parse

#health_check_path ⇒ Object?

Returns Url to call for cheking. Required for HTTP health check. maxLength=1000.

Returns:

  • (Object, nil) —

    Url to call for cheking. Required for HTTP health check. maxLength=1000



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 39

attribute :health_check_path

#health_check_test ⇒ :NONE, ...

Returns Type of the health check. At the moment, HTTP is not allowed.

Returns:

  • (:NONE, :TCP, :HTTP, :ICMP) —

    Type of the health check. At the moment, HTTP is not allowed.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 31

attribute :health_check_test

#load_balancer ⇒ String

Returns The identifier (id or name) of the load balancer used with update state.

Returns:

  • (String) —

    The identifier (id or name) of the load balancer used with update state.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 20

attribute :load_balancer

#method ⇒ :ROUND_ROBIN, :LEAST_CONNECTIONS

Returns Balancing procedure.

Returns:

  • (:ROUND_ROBIN, :LEAST_CONNECTIONS) —

    Balancing procedure.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 53

attribute :method

#name ⇒ String

Returns Load balancer name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128.

Returns:

  • (String) —

    Load balancer name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 27

attribute :name

#persistence ⇒ Boolean

Returns Persistence.

Returns:

  • (Boolean) —

    Persistence.



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 45

attribute :persistence

#persistence_time ⇒ Integer

Returns Persistence time in seconds. Required if persistence is enabled. minimum=30, maximum=1200, multipleOf=1.

Returns:

  • (Integer) —

    Persistence time in seconds. Required if persistence is enabled. minimum=30, maximum=1200, multipleOf=1



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 49

attribute :persistence_time

#remove_rules ⇒ Array<String>, ...

Returns A list of rule ids that will be removed from an existing load balancer. Used in combination with update state.

Returns:

  • (Array<String>, String, nil) —

    A list of rule ids that will be removed from an existing load balancer. Used in combination with update state.



81
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 81

attribute :remove_rules

#remove_server_ips ⇒ Array<String>, ...

Returns A list of server IP ids to be unassigned from a load balancer. Used in combination with update state.

Returns:

  • (Array<String>, String, nil) —

    A list of server IP ids to be unassigned from a load balancer. Used in combination with update state.



73
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 73

attribute :remove_server_ips

#rules ⇒ Array<Hash>, Hash

Returns A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and port_server parameters, in addition to source parameter, which is optional.

Returns:

  • (Array<Hash>, Hash) —

    A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and port_server parameters, in addition to source parameter, which is optional.



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 61

attribute :rules

#state ⇒ :present, ...

Returns Define a load balancer state to create, remove, or update.

Returns:

  • (:present, :absent, :update, nil) —

    Define a load balancer state to create, remove, or update.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 12

attribute :state

#wait ⇒ :yes, ...

Returns wait for the instance to be in state ‘running’ before returning.

Returns:

  • (:yes, :no, nil) —

    wait for the instance to be in state ‘running’ before returning



85
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 85

attribute :wait

#wait_interval ⇒ Integer?

Returns Defines the number of seconds to wait when using the _wait_for methods.

Returns:

  • (Integer, nil) —

    Defines the number of seconds to wait when using the _wait_for methods



93
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 93

attribute :wait_interval

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



89
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_load_balancer.rb', line 89

attribute :wait_timeout