community.aws.aws_direct_connect_gateway – Управление шлюзом AWS Direct Connect

Примечание

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

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

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

Новое в версии 1.0.0: из community.aws

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

Обзор

Создает шлюз AWS Direct Connect.
Удаляет шлюз AWS Direct Connect.
Присоединяет виртуальные шлюзы к шлюзу Direct Connect.
Отсоединяет виртуальные шлюзы от шлюза Direct Connect.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Выборы/Значения по умолчанию	Комментарии
amazon_asn строка		ASN со стороны Amazon. Требуется при state=present.
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
debug_botocore_endpoint_logs логическое значение	Выборы: нет ← да	Используйте logger botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, вывода набора в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
direct_connect_gateway_id строка		Идентификатор существующего шлюза Direct Connect. Требуется при state=absent.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. алиасы: aws_endpoint_url, endpoint_url
name строка		Имя шлюза Direct Connect, который нужно создать или удалить.
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
security_token строка		AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет исключено после 2022-06-01. алиасы: aws_security_token, access_token
state строка	Выборы: present ← absent	Установите state=present, чтобы убедиться в создании ресурса. Установите state=absent, чтобы удалить ресурс.
validate_certs логическое значение	Выборы: нет да ←	При значении "нет" SSL-сертификаты не будут проверены для версий boto >= 2.6.0.
virtual_gateway_id строка		Идентификатор VPN-шлюза существующего виртуального шлюза.
wait_timeout целое число	Значение по умолчанию: 320	Время ожидания удаления ассоциации.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета 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 a new direct connect gateway attached to virtual private gateway
  community.aws.aws_direct_connect_gateway:
    state: present
    name: my-dx-gateway
    amazon_asn: 7224
    virtual_gateway_id: vpg-12345
  register: created_dxgw

- name: Create a new unattached dxgw
  community.aws.aws_direct_connect_gateway:
    state: present
    name: my-dx-gateway
    amazon_asn: 7224
  register: created_dxgw

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
result сложное		state=present	Атрибуты шлюза Direct Connect
	amazon_side_asn строка	успех	ASN со стороны Amazon.
	direct_connect_gateway_id строка	успех	Идентификатор шлюза direct connect.
	direct_connect_gateway_name строка	успех	Имя шлюза direct connect.
	direct_connect_gateway_state строка	успех	Состояние шлюза direct connect.
	owner_account строка	успех	AWS-ID учетной записи владельца шлюза direct connect.

Авторы

Gobin Sougrakpam (@gobins)

© 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/aws_direct_connect_gateway_module.html