Модуль community.aws.ec2_customer_gateway — управление клиентским шлюзом AWS

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.ec2_customer_gateway.

Добавлено в community.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Описание
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` (в порядке убывания предпочтительности). Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры перечислены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
bgp_asn целое число	Номер автономной системы (ASN) протокола граничного шлюза (BGP). Если параметр не указан при state=present, по умолчанию используется `65000`.
debug_botocore_endpoint_logs логический	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте обработчик обратных вызовов `aws_resource_action`, чтобы вывести общий список вызовов, выполненных за время плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
ip_address строка / обязательный	Доступный в Интернете IP-адрес клиентского шлюза; адрес должен быть статическим.
name строка / обязательный	Имя клиентского шлюза.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
routing строка	Тип маршрутизации. Варианты: `"static"` `"dynamic"` ← (по умолчанию)
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` (в порядке убывания предпочтительности). Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile взаимоисключающие.
state строка	Создать или удалить клиентский шлюз. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логический	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Нельзя создать несколько клиентских шлюзов с одним и тем же IP-адресом. Если выполнить идентичный запрос несколько раз, первый запрос создаст клиентский шлюз, а последующие вернут сведения о существующем клиентском шлюзе. Последующие запросы не создают новые ресурсы клиентского шлюза.
Возвращаемые значения содержат ключи customer_gateway и customer_gateways с идентичными словарями. Рекомендуется использовать customer_gateway. Подробности см. на странице https://github.com/ansible/ansible-modules-extras/issues/2773.
Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров, например региона, по умолчанию из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- 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 строка	Номер автономной системы протокола граничного шлюза. Возвращается: если шлюз существует и доступен. Пример: `"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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/ec2_customer_gateway_module.html