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 | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| bgp_asn | По умолчанию: 65000 | Номер автономной системы (AS) для конфигурации Border Gateway Protocol (BGP). |
| cidr | Список CIDR-блоков префиксов маршрутов для создания публичного виртуального интерфейса. | |
| customer_address | CIDR-блок адреса клиента для создания виртуального интерфейса. | |
| ec2_url | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | |
| id_to_associate | Идентификатор группы агрегации каналов или подключения для ассоциации с виртуальным интерфейсом. псевдонимы: link_aggregation_group_id, connection_id | |
| name | Имя виртуального интерфейса. | |
| profile (добавлено в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| public bool |
| Тип виртуального интерфейса. |
| 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) | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state |
| Желаемое состояние виртуального интерфейса Direct Connect. |
| validate_certs bool (добавлено в 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, сконфигурированных на этом виртуальном интерфейсе. | |
| 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 строка | всегда | Информация для генерации конфигурации маршрутизатора клиента. | |
| 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 | |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как общественный, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Sloane Hertel (@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.6/modules/aws_direct_connect_virtual_interface_module.html