Spec-Zone.ru › Ansible 2.8

ec2_vpc_subnet – Управление подсетями в виртуальных частных облаках AWS

Новая в версии 2.0.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

  • Управление подсетями в виртуальных частных облаках AWS

Требования

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

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
assign_instances_ipv6
boolean
добавлен в 2.5
    Варианты:
  • нет ←
  • да
Указывает yes, что экземпляры, запущенные в подсети, должны автоматически получать IPv6-адрес.
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
az
-
Зона доступности для подсети.
cidr
-
Блок CIDR для подсети. Например, 192.0.2.0/24.
debug_botocore_endpoint_logs
boolean
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", сделанных во время задачи, выводить набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, сделанный во время выполнения книги команд. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть.
ipv6_cidr
-
добавлен в 2.5
Блок IPv6 CIDR для подсети. VPC должен иметь назначенный блок /56, а это значение должно быть допустимым IPv6 /64, который находится в диапазоне VPC.
Требуется, если assign_instances_ipv6=true
map_public
boolean
добавлен в 2.4
    Варианты:
  • нет ←
  • да
Указывает yes, что экземпляры, запущенные в подсети, по умолчанию должны получать общедоступный IP-адрес.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_tags
boolean
добавлен в 2.5
    Варианты:
  • нет
  • да ←
Удалить теги, которые отсутствуют в списке tags.
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.

псевдонимы: access_token
state
-
    Варианты:
  • present ←
  • absent
Создать или удалить подсеть
tags
-
Словарь тегов для применения к подсети. Все теги, которые применены к подсети и отсутствуют здесь, будут удалены.

псевдонимы: resource_tags
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Если установлено "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверены.
vpc_id
- / обязательно
ID VPC, в котором нужно создать или удалить подсеть.
wait
boolean
добавлен в 2.5
    Варианты:
  • нет
  • да ←
Если указано, модуль state=present подождёт, пока подсеть не перейдёт в состояние доступности, прежде чем продолжить.
wait_timeout
-
добавлен в 2.5
По умолчанию:
300
Количество секунд ожидания, пока подсеть не станет доступной wait=True.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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), если учетные данные не предоставлены. См. 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 subnet for database servers
  ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28
    resource_tags:
      Name: Database Subnet
  register: database_subnet

- name: Remove subnet for database servers
  ec2_vpc_subnet:
    state: absent
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28

- name: Create subnet with IPv6 block assigned
  ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: 2001:db8:0:102::/64

- name: Remove IPv6 block assigned to subnet
  ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: ''

Значения возврата

Общие значения возврата описаны в здесь, следующие поля уникальны для данного модуля:

Ключ Возвращаемое значение Описание
subnet
сложный
state=present
Словарь значений подсети

assign_ipv6_address_on_creation
логическое
state=present
указывает, назначается ли IPv6-адрес новым экземплярам автоматически

availability_zone
строка
state=present
Зона доступности подсети

Пример:
us-east-1a
available_ip_address_count
строка
state=present
количество доступных IPv4-адресов

Пример:
251
cidr_block
строка
state=present
IPv4 CIDR подсети

Пример:
10.0.0.0/16
default_for_az
логическое
state=present
указывает, является ли данная подсеть стандартной для этой зоны доступности

id
строка
state=present
Идентификатор ресурса подсети

Пример:
subnet-b883b2c4
ipv6_association_id
строка
state=present
Идентификатор ассоциации IPv6 для текущего связанного CIDR

Пример:
subnet-cidr-assoc-b85c74d2
ipv6_cidr_block
строка
state=present
Активно связанный блок IPv6 CIDR с подсетью

Пример:
2001:db8:0:102::/64
ipv6_cidr_block_association_set
сложный
state=present
Массив данных о наборе ассоциаций блоков IPv6 cidr.

association_id
строка
всегда
Идентификатор ассоциации

ipv6_cidr_block
строка
всегда
Блок IPv6 CIDR, связанный с подсетью.

ipv6_cidr_block_state
словарь
всегда
Хэш/словарь, содержащий единственный элемент. Состояние ассоциации блока cidr.

state
строка
всегда
Состояние ассоциации блока CIDR.

map_public_ip_on_launch
логическое
state=present
Назначается ли публичный IP-адрес новым экземплярам автоматически

state
строка
state=present
Состояние подсети

Пример:
available
tags
словарь
state=present
Теги, присоединенные к подсети, включая имя

Пример:
{'Name': 'Моя подсеть', 'env': 'staging'}
vpc_id
строка
state=present
Идентификатор VPC, в котором существует данная подсеть

Пример:
vpc-67236184


Статус

  • Этот модуль гарантирует отсутствие обратной несовместимости в будущих изменениях интерфейса. [stableinterface]
  • Этот модуль поддерживается командой Ansible Core. [core]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat см. в статье базы знаний Red Hat Red Hat Knowledge Base article.

Авторы

  • Robert Estelle (@erydo)
  • Brad Davidson (@brandond)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_vpc_subnet_module.html

Spec-Zone.ru

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