ANSIBLE.GCE_LB(3)

NAME
gce_lb - create/destroy GCE load-balancer resources

DESCRIPTION

This module can create and destroy Google Compute Engine loadbalancer and httphealthcheck resources. The primary LB resource is the load_balancer resource and the health check parameters are all prefixed with httphealthcheck. The full documentation for Google Compute Engine load balancing is at https://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.

OPTIONS

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

httphealthcheck_healthy_count
    number of consecutive successful checks before marking a node healthy (default: 2)

httphealthcheck_host
    host header to pass through on HTTP check requests

httphealthcheck_interval
    the duration in seconds between each health check request (default: 5)

httphealthcheck_name
    the name identifier for the HTTP health check

httphealthcheck_path
    the url path to use for HTTP health checking (default: /)

httphealthcheck_port
    the TCP port to use for HTTP health checking (default: 80)

httphealthcheck_timeout
    the timeout in seconds before a request is considered a failed check (default: 5)

httphealthcheck_unhealthy_count
    number of consecutive failed checks before marking a node unhealthy (default: 2)

members
    a list of zone/nodename pairs, e.g ['us-central1-a/www-a', ...]

name
    name of the load-balancer resource

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

protocol
    the protocol used for the load-balancer packet forwarding, tcp or udp Choices: tcp,udp. (default: tcp)

region
    the GCE region where the load-balancer is defined Choices: us-central1,us-central2,europe-west1.

state
    desired state of the LB Choices: active,present,absent,deleted. (default: present).

EXAMPLES
# Simple example of creating a new LB, adding members, and a health check
- local_action:
    module: gce_lb
    name: testlb
    region: us-central1
    members: ["us-central1-a/www-a", "us-central1-b/www-b"]
    httphealthcheck_name: hc
    httphealthcheck_port: 80
    httphealthcheck_path: "/up"

AUTHOR
Eric Johnson <erjohnso@google.com>

SEE ALSO
ansible(1), http://ansible.github.com/modules.html#gce-lb