aws_direct_connect_virtual_interface — Управление виртуальными интерфейсами Direct Connect.
Новое в версии 2.5.
Описание
- Создание, удаление или изменение публичного или частного виртуального интерфейса Direct Connect.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| address_type | Тип IP-адреса для BGP-пира. | |
| amazon_address | CIDR-диапазон Amazon-адресов для создания виртуального интерфейса. | |
| authentication_key | Ключ аутентификации для конфигурации BGP. | |
| aws_access_key | По умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | По умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| bgp_asn | По умолчанию: 65000 | Номер автономной системы (AS) для конфигурации протокола BGP. |
| cidr | Список префиксов CIDR фильтров маршрутов для создания публичного виртуального интерфейса. | |
| customer_address | CIDR-диапазон адресов клиента для создания виртуального интерфейса. | |
| ec2_url | По умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. |
| id_to_associate | Идентификатор группы агрегирования каналов или подключения, которые нужно связать с виртуальным интерфейсом. Псевдонимы: link_aggregation_group_id, connection_id | |
| name | Имя виртуального интерфейса. | |
| profile (добавлено в 1.6) | По умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| 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 (добавлено в 1.6) | По умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| state |
| Желаемое состояние виртуального интерфейса Direct Connect. |
| validate_certs (добавлено в 1.5) |
| При значении "no" сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
| virtual_gateway_id | Идентификатор виртуального шлюза, необходимый для создания частного виртуального интерфейса. | |
| virtual_interface_id | Идентификатор виртуального интерфейса. | |
| vlan | По умолчанию: 100 | Идентификатор VLAN. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует конфигурационный файл boto (обычно ~/.boto), если данные учетных данных не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
---
- name: create an association between a LAG and connection
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
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-пиров, настроенных на этом виртуальном интерфейсе. | |
| customer_address строка | всегда | IP-адрес, назначенный интерфейсу клиента. Пример: 169.254.255.2/30 | |
| amazon_address строка | всегда | IP-адрес, назначенный интерфейсу Amazon. Пример: 169.254.255.1/30 | |
| address_family строка | всегда | Семейство адресов для BGP-пира. Пример: ipv4 | |
| auth_key строка | всегда | Ключ аутентификации для конфигурации BGP. Пример: 0xZ59Y1JZ2oDOSh6YriIlyRE | |
| bgp_peer_state строка | всегда | Состояние BGP-пира (проверка, ожидание, доступен). Пример: доступен | |
| asn целое число | всегда | Номер автономной системы (AS) для конфигурации Border Gateway Protocol (BGP). Пример: 65000 | |
| bgp_status строка | всегда | Состояние BGP-пира (включен/выключен). Пример: включен | |
| changed логическое значение | всегда | Указано, был ли виртуальный интерфейс создан/изменён/удален | |
| connection_id строка | всегда | Идентификатор подключения. Это поле также используется как тип идентификатора для операций, использующих несколько типов подключений (LAG, соединение, и/или подключение). Пример: dxcon-fgb175av | |
| customer_address строка | всегда | IP-адрес, назначенный интерфейсу клиента. Пример: 169.254.255.2/30 | |
| customer_router_config строка | всегда | Информация для генерации конфигурации маршрутизатора клиента. | |
| 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 | |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Слоун Хертель (@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.5/modules/aws_direct_connect_virtual_interface_module.html