Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_vpc_subnet — управление подсетями в виртуальных частных облаках AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_vpc_subnet.

Добавлено в amazon.aws 1.0.0

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

Краткое описание

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Описание

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа AWS.

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY (в порядке убывания приоритета).

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

assign_instances_ipv6

логический

Следует ли автоматически назначать IPv6-адрес экземплярам, запущенным в подсети.

Если задано значение assign_instances_ipv6=true, также необходимо указать ipv6_cidr.

Варианты:

  • false ← (по умолчанию)
  • true

aws_ca_bundle

путь

Путь к набору сертификатов CA, используемому для проверки SSL-сертификатов.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

az

строка

Зона доступности для подсети.

Обязательный параметр, если задан outpost_arn.

cidr

строка / обязательный

Блок CIDR для подсети. Например, 192.0.2.0/24.

debug_botocore_endpoint_logs

логический

Использовать регистратор botocore.endpoint для анализа уникальных (а не всех) вызовов API "resource:action", выполненных во время задачи, и сохранять их список в ключе resource_actions результатов задачи. Используйте обработчик обратного вызова aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

ipv6_cidr

строка

Блок IPv6 CIDR для подсети.

Для VPC должен быть назначен блок /56, а это значение должно быть допустимым блоком IPv6 /64, входящим в диапазон VPC.

Обязательный параметр, если assign_instances_ipv6=true

По умолчанию: ""

map_public

логический

Следует ли по умолчанию назначать публичный IP-адрес экземплярам, запущенным в подсети.

Варианты:

  • false ← (по умолчанию)
  • true

outpost_arn

строка

Имя ресурса Amazon (ARN) Outpost.

Если задано, позволяет создавать подсеть в Outpost.

Если задано outpost_arn, также необходимо указать az.

По умолчанию: ""

profile

псевдонимы: aws_profile

строка

Именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.

purge_tags

логический

Если задано значение purge_tags=true и задан параметр tags, существующие теги будут удалены из ресурса, чтобы его теги в точности соответствовали указанным в параметре tags.

Если параметр tags не задан, теги не будут изменены, даже если задано purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра purge_tags. Дополнительную информацию см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

  • false
  • true ← (по умолчанию)

region

псевдонимы: aws_region

строка

Регион AWS.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY (в порядке убывания приоритета).

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

session_token

псевдонимы: aws_session_token

строка

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную окружения AWS_SESSION_TOKEN.

Параметры session_token и profile взаимоисключающие.

state

строка

Создать или удалить подсеть.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

псевдонимы: resource_tags

словарь

Словарь с тегами, которые следует применить к ресурсу.

Если параметр tags не задан, теги не будут изменены.

validate_certs

логический

Если задано значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; рассмотрите возможность указать вместо этого aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

vpc_id

строка / обязательный

-”Идентификатор VPC, в которой нужно создать или удалить подсеть.

wait

логический

Ожидать ли завершения изменений.

Варианты:

  • false
  • true ← (по умолчанию)

wait_timeout

целое число

Количество секунд ожидания завершения изменений

Игнорируется, если не задано wait=true.

По умолчанию: 300

Примечания

Примечание

  • Внимание: В случае модулей переменные окружения и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create subnet for database servers
  amazon.aws.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
  amazon.aws.ec2_vpc_subnet:
    state: absent
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28

- name: Create subnet with IPv6 block assigned
  amazon.aws.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
  amazon.aws.ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: ''

Возвращаемые значения

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

Ключ

Описание

subnet

complex

Словарь со значениями подсети.

Возвращается: state=present

assign_ipv6_address_on_creation

boolean

Назначается ли IPv6-адрес новым экземплярам автоматически.

Возвращается: state=present

Пример: false

availability_zone

string

Зона доступности подсети.

Возвращается: state=present

Пример: "us-east-1a"

availability_zone_id

string

Идентификатор AZ подсети.

Возвращается: state=present

Пример: "use1-az6"

available_ip_address_count

string

Количество доступных IPv4-адресов.

Возвращается: state=present

Пример: "251"

cidr_block

string

Блок IPv4 CIDR подсети.

Возвращается: state=present

Пример: "10.0.0.0/16"

default_for_az

boolean

Указывает, является ли эта подсеть подсетью по умолчанию для данной зоны доступности.

Возвращается: state=present

Пример: false

enable_dns64

boolean

Указывает, должны ли DNS-запросы возвращать синтетические IPv6-адреса для узлов, поддерживающих только IPv4.

Возвращается: success

Пример: false

id

string

Идентификатор ресурса подсети.

Возвращается: state=present

Пример: "subnet-b883b2c4"

ipv6_association_id

string

Идентификатор ассоциации IPv6 для текущего связанного блока CIDR.

Возвращается: state=present

Пример: "subnet-cidr-assoc-b85c74d2"

ipv6_cidr_block

string

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

Возвращается: state=present

Пример: "2001:db8:0:102::/64"

ipv6_cidr_block_association_set

complex

Массив сведений об ассоциациях блоков IPv6 CIDR.

Возвращается: state=present

association_id

string

Идентификатор ассоциации.

Возвращается: всегда

ipv6_cidr_block

string

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

Возвращается: всегда

ipv6_cidr_block_state

dictionary

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

Возвращается: всегда

state

string

Состояние ассоциации блока CIDR.

Возвращается: всегда

ipv6_native

boolean

Указывает, является ли эта подсеть подсетью только IPv6.

Возвращается: success

Пример: false

map_customer_owned_ip_on_launch

boolean

Указывает, получает ли сетевой интерфейс IPv4-адрес, принадлежащий клиенту.

Возвращается: success

Пример: "flase"

map_public_ip_on_launch

boolean

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

Возвращается: state=present

Пример: false

owner_id

string

Идентификатор учетной записи Amazon Web Services, которой принадлежит подсеть.

Возвращается: success

Пример: "12344567"

private_dns_name_options_on_launch

dictionary

Тип имен хостов, назначаемых экземплярам в подсети при запуске.

Имя хоста экземпляра формируется на основе его IPv4-адреса или идентификатора.

Возвращается: success

Пример: {"enable_resource_name_dns_a_record": false, "enable_resource_name_dns_aaaa_record": false, "hostname_type": "ip-name"}

state

string

Состояние подсети.

Возвращается: state=present

Пример: "available"

subnet_arn

string

Amazon Resource Name (ARN) подсети.

Возвращается: success

Пример: "arn:aws:ec2:us-east-1:xxx:subnet/subnet-xxx"

tags

dictionary

Теги, назначенные подсети, включая имя.

Возвращается: state=present

Пример: {"Name": "My Subnet", "env": "staging"}

vpc_id

string

Идентификатор VPC, в которой находится эта подсеть.

Возвращается: state=present

Пример: "vpc-67236184"

Авторы

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

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_vpc_subnet_module.html

Spec-Zone.ru

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