Модуль community.aws.directconnect_connection — создание, удаление и изменение подключения DirectConnect

Примечание

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

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

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

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

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

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

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

Создание, обновление или удаление подключения Direct Connect между сетью и определённой точкой присутствия AWS Direct Connect.
При создании подключение можно добавить в группу агрегации каналов или создать как отдельное подключение.
Позднее подключение можно связать с группой агрегации каналов или отсоединить от неё.
До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_direct_connect_connection. Использование не изменилось.

Псевдонимы: aws_direct_connect_connection

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key string	Идентификатор ключа доступа 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 SDK botocore.
aws_ca_bundle path	Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
bandwidth string	Пропускная способность подключения Direct Connect. Обязательный параметр при state=present. Допустимые значения: `"1Gbps"` `"10Gbps"`
connection_id string	Идентификатор подключения Direct Connect. Изменение атрибутов подключения с помощью forced_update приведёт к созданию нового идентификатора подключения Direct Connect. Необходимо указать один из параметров: connection_id или name.
debug_botocore_endpoint_logs boolean	Использовать регистратор `botocore.endpoint` для подсчёта уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести полный список вызовов, выполненных в ходе плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Допустимые значения: `false` ← (значение по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
forced_update boolean	Для изменения параметра bandwidth или location подключение необходимо удалить и создать заново. По умолчанию этого не происходит. Чтобы изменить bandwith или location, необходимо явно установить для этого параметра значение `true`. Допустимые значения: `false` ← (значение по умолчанию) `true`
link_aggregation_group string	Идентификатор группы агрегации каналов, с которой нужно связать подключение. Этот параметр необязателен, если требуется отдельное подключение.
location string	Местоположение подключения Direct Connect. Обязательный параметр при state=present.
name string	Имя подключения Direct Connect. Этот параметр необходим для создания нового подключения. Необходимо указать один из параметров: connection_id или name.
profile псевдоним: aws_profile string	Именованный профиль 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 string	Регион AWS, который нужно использовать. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key string	Секретный ключ доступа 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 SDK botocore.
session_token псевдоним: aws_session_token string	Токен сеанса 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 string / обязательный	Состояние подключения Direct Connect. Допустимые значения: `"present"` `"absent"`
validate_certs boolean	Если установлено значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать параметр aws_ca_bundle. Допустимые значения: `false` `true` ← (значение по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
SDK AWS (boto3), используемый Ansible, также может считывать значения учётных данных и другие настройки по умолчанию, например регион, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# create a Direct Connect connection
- community.aws.directconnect_connection:
    name: ansible-test-connection
    state: present
    location: EqDC2
    link_aggregation_group: dxlag-xxxxxxxx
    bandwidth: 1Gbps
  register: dc

# disassociate the LAG from the connection
- community.aws.directconnect_connection:
    state: present
    connection_id: dc.connection.connection_id
    location: EqDC2
    bandwidth: 1Gbps

# replace the connection with one with more bandwidth
- community.aws.directconnect_connection:
    state: present
    name: ansible-test-connection
    location: EqDC2
    bandwidth: 10Gbps
    forced_update: true

# delete the connection
- community.aws.directconnect_connection:
    state: absent
    name: ansible-test-connection

Возвращаемые значения

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

Ключ	Описание
connection complex	Атрибуты подключения Direct Connect. Возвращается: state=present
aws_device string	Конечная точка, в которой завершается физическое подключение. Возвращается: когда запрошенное состояние больше не является «requested» Пример: `"EqDC2-12pmo7hemtz1z"`
bandwidth string	Пропускная способность подключения. Возвращается: всегда Пример: `"1Gbps"`
connection_id string	Идентификатор подключения. Возвращается: всегда Пример: `"dxcon-ffy9ywed"`
connection_name string	Имя подключения. Возвращается: всегда Пример: `"ansible-test-connection"`
connection_state string	Состояние подключения. Возвращается: всегда Пример: `"pending"`
loa_issue_time string	Время выдачи письма-разрешения Letter of Authorization — Connecting Facility Assignment для подключения. Возвращается: когда выдано LOA-CFA (состояние подключения больше не будет «requested») Пример: `"2018-03-20T17:36:26-04:00"`
location string	Местоположение подключения. Возвращается: всегда Пример: `"EqDC2"`
owner_account string	Учётная запись, которой принадлежит подключение Direct Connect. Возвращается: всегда Пример: `"123456789012"`
region string	Регион, в котором находится подключение. Возвращается: всегда Пример: `"us-east-1"`

Авторы

Sloane Hertel (@s-hertel)

Ссылки на коллекцию

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