Модуль amazon.aws.ec2_vpc_vgw_info — сбор информации о виртуальных шлюзах в AWS

Примечание

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

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

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

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

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

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

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

Сбор информации о виртуальных шлюзах (VGW) в 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 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 результатов задачи. Используйте callback `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_DescribeVpnGateways.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 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` ← (по умолчанию)
vpn_gateway_ids список / элементы=строка	Один или несколько идентификаторов виртуальных частных шлюзов.

Примечания

Примечание

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

- name: Gather information about all virtual gateways for an account or profile
  amazon.aws.ec2_vpc_vgw_info:
    region: ap-southeast-2

- name: Gather information about a filtered list of Virtual Gateways
  amazon.aws.ec2_vpc_vgw_info:
    region: ap-southeast-2
    profile: production
    filters:
      "tag:Name": "main-virt-gateway"

- name: Gather information about a specific virtual gateway by VpnGatewayIds
  amazon.aws.ec2_vpc_vgw_info:
    region: ap-southeast-2
    profile: production
    vpn_gateway_ids: vgw-c432f6a7

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

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

Ключ	Описание
virtual_gateways список / элементы=словарь	Информация об одном или нескольких виртуальных частных шлюзах. Возвращается: всегда
resource_tags словарь	Словарь, представляющий теги, прикрепленные к VGW. Содержит те же сведения, что и `virtual_gateways.tags`. Возвращается: при успешном выполнении Пример: `{"Env": "Dev_Test_01", "MyKey": "MyValue"}`
state строка	Информация о текущем состоянии виртуального частного шлюза. Возвращается: при успешном выполнении Пример: `"available"`
tags список / элементы=словарь	Список словарей, представляющих теги, прикрепленные к виртуальному частному шлюзу. Содержит те же сведения, что и `virtual_gateways.resource_tags`. Возвращается: при успешном выполнении
key строка	Ключ тега. Возвращается: при успешном выполнении Пример: `"MyKey"`
value строка	Значение тега. Возвращается: при успешном выполнении Пример: `"MyValue"`
type строка	Информация о типе VPN-подключения, поддерживаемого виртуальным частным шлюзом. Возвращается: при успешном выполнении Пример: `"ipsec.1"`
vpc_attachments список / элементы=словарь	Информация о VPC, подключенных к виртуальному частному шлюзу. Возвращается: при успешном выполнении
state строка	Текущее состояние подключения. Возвращается: при успешном выполнении Пример: `"available"`
vpc_id строка	Идентификатор VPC. Возвращается: при успешном выполнении Пример: `"vpc-12345678901234567"`
vpn_gateway_id строка	Идентификатор виртуального частного шлюза. Возвращается: при успешном выполнении Пример: `"vgw-0123456789abcdef0"`

Авторы

Nick Aslanidis (@naslanidis)

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

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