Spec-Zone.ru › Ansible

amazon.aws.ec2_vpc_subnet_info модуль — Сбор информации о подсетях EC2 VPC в AWS

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_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 или EC2_ACCESS_KEY в порядке убывания предпочтения.

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

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

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

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 логгер для анализа уникальных (а не общих) "resource:action" вызовов API во время задачи, выводите набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, созданный во время выполнения книги.

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

Варианты:

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

endpoint_url

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

строка

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

Также могут использоваться переменные среды AWS_URL или EC2_URL в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

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 и security_token.

region

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

строка

Используемый регион AWS.

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

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

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

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания предпочтения.

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

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

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания предпочтения.

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

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

subnet_ids

aliases: subnet_id

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

Список идентификаторов подсетей для сбора информации.

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

validate_certs

логическое

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

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

Возможные значения:

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

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста Ansible ‘хост’, а не ‘контроллер’. Поэтому, файлы может потребоваться скопировать на ‘хост’. Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста Ansible ‘контроллер’, а не ‘хост’.
  • AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

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

Возвращено: success

assign_ipv6_address_on_creation

boolean

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

Возвращено: always

Пример: false

availability_zone

string

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

Возвращено: always

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

availability_zone_id

string

ID зоны доступности подсети.

Возвращено: always

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

available_ip_address_count

string

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

Возвращено: always

Пример: "251"

cidr_block

string

IPv4 CIDR подсети.

Возвращено: always

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

default_for_az

boolean

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

Возвращено: always

Пример: false

enable_dns64

boolean

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

Возвращено: success

Пример: false

id

string

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

Возвращено: always

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

ipv6_association_id

string

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

Возвращено: always

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

ipv6_cidr_block

string

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

Возвращено: always

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

ipv6_cidr_block_association_set

complex

Массив информации о наборе ассоциаций IPv6 cidr block.

Возвращено: always

association_id

string

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

Возвращено: always

ipv6_cidr_block

string

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

Возвращено: always

ipv6_cidr_block_state

dictionary

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

Возвращено: always

state

string

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

Возвращено: always

ipv6_native

boolean

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

Возвращено: success

Пример: false

map_customer_owned_ip_on_launch

boolean

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

Возвращено: success

Пример: "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/ec2_vpc_subnet_info_module.html

Spec-Zone.ru

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