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.
debug_botocore_endpoint_logs логический тип добавлен в 2.8	Варианты: нет ← да	Используйте регистрирующий компонент botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action» во время выполнения задачи, выводя набор в ключ task results.resource_actions. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного в рамках выполнения play. Переменная среды 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 ← absent	Создать или удалить шлюз клиента.
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 строка	при наличии и доступности шлюза.	Номер автономной системы BGP. Пример: 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.8/modules/ec2_customer_gateway_module.html