ec2_vpc_vpn_info – Сбор информации о VPN-соединениях в AWS

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

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

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

Сбор информации о VPN-соединениях в AWS.
Этот модуль назывался ec2_vpc_vpn_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: ec2_vpc_vpn_facts

Требования

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

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:action», сделанных во время задачи, выводит множество в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный в ходе выполнения книги задач. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
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-соединениях с использованием идентификатора(ов) 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 information about all vpn connections
  ec2_vpc_vpn_info:

- name: Gather information about a filtered list of vpn connections, based on tags
  ec2_vpc_vpn_info:
    filters:
      "tag:Name": test-connection
  register: vpn_conn_info

- name: Gather information about vpn connections by specifying connection IDs.
  ec2_vpc_vpn_info:
    filters:
      vpn-gateway-id: vgw-cbe66beb
  register: vpn_conn_info

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

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

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