Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_vpc_net_info — сбор сведений о VPC EC2 в AWS

Примечание

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

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

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

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

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

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

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

  • Собирает сведения о VPC EC2 в AWS.

Требования

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

  • 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 botocore SDK.

aws_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 для анализа уникальных (а не общего количества) вызовов 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/AWSEC2/latest/APIReference/API_DescribeVpcs.html.

По умолчанию: {}

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 botocore SDK.

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 ← (по умолчанию)

vpc_ids

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

Список идентификаторов VPC, существующих в вашей учетной записи.

По умолчанию: []

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» 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, see the AWS Guide for details.

# Gather information about all VPCs
- amazon.aws.ec2_vpc_net_info:

# Gather information about a particular VPC using VPC ID
- amazon.aws.ec2_vpc_net_info:
    vpc_ids: vpc-00112233

# Gather information about any VPC with a tag key Name and value Example
- amazon.aws.ec2_vpc_net_info:
    filters:
      "tag:Name": Example

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

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

Ключ

Описание

vpcs

составной тип

Возвращает массив составных объектов, описанных ниже.

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

cidr_block

строка

Блок IPv4 CIDR, назначенный VPC.

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

cidr_block_association_set

составной тип

Массив сведений о наборах связей блоков IPv4 CIDR.

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

association_id

строка

Идентификатор связи.

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

cidr_block

строка

Блок IPv4 CIDR, связанный с VPC.

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

cidr_block_state

словарь

Хеш/словарь, содержащий один элемент. Состояние связи блока CIDR.

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

state

строка

Состояние связи блока CIDR.

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

dhcp_options_id

строка

Идентификатор параметров DHCP, связанных с этой VPC.

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

Пример: "dopt-12345678"

enable_dns_hostnames

логическое значение

Значение True/False в зависимости от настройки атрибута поддержки DNS-имен узлов.

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

enable_dns_support

логическое значение

Значение True/False в зависимости от настройки атрибута поддержки DNS.

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

id

строка

Идентификатор VPC (для обратной совместимости).

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

instance_tenancy

строка

Настройка изоляции экземпляров для VPC.

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

ipv6_cidr_block_association_set

составной тип

Массив сведений о наборах связей блоков IPv6 CIDR.

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

association_id

строка

Идентификатор связи.

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

ipv6_cidr_block

строка

Блок IPv6 CIDR, связанный с VPC.

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

ipv6_cidr_block_state

словарь

Хеш/словарь, содержащий один элемент. Состояние связи блока CIDR.

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

state

строка

Состояние связи блока CIDR.

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

is_default

логическое значение

Значение True, если это VPC по умолчанию для учетной записи.

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

owner_id

строка

Учетная запись AWS, которой принадлежит VPC.

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

Пример: "123456789012"

state

строка

Состояние VPC.

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

tags

словарь

Словарь тегов, связанных с VPC.

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

vpc_id

строка

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

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

Авторы

  • Rob White (@wimnat)

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

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

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

Spec-Zone.ru

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