Spec-Zone.ru › Ansible 2.11

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 (по умолчанию модуль использует конечные точки 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
список / элементы=строка
Список идентификаторов 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
complex
success
Возвращает массив объектов complex, как описано ниже.

cidr_block
string
always
Блок IPv4 CIDR, назначенный VPC.

cidr_block_association_set
complex
always
Массив информации о наборе ассоциаций блоков IPv4 cidr.

association_id
string
always
Идентификатор ассоциации

cidr_block
string
always
Блок IPv4 CIDR, связанный с VPC.

cidr_block_state
dictionary
always
Словарь/hash, содержащий единственный элемент. Состояние ассоциации блока cidr.

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

classic_link_dns_supported
boolean
always
True/False в зависимости от настройки атрибута для поддержки DNS классической связи.

classic_link_enabled
boolean
always
True/False в зависимости от того, включена ли поддержка классической связи.

enable_dns_hostnames
boolean
always
True/False в зависимости от настройки атрибута для поддержки DNS имен хостов.

enable_dns_support
boolean
always
True/False в зависимости от настройки атрибута для поддержки DNS.

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

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

ipv6_cidr_block_association_set
complex
always
Массив информации о наборе ассоциаций блоков IPv6 cidr.

association_id
string
always
Идентификатор ассоциации

ipv6_cidr_block
string
always
Блок IPv6 CIDR, связанный с VPC.

ipv6_cidr_block_state
dictionary
always
Словарь/hash, содержащий единственный элемент. Состояние ассоциации блока cidr.

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

is_default
boolean
always
True, если это стандартный VPC для учетной записи.

state
string
always
Состояние VPC.

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

vpc_id
string
always
Идентификатор VPC.



Авторы

  • Роб Уайт (@wimnat)

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

Spec-Zone.ru

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