Spec-Zone.ru › Ansible

Модуль community.aws.directconnect_virtual_interface — Управление виртуальными интерфейсами Direct Connect

Примечание

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

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

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

Для использования в playbook укажите: community.aws.directconnect_virtual_interface.

Новинка в community.aws 1.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

  • Создание, удаление или изменение виртуального интерфейса Direct Connect (публичного или частного).
  • До версии 5.0.0 этот модуль назывался community.aws.aws_direct_connect_virtual_interface. Способ использования не изменился.

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

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

address_type

string

Тип IP-адреса для BGP-пира.

amazon_address

string

CIDR-адрес Amazon, с помощью которого будет создан виртуальный интерфейс.

authentication_key

string

Ключ аутентификации для конфигурации BGP.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

bgp_asn

integer

Номер автономной системы (AS) для конфигурации протокола Border Gateway Protocol (BGP).

Значение по умолчанию: 65000

cidr

list / elements=string

Список префиксов маршрутных фильтров CIDR, с помощью которых будет создан публичный виртуальный интерфейс.

customer_address

string

CIDR-адрес клиента, с помощью которого будет создан виртуальный интерфейс.

debug_botocore_endpoint_logs

boolean

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

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

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

direct_connect_gateway_id

string

Идентификатор шлюза Direct Connect для создания частного виртуального интерфейса.

Для создания частного виртуального интерфейса требуется virtual_gateway_id или direct_connect_gateway_id. Эти параметры являются взаимоисключающими.

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

id_to_associate

aliases: link_aggregation_group_id, connection_id

string / required

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

name

string

Имя виртуального интерфейса.

profile

aliases: aws_profile

string

Именованный профиль AWS для использования при аутентификации.

См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Переменная среды AWS_PROFILE также может использоваться.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.

public

boolean

Тип виртуального интерфейса.

Варианты:

  • false
  • true

region

aliases: aws_region, ec2_region

string

AWS регион для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут использоваться переменные окружения AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS по адресу http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в выпуске после 2024-12-01

Поддержка переменной окружения EC2_REGION устарела и будет удалена в выпуске после 2024-12-01.

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.

Также могут использоваться переменные окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в выпуске после 2024-12-01.

Поддержка переменной окружения 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.

Также могут использоваться переменные окружения AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных окружения EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в выпуске после 2024-12-01.

state

string / обязательный

Желаемое состояние виртуального интерфейса Direct Connect.

Выбоp:

  • "present"
  • "absent"

validate_certs

boolean

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

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

Выбоp:

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

virtual_gateway_id

string

Идентификатор виртуального шлюза, необходимый для создания частного виртуального интерфейса.

Для создания частного виртуального интерфейса требуется virtual_gateway_id или direct_connect_gateway_id. Эти параметры взаимоисключающие.

virtual_interface_id

string

Идентификатор виртуального интерфейса.

vlan

целое число

Идентификатор VLAN.

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

Примечания

Примечание

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

Примеры

---
- name: create an association between a LAG and connection
  community.aws.directconnect_virtual_interface:
    state: present
    name: "{{ name }}"
    link_aggregation_group_id: LAG-XXXXXXXX
    connection_id: dxcon-XXXXXXXX

- name: remove an association between a connection and virtual interface
  community.aws.directconnect_virtual_interface:
    state: absent
    connection_id: dxcon-XXXXXXXX
    virtual_interface_id: dxv-XXXXXXXX

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

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

Ключ

Описание

address_family

строка

Семейство адресов для BGP-пира.

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

Пример: "ipv4"

amazon_address

строка

IP-адрес, назначенный интерфейсу Amazon.

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

Пример: "169.254.255.1/30"

asn

целое число

Номер автономной системы (AS) для конфигурации Border Gateway Protocol (BGP).

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

Пример: 65000

auth_key

строка

Ключ аутентификации для конфигурации BGP.

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

Пример: "0xZ59Y1JZ2oDOSh6YriIlyRE"

bgp_peers

сложное

Список BGP-пиров, настроенных на этом виртуальном интерфейсе.

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

address_family

строка

Семейство адресов для BGP-пира.

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

Пример: "ipv4"

amazon_address

строка

IP-адрес, назначенный интерфейсу Amazon.

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

Пример: "169.254.255.1/30"

asn

целое число

Номер автономной системы (AS) для конфигурации Border Gateway Protocol (BGP).

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

Пример: 65000

auth_key

строка

Ключ аутентификации для конфигурации BGP.

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

Пример: "0xZ59Y1JZ2oDOSh6YriIlyRE"

bgp_peer_state

строка

Состояние BGP-пира (проверка, ожидается, доступен)

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

Пример: "available"

bgp_status

строка

Состояние (включен/выключен) BGP-пира.

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

Пример: "up"

customer_address

строка

IP-адрес, назначенный интерфейсу клиента.

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

Пример: "169.254.255.2/30"

changed

логическое

Указание, был ли виртуальный интерфейс создан/изменён/удален

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

Пример: false

connection_id

строка

Идентификатор соединения. Это поле также используется в качестве типа идентификатора для операций, использующих несколько типов соединений (LAG, соединение, и/или соединение).

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

Пример: "dxcon-fgb175av"

customer_address

строка

IP-адрес, назначенный интерфейсу клиента.

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

Пример: "169.254.255.2/30"

customer_router_config

строка

Информация для генерации конфигурации маршрутизатора клиента.

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

direct_connect_gateway_id

строка

Идентификатор шлюза Direct Connect. Применимо только к частным виртуальным интерфейсам.

Возвращается: когда public=False

Пример: "f7593767-eded-44e8-926d-a2234175835d"

location

string

Местоположение подключения.

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

Пример: "EqDC2"

owner_account

string

AWS-аккаунт, который будет владельцем нового виртуального интерфейса.

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

Пример: "123456789012"

route_filter_prefixes

complex

Список маршрутов, которые будут рекламироваться сети AWS в этом регионе (публичный виртуальный интерфейс).

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

cidr

string

Маршруты, которые будут рекламироваться сети AWS в этом регионе.

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

Пример: "54.227.92.216/30"

virtual_gateway_id

string

Идентификатор виртуального шлюза для VPC. Это относится только к частным виртуальным интерфейсам.

Возвращается: при public=False

Пример: "vgw-f3ce259a"

virtual_interface_id

string

Идентификатор виртуального интерфейса.

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

Пример: "dxvif-fh0w7cex"

virtual_interface_name

string

Имя виртуального интерфейса, назначенное клиентом.

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

Пример: "test_virtual_interface"

virtual_interface_state

string

Состояние виртуального интерфейса (подтверждение, проверка, ожидается, доступен, отключен, отклонен).

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

Пример: "available"

virtual_interface_type

string

Тип виртуального интерфейса (частный, публичный).

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

Пример: "private"

vlan

integer

ID VLAN.

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

Пример: 100

Авторы

  • Sloane Hertel (@s-hertel)

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (источники)
  • Связь

© 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_virtual_interface_module.html

Spec-Zone.ru

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