Spec-Zone.ru › Ansible 2.11

community.aws.aws_direct_connect_connection – Создаёт, удаляет, изменяет подключение Direct Connect

Примечание

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

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

Чтобы использовать его в книге задач, укажите: community.aws.aws_direct_connect_connection.

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

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

Описание

  • Создать, обновить или удалить подключение Direct Connect между сетью и определённым расположением AWS Direct Connect. При создании подключение может быть добавлено в группу агрегирования каналов или установлено как независимое подключение. Позже подключение может быть связано или отсоединено от группы агрегирования каналов.

Требования

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

  • 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.
Только ключ 'user_agent' используется для модулей boto. См. 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
bandwidth
строка
    Варианты:
  • 1Gbps
  • 10Gbps
Пропускная способность подключения Direct Connect.
Требуется, когда state=present.
connection_id
строка
Идентификатор подключения Direct Connect.
Изменение атрибутов подключения с forced_update приведёт к новому идентификатору подключения Direct Connect.
Один из параметров connection_id или name должен быть указан.
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Используйте регистрирователь botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие», выполненных во время задачи, выводив их в ключ task results, ресурс_действий. Используйте обратный вызов aws_resource_action, чтобы выводить в полный список, созданный во время игры в плейбук.
ec2_url
строка
URL для подключения к EC2 или вашей облачной системе Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не установлен, используется значение переменной окружения EC2_URL, если таковое имеется.

алиасы: aws_endpoint_url, endpoint_url
forced_update
булево
    Варианты:
  • нет ←
  • да
Для изменения bandwidth или location подключение необходимо удалить и создать заново.
По умолчанию этого не произойдёт. Этот параметр нужно явно установить в значение true, чтобы изменить bandwith или location.
link_aggregation_group
строка
Идентификатор группы агрегирования каналов, которую вы хотите связать с подключением.
Это необязательно, когда требуется независимое подключение.
location
строка
Расположение подключения Direct Connect.
Требуется, когда state=present.
name
строка
Имя подключения Direct Connect. Это необходимо для создания нового подключения.
Один из параметров connection_id или 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
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
Состояние подключения Direct Connect.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Если установлено в «нет», SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

  • Если параметры не установлены внутри модуля, можно использовать следующие переменные среды в порядке убывания приоритета 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

Примеры

# create a Direct Connect connection
- community.aws.aws_direct_connect_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.aws_direct_connect_connection:
    state: present
    connection_id: dc.connection.connection_id
    location: EqDC2
    bandwidth: 1Gbps

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

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

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

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

Ключ Возвращаемое значение Описание
connection
сложный
state=present
Атрибуты прямого подключения.
aws_device
строка
когда запрашиваемое состояние больше не 'requested'
Точка подключения физического соединения.

Пример:
EqDC2-12pmo7hemtz1z
bandwidth
строка
всегда
Пропускная способность соединения.

Пример:
1Gbps
connection_id
строка
всегда
Идентификатор соединения.

Пример:
dxcon-ffy9ywed
connection_name
строка
всегда
Название соединения.

Пример:
ansible-test-connection
connection_state
строка
всегда
Состояние соединения.

Пример:
pending
loa_issue_time
строка
когда LOA-CFA был выдан (состояние соединения больше не будет 'requested')
Время выдачи Letters of Authorization - Connecting Facility Assignment (LOA-CFA) соединения.

Пример:
2018-03-20T17:36:26-04:00
location
строка
всегда
Расположение соединения.

Пример:
EqDC2
owner_account
строка
всегда
Аккаунт, владеющий прямым подключением.

Пример:
123456789012
region
строка
всегда
Регион, в котором существует соединение.

Пример:
us-east-1


Авторы

  • Sloane Hertel (@s-hertel)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API