Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_dedicated_host — создание, обновление или удаление (освобождение) выделенного хоста EC2

Примечание

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

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

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

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

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

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

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

  • Создание, обновление или удаление (освобождение) выделенного хоста EC2.

Требования

Следующие требования необходимы на узле, который выполняет этот модуль.

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа 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.

asset_ids

list / элементы=string

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

Выбор конкретных аппаратных ресурсов Outpost может помочь свести к минимуму задержку между рабочими нагрузками.

Этот параметр поддерживается только при указании outpost_arn.

При указании этого параметра quantity можно не указывать.

Если указаны и asset_ids, и quantity, значение quantity должно быть равно количеству указанных asset_ids.

auto_placement

string

Указывает, принимает ли хост запуск любых нетаргетированных экземпляров, соответствующих его конфигурации типа экземпляра, или принимает только запуски экземпляров с арендой Host, в которых указан уникальный идентификатор хоста.

Варианты:

  • "on"
  • "off" ← (по умолчанию)

availability_zone

string

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

Обязателен, если указано state=present.

aws_ca_bundle

path

Путь к пакету сертификатов центра сертификации, используемому при проверке сертификатов SSL.

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

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

client_token

string

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

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

endpoint_url

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

string

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

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

host_id

string

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

host_maintenance

string

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

Варианты:

  • "on"
  • "off" ← (по умолчанию)

host_recovery

string

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

По умолчанию восстановление хоста отключено.

Варианты:

  • "on"
  • "off" ← (по умолчанию)

instance_family

string

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

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

При размещении выделенного хоста необходимо указать как минимум один из параметров instance_family или instance_type.

Несовместим с параметром instance_type.

instance_type

string

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

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

При размещении выделенного хоста необходимо указать как минимум один из параметров instance_family или instance_type.

Несовместим с параметром instance_family.

lookup

string

Поиск выделенного хоста EC2 по tags или по host_id.

Если lookup=tag и tags не указаны, поиск существующего выделенного хоста не выполняется и будет создан новый выделенный хост.

При использовании lookup=tag обнаружение нескольких совпадений приведет к сбою, изменения внесены не будут.

Чтобы изменить теги выделенного хоста, используйте lookup=host_id.

Варианты:

  • "tag" ← (по умолчанию)
  • "host_id"

outpost_arn

string

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

profile

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

string

Именованный профиль 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.

purge_tags

boolean

Если указано purge_tags=true и задано tags, существующие теги ресурса будут удалены, чтобы набор тегов точно соответствовал заданному параметром tags.

Если параметр tags не задан, теги не будут изменены, даже если указано purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра purge_tags они будут игнорироваться. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

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

quantity

integer

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

Обязателен, если указано state=present.

Если выделенные хосты размещаются на Outpost и указан параметр asset_ids, этот параметр можно не указывать.

Если указаны и asset_ids, и quantity, значение, указанное для quantity, должно быть равно количеству указанных asset_ids.

region

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

string

Регион 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

string

Секретный ключ доступа 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

string

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

state

string

Создать или удалить выделенный хост.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

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

dictionary

Словарь с тегами, применяемыми к ресурсу.

Если параметр tags не задан, теги не будут изменены.

validate_certs

boolean

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

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

Варианты:

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

Примечания

Примечание

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

# Release dedicated hosts
- name: Release dedicated host
  amazon.aws.ec2_dedicated_host:
    host_id: "h-0123456789abcdef0"

# Allocate dedicated host using instance type
- name: Allocate dedicated host using instance_type
  amazon.aws.ec2_dedicated_host:
    availability_zone: us-east-1a
    quantity: 1
    instance_type: mac2.metal
    tags:
      Scope: Mac

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

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

Ключ

Описание

host

complex

Информация о созданном или обновлённом выделенном хосте.

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

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 Resource Name (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

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

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

Пример: {}

Авторы

  • 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_module.html

Spec-Zone.ru

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