Spec-Zone.ru › Ansible

amazon.aws.ec2_eni_info модуль – Сбор информации о интерфейсах EC2 ENI в AWS

Примечание

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

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

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

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

Новый в amazon.aws 1.0.0

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

Обзор

  • Сбор информации об интерфейсах EC2 ENI в AWS.

Требования

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

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

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

ID ключа доступа AWS.

Дополнительную информацию об access-токенах см. в документации 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 Bundle для проверки 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-end-point. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws протестированы только с AWS.

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

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

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

eni_id

строка

добавлен в amazon.aws 1.3.0

ID сетевого интерфейса (ENI).

Этот параметр взаимоисключающий с filters.

filters

словарь

Словарь фильтров для применения. Каждый элемент словаря содержит ключ фильтра и значение фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html для возможных фильтров.

Этот параметр взаимоисключающий с eni_id.

Значение по умолчанию: {}

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.

Дополнительную информацию об access-токенах см. в документации 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.
END_OF_DOCUMENT_MARKER

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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, see the AWS Guide for details.

# Gather information about all ENIs
- amazon.aws.ec2_eni_info:

# Gather information about a particular ENI
- amazon.aws.ec2_eni_info:
    filters:
      network-interface-id: eni-xxxxxxx

Значения возврата

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

Ключ

Описание

network_interfaces

complex

Список соответствующих эластичных сетевых интерфейсов.

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

association

словарь

Информация об ассоциированном эластичном IP-адресе (EIP).

Возвращается: когда ENI ассоциирован с EIP

Пример: {"allocation_id": "eipalloc-5sdf123", "association_id": "eipassoc-8sdf123", "ip_owner_id": "123456789012", "public_dns_name": "ec2-52-1-0-63.compute-1.amazonaws.com", "public_ip": "52.1.0.63"}

attachment

словарь

Информация об прикреплённой виртуальной машине ec2.

Возвращается: когда ENI прикреплён к виртуальной машине ec2

Пример: {"attach_time": "2017-08-05T15:25:47+00:00", "attachment_id": "eni-attach-149d21234", "delete_on_termination": false, "device_index": 1, "instance_id": "i-15b8d3cadbafa1234", "instance_owner_id": "123456789012", "network_card_index": 0, "status": "attached"}

availability_zone

строка

Зона доступности ENI.

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

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

description

строка

Текстовое описание ENI.

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

Пример: "My favourite network interface"

groups

список / элементы=строка

Список прикреплённых групп безопасности.

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

Пример: [{"group_id": "sg-26d0f1234", "group_name": "my_ec2_security_group"}]

id

строка

Идентификатор ENI (псевдоним для network_interfaces.network_interface_id).

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

Пример: "eni-392fsdf"

interface_type

строка

Тип сетевого интерфейса.

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

Пример: "interface"

ipv6_addresses

список / элементы=строка

Список адресов IPv6 для этого интерфейса.

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

Пример: []

mac_address

строка

MAC-адрес сетевого интерфейса.

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

Пример: "0a:f8:10:2f:ab:a1"

name

строка

добавлен в amazon.aws 1.3.0

Тег Name ENI, часто отображаемый в AWS UIs как Name.

Возвращается: когда установлен тег Name

network_interface_id

строка

Идентификатор ENI.

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

Пример: "eni-392fsdf"

owner_id

строка

ID учетной записи AWS владельца ENI.

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

Пример: "123456789012"

private_dns_name

строка

Приватное имя DNS для ENI.

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

Пример: "ip-172-16-1-180.ec2.internal"

private_ip_address

строка

Приватный IP-адрес для ENI.

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

Пример: "172.16.1.180"

private_ip_addresses

список / элементы=строка

Список приватных IP-адресов, прикрепленных к ENI.

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

Пример: []

requester_id

строка

Идентификатор сущности, запустившей ENI.

Возвращается: успешно

Пример: "AIDA12345EXAMPLE54321"

requester_managed

boolean

Указывает, управляются ли сетевой интерфейс службой AWS.

Возвращаемое значение: всегда

Пример: false

source_dest_check

boolean

Указывает, выполняет ли сетевой интерфейс проверку источника/назначения.

Возвращаемое значение: всегда

Пример: false

status

string

Указывает, подключен ли сетевой интерфейс к экземпляру.

Возвращаемое значение: всегда

Пример: "in-use"

subnet_id

string

Идентификатор подсети, в которой находится сетевой интерфейс.

Возвращаемое значение: всегда

Пример: "subnet-7bbf01234"

tag_set

dictionary

Словарь тегов, добавленных к сетевому интерфейсу.

Возвращаемое значение: всегда

Пример: {}

tags

dictionary

добавлено в amazon.aws 1.3.0

Словарь тегов, добавленных к сетевому интерфейсу.

Возвращаемое значение: всегда

Пример: {}

vpc_id

string

Идентификатор VPC, к которому принадлежит сетевой интерфейс.

Возвращаемое значение: всегда

Пример: "vpc-b3f1f123"

Авторы

  • Rob White (@wimnat)

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

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

© 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_eni_info_module.html

Spec-Zone.ru

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