Spec-Zone.ru › Ansible 2.11

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 читается со стороны модуля и, возможно, требует явного копирования с контроллера, если он не используется локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. 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
булево
    Варианты:
  • нет ←
  • да
Запросить предоставленный Amazon 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 токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01.

псевдонимы: aws_security_token, access_token
state
строка
    Варианты:
  • present ←
  • absent
Состояние VPC. Либо absent, либо present.
tags
словарь
Теги, которые нужно прикрепить к VPC. Независимо от имени, если вы передадите ключ 'Name', он переопределит имя VPC, если оно отличается.

псевдонимы: resource_tags
tenancy
строка
    Варианты:
  • default ←
  • dedicated
Тип аренды (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
список / элементы=строка
успех
ассоциированные IPv4 CIDR-блоки VPC

Пример:
{'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
список / элементы=строка
успех
ассоциированные IPv6 CIDR-блоки VPC

Пример:
{'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

Пример:
доступно
tags
сложный
всегда
метки, прикрепленные к VPC, включая имя

Имя
строка
всегда
имя метки для VPC

Пример:
pk_vpc4


Авторы

  • Jonathan Davila (@defionscode)
  • 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/amazon/aws/ec2_vpc_net_module.html

Spec-Zone.ru

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