ec2_eip - управляет адресами EC2 elastic IP (EIP).
Новая версия 1.4.
Описание
- Этот модуль может выделять или освобождать EIP.
- Этот модуль может связывать/отключать EIP с экземплярами или сетевыми интерфейсами.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_reassociation (добавлен в 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 | |
| device_id (добавлен в 2.0) | Идентификатор устройства для EIP. Может быть идентификатором экземпляра EC2 или идентификатором Elastic Network Interface (ENI). Псевдонимы: instance_id | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое есть. | |
| in_vpc (добавлен в 1.4) | Значение по умолчанию: "нет" | Выделить EIP внутри VPC или нет. Требуется, если указан ENI. |
| private_ip_address (добавлен в 2.3) | Основной или дополнительный частный IP-адрес для привязки к адресу Elastic IP. | |
| profile (добавлен в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| public_ip | IP-адрес ранее выделенного EIP. Если задан и указан параметр device, EIP привязывается к устройству. Если отсутствует и указан параметр device, 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 (добавлен в 2.0) | Значение по умолчанию: "нет" | Автоматически освобождать EIP при отключении? |
| reuse_existing_ip_allowed (добавлен в 1.6) | Значение по умолчанию: "нет" | Использовать имеющийся EIP, не привязанный к устройству (если доступен), вместо выделения нового. |
| security_token (добавлен в 1.6) | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state |
| Если present, выделить EIP или связать существующий EIP с устройством. Если absent, отключить EIP от устройства и, по желанию, освободить его. |
| validate_certs bool (добавлен в 1.5) |
| При значении "нет" сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 }}"
with_items: "{{ 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. Более подробная информация о техническом обслуживании модулей приведена в разделе Поддержка и техническое обслуживание модулей.
Список других модулей, которые также поддерживаются партнерами Ansible, см. здесь.
Автор
- 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.6/modules/ec2_eip_module.html