Модуль amazon.aws.ec2_eip_info — список сведений об EIP EC2

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_eip_info.

Добавлено в amazon.aws 5.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Выводит сведения об эластичных IP-адресах EC2.
Этот модуль был впервые добавлен в community.aws в выпуске 1.0.0.

Требования

Следующие требования необходимы на узле, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Подробнее о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в рамках плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
filters словарь	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. Список доступных фильтров см. здесь: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses.html#options. Имена фильтров и значения чувствительны к регистру. По умолчанию: `{}`
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Подробнее об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Подробнее см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Подробнее о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Подробнее о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты не будут проверяться при взаимодействии с API AWS. Настоятельно не рекомендуется задавать validate_certs=false. Вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключений переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Подробнее см. в разделе https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details or the AWS region,
# see the AWS Guide for details.

- name: List all EIP addresses in the current region.
  amazon.aws.ec2_eip_info:
  register: regional_eip_addresses

- name: List all EIP addresses for a VM.
  amazon.aws.ec2_eip_info:
    filters:
      instance-id: i-123456789
  register: my_vm_eips

- ansible.builtin.debug:
    msg: "{{ my_vm_eips.addresses | selectattr('private_ip_address', 'equalto', '10.0.0.5') }}"

- name: List all EIP addresses for several VMs.
  amazon.aws.ec2_eip_info:
    filters:
      instance-id:
        - i-123456789
        - i-987654321
  register: my_vms_eips

- name: List all EIP addresses using the 'Name' tag as a filter.
  amazon.aws.ec2_eip_info:
    filters:
      tag:Name: www.example.com
  register: my_vms_eips

- name: List all EIP addresses using the Allocation-id as a filter
  amazon.aws.ec2_eip_info:
    filters:
      allocation-id: eipalloc-64de1b01
  register: my_vms_eips

# Set the variable eip_alloc to the value of the first allocation_id
# and set the variable my_pub_ip to the value of the first public_ip
- ansible.builtin.set_fact:
    eip_alloc: my_vms_eips.addresses[0].allocation_id
    my_pub_ip: my_vms_eips.addresses[0].public_ip

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

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

Ключ	Описание
addresses список / элементы=словарь	Свойства всех эластичных IP-адресов, соответствующих заданным фильтрам. Каждый элемент — это словарь со всеми сведениями об EIP. Возвращается: при успешном выполнении
allocation_id строка	Идентификатор, представляющий выделение адреса. Возвращается: всегда Пример: `"eipalloc-64de1b01"`
association_id строка	Идентификатор, представляющий связь адреса с экземпляром. Возвращается: при успешном выполнении Пример: `"eipassoc-0fe9ce90d6e983e97"`
domain строка	Сеть (vpc). Возвращается: всегда Пример: `"vpc"`
instance_id строка	Идентификатор экземпляра, с которым связан адрес (если есть). Возвращается: если связан с каким-либо экземпляром Пример: `"i-01020cfeb25b0c84f"`
network_border_group строка	Имя уникального набора зон доступности, локальных зон или зон Wavelength, из которых Amazon Web Services объявляет IP-адреса. Возвращается: если связан с каким-либо экземпляром Пример: `"us-east-1"`
network_interface_id строка	Идентификатор сетевого интерфейса. Возвращается: если связан с каким-либо экземпляром Пример: `"eni-02fdeadfd4beef9323b"`
network_interface_owner_id строка	Идентификатор сетевого интерфейса. Возвращается: если связан с каким-либо экземпляром Пример: `"0123456789"`
private_ip_address строка	Частный IP-адрес, связанный с эластичным IP-адресом. Возвращается: всегда Пример: `"10.0.0.1"`
public_ip строка	Эластичный IP-адрес. Возвращается: если связан с каким-либо экземпляром Пример: `"54.81.104.1"`
tags словарь	Все теги, назначенные эластичному IP-адресу. Возвращается: при успешном выполнении Пример: `{"Name": "test-vm-54.81.104.1"}`

Авторы

Brad Macpherson (@iiibrad)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_eip_info_module.html