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

Статус

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

Техническое обслуживание

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

Список других модулей, также поддерживаемых сообществом 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.6/modules/ec2_customer_gateway_module.html