Модуль amazon.aws.ec2_vpc_vpn_info — сбор информации о VPN-подключениях EC2 в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: amazon.aws.ec2_vpc_vpn_info.
Новое в community.aws 1.0.0
Краткое описание
- Сбор информации о VPN-подключениях EC2 в AWS.
Требования
Перечисленные ниже компоненты должны быть установлены на узле, выполняющем этот модуль.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key string | Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK. |
aws_ca_bundle path | Путь к пакету сертификатов CA, используемому для проверки сертификатов SSL. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Описание параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL-адрес для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
filters dictionary | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и его значения. Возможные фильтры см. в разделе https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html. По умолчанию: |
profile псевдонимы: aws_profile string | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region string | Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key string | Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK. |
session_token псевдонимы: aws_session_token string | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать aws_ca_bundle. Варианты:
|
vpn_connection_ids list / elements=string | Получение сведений об одном или нескольких конкретных VPN-подключениях EC2 по их идентификаторам. Это значение необходимо передать в виде списка. По умолчанию: |
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» 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 EC2 VPN Connections
amazon.aws.ec2_vpc_vpn_info:
- name: Gather information about a filtered list of EC2 VPN Connections, based on tags
amazon.aws.ec2_vpc_vpn_info:
filters:
"tag:Name": "test-connection"
register: vpn_conn_info
- name: Gather information about EC2 VPN Connections by specifying connection IDs
amazon.aws.ec2_vpc_vpn_info:
filters:
"vpn-gateway-id": "vgw-cbe66beb"
register: vpn_conn_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
vpn_connections list / elements=dictionary | Список из одного или нескольких VPN-подключений EC2. Возвращается: всегда |
|
category string |
Категория VPN-подключения. Возвращается: всегда Пример: |
|
customer_gateway_id string |
Идентификатор шлюза клиента на вашей стороне VPN-подключения. Возвращается: всегда Пример: |
|
customer_gatway_configuration string |
Сведения о конфигурации шлюза клиента для VPN-подключения (в исходном формате XML). Возвращается: всегда |
|
gateway_association_state string |
Текущее состояние ассоциации шлюза. Возвращается: при успехе Пример: |
|
options list / elements=dictionary |
Параметры VPN-подключения. Возвращается: при успехе |
|
enable_acceleration boolean |
Указывает, включено ли ускорение для VPN-подключения. Возвращается: при успехе Пример: |
|
local_ipv4_network_cidr string |
Блок CIDR IPv4 на стороне шлюза клиента (локальной сети) VPN-подключения. Возвращается: при успехе Пример: |
|
outside_ip_address_type string |
Внешний IP-адрес VPN-туннеля. Возвращается: при успехе Пример: |
|
remote_ipv4_network_cidr string |
Блок CIDR IPv4 на стороне Amazon Web Services VPN-подключения. Возвращается: при успехе Пример: |
|
static_routes_only boolean |
Указывает, разрешает ли VPN-подключение только статические маршруты. Возвращается: при успехе Пример: |
|
tunnel_inside_ip_version string |
Указывает, обрабатывают ли VPN-туннели трафик IPv4 или IPv6. Возвращается: при успехе Пример: |
|
tunnel_options list / elements=dictionary |
Параметры VPN-туннеля. Возвращается: при успехе Пример: |
|
log_options dictionary |
Параметры ведения журнала активности VPN-туннеля. Возвращается: при успехе |
|
cloud_watch_log_options dictionary |
Параметры отправки журналов VPN-туннеля в CloudWatch. Возвращается: при успехе |
|
outside_ip_address string |
Внешний IP-адрес VPN-туннеля. Возвращается: при успехе |
|
string |
Предварительно согласованный ключ (PSK) для первоначальной аутентификации между виртуальным частным шлюзом и шлюзом клиента. Возвращается: при успехе |
|
tunnel_inside_cidr string |
Диапазон внутренних IPv4-адресов туннеля. Возвращается: при успехе |
|
routes list / elements=dictionary |
Список статических маршрутов, связанных с VPN-подключением. Возвращается: всегда |
|
destination_cidr_block string |
Блок CIDR, связанный с локальной подсетью центра обработки данных клиента. Возвращается: при успехе |
|
source string |
Указывает, каким образом были заданы маршруты. Возвращается: при успехе |
|
state string |
Текущее состояние статического маршрута. Возвращается: при успехе |
|
state string |
Текущее состояние VPN-подключения. Возвращается: всегда Пример: |
|
tags dictionary |
Все теги, назначенные VPN-подключению. Возвращается: всегда Пример: |
|
type string |
Тип VPN-подключения. Возвращается: всегда Пример: |
|
vgw_telemetry dictionary |
Информация о VPN-туннеле. Возвращается: всегда |
|
accepted_route_count integer |
Количество принятых маршрутов. Возвращается: всегда Пример: |
|
certificate_arn string |
Имя ресурса Amazon (ARN) сертификата конечной точки туннеля виртуального частного шлюза. Возвращается: если для аутентификации используется частный сертификат Пример: |
|
last_status_change string |
Дата и время последнего изменения состояния. Возвращается: всегда Пример: |
|
outside_ip_address string |
Доступный из Интернета IP-адрес внешнего интерфейса виртуального частного шлюза. Возвращается: всегда Пример: |
|
status string |
Состояние VPN-туннеля. Возвращается: всегда Пример: |
|
status_message string |
Описание ошибки, если она произошла. Возвращается: всегда Пример: |
|
vpn_connection_id string |
Идентификатор VPN-подключения. Возвращается: всегда Пример: |
|
vpn_gateway_id string |
Идентификатор виртуального частного шлюза на стороне AWS VPN-подключения. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_vpn_info_module.html