amazon.aws.ec2_vpc_net – Настройка виртуальных частных облаков AWS
Примечание
Этот плагин является частью коллекции amazon.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install amazon.aws.
Для использования в книге задач укажите: amazon.aws.ec2_vpc_net.
Новое в версии 1.0.0: из amazon.aws
Обзор
- Создание, изменение и завершение виртуальных частных облаков AWS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 Bundle читается на стороне модуля и может потребоваться явно скопировать его с контроллера, если модуль не выполняется локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Только ключ 'user_agent' используется для модулей boto. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для более подробной конфигурации 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 | |
| cidr_block список / элементы=строка / обязательный | Основной CIDR VPC. После версии 2.5 можно указать список CIDR. Первый в списке будет использоваться в качестве основного CIDR и используется совместно с name, чтобы обеспечить идемпотентность. | |
| debug_botocore_endpoint_logs логический |
| Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, выполненный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| dhcp_opts_id строка | Идентификатор DHCP-опций для использования в этом VPC. | |
| dns_hostnames логический |
| Включить поддержку имен хостов AWS. |
| dns_support логический |
| Включить поддержку DNS AWS. |
| ec2_url строка | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | |
| ipv6_cidr логический |
| Запрос выделенного IPv6-блока CIDR с префиксом /56. Вы не можете указать диапазон IPv6-адресов или размер блока CIDR. |
| multi_ok логический |
| По умолчанию модуль не создаст другой VPC, если уже существует VPC с таким же именем и блоком CIDR. Установите это значение в true, если хотите создать дублируемые VPC. |
| name строка / обязательный | Имя для вашего VPC. Используется в сочетании с cidr_block, чтобы определить, существует ли VPC уже. | |
| 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 | |
| purge_cidrs логический |
| Удалить CIDR, которые связаны с VPC и не указаны в cidr_block. |
| 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 security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| state строка |
| Состояние VPC. Либо absent, либо present. |
| tags словарь | Теги, которые вы хотите прикрепить к VPC. Независимо от имени. Обратите внимание, что если вы передаете ключ 'Name', он переопределит имя VPC, если оно отличается. псевдонимы: resource_tags | |
| tenancy строка |
| Тип аренды — default или dedicated. Не может быть изменён после создания VPC. |
| validate_certs логический |
| При значении "нет" SSL-сертификаты для boto-версий >= 2.6.0 не будут проверятся. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: create a VPC with dedicated tenancy and a couple of tags
amazon.aws.ec2_vpc_net:
name: Module_dev2
cidr_block: 10.10.0.0/16
region: us-east-1
tags:
module: ec2_vpc_net
this: works
tenancy: dedicated
- name: create a VPC with dedicated tenancy and request an IPv6 CIDR
amazon.aws.ec2_vpc_net:
name: Module_dev2
cidr_block: 10.10.0.0/16
ipv6_cidr: True
region: us-east-1
tenancy: dedicated
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| vpc сложный | всегда | информация о созданном или удалённом VPC | ||
| cidr_block строка | всегда | CIDR VPC Пример: 10.0.0.0/16 | ||
| cidr_block_association_set список / элементы=строка | успех | ассоциированные с VPC блоки IPv4 CIDR Пример: {'cidr_block_association_set': [{'association_id': 'vpc-cidr-assoc-97aeeefd', 'cidr_block': '20.0.0.0/24', 'cidr_block_state': {'state': 'associated'}}]} | ||
| classic_link_enabled булево | всегда | указывается, включён ли ClassicLink | ||
| dhcp_options_id строка | всегда | идентификатор DHCP-опций, связанных с этим VPC Пример: dopt-0fb8bd6b | ||
| id строка | всегда | идентификатор ресурса VPC Пример: vpc-c2e00da5 | ||
| instance_tenancy строка | всегда | указывается, использует ли VPC стандартную или выделенную аренду Пример: default | ||
| ipv6_cidr_block_association_set список / элементы=строка | успех | ассоциированные с VPC блоки IPv6 CIDR Пример: {'ipv6_cidr_block_association_set': [{'association_id': 'vpc-cidr-assoc-97aeeefd', 'ipv6_cidr_block': '2001:db8::/56', 'ipv6_cidr_block_state': {'state': 'associated'}}]} | ||
| is_default булево | всегда | указывается, является ли это значение VPC по умолчанию | ||
| state строка | всегда | состояние VPC Пример: available | ||
| tags сложный | всегда | теги, прикреплённые к VPC, включая имя | ||
| Name строка | всегда | имя тега для VPC Пример: pk_vpc4 | ||
Авторы
- Jonathan Davila (@defionscode)
- 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.10/collections/amazon/aws/ec2_vpc_net_module.html