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

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

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

Описание

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

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	По умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
aws_secret_key	По умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
bgp_asn	По умолчанию: None	Номер автономной системы BGP (ASN), необходимый, когда state=present.
ec2_url	По умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
ip_address обязательно		Интернет-адрес IP для шлюза клиента, должен быть статическим.
name обязательно		Имя шлюза клиента.
profile (добавлен в 1.6)	По умолчанию: None	Использует профиль boto. Работает только с boto >= 2.24.0.
region		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
routing (добавлен в 2.4)	Варианты: static dynamic ←	Тип маршрутизации.
security_token (добавлен в 1.6)	По умолчанию: None	Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
state	Варианты: present ← absent	Создание или завершение работы шлюза клиента.
validate_certs (добавлен в 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), если учетные данные не указаны. См. http://boto.readthedocs.org/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 сложный		успех	Детали созданного шлюза.
	state строка	при наличии и доступности шлюза.	Состояние шлюза.
	customer_gateway_id строка	при наличии и доступности шлюза.	Идентификатор шлюза, присвоенный Amazon.
	tags строка	при наличии и доступности шлюза и наличии тегов.	Любые теги на шлюзе.
	type строка	при наличии и доступности шлюза.	Тип шифрования.
	bgp_asn строка	при наличии и доступности шлюза.	Номер автономной системы Border Gateway.
	ip_address строка	при наличии и доступности шлюза.	IP-адрес вашего устройства шлюза.

Статус

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

Автор

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.5/modules/ec2_customer_gateway_module.html