Модуль community.aws.directconnect_link_aggregation_group — Управление группами агрегирования каналов Direct Connect
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
bandwidth string | Пропускная способность группы агрегации каналов. |
connection_id string | Идентификатор соединения для связи с группой агрегации каналов при создании. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
delete_with_disassociation boolean | Для использования с state=absent для удаления соединений после их отключения от LAG. Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только на AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
force_delete boolean | Это позволяет установить минимальное количество каналов в 0, отключить любые размещенные соединения и удалить любые виртуальные интерфейсы, связанные с LAG. Варианты:
|
link_aggregation_group_id string | Идентификатор группы агрегации каналов Direct Connect. |
location string | Местоположение группы агрегации каналов. |
min_links integer | Минимальное количество физических соединений, которые должны быть работоспособными, чтобы сам LAG был работоспособен. |
name string | Название группы агрегации каналов Direct Connect. |
num_connections integer | Количество соединений, с помощью которых инициализировать группу агрегации каналов. |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные среды Дополнительную информацию см. в документации Amazon AWS по адресу http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. Дополнительную информацию о маркерах доступа см. в документации AWS по адресу https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию о маркерах доступа см. в документации AWS по адресу https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
state string / required | Состояние группы агрегирования каналов Direct Connect. Варианты:
|
validate_certs boolean | При установке в Устанавливать validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
wait boolean | Ожидать завершения операции. Может быть полезно при ожидании удаления виртуальных интерфейсов. Время ожидания можно контролировать, установив wait_timeout. Варианты:
|
wait_timeout integer | Длительность ожидания в секундах, если wait=true. По умолчанию: |
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». В связи с этим, файлы, возможно, потребуются скопировать явно на «хост». Для плагинов поиска и соединения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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 Пример: |
changed строка | Изменилась ли группа LAG. Возвращается: всегда |
connections список / элементы=строка | Список подключений, объединённых в эту группу LAG. Возвращается: при state=present Пример: |
connections_bandwidth строка | Пропускная способность отдельных физических подключений, объединённых в группу LAG. Возвращается: при state=present Пример: |
lag_id строка | Уникальный идентификатор группы агрегирования каналов. Возвращается: при state=present Пример: |
lag_name строка | Имя группы агрегирования каналов, заданное пользователем. Возвращается: при state=present |
lag_state строка | Состояние группы LAG. Возвращается: при state=present Пример: |
location строка | Местоположение подключения. Возвращается: при state=present Пример: |
minimum_links целое число | Минимальное количество физических подключений, которые должны быть активны для работоспособности самой группы LAG. Возвращается: при state=present |
number_of_connections целое число | Количество физических подключений, объединённых в группу LAG. Возвращается: при state=present |
owner_account строка | Идентификатор учётной записи владельца группы LAG. Возвращается: при state=present |
region строка | Регион, в котором существует группа LAG. Возвращается: при state=present |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/directconnect_link_aggregation_group_module.html