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

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

Обзор

Управление шлюзом 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.
debug_botocore_endpoint_logs логический тип добавлен в 2.8	Варианты: нет ← да	Использует логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action» во время выполнения задачи, выводит множество в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения сценария. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не указан, используется значение переменной среды EC2_URL, если таковое есть.
ip_address - / обязательно		Интернет-адрес IP для шлюза клиента, должен быть статическим.
name - / обязательно		Имя шлюза клиента.
profile строка		Использует профиль 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	Варианты: статический динамический ←	Тип маршрутизации.
security_token строка		AWS STS токен безопасности. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
state -	Варианты: present ← отсутствует	Создать или удалить шлюз клиента.
validate_certs логический тип	Варианты: нет да ←	Если установлено "нет", сертификаты 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.9/modules/ec2_customer_gateway_module.html