Spec-Zone.ru › Ansible

amazon.aws.ec2_vpc_net_info модуль — Сбор информации об EC2 VPC в AWS

Примечание

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

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

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

Для использования в плейбуке укажите: amazon.aws.ec2_vpc_net_info.

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

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

Описание

  • Сбор информации об EC2 VPC в AWS.

Требования

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

  • 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 для согласованности с AWS botocore SDK.

Псевдоним 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/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 и 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 для согласованности с AWS botocore SDK.

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

vpc_ids

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

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

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста 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 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

complex

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

Возвращено: success

cidr_block

string

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

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

cidr_block_association_set

complex

Массив информации о наборе ассоциаций блоков IPv4 cidr.

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

association_id

string

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

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

cidr_block

string

Блок IPv4 CIDR, ассоциированный с VPC.

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

cidr_block_state

dictionary

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

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

state

string

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

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

dhcp_options_id

string

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

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

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

enable_dns_hostnames

boolean

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

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

enable_dns_support

boolean

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

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

id

string

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

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

instance_tenancy

string

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

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

ipv6_cidr_block_association_set

complex

Массив информации о наборе ассоциаций блоков IPv6 cidr.

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

association_id

string

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

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

ipv6_cidr_block

string

Блок IPv6 CIDR, ассоциированный с VPC.

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

ipv6_cidr_block_state

dictionary

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

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

state

string

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

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

is_default

boolean

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

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

owner_id

string

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

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

Пример: "123456789012"

state

string

Состояние VPC.

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

tags

dictionary

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

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

vpc_id

string

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

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

Авторы

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

Spec-Zone.ru

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