Class: Ansible::Ruby::Modules::Gce_lb

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb

Overview

This module can create and destroy Google Compute Engine C(loadbalancer) and C(httphealthcheck) resources. The primary LB resource is the C(load_balancer) resource and the health check parameters are all prefixed with I(httphealthcheck). The full documentation for Google Compute Engine load balancing is at U(developers.google.com/compute/docs/load-balancing/). However, the ansible module simplifies the configuration by following the libcloud model. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Instance Method Summary

• #credentials_file ⇒ Object^?

  Path to the JSON file associated with the service account email.

• #external_ip ⇒ Object^?

  The external static IPv4 (or auto-assigned) address for the LB.

• #httphealthcheck_healthy_count ⇒ Integer^?

  Number of consecutive successful checks before marking a node healthy.

• #httphealthcheck_host ⇒ Object^?

  Host header to pass through on HTTP check requests.

• #httphealthcheck_interval ⇒ Integer^?

  The duration in seconds between each health check request.

• #httphealthcheck_name ⇒ String^?

  The name identifier for the HTTP health check.

• #httphealthcheck_path ⇒ String^?

  The url path to use for HTTP health checking.

• #httphealthcheck_port ⇒ Integer^?

  The TCP port to use for HTTP health checking.

• #httphealthcheck_timeout ⇒ Integer^?

  The timeout in seconds before a request is considered a failed check.

• #httphealthcheck_unhealthy_count ⇒ Integer^?

  Number of consecutive failed checks before marking a node unhealthy.

• #members ⇒ Array<String>, ...

  A list of zone/nodename pairs, e.g [‘us-central1-a/www-a’, …].

• #name ⇒ String^?

  Name of the load-balancer resource.

• #pem_file ⇒ Object^?

  Path to the pem file associated with the service account email This option is deprecated.

• #port_range ⇒ Object^?

  The port (range) to forward, e.g.

• #project_id ⇒ Object^?

  Your GCE project ID.

• #protocol ⇒ :tcp, ...

  The protocol used for the load-balancer packet forwarding, tcp or udp.

• #region ⇒ String^?

  The GCE region where the load-balancer is defined.

• #service_account_email ⇒ Object^?

  Service account email.

• #state ⇒ :active, ...

  Desired state of the LB.

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

#credentials_file ⇒ Object^?

Returns path to the JSON file associated with the service account email.

Returns:

• (Object, nil) —

  path to the JSON file associated with the service account email

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 75

attribute :credentials_file

#external_ip ⇒ Object^?

Returns the external static IPv4 (or auto-assigned) address for the LB.

Returns:

• (Object, nil) —

  the external static IPv4 (or auto-assigned) address for the LB

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 55

attribute :external_ip

#httphealthcheck_healthy_count ⇒ Integer^?

Returns number of consecutive successful checks before marking a node healthy.

Returns:

• (Integer, nil) —

  number of consecutive successful checks before marking a node healthy

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 36

attribute :httphealthcheck_healthy_count

#httphealthcheck_host ⇒ Object^?

Returns host header to pass through on HTTP check requests.

Returns:

• (Object, nil) —

  host header to pass through on HTTP check requests

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 40

attribute :httphealthcheck_host

#httphealthcheck_interval ⇒ Integer^?

Returns the duration in seconds between each health check request.

Returns:

• (Integer, nil) —

  the duration in seconds between each health check request

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 24

attribute :httphealthcheck_interval

#httphealthcheck_name ⇒ String^?

Returns the name identifier for the HTTP health check.

Returns:

• (String, nil) —

  the name identifier for the HTTP health check

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 12

attribute :httphealthcheck_name

#httphealthcheck_path ⇒ String^?

Returns the url path to use for HTTP health checking.

Returns:

• (String, nil) —

  the url path to use for HTTP health checking

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 20

attribute :httphealthcheck_path

#httphealthcheck_port ⇒ Integer^?

Returns the TCP port to use for HTTP health checking.

Returns:

• (Integer, nil) —

  the TCP port to use for HTTP health checking

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 16

attribute :httphealthcheck_port

#httphealthcheck_timeout ⇒ Integer^?

Returns the timeout in seconds before a request is considered a failed check.

Returns:

• (Integer, nil) —

  the timeout in seconds before a request is considered a failed check

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 28

attribute :httphealthcheck_timeout

#httphealthcheck_unhealthy_count ⇒ Integer^?

Returns number of consecutive failed checks before marking a node unhealthy.

Returns:

• (Integer, nil) —

  number of consecutive failed checks before marking a node unhealthy

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 32

attribute :httphealthcheck_unhealthy_count

#members ⇒ Array<String>, ...

Returns a list of zone/nodename pairs, e.g [‘us-central1-a/www-a’, …].

Returns:

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

  a list of zone/nodename pairs, e.g [‘us-central1-a/www-a’, …]

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 61

attribute :members

#name ⇒ String^?

Returns name of the load-balancer resource.

Returns:

• (String, nil) —

  name of the load-balancer resource

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 43

attribute :name

#pem_file ⇒ Object^?

Returns path to the pem file associated with the service account email This option is deprecated. Use ‘credentials_file’.

Returns:

• (Object, nil) —

  path to the pem file associated with the service account email This option is deprecated. Use ‘credentials_file’.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 72

attribute :pem_file

#port_range ⇒ Object^?

Returns the port (range) to forward, e.g. 80 or 8000-8888 defaults to all ports.

Returns:

• (Object, nil) —

  the port (range) to forward, e.g. 80 or 8000-8888 defaults to all ports

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 58

attribute :port_range

#project_id ⇒ Object^?

Returns your GCE project ID.

Returns:

• (Object, nil) —

  your GCE project ID

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 78

attribute :project_id

#protocol ⇒ :tcp, ...

Returns the protocol used for the load-balancer packet forwarding, tcp or udp.

Returns:

• (:tcp, :udp, nil) —

  the protocol used for the load-balancer packet forwarding, tcp or udp

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 47

attribute :protocol

#region ⇒ String^?

Returns the GCE region where the load-balancer is defined.

Returns:

• (String, nil) —

  the GCE region where the load-balancer is defined

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 51

attribute :region

#service_account_email ⇒ Object^?

Returns service account email.

Returns:

• (Object, nil) —

  service account email

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 69

attribute :service_account_email

#state ⇒ :active, ...

Returns desired state of the LB.

Returns:

• (:active, :present, :absent, :deleted, nil) —

  desired state of the LB

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_lb.rb', line 65

attribute :state