Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_eip_info – Список деталей EC2 EIP

Примечание

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

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

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

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

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Список деталей адресов EC2 Elastic IP.
  • Этот модуль был первоначально добавлен в community.aws в релизе 1.0.0.

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_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 или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключают друг друга.

Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

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 логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводом набора в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, созданный во время выполнения плейбука.

Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS.

Также могут быть использованы переменные окружения AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной окружения EC2_URL устарела и будет удалена в релизе после 2024-12-01.

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 и security_token.

region

псевдонимы: aws_region, ec2_region

строка

AWS регион для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут быть использованы переменные окружения AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной окружения EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключают друг друга.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключают друг друга.

Псевдонимы aws_session_token и session_token добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных окружения EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке false, сертификаты SSL не будут проверяться для связи с API AWS.

Настройка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы рассмотрите возможность настройки aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не из контекста «контроллер». Таким образом, файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), который использует Ansible, также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте 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

list / elements=dictionary

Свойства всех Elastic IP-адресов, соответствующих предоставленным фильтрам. Каждый элемент представляет собой словарь со всей информацией, относящейся к EIP.

Возвращается: при успехе

allocation_id

string

Идентификатор, представляющий назначение адреса.

Возвращается: всегда

Пример: "eipalloc-64de1b01"

association_id

string

Идентификатор, представляющий связь адреса с экземпляром.

Возвращается: при успехе

Пример: "eipassoc-0fe9ce90d6e983e97"

domain

string

Сеть (vpc).

Возвращается: всегда

Пример: "vpc"

instance_id

string

Идентификатор экземпляра, с которым связан адрес (если таковой имеется).

Возвращается: если связан любой экземпляр

Пример: "i-01020cfeb25b0c84f"

network_border_group

string

Название уникального набора зон доступности, локальных зон или зон Wavelength, из которых Amazon Web Services объявляет IP-адреса.

Возвращается: если связан любой экземпляр

Пример: "us-east-1"

network_interface_id

string

Идентификатор сетевого интерфейса.

Возвращается: если связан любой экземпляр

Пример: "eni-02fdeadfd4beef9323b"

network_interface_owner_id

string

Идентификатор сетевого интерфейса.

Возвращается: если связан любой экземпляр

Пример: "0123456789"

private_ip_address

string

Приватный IP-адрес, связанный с Elastic IP-адресом.

Возвращается: всегда

Пример: "10.0.0.1"

public_ip

string

Elastic IP-адрес.

Возвращается: если связан любой экземпляр

Пример: "54.81.104.1"

tags

dictionary

Все теги, назначенные Elastic IP-адресу.

Возвращается: при успехе

Пример: {"Name": "test-vm-54.81.104.1"}

Авторы

  • Brad Macpherson (@iiibrad)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Связь

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

Spec-Zone.ru

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