Spec-Zone.ru › Ansible 2.10

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 Bundle считывается со стороны модуля и, возможно, требует явного копирования с контроллера, если выполнение не происходит локально.
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
bandwidth
строка
    Варианты:
  • 1 Гбит/с
  • 10 Гбит/с
Пропускная способность соединения Direct Connect.
Требуется при state=present.
connection_id
строка
Идентификатор соединения Direct Connect.
Изменение атрибутов соединения с параметром forced_update приведет к новому идентификатору соединения Direct Connect.
Должен быть задан либо connection_id, либо name.
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Использование логгера botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводит набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
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. Если не задан, используется значение переменной окружения 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
complex
state=present
Атрибуты подключения direct connect.
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
когда LOA-CFA выпущен (состояние подключения больше не 'requested')
Время выдачи Letter of Authorization - Connecting Facility Assignment для подключения.

Пример:
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–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_connection_module.html

Spec-Zone.ru

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