community.aws.ec2_vpc_vpn_facts – Сбор информации о подключениях VPN в AWS.

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

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

Новое в версии 1.0.0: of community.aws

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и станет взаимоисключающим после 2022-06-01. алиасы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла сертификатов CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: файл CA Bundle считывается на стороне модуля и, возможно, потребует явного копирования с контроллера, если выполняется не локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти на https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и станет взаимоисключающим после 2022-06-01. алиасы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Используйте логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API "resource:action" во время выполнения задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время плейбука. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. алиасы: aws_endpoint_url, endpoint_url
filters словарь		Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html для возможных фильтров.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременного указания их с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01. алиасы: aws_profile
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. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и станет взаимоисключающим после 2022-06-01. алиасы: aws_security_token, access_token
validate_certs логический тип	Варианты: нет да ←	При значении "нет" SSL-сертификаты не будут проверены для версий boto >= 2.6.0.
vpn_connection_ids список / элементы=строка		Получить детали конкретных подключений VPN с помощью идентификатора/идентификаторов подключений VPN. Это значение должно быть указано как список.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
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
  community.aws.ec2_vpc_vpn_info:

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

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

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

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

Ключ			Возвращаемое значение	Описание
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 строка	всегда	Текущее состояние статического маршрута. Пример: доступно
	state строка		всегда	Текущее состояние VPN-соединения. Пример: доступно
	tags словарь		всегда	Любые метки, назначенные VPN-соединению. Пример: {'Имя': 'test-conn'}
	type строка		всегда	Тип VPN-соединения. Пример: ipsec.1
	vgw_telemetry сложный		всегда	Информация о VPN-туннеле.
		accepted_route_count целое число	всегда	Количество принятых маршрутов.
		certificate_arn строка	при использовании частного сертификата для аутентификации	Идентификатор ресурса Amazon для сертификата конечной точки туннеля виртуального частного шлюза. Пример: 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-туннеля. Пример: ВЫКЛ.
		status_message строка	всегда	Если произошла ошибка, описание ошибки. Пример: IPSEC ВЫКЛ.
	vpn_connection_id строка		всегда	Идентификатор VPN-соединения. Пример: vpn-f700d5c0
	vpn_gateway_id строка		всегда	Идентификатор виртуального частного шлюза на стороне AWS VPN-соединения. Пример: vgw-cbe56bfb

Авторы

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.10/collections/community/aws/ec2_vpc_vpn_facts_module.html