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

Примечание

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

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

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

Новое в версии 1.0.0: от community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Создание, удаление или изменение публичного или частного виртуального интерфейса Direct Connect.

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address_type строка		Тип IP-адреса для BGP-пира.
amazon_address строка		CIDR-диапазон amazon-адреса для создания виртуального интерфейса.
authentication_key строка		Ключ аутентификации для конфигурации BGP.
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
bgp_asn целое число	По умолчанию: 65000	Номер автономной системы (AS) для конфигурации Border Gateway Protocol (BGP).
cidr список / элементы=строка		Список префиксов CIDR фильтра маршрутов для создания публичного виртуального интерфейса.
customer_address строка		CIDR-диапазон адреса клиента для создания виртуального интерфейса.
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Используйте регистратор botocore.endpoint для разбора уникальных (а не общих) API-вызовов "resource:action" во время выполнения задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время плейбука. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
direct_connect_gateway_id строка		ID шлюза Direct Connect для создания частного виртуального интерфейса. Для создания частного виртуального интерфейса требуется virtual_gateway_id или direct_connect_gateway_id. Эти параметры взаимоисключающие.
ec2_url строка		URL для подключения к EC2 или Eucalyptus-облаку (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
id_to_associate строка / обязательно		ID группы агрегации каналов или соединения для ассоциации с виртуальным интерфейсом. псевдонимы: link_aggregation_group_id, connection_id
name строка		Имя виртуального интерфейса.
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
public логический	Варианты: нет да	Тип виртуального интерфейса.
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.
virtual_gateway_id строка		ID виртуального шлюза, необходимый для создания частного виртуального интерфейса. Для создания частного виртуального интерфейса требуется virtual_gateway_id или direct_connect_gateway_id. Эти параметры взаимоисключающие.
virtual_interface_id строка		ID виртуального интерфейса.
vlan целое число	По умолчанию: 100	ID VLAN.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Примеры

---
- name: create an association between a LAG and connection
  community.aws.aws_direct_connect_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.aws_direct_connect_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-пира (проверка, ожидание, доступно). Пример: доступно
	bgp_status строка	всегда	Состояние подключения BGP-пира (включен/выключен). Пример: включен
	customer_address строка	всегда	IP-адрес, назначенный интерфейсу клиента. Пример: 169.254.255.2/30
changed булево		всегда	Указывает, был ли виртуальный интерфейс создан/изменён/удален.
connection_id строка		всегда	Идентификатор подключения. Это поле также используется как тип идентификатора для операций, использующих несколько типов подключений (LAG, подключение, и/или соединение). Пример: dxcon-fgb175av
customer_address строка		всегда	IP-адрес, назначенный интерфейсу клиента. Пример: 169.254.255.2/30
customer_router_config строка		всегда	Информация для генерации конфигурации маршрутизатора клиента.
direct_connect_gateway_id строка		при public=False	Идентификатор шлюза Direct Connect. Это применимо только к частным виртуальным интерфейсам. Пример: f7593767-eded-44e8-926d-a2234175835d
location строка		всегда	Расположение подключения. Пример: EqDC2
owner_account строка		всегда	AWS-аккаунт, который будет владельцем нового виртуального интерфейса. Пример: 123456789012
route_filter_prefixes сложный тип		всегда	Список маршрутов, которые будут рекламироваться сети AWS в этом регионе (публичный виртуальный интерфейс).
	cidr строка	всегда	Маршрут, который будет рекламироваться сети AWS в этом регионе. Пример: 54.227.92.216/30
virtual_gateway_id строка		при public=False	Идентификатор виртуального частного шлюза для VPC. Это применимо только к частным виртуальным интерфейсам. Пример: vgw-f3ce259a
virtual_interface_id строка		всегда	Идентификатор виртуального интерфейса. Пример: dxvif-fh0w7cex
virtual_interface_name строка		всегда	Имя виртуального интерфейса, назначенное клиентом. Пример: test_virtual_interface
virtual_interface_state строка		всегда	Состояние виртуального интерфейса (подтверждение, проверка, ожидание, доступно, выключено, отклонено). Пример: доступно
virtual_interface_type строка		всегда	Тип виртуального интерфейса (частный, публичный). Пример: частный
vlan целое число		всегда	Идентификатор VLAN. Пример: 100

Авторы

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