ec2_vpc_vgw – Создание и удаление виртуальных шлюзов AWS VPN

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

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

Описание

Создает виртуальные шлюзы AWS VPN
Удаляет виртуальные шлюзы AWS VPN
Подключает виртуальные шлюзы к VPC
Отключает виртуальные шлюзы от VPC

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
asn - добавлено в 2.6		ASN BGP со стороны Amazon
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	Варианты: нет ← да	Используйте logger botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения книги задач. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
name -		Имя создаваемого или удаляемого vgw
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
state -	Варианты: present ← absent	present — для обеспечения создания ресурса. absent — для удаления ресурса
tags -		словарь тегов ресурсов псевдонимы: resource_tags
type -	Варианты: ipsec.1	тип виртуального шлюза для создания
validate_certs логический тип	Варианты: нет да ←	Если установлено в "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpc_id -		vpc-id VPC для подключения или отключения
vpn_gateway_id -		идентификатор vpn-шлюза существующего виртуального шлюза
wait_timeout -	По умолчанию: 320	количество секунд ожидания статуса при подключении и отключении VPC

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета 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

Примеры

- name: Create a new vgw attached to a specific VPC
  ec2_vpc_vgw:
    state: present
    region: ap-southeast-2
    profile: personal
    vpc_id: vpc-12345678
    name: personal-testing
    type: ipsec.1
  register: created_vgw

- name: Create a new unattached vgw
  ec2_vpc_vgw:
    state: present
    region: ap-southeast-2
    profile: personal
    name: personal-testing
    type: ipsec.1
    tags:
      environment: production
      owner: ABC
  register: created_vgw

- name: Remove a new vgw using the name
  ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    name: personal-testing
    type: ipsec.1
  register: deleted_vgw

- name: Remove a new vgw using the vpn_gateway_id
  ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    vpn_gateway_id: vgw-3a9aa123
  register: deleted_vgw

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

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

Ключ	Возвращаемое значение	Описание
result словарь	успех	Результат действия создания или удаления.

Статус

Этот модуль гарантированно не будет содержать изменений интерфейса, несовместимых со старыми версиями, в дальнейшем. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Nick Aslanidis (@naslanidis)

Подсказка

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

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