Spec-Zone.ru › Ansible 2.11

community.aws.aws_direct_connect_link_aggregation_group – Управление группами агрегирования каналов Direct Connect

Примечание

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

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

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

Новый в версии 1.0.0: of community.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.
Для модулей boto используется только ключ 'user_agent'. Подробнее о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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
строка
Пропускная способность группы агрегирования каналов.
connection_id
строка
Идентификатор подключения для связи с группой агрегирования каналов при создании.
debug_botocore_endpoint_logs
логический тип
    Варианты:
  • нет ←
  • да
Используйте журналирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время книги задач. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
delete_with_disassociation
логический тип
    Варианты:
  • нет ←
  • да
Используется с state=absent для удаления подключений после их отсоединения от LAG.
ec2_url
строка
URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если она задана.

псевдонимы: aws_endpoint_url, endpoint_url
force_delete
логический тип
    Варианты:
  • нет ←
  • да
Это позволяет установить минимальное количество ссылок на 0, отключить все размещённые подключения и удалить все виртуальные интерфейсы, связанные с LAG.
link_aggregation_group_id
строка
Идентификатор группы агрегирования каналов Direct Connect.
location
строка
Расположение группы агрегирования каналов.
min_links
целое число
Минимальное количество физических подключений, которые должны быть активными для работоспособности самой LAG.
name
строка
Имя группы агрегирования каналов Direct Connect.
num_connections
целое число
Количество подключений, с помощью которых следует инициализировать группу агрегирования каналов.
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.
wait
логический тип
    Варианты:
  • нет ←
  • да
Ожидать ли завершения операции.
Может быть полезно при ожидании удаления виртуальных интерфейсов.
Время ожидания можно контролировать, установив wait_timeout.
wait_timeout
целое число
По умолчанию:
120
Время ожидания в секундах, если wait=true.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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_link_aggregation_group:
  state: present
  location: EqDC2
  lag_id: dxlag-xxxxxxxx
  bandwidth: 1Gbps

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

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

Ключ Возвращаемое значение Описание
aws_device
строка
при state=present
Конечная точка AWS Direct Connection, на которой размещается LAG.

Пример:
EqSe2-1bwfvazist2k0
changed
строка
всегда
Изменился ли LAG.
connections
список / элементы=строка
при state=present
Список соединений, объединённых в этот LAG.

Пример:
{'connections': [{'aws_device': 'EqSe2-1bwfvazist2k0', 'bandwidth': '1Gbps', 'connection_id': 'dxcon-fgzjah5a', 'connection_name': 'Запрошенное соединение 1 для Lag dxlag-fgtoh97h', 'connection_state': 'выключено', 'lag_id': 'dxlag-fgnsp4rq', 'location': 'EqSe2', 'owner_account': '448830907657', 'region': 'us-west-2'}]}
connections_bandwidth
строка
при state=present
Пропускная способность отдельных физических соединений, объединённых в LAG.

Пример:
1Gbps
lag_id
строка
при state=present
Уникальный идентификатор группы агрегирования каналов.

Пример:
dxlag-fgnsp4rq
lag_name
строка
при state=present
Имя, заданное пользователем для группы агрегирования каналов.
lag_state
строка
при state=present
Состояние LAG.

Пример:
ожидание
location
строка
при state=present
Местоположение соединения.

Пример:
EqSe2
minimum_links
целое число
при state=present
Минимальное количество физических соединений, которые должны быть активными для функционирования самого LAG.
number_of_connections
целое число
при state=present
Количество физических соединений, объединённых в LAG.
owner_account
строка
при state=present
Идентификатор учётной записи владельца LAG.
region
строка
при state=present
Регион, в котором существует LAG.


Авторы

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

Spec-Zone.ru

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