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 | |
| ec2_url - | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть. | |
| filters - | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html для возможных фильтров. | |
| profile - добавлен в 1.6 | Использует профиль 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 - добавлен в 1.6 | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| validate_certs boolean добавлен в 1.5 |
| При установке в "no", сертификаты SSL не будут проверяться для boto версий >= 2.6.0. |
| vpn_connection_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 (в формате 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 целое число | всегда | Количество принятых маршрутов. | ||
| vpn_connection_id строка | всегда | Идентификатор подключения VPN. Пример: vpn-f700d5c0 | ||
| vpn_gateway_id строка | всегда | Идентификатор виртуального шлюза в AWS на стороне подключения VPN. Пример: vgw-cbe56bfb | ||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
- Данный модуль поддерживается сообществом 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.7/modules/ec2_vpc_vpn_facts_module.html