ec2_vpc_vpn_facts – Сбор фактов о VPN-соединениях в AWS

Новая в версии 2.6.

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

Обзор

Сбор фактов о VPN-соединениях в AWS.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs булево добавлен в 2.8	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не всех) API-вызовов «ресурс:действие», выполненных во время задачи, выводить набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы выводить полный список, сделанный во время выполнения задания.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она задана.
filters -		Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html для возможных фильтров.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0.
region строка		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она задана. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
validate_certs булево	Варианты: нет да ←	При значении "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
vpn_connection_ids -		Получить подробности определённых VPN-соединений, используя ID/IDs VPN-соединения. Это значение должно быть предоставлено как список.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION могут быть использованы для указания региона AWS, когда это требуется, но это также может быть настроено в конфигурационном файле boto

Примеры

# # Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather facts about all vpn connections
  ec2_vpc_vpn_facts:

- name: Gather facts about a filtered list of vpn connections, based on tags
  ec2_vpc_vpn_facts:
    filters:
      "tag:Name": test-connection
  register: vpn_conn_facts

- name: Gather facts about vpn connections by specifying connection IDs.
  ec2_vpc_vpn_facts:
    filters:
      vpn-gateway-id: vgw-cbe66beb
  register: vpn_conn_facts

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

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

Ключ			Возвращаемое значение	Описание
vpn_connections сложный			всегда	Список одного или нескольких VPN-соединений.
	category строка		всегда	Категория VPN-соединения. Пример: VPN
	customer_gateway_id строка		всегда	Идентификатор шлюза клиента на вашем конце VPN-соединения. Пример: cgw-17a53c37
	customer_gatway_configuration строка		всегда	Информация о конфигурации шлюза клиента VPN-соединения (в формате native XML).
	options словарь		всегда	Параметры VPN-соединения. Пример: {'static_routes_only': False}
	routes сложный		всегда	Список статических маршрутов, связанных с VPN-соединением.
		destination_cidr_block строка	всегда	Блок CIDR, связанный с локальной подсетью дата-центра клиента. Пример: 10.0.0.0/16
		state строка	всегда	Текущее состояние статического маршрута. Пример: available
	state строка		всегда	Текущее состояние VPN-соединения. Пример: available
	tags словарь		всегда	Все теги, назначенные VPN-соединению. Пример: {'Name': 'test-conn'}
	type строка		всегда	Тип VPN-соединения. Пример: ipsec.1
	vgw_telemetry сложный		всегда	Информация о VPN-туннеле.
		accepted_route_count целое число	всегда	Количество принятых маршрутов.
		certificate_arn строка	при использовании сертификата для аутентификации	Amazon Resource Name сертификата конечной точки туннеля виртуального частного шлюза. Пример: arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example
		last_status_change строка	всегда	Дата и время последнего изменения статуса. Пример: 2018-02-09T14:35:27+00:00
		outside_ip_address строка	всегда	Интернет-маршрутизируемый IP-адрес внешнего интерфейса виртуального частного шлюза. Пример: 13.127.79.191
		status строка	всегда	Состояние VPN-туннеля. Пример: DOWN
		status_message строка	всегда	Если возникла ошибка, описание ошибки. Пример: IPSEC IS DOWN
	vpn_connection_id строка		всегда	Идентификатор VPN-соединения. Пример: vpn-f700d5c0
	vpn_gateway_id строка		всегда	Идентификатор виртуального частного шлюза на стороне AWS VPN-соединения. Пример: vgw-cbe56bfb

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Madhura Naniwadekar (@Madhura-CSI)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_vpc_vpn_facts_module.html