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

Примечания

Примечание

Вы не можете создать более одного шлюза клиента с одним и тем же 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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html.
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, если это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

# 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 сложный		успешно	детали созданного шлюза.
	bgp_asn строка	при наличии и доступности шлюза.	Номер автономной системы Border Gateway. Пример: 65123
	customer_gateway_id строка	при наличии и доступности шлюза.	Идентификатор шлюза, присвоенный Amazon. Пример: cgw-cb6386a2
	ip_address строка	при наличии и доступности шлюза.	IP-адрес устройства шлюза. Пример: 1.2.3.4
	state строка	при наличии и доступности шлюза.	Состояние шлюза.
	tags строка	при наличии шлюза и доступности, а также при наличии тегов.	Любые теги на шлюзе.
	type строка	при наличии и доступности шлюза.	Тип шифрования. Пример: ipsec.1

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Michael Baydoun (@MichaelBaydoun)

Подсказка

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

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