ec2_eip – управляет адресами EC2 Elastic IP (EIP)
Обзор
- Этот модуль может выделять или освобождать EIP.
- Этот модуль может назначать/отключать EIP для экземпляров или сетевых интерфейсов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_reassociation boolean добавлен в 2.5 |
| Укажите этот параметр, чтобы разрешить повторное назначение адреса Elastic IP, который уже назначен другому сетевому интерфейсу или экземпляру, с указанным экземпляром или интерфейсом. |
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs boolean добавлен в 2.8 |
| Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", выполненных во время задачи, выведя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения playbook. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| device_id - добавлен в 2.0 | Идентификатор устройства для EIP. Может быть идентификатором экземпляра EC2 или идентификатором Elastic Network Interface (ENI). псевдонимы: instance_id | |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое есть. | |
| in_vpc boolean |
| Выделить EIP внутри VPC или нет. Требуется, если указан ENI. |
| private_ip_address - добавлен в 2.3 | Основной или дополнительный частный IP-адрес для ассоциации с адресом Elastic IP. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| public_ip - | IP-адрес ранее выделенного EIP. Если присутствует и указано устройство, EIP ассоциируется с устройством. Если отсутствует и указано устройство, EIP отключается от устройства. псевдонимы: ip | |
| region строка | Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковое есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| release_on_disassociation boolean добавлен в 2.0 |
| Автоматически освободить EIP при его отключении или нет |
| reuse_existing_ip_allowed boolean |
| Использовать EIP, не связанный с устройством (если доступен), вместо выделения нового. |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state - |
| При заданном значении, выделить EIP или ассоциировать существующий EIP с устройством. При значении absent, отключить EIP от устройства и, при необходимости, освободить его. |
| validate_certs boolean |
| При значении "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Возможна задержка между назначением EIP и возможностью доступа к экземпляру облака по новому адресу. Используйте wait_for и pause, чтобы приостановить дальнейшее выполнение playbook до достижения доступности экземпляра, если это необходимо.
- Этот модуль возвращает несколько статусов изменения при отключении или освобождении. Он возвращает общий статус, основанный на произошедших изменениях. Он также возвращает отдельные статусы изменения для отключения и освобождения.
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: associate an elastic IP with an instance
ec2_eip:
device_id: i-1212f003
ip: 93.184.216.119
- name: associate an elastic IP with a device
ec2_eip:
device_id: eni-c8ad70f3
ip: 93.184.216.119
- name: associate an elastic IP with a device and allow reassociation
ec2_eip:
device_id: eni-c8ad70f3
public_ip: 93.184.216.119
allow_reassociation: yes
- name: disassociate an elastic IP from an instance
ec2_eip:
device_id: i-1212f003
ip: 93.184.216.119
state: absent
- name: disassociate an elastic IP with a device
ec2_eip:
device_id: eni-c8ad70f3
ip: 93.184.216.119
state: absent
- name: allocate a new elastic IP and associate it with an instance
ec2_eip:
device_id: i-1212f003
- name: allocate a new elastic IP without associating it to anything
ec2_eip:
state: present
register: eip
- name: output the IP
debug:
msg: "Allocated IP is {{ eip.public_ip }}"
- name: provision new instances with ec2
ec2:
keypair: mykey
instance_type: c1.medium
image: ami-40603AD1
wait: yes
group: webserver
count: 3
register: ec2
- name: associate new elastic IPs with each of the instances
ec2_eip:
device_id: "{{ item }}"
loop: "{{ ec2.instance_ids }}"
- name: allocate a new elastic IP inside a VPC in us-west-2
ec2_eip:
region: us-west-2
in_vpc: yes
register: eip
- name: output the IP
debug:
msg: "Allocated IP inside a VPC is {{ eip.public_ip }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| allocation_id строка | при успехе | Идентификатор выделения elastic ip Пример: eipalloc-51aa3a6c |
| public_ip строка | при успехе | адрес elastic ip Пример: 52.88.159.209 |
Статус
- Этот модуль гарантирует отсутствие несовместимых изменений интерфейса в будущем. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Rick Mendes (@rickmendes) <rmendes@illumina.com>
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_eip_module.html