Spec-Zone.ru › Ansible 2.5

ec2_vpc_vpn — Создание, изменение и удаление подключений VPN EC2.

Новое в версии 2.4.

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

Обзор

  • Этот модуль создаёт, изменяет и удаляет подключения VPN. Идемпотентность достигается с помощью параметра filters или указания идентификатора подключения VPN.

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key Значение по умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key Значение по умолчанию:
None
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
connection_type
    Варианты:
  • ipsec.1 ←
Тип подключения VPN.
customer_gateway_id
Идентификатор шлюза клиента.
ec2_url Значение по умолчанию:
None
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
filters
Альтернатива использованию vpn_connection_id. Если найдено несколько совпадений, требуется vpn_connection_id. Если один из следующих подвариантов представляет собой список элементов для фильтрации, для поиска соответствующего VPN необходимо, чтобы соответствовал только один элемент. Например, если фильтр «cidr» содержит ['194.168.2.0/24', '192.168.2.0/24'], и маршрут VPN содержит только блок назначения CIDR '192.168.2.0/24', VPN будет найден с этим фильтром (при условии, что не существует нескольких VPN, которые соответствуют ему). Другой пример, если фильтр 'vpn' равен ['vpn-ccf7e7ad', 'vpn-cb0ae2a2'], и один из VPN имеет состояние deleted (существует, но не может быть изменён), а другой существует и не имеет состояния deleted, он будет найден по этому фильтру. Смотрите примеры.
cgw-config
Настройка шлюза клиента VPN в виде строки (в формате возвращаемого значения) или списка таких строк.
vpn
Идентификатор подключения VPN в виде строки или списка таких строк.
tag-keys
Ключ тега в виде строки или списка таких строк.
static-routes-only
Тип маршрутизации; true или false.
tags
Словарь пар ключ-значение.
bgp
Номер ASN BGP, связанный с устройством BGP. Работает только если подключение подключено. Этот параметр фильтрации в настоящее время не работает.
tag-values
Значение тега в виде строки или списка таких строк.
cidr
Блок назначения CIDR маршрута VPN в виде строки или списка таких строк.
vgw
Виртуальный частный шлюз в виде строки или списка таких строк.
cgw
Идентификатор шлюза клиента в виде строки или списка таких строк.
profile
(добавлено в 1.6)
 Значение по умолчанию:
None
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_routes
Удалять ли маршруты подключений VPN, не указанные в задаче.
purge_tags
    Варианты:
  • no ←
  • yes
Удалять ли теги подключений VPN, связанные с подключением, но не указанные в задаче.
region
Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

Псевдонимы: aws_region, ec2_region
routes
Маршруты для добавления к подключению.
security_token
(добавлено в 1.6)
 Значение по умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
state
    Варианты:
  • present ←
  • absent
Желаемое состояние подключения VPN.
static_only Значение по умолчанию:
no
Указывает, использует ли подключение VPN только статические маршруты. Статические маршруты должны использоваться для устройств, которые не поддерживают BGP.
tags
Теги для добавления к подключению VPN.
tunnel_options
(добавлено в 2.5)
Необязательный список объектов, содержащий не более двух элементов словаря, каждый из которых может содержать ключи 'TunnelInsideCidr' и/или 'PreSharedKey' с соответствующими строковыми значениями. Значения по умолчанию AWS будут использоваться при отсутствии одного из перечисленных ключей.
validate_certs
(добавлено в 1.5)
    Варианты:
  • no
  • yes ←
При установке в «no», сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpn_connection_id
Идентификатор подключения VPN. Требуется для изменения или удаления подключения, если параметр filters не обеспечивает уникальное соответствие.
vpn_gateway_id
Идентификатор виртуального шлюза.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.

- name: create a VPN connection
  ec2_vpc_vpn:
    state: present
    vpn_gateway_id: vgw-XXXXXXXX
    customer_gateway_id: cgw-XXXXXXXX

- name: modify VPN connection tags
  ec2_vpc_vpn:
    state: present
    vpn_connection_id: vpn-XXXXXXXX
    tags:
      Name: ansible-tag-1
      Other: ansible-tag-2

- name: delete a connection
  ec2_vpc_vpn:
    vpn_connection_id: vpn-XXXXXXXX
    state: absent

- name: modify VPN tags (identifying VPN by filters)
  ec2_vpc_vpn:
    state: present
    filters:
      cidr: 194.168.1.0/24
      tag-keys:
        - Ansible
        - Other
    tags:
      New: Tag
    purge_tags: true
    static_only: true

- name: set up VPN with tunnel options utilizing 'TunnelInsideCidr' only
  ec2_vpc_vpn:
    state: present
    filters:
      vpn: vpn-XXXXXXXX
    static_only: true
    tunnel_options:
      -
        TunnelInsideCidr: '169.254.100.1/30'
      -
        TunnelInsideCidr: '169.254.100.5/30'

- name: add routes and remove any preexisting ones
  ec2_vpc_vpn:
    state: present
    filters:
      vpn: vpn-XXXXXXXX
    routes:
      - 195.168.2.0/24
      - 196.168.2.0/24
    purge_routes: true

- name: remove all routes
  ec2_vpc_vpn:
    state: present
    vpn_connection_id: vpn-XXXXXXXX
    routes: []
    purge_routes: true

- name: delete a VPN identified by filters
  ec2_vpc_vpn:
    state: absent
    filters:
      tags:
        Ansible: Tag

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

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

Ключ Возвращаемое значение Описание
changed
bool
 всегда
Если соединение VPN изменилось.

Пример:
{'changed': True}
customer_gateway_configuration
str
 состояние=present
Настройка подключения VPN.
customer_gateway_id
str
 состояние=present
Клиентский шлюз, подключенный через соединение.

Пример:
{'customer_gateway_id': 'cgw-1220c87b'}
options
complex
 состояние=present
Параметры подключения VPN (в настоящее время содержат только static_routes_only).
static_routes_only
str
 состояние=present
Если VPN-соединение допускает только статические маршруты.

Пример:
{'static_routes_only': True}
routes
list
 состояние=present
Маршруты VPN-соединения.

Пример:
{'routes': [{'state': 'доступно', 'destination_cidr_block': '192.168.1.0/24'}]}
state
string
 состояние=present
Состояние VPN-соединения.

Пример:
{'state': 'доступно'}
tags
dict
 состояние=present
Теги, связанные с подключением.

Пример:
{'tags': {'other': 'тег', 'name': 'ansible-test'}}
type
str
 состояние=present
Тип VPN-соединения (в настоящее время доступен только ipsec.1).

Пример:
{'type': 'ipsec.1'}
vgw_telemetry
list
 состояние=present
Телеметрия для туннеля VPN.

Пример:
{'vgw_telemetry': [{'status': 'включено', 1: None, 'last_status_change': 'datetime(2015', 'outside_ip_address': 'строка', '1)': None, 'status_message': 'строка', 'accepted_route_count': 123}]}
vpn_connection_id
str
 состояние=present
Идентификатор VPN-соединения.

Пример:
{'vpn_connection_id': 'vpn-781e0e19'}
vpn_gateway_id
str
 состояние=present
Виртуальный частный шлюз, подключенный через соединение.

Пример:
{'vpn_gateway_id': 'vgw-cb0ae2a2'}


Статус

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

Автор

  • Sloane Hertel (@s-hertel)

Подсказка

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

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

Spec-Zone.ru

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