Spec-Zone.ru › Ansible 2.9

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_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения playbook.
Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
device_id
-
Идентификатор устройства для 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
-
Основной или дополнительный частный IP-адрес для ассоциации с адресом Elastic IP.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
public_ip
-
IP-адрес ранее выделенного EIP.
Если присутствует и указано устройство, EIP связывается с устройством.
Если отсутствует и указано устройство, EIP отключается от устройства.

псевдонимы: ip
public_ipv4_pool
-
добавлено в 2.9
По умолчанию:
"нет"
Выделяет новый Elastic IP из предоставленного публичного IPv4 пула (BYOIP), применяется только к вновь выделенным Elastic IP, не проверяется, когда reuse_existing_ip_allowed равен true.
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
    Варианты:
  • нет ←
  • да
Автоматически освобождать EIP при отключении?
reuse_existing_ip_allowed
boolean
    Варианты:
  • нет ←
  • да
Использовать уже существующий EIP, не связанный с устройством (если доступен), вместо выделения нового.
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
state
-
    Варианты:
  • present ←
  • absent
Если present, выделить EIP или связать существующий EIP с устройством.
Если absent, отключить EIP от устройства и, при необходимости, освободить его.
tag_name
-
добавлено в 2.9
По умолчанию:
"нет"
При reuse_existing_ip_allowed = true, использовать этот параметр, чтобы повторно использовать Elastic IP только если он помечен тегом tag_name.
tag_value
-
добавлено в 2.9
По умолчанию:
"нет"
Дополнительный параметр к tag_name, проверяющий, что значение тега, указанного в tag_name, соответствует tag_value.
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 }}"

- name: allocate eip - reuse unallocated ips (if found) with FREE tag
  ec2_eip:
    region: us-east-1
    in_vpc: yes
    reuse_existing_ip_allowed: yes
    tag_name: FREE

- name: allocate eip - reuse unallocted ips if tag reserved is nope
  ec2_eip:
    region: us-east-1
    in_vpc: yes
    reuse_existing_ip_allowed: yes
    tag_name: reserved
    tag_value: nope

- name: allocate new eip - from servers given ipv4 pool
  ec2_eip:
    region: us-east-1
    in_vpc: yes
    public_ipv4_pool: ipv4pool-ec2-0588c9b75a25d1a02

- name: allocate eip - from a given pool (if no free addresses where dev-servers tag is dynamic)
  ec2_eip:
    region: us-east-1
    in_vpc: yes
    reuse_existing_ip_allowed: yes
    tag_name: dev-servers
    public_ipv4_pool: ipv4pool-ec2-0588c9b75a25d1a02

- name: allocate eip from pool - check if tag reserved_for exists and value is our hostname
  ec2_eip:
    region: us-east-1
    in_vpc: yes
    reuse_existing_ip_allowed: yes
    tag_name: reserved_for
    tag_value: "{{ inventory_hostname }}"
    public_ipv4_pool: ipv4pool-ec2-0588c9b75a25d1a02

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ Возвращаемое значение Описание
allocation_id
строка
при успехе
allocation_id эластичного IP-адреса

Пример:
eipalloc-51aa3a6c
public_ip
строка
при успехе
адрес эластичного 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.9/modules/ec2_eip_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API