Spec-Zone.ru › Ansible 2.6

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
bool

(добавлено в 1.5)
    Варианты:
  • нет
  • да ←
Если установлено "нет", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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_gatway_configuration
строка
всегда
Информация о конфигурации шлюза клиента VPN-соединения (в формате native XML).

customer_gateway_id
строка
всегда
Идентификатор шлюза клиента на вашей стороне VPN-соединения.

Пример:
cgw-17a53c37
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
целое
всегда
Количество принятых маршрутов.

vpn_connection_id
строка
всегда
Идентификатор VPN-соединения.

Пример:
vpn-f700d5c0
vpn_gateway_id
строка
всегда
Идентификатор виртуального шлюза VPN на стороне AWS VPN-соединения.

Пример:
vgw-cbe56bfb


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Для списка других модулей, которые также поддерживаются сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/ec2_vpc_vpn_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API