Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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.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.

address_type

строка

Тип IP-адреса для однорангового узла BGP.

amazon_address

строка

Диапазон CIDR адреса Amazon для создания виртуального интерфейса.

authentication_key

строка

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

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.

bgp_asn

целое число

Номер автономной системы (AS) для настройки протокола граничного шлюза (BGP).

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

cidr

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

Список префиксов CIDR фильтра маршрутов для создания общедоступного виртуального интерфейса.

customer_address

строка

Диапазон CIDR адреса клиента для создания виртуального интерфейса.

debug_botocore_endpoint_logs

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

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

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

Варианты:

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

direct_connect_gateway_id

строка

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

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

endpoint_url

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

строка

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

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

id_to_associate

псевдонимы: link_aggregation_group_id, connection_id

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

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

name

строка

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

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.

public

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

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

Варианты:

  • false
  • true

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 ← (по умолчанию)

virtual_gateway_id

строка

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

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

virtual_interface_id

строка

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

vlan

целое число

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

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для подключаемых модулей поиска и подключения переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» 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

string

Семейство адресов для узла BGP.

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

Пример: "ipv4"

amazon_address

string

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

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

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

asn

integer

Номер автономной системы (AS) для настройки протокола граничного шлюза (BGP).

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

Пример: 65000

auth_key

string

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

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

Пример: "0xZ59Y1JZ2oDOSh6YriIlyRE"

bgp_peers

complex

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

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

address_family

string

Семейство адресов для узла BGP.

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

Пример: "ipv4"

amazon_address

string

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

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

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

asn

integer

Номер автономной системы (AS) для настройки протокола граничного шлюза (BGP).

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

Пример: 65000

auth_key

string

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

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

Пример: "0xZ59Y1JZ2oDOSh6YriIlyRE"

bgp_peer_state

string

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

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

Пример: "available"

bgp_status

string

Состояние узла BGP (активен/неактивен).

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

Пример: "up"

customer_address

string

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

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

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

changed

boolean

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

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

Пример: false

connection_id

string

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

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

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

customer_address

string

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

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

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

customer_router_config

string

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

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

direct_connect_gateway_id

string

Идентификатор шлюза 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

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

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

Пример: 100

Авторы

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

Spec-Zone.ru

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