ec2_elb - De-registers or registers instances from EC2 ELBs

Author:John Jarvis

Synopsis

New in version 1.2.

This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. Returns fact “ec2_elbs” which is a list of elbs attached to the instance if state=absent is passed as an argument. Will be marked changed when called only if there are ELBs found to operate on.

Options

parameter required default choices comments
aws_access_key no
    AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.
    aws_secret_key no
      AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.
      ec2_elbs no None
        List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.
        ec2_url no
          Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Must be specified if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used
          enable_availability_zone no True
          • yes
          • no
          Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
          instance_id yes
            EC2 Instance ID
            profile no
              uses a boto profile. Only works with boto >= 2.24.0 (added in Ansible 1.6)
              region no
                The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.
                security_token no
                  security token to authenticate against AWS (added in Ansible 1.6)
                  state yes
                  • present
                  • absent
                  register or deregister the instance
                  validate_certs no yes
                  • yes
                  • no
                  When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. (added in Ansible 1.5)
                  wait no True
                  • yes
                  • no
                  Wait for instance registration or deregistration to complete successfully before returning.
                  wait_timeout no
                    Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no. (added in Ansible 1.6)

                    Note

                    Requires boto

                    Examples


                    # basic pre_task and post_task example
                    pre_tasks:
                      - name: Gathering ec2 facts
                        ec2_facts:
                      - name: Instance De-register
                        local_action: ec2_elb
                        args:
                          instance_id: "{{ ansible_ec2_instance_id }}"
                          state: 'absent'
                    roles:
                      - myrole
                    post_tasks:
                      - name: Instance Register
                        local_action: ec2_elb
                        args:
                          instance_id: "{{ ansible_ec2_instance_id }}"
                          ec2_elbs: "{{ item }}"
                          state: 'present'
                        with_items: ec2_elbs

                    Note

                    The following environment variables can be used AWS_ACCESS_KEY or EC2_ACCESS_KEY or AWS_ACCESS_KEY_ID, AWS_SECRET_KEY or EC2_SECRET_KEY or AWS_SECRET_ACCESS_KEY, AWS_REGION or EC2_REGION, AWS_SECURITY_TOKEN

                    Note

                    Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

                    Note

                    AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file