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 устарело и будет сделано взаимоисключающими после 01.06.2022. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Путь к файлу с сертификатами CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: файл CA Bundle читается на стороне модуля и, возможно, требует явного копирования с контроллера, если он не запускается локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Подробнее о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и будет сделано взаимоисключающими после 01.06.2022. псевдонимы: ec2_secret_key, secret_key
bgp_asn целое число		Номер автономной системы BGP (ASN), необходимый, когда state=present.
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action», производимых во время выполнения задачи, выводит набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
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 после 01.06.2022. псевдонимы: 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 устарело и будет сделано взаимоисключающими после 01.06.2022. псевдонимы: aws_security_token, access_token
state строка	Варианты: present ← absent	Создать или удалить шлюз клиента.
validate_certs булево	Варианты: нет да ←	Если установлено значение "нет", для boto-версий >= 2.6.0 валидация SSL-сертификатов не будет выполняться.

Примечания

Примечание

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

Авторы

Michael Baydoun (@MichaelBaydoun)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_customer_gateway_module.html