community.aws.ec2_customer_gateway – Управление клиенским шлюзом AWS

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.ec2_customer_gateway.

Введено в версии 1.0.0: коллекции community.aws

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

Обзор

Управление клиенским шлюзом AWS.

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение пакета сертификатов CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Пакет CA считывается на стороне модуля и может потребоваться явное копирование с контроллера, если он не запущен локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
bgp_asn целое число		Номер автономной системы BGP (ASN), необходимый при state=present.
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Используйте logger botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводив набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести в список, составленный во время выполнения книги задач.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. псевдонимы: aws_endpoint_url, endpoint_url
ip_address строка / обязательно		IP-адрес, доступный в интернете, для клиенского шлюза, должен быть статическим.
name строка / обязательно		Имя клиенского шлюза.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование параметра profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка их одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
routing строка	Варианты: статический динамический ←	Тип маршрутизации.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: aws_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_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE.
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html.
AWS_REGION или EC2_REGION обычно используются для указания AWS-региона, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- name: Create Customer Gateway
  community.aws.ec2_customer_gateway:
    bgp_asn: 12345
    ip_address: 1.2.3.4
    name: IndianapolisOffice
    region: us-east-1
  register: cgw

- name: Delete Customer Gateway
  community.aws.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 строка	при существовании и доступности шлюза.	Состояние шлюза. Пример: available
	tags список / элементы=строка	при существовании и доступности шлюза, а также при наличии тегов.	Любые теги шлюза.
	type строка	при существовании и доступности шлюза.	Тип шифрования. Пример: ipsec.1

Авторы

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.10/collections/community/aws/ec2_customer_gateway_module.html