Spec-Zone.ru › Ansible 2.4

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

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

  • Описание
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Описание

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

Требования (к хосту, на котором выполняется модуль)

  • 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, если таковая есть.
name
нет
Имя создаваемого или удаляемого VGW.
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
state
нет present
  • present
  • absent
present — для обеспечения создания ресурса.
absent — для удаления ресурса
tags
нет
Словарь тегов ресурса.
Псевдонимы: resource_tags
type
нет
  • ipsec.1
Тип создаваемого виртуального шлюза.
validate_certs
(добавлено в 1.5)
нет да
  • да
  • нет
При значении "нет" сертификаты SSL для boto версий >= 2.6.0 не будут валидироваться.
vpc_id
нет
Идентификатор VPC для подключения или отключения.
vpn_gateway_id
нет
Идентификатор существующего виртуального шлюза VPN.
wait_timeout
нет 320
Количество секунд ожидания статуса при подключении и отключении VPC.

Примеры

- 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
Результат действия создания или удаления.
успех словарь

Примечания

Примечание

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

Статус

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

Для получения помощи в разработке модулей обратитесь к Информация и участие в сообществе Ansible, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

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