ec2_customer_gateway - Управление шлюзом клиента AWS

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

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

Описание

Управление шлюзом клиента AWS

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

boto
boto3
botocore
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
bgp_asn	нет			Номер автономной системы BGP (ASN), необходим, когда state=present.
ec2_url	нет			URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
ip_address	да			Интернет-адрес для шлюза клиента, должен быть статическим.
name	да			Имя шлюза клиента.
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
routing (добавлено в 2.4)	нет	dynamic	static dynamic	Тип маршрутизации.
security_token (добавлено в 1.6)	нет			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
state	нет	present	present absent	Создать или удалить шлюз клиента.
validate_certs (добавлено в 1.5)	нет	да	да нет	Если установлено «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примеры

# Create Customer Gateway
- ec2_customer_gateway:
    bgp_asn: 12345
    ip_address: 1.2.3.4
    name: IndianapolisOffice
    region: us-east-1
  register: cgw

# Delete Customer Gateway
- ec2_customer_gateway:
    ip_address: 1.2.3.4
    name: IndianapolisOffice
    state: absent
    region: us-east-1
  register: cgw

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

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

имя

описание

возвращается

тип

пример

gateway.customer_gateways

Подробная информация о созданном шлюзе.

успех

сложный

содержит:

имя	описание	возвращается	тип	пример
state	состояние шлюза.	когда шлюз существует и доступен.	строка
customer_gateway_id	идентификатор шлюза, присвоенный Amazon.	когда существует и шлюз доступен.	строка	cgw-cb6386a2
tags	любые метки на шлюзе.	когда шлюз существует и доступен, и когда метки существуют.	строка
type	тип шифрования.	когда шлюз существует и доступен.	строка	ipsec.1
bgp_asn	Номер автономной системы BGP.	когда существует и шлюз доступен.	строка	65123
ip_address	IP-адрес вашего устройства шлюза.	когда существует и шлюз доступен.	строка	1.2.3.4

Примечания

Примечание

Вы не можете создать более одного шлюза клиента с одинаковым IP-адресом. Если вы выполните идентичный запрос более одного раза, первый запрос создаст шлюз клиента, а последующие запросы вернут информацию об имеющемся шлюзе клиента. Последующие запросы не создают новых ресурсов шлюзов клиентов.
Возвращаемые значения содержат ключи customer_gateway и customer_gateways, которые являются идентичными словарями. Вы должны использовать customer_gateway. См. https://github.com/ansible/ansible-modules-extras/issues/2773 для получения подробностей.
Если параметры не заданы в модуле, следующие переменные окружения могут быть использованы в порядке убывания приоритета 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

Статус

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

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочтите Информация о сообществе и участие, Тестирование 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_customer_gateway_module.html