Documentation

ec2_elb - De-registers or registers instances from EC2 ELBs

Synopsis

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.

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
aws_access_key
no
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

    aliases: ec2_access_key, access_key
    aws_secret_key
    no
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

      aliases: ec2_secret_key, secret_key
      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). Ignored for modules where region is required. Must be specified for all other modules 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
            (added in 1.6)
            no
              uses a boto profile. Only works with boto >= 2.24.0
              region
              no
                The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

                aliases: aws_region, ec2_region
                security_token
                (added in 1.6)
                no
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

                  aliases: access_token
                  state
                  yes
                  • present
                  • absent
                  register or deregister the instance
                  validate_certs
                  (added in 1.5)
                  no yes
                  • yes
                  • no
                  When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
                  wait
                  no True
                  • yes
                  • no
                  Wait for instance registration or deregistration to complete successfully before returning.
                  wait_timeout
                  (added in 1.6)
                  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.

                    Examples

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

                    Notes

                    Note

                    If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION

                    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

                    This is a Core Module

                    For more information on what this means please read Core Modules

                    For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.