Spec-Zone.ru › Ansible

модуль amazon.aws.ec2_dedicated_host_info — сбор информации о выделенных хостах EC2 в AWS

Примечание

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

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

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

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

Новое в amazon.aws 9.3.0

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

Обзор

  • Сбор информации о выделенных хостах EC2 в AWS.
  • Модуль также может собирать информацию о выделенных хостах Mac.

Требования

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

  • 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 botocore SDK.

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_DescribeHosts.html.

Возможные фильтры для выделенных хостов EC2 Mac см. в разделе https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeMacHosts.html.

host_ids

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

Идентификаторы выделенных хостов.

mac_only

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

Если задано значение true, получать сведения только о выделенных хостах EC2 Mac.

Варианты:

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

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 botocore SDK.

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

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 dedicated hosts
- name: Gather information about all dedicated hosts
  amazon.aws.ec2_dedicated_host_info:

# Gather information about all EC2 Mac dedicated hosts only
- name: Gather information about all EC2 Mac dedicated hosts
  amazon.aws.ec2_dedicated_host_info:
    mac_only: true

# Gather information about dedicated hosts with state=released
- name: Gather information about released dedicated hosts
  amazon.aws.ec2_dedicated_host_info:
    filters:
      state: released

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

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

Ключ

Описание

hosts

complex

Список выделенных хостов.

Возвращается: когда mac_only=false

allocation_time

string

Время выделения выделенного хоста.

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

Пример: "2025-02-12T12:09:22+00:00"

allows_multiple_instance_types

string

Указывает, поддерживает ли выделенный хост несколько типов инстансов одного семейства инстансов.

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

Пример: "off"

asset_id

string

Идентификатор аппаратного ресурса Outpost, на котором выделен выделенный хост.

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

Пример: "abcdefgh"

auto_placement

string

Включено или выключено автоматическое размещение.

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

Пример: "off"

availability_zone

string

Зона доступности выделенного хоста.

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

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

availability_zone_id

string

Идентификатор зоны доступности, в которой выделен выделенный хост.

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

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

available_capacity

dictionary

Сведения об инстансах, запущенных на выделенном хосте.

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

available_instance_capacity

complex

Количество инстансов, которые можно запустить на выделенном хосте.

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

available_capacity

integer

Количество инстансов, которые можно запустить на выделенном хосте.

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

Пример: 1

instance_type

string

Тип инстанса, поддерживаемый выделенным хостом.

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

Пример: "mac2.metal"

total_capacity

dictionary

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

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

Пример: 1

available_v_cpus

integer

Количество виртуальных ЦП, доступных для запуска инстансов на выделенном хосте.

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

Пример: 8

client_token

string

Уникальный идентификатор с учетом регистра, предоставляемый вами для обеспечения идемпотентности запроса.

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

Пример: "token-0123456789a"

host_id

string

Идентификатор выделенного хоста.

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

Пример: "h-03f51341e6e39f848"

host_maintenance

string

Указывает, включено или отключено обслуживание хоста для выделенного хоста.

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

Пример: "off"

host_properties

dictionary

Аппаратные характеристики выделенного хоста.

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

cores

integer

Количество ядер на выделенном хосте.

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

Пример: 8

instance_family

string

Семейство инстансов, поддерживаемое выделенным хостом.

Возвращается: если задано

Пример: "mac2"

instance_type

string

Тип инстанса, поддерживаемый выделенным хостом.

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

Пример: "mac2.metal"

sockets

integer

Количество сокетов на выделенном хосте.

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

Пример: 1

total_v_cpus

integer

Общее количество виртуальных ЦП на выделенном хосте.

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

Пример: 8

host_recovery

string

Указывает, включено или отключено восстановление хоста для выделенного хоста.

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

Пример: "off"

host_reservation_id

string

Идентификатор резервирования выделенного хоста.

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

instances

complex

Идентификаторы и типы инстансов, запущенных в данный момент на выделенном хосте.

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

instance_id

string

Идентификатор инстанса, запущенного на выделенном хосте.

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

Пример: "i-0123456789abcd"

instance_type

string

Тип запущенного инстанса.

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

Пример: "ec2.micro"

owner_id

string

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

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

Пример: "0123456789"

member_of_service_linked_resource_group

boolean

Указывает, входит ли выделенный хост в группу ресурсов хостов.

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

Пример: false

outpost_arn

string

Имя ресурса Amazon (ARN) Amazon Web Services Outpost, на котором выделен выделенный хост.

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

Пример: "arn:aws:outposts:us-east-1:0123012301230123:outpost/op-0123456789abcdef0"

owner_id

string

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

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

Пример: "0123456789"

release_time

string

Время освобождения выделенного хоста.

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

Пример: "2025-02-12T12:09:22+00:00"

state

string

Состояние выделенного хоста.

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

Пример: "available"

tags

dictionary

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

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

Пример: {}

mac_hosts

complex

Список выделенных хостов EC2 Mac.

Возвращается: когда mac_only=true

host_id

string

Идентификатор выделенного хоста EC2 Mac.

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

Пример: "h-04b38258aba8c1875"

mac_os_latest_supported_versions

list / elements=string

Последние версии macOS, которые можно запустить на выделенном хосте EC2 Mac без его обновления.

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

Пример: ["15.3", "14.7.3", "13.7.3"]

Авторы

  • Aubin Bikouo (@abikouo)

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

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

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

Spec-Zone.ru

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