Spec-Zone.ru › Ansible 2.9

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

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

Описание

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

Требования

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

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
assign_instances_ipv6
boolean
добавлен в версии 2.5
    Варианты:
  • no ←
  • yes
Указывает, что экземпляры, запущенные в подсети, должны автоматически получать IPv6-адрес.
aws_access_key
string
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

псевдонимы: ec2_access_key, access_key
aws_secret_key
string
Секретный ключ 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
    Варианты:
  • no ←
  • yes
Используйте logger botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action», сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения playbook. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
string
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
    Варианты:
  • no ←
  • yes
Указывает, что экземпляры, запущенные в подсети, должны по умолчанию получать общедоступный IP-адрес.
profile
string
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_tags
boolean
добавлен в версии 2.5
    Варианты:
  • no
  • yes ←
Удалить теги, которые отсутствуют в списке tags.
region
string
AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_token
string
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

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

псевдонимы: resource_tags
validate_certs
boolean
    Варианты:
  • no
  • yes ←
При значении «no» сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpc_id
- / обязательно
ID VPC, в котором должна быть создана или удалена подсеть.
wait
boolean
добавлен в версии 2.5
    Варианты:
  • no
  • yes ←
Если задано, модуль 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
    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]

Поддержка Red Hat

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

Авторы

  • 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.9/modules/ec2_vpc_subnet_module.html

Spec-Zone.ru

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