Spec-Zone.ru › Ansible 2.10

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-вызовов «ресурс:действие», выполненных во время задачи, выводите набор в ключ task results с именем resource_actions. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время плейбука. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
delete_with_disassociation
логический тип
    Варианты:
  • нет ←
  • да
Используется с state=absent для удаления подключений после их отсоединения от группы агрегирования каналов.
ec2_url
строка
Адрес для подключения к EC2 или Eucalyptus cloud (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая есть.

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

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

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

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

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

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

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


Авторы

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

Spec-Zone.ru

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