Spec-Zone.ru › Ansible

Модуль community.aws.directconnect_link_aggregation_group — управление пакетами LAG Direct Connect

Примечание

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

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

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

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

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

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

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

  • Создание, удаление или изменение группы агрегации каналов Direct Connect.
  • До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_direct_connect_link_aggregation_group. Использование не изменилось.

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

Требования

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

  • 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 SDK botocore.

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.

bandwidth

строка

Пропускная способность группы агрегации каналов.

connection_id

строка

Идентификатор подключения, которое связывается с группой агрегации каналов при её создании.

debug_botocore_endpoint_logs

логическое значение

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего числа) вызовов API "resource:action", выполняемых во время задачи, и выводить их список в ключ resource_actions в результатах задачи. Используйте обработчик обратного вызова aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

delete_with_disassociation

логическое значение

Используется с state=absent, чтобы удалить подключения после отсоединения их от LAG.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

force_delete

логическое значение

Этот параметр позволяет установить минимальное число каналов равным 0, отсоединить все размещённые подключения и удалить все виртуальные интерфейсы, связанные с LAG.

Варианты:

  • false ← (по умолчанию)
  • true

link_aggregation_group_id

строка

Идентификатор группы агрегации каналов Direct Connect.

location

строка

Расположение группы агрегации каналов.

min_links

целое число

Минимальное количество физических подключений, которые должны быть работоспособны, чтобы сама LAG считалась работоспособной.

name

строка

Имя группы агрегации каналов Direct Connect.

num_connections

целое число

Количество подключений, создаваемых при инициализации группы агрегации каналов.

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.

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 SDK botocore.

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

строка / обязательный

Состояние группы агрегации каналов Direct Connect.

Варианты:

  • "present"
  • "absent"

validate_certs

логическое значение

Если задано значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

wait

логическое значение

Ожидать ли завершения операции.

Может быть полезно при ожидании удаления виртуальных интерфейсов.

Время ожидания можно задать с помощью параметра wait_timeout.

Варианты:

  • false ← (по умолчанию)
  • true

wait_timeout

целое число

Время ожидания в секундах, если wait=true.

По умолчанию: 120

Примечания

Примечание

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

Примеры

# create a Direct Connect connection
- community.aws.directconnect_link_aggregation_group:
  state: present
  location: EqDC2
  lag_id: dxlag-xxxxxxxx
  bandwidth: 1Gbps

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

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

Ключ

Описание

aws_device

строка

Конечная точка AWS Direct Connect, на которой размещена LAG.

Возвращается: если state=present

Пример: "EqSe2-1bwfvazist2k0"

changed

строка

Изменилась ли LAG.

Возвращается: всегда

connections

список / элементы=строка

Список подключений, объединённых этой LAG.

Возвращается: если state=present

Пример: {"connections": [{"aws_device": "EqSe2-1bwfvazist2k0", "bandwidth": "1Gbps", "connection_id": "dxcon-fgzjah5a", "connection_name": "Requested Connection 1 for Lag dxlag-fgtoh97h", "connection_state": "down", "lag_id": "dxlag-fgnsp4rq", "location": "EqSe2", "owner_account": "123456789012", "region": "us-west-2"}]}

connections_bandwidth

строка

Пропускная способность отдельных физических подключений, объединённых в LAG.

Возвращается: если state=present

Пример: "1Gbps"

lag_id

строка

Уникальный идентификатор группы агрегации каналов.

Возвращается: если state=present

Пример: "dxlag-fgnsp4rq"

lag_name

строка

Имя группы агрегации каналов, заданное пользователем.

Возвращается: если state=present

lag_state

строка

Состояние LAG.

Возвращается: если state=present

Пример: "pending"

location

строка

Расположение подключения.

Возвращается: если state=present

Пример: "EqSe2"

minimum_links

целое число

Минимальное количество физических подключений, которые должны быть работоспособны, чтобы сама LAG считалась работоспособной.

Возвращается: если state=present

number_of_connections

целое число

Количество физических подключений, объединённых в LAG.

Возвращается: если state=present

owner_account

строка

Идентификатор учётной записи владельца LAG.

Возвращается: если state=present

region

строка

Регион, в котором находится LAG.

Возвращается: если state=present

Авторы

  • 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_link_aggregation_group_module.html

Spec-Zone.ru

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