Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_vpc_vgw – создание и удаление виртуальных VPN-шлюзов AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_vpc_vgw.

Добавлено в community.aws 1.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile нельзя использовать одновременно.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

asn

integer

Номер ASN для BGP на стороне Amazon.

aws_ca_bundle

path

Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Список параметров приведён в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных за время плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

aliases: aws_endpoint_url

string

URL для подключения вместо используемых по умолчанию конечных точек AWS. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

name

string

Имя создаваемого или удаляемого VGW.

profile

aliases: aws_profile

string

Именованный профиль AWS, используемый для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile нельзя использовать одновременно с параметрами aws_access_key, aws_secret_key и session_token.

purge_tags

boolean

Если задано значение purge_tags=true и задан параметр tags, существующие теги ресурса будут удалены, чтобы их набор точно соответствовал указанному параметром tags.

Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра purge_tags они будут игнорироваться. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

  • false
  • true ← (по умолчанию)

region

aliases: aws_region

string

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

aliases: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile нельзя использовать одновременно.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

session_token

aliases: aws_session_token

string

Токен сеанса AWS STS для использования с временными учётными данными.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную окружения AWS_SESSION_TOKEN.

Параметры session_token и profile нельзя использовать одновременно.

state

string

present, чтобы ресурс был создан.

absent, чтобы удалить ресурс.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

aliases: resource_tags

dictionary

Словарь с тегами, которые нужно применить к ресурсу.

Если параметр tags не задан, теги не будут изменены.

type

string

Тип создаваемого виртуального шлюза.

Варианты:

  • "ipsec.1" ← (по умолчанию)

validate_certs

boolean

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

vpc_id

string

Идентификатор VPC, к которому нужно подключить или от которого нужно отключить VGW.

vpn_gateway_id

string

Идентификатор VPN-шлюза существующего виртуального шлюза.

wait_timeout

integer

Количество секунд ожидания изменения состояния при подключении VGW к VPC и отключении от неё.

По умолчанию: 320

Примечания

Примечание

  • Поддержка purge_tags добавлена в выпуске 4.0.0.
  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учётных данных по умолчанию и другие параметры, например регион, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

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

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

- name: Remove a new VGW using the name
  amazon.aws.ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    name: personal-testing
    type: ipsec.1

- name: Remove a new VGW using the vpn_gateway_id
  amazon.aws.ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    vpn_gateway_id: vgw-3a9aa123

- name: Detach vpn gateway from VPC
  amazon.aws.ec2_vpc_vgw:
    state: present
    name: "{{ vgw_name }}"
    register: vgw

- name: Delete vpn gateway
  amazon.aws.ec2_vpc_vgw:
    state: absent
    vpn_gateway_id: '{{ vgw.vgw.id | default(vgw_id) }}'
    ignore_errors: true

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

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

Ключ

Описание

vgw

dictionary

Сведения о виртуальном частном шлюзе.

Возвращается: success

id

string

Идентификатор виртуального частного шлюза.

Возвращается: success

Пример: "vgw-0123456789abcdef0"

state

string

Текущее состояние виртуального частного шлюза.

Возвращается: success

Пример: "available"

tags

dictionary

Словарь с тегами, присвоенными виртуальному частному шлюзу.

Возвращается: success

Пример: {"Env": "Dev_Test_001", "Name": "ansible-test-ec2-vpc-vgw"}

type

string

Тип VPN-подключения, поддерживаемого виртуальным частным шлюзом.

Возвращается: success

Пример: "ipsec.1"

vpc_id

string

Идентификатор VPC.

Возвращается: success

Пример: "vpc-123456789abcdef01"

Авторы

  • Nick Aslanidis (@naslanidis)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_vpc_vgw_module.html

Spec-Zone.ru

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