Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_vpc_subnet_info — сбор сведений о подсетях EC2 VPC в AWS

Примечание

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

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

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

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

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

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

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

  • Собирает сведения о подсетях EC2 VPC в 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.

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.

debug_botocore_endpoint_logs

логическое значение

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

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

Варианты:

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

endpoint_url

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

строка

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

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

filters

словарь

Словарь фильтров, которые нужно применить. Каждый элемент словаря состоит из ключа фильтра и его значения. Возможные фильтры см. в документации: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html.

По умолчанию: {}

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.

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 являются взаимоисключающими.

subnet_ids

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

список / элементы=строка

Список идентификаторов подсетей, сведения о которых нужно собрать.

По умолчанию: []

validate_certs

логическое значение

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

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

Варианты:

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

Примечания

Примечание

  • Внимание: В модулях переменные среды и файлы конфигурации считываются в контексте «узла» 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.

# Gather information about all VPC subnets
- amazon.aws.ec2_vpc_subnet_info:

# Gather information about a particular VPC subnet using ID
- amazon.aws.ec2_vpc_subnet_info:
    subnet_ids: subnet-00112233

# Gather information about any VPC subnet with a tag key Name and value Example
- amazon.aws.ec2_vpc_subnet_info:
    filters:
      "tag:Name": Example

# Gather information about any VPC subnet within VPC with ID vpc-abcdef00
- amazon.aws.ec2_vpc_subnet_info:
    filters:
      vpc-id: vpc-abcdef00

# Gather information about a set of VPC subnets, publicA, publicB and publicC within a
# VPC with ID vpc-abcdef00 and then use the jinja map function to return the
# subnet_ids as a list.

- amazon.aws.ec2_vpc_subnet_info:
    filters:
      vpc-id: vpc-abcdef00
      "tag:Name": "{{ item }}"
  loop:
    - publicA
    - publicB
    - publicC
  register: subnet_info

- set_fact:
    subnet_ids: "{{ subnet_info.results | sum(attribute='subnets', start=[]) | map(attribute='subnet_id') }}"

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

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

Ключ

Описание

subnets

complex

Возвращает массив сложных объектов, описанных ниже.

Возвращается: при успешном выполнении

assign_ipv6_address_on_creation

boolean

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

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

Пример: false

availability_zone

string

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

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

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

availability_zone_id

string

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

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

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

available_ip_address_count

string

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

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

Пример: "251"

cidr_block

string

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

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

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

default_for_az

boolean

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

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

Пример: false

enable_dns64

boolean

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

Возвращается: при успешном выполнении

Пример: false

id

string

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

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

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

ipv6_association_id

string

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

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

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

ipv6_cidr_block

string

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

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

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

ipv6_cidr_block_association_set

complex

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

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

association_id

string

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

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

ipv6_cidr_block

string

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

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

ipv6_cidr_block_state

dictionary

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

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

state

string

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

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

ipv6_native

boolean

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

Возвращается: при успешном выполнении

Пример: false

map_customer_owned_ip_on_launch

boolean

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

Возвращается: при успешном выполнении

Пример: "flase"

map_public_ip_on_launch

boolean

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

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

Пример: false

owner_id

string

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

Возвращается: при успешном выполнении

Пример: "12344567"

private_dns_name_options_on_launch

dictionary

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

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

Возвращается: при успешном выполнении

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

state

string

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

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

Пример: "available"

subnet_arn

string

Имя ресурса Amazon Resource Name (ARN) подсети.

Возвращается: при успешном выполнении

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

subnet_id

string

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

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

tags

dictionary

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

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

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

vpc_id

string

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

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

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

Авторы

  • Rob White (@wimnat)

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

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

© 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_info_module.html

Spec-Zone.ru

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