Spec-Zone.ru › Ansible 2.10

amazon.aws.ec2_vpc_net_info – Сбор информации о VPC ec2 в AWS

Примечание

Этот плагин входит в состав коллекции amazon.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install amazon.aws.

Для использования в плейбуке укажите: amazon.aws.ec2_vpc_net_info.

Новое в версии 1.0.0: библиотеки amazon.aws

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

Обзор

  • Сбор информации о VPC ec2 в AWS
  • Этот модуль назывался ec2_vpc_net_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров aws_access_key и profile устарело и будет сделать взаимоисключающими после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла с сертификатами доверенных центров сертификации (CA Bundle), используемых при проверке SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: CA Bundle считывается на стороне модуля и может потребоваться его явное копирование с контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти на https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. Дополнительные параметры конфигурации boto см. на http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров aws_secret_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
логический тип
    Варианты:
  • нет ←
  • да
Используйте логирование botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводимых в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время плейбука. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или Eucalyptus cloud (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.

псевдонимы: aws_endpoint_url, endpoint_url
filters
словарь
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html для возможных фильтров.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка их одновременного указания с profile устарела.
aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
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.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
При значении «нет» SSL-сертификаты не будут проверены для версий boto >= 2.6.0.
vpc_ids
список / элементы=строка
Список ID VPC, которые существуют в вашем аккаунте.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • 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.

# Gather information about all VPCs
- amazon.aws.ec2_vpc_net_info:

# Gather information about a particular VPC using VPC ID
- amazon.aws.ec2_vpc_net_info:
    vpc_ids: vpc-00112233

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

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

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

Ключ Возвращаемое значение Описание
vpcs
сложный
успех
Возвращает массив объектов сложного типа, как описано ниже.

cidr_block
строка
всегда
Блок CIDR IPv4, назначенный VPC.

cidr_block_association_set
сложный
всегда
Массив данных о наборе ассоциаций блоков CIDR IPv4.

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

cidr_block
строка
всегда
Блок IPv4 CIDR, связанный с VPC.

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

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

classic_link_dns_supported
булево
всегда
Истина/Ложь в зависимости от настроек атрибутов для поддержки DNS классического подключения.

classic_link_enabled
булево
всегда
Истина/Ложь в зависимости от того, включена ли поддержка классического подключения.

enable_dns_hostnames
булево
всегда
Истина/Ложь в зависимости от настроек атрибутов для поддержки DNS имен хостов.

enable_dns_support
булево
всегда
Истина/Ложь в зависимости от настроек атрибутов для поддержки DNS.

id
строка
всегда
Идентификатор VPC (для обратной совместимости).

instance_tenancy
строка
всегда
Настройка аренды экземпляров для VPC.

ipv6_cidr_block_association_set
сложный
всегда
Массив данных о наборе ассоциаций блоков CIDR IPv6.

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

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

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

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

is_default
булево
всегда
Истина, если это стандартный VPC для учетной записи.

state
строка
всегда
Состояние VPC.

tags
словарь
всегда
Словарь тегов, связанных с VPC.

vpc_id
строка
всегда
Идентификатор VPC.



Авторы

  • Rob White (@wimnat)

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

Spec-Zone.ru

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