Модуль community.general.ali_instance_info — сбор информации об экземплярах Alibaba Cloud ECS

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.ali_instance_info.

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

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

Этот модуль получает данные из Open API в Alicloud. Модуль необходимо вызывать непосредственно из экземпляра ECS.

Требования

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

Python >= 3.6
footmark >= 1.13.0

Параметры

Параметр	Комментарии
alicloud_access_key псевдонимы: access_key_id, access_key строка	Ключ доступа Alibaba Cloud. Если параметр не задан, вместо него используется значение переменной среды `ALICLOUD_ACCESS_KEY`, `ALICLOUD_ACCESS_KEY_ID`.
alicloud_assume_role псевдонимы: assume_role словарь	Если указан ARN роли, Ansible попытается принять эту роль, используя предоставленные учетные данные. Вложенный блок assume_role поддерживает `alicloud_assume_role_arn`, `alicloud_assume_role_session_name`, `alicloud_assume_role_session_expiration` и `alicloud_assume_role_policy`.
alicloud_assume_role_arn псевдонимы: assume_role_arn строка	`role_arn` Alibaba Cloud. ARN роли, которую необходимо принять. Если ARN задан пустой строкой, переключение роли не выполняется. Поддерживается переменная среды `ALICLOUD_ASSUME_ROLE_ARN`. Ansible выполняется с предоставленными учетными данными.
alicloud_assume_role_session_expiration псевдонимы: assume_role_session_expiration целое число	`session_expiration` Alibaba Cloud. Время, по истечении которого завершается созданный сеанс принятия роли. Допустимый диапазон значений — 900–3600 секунд. Значение по умолчанию — 3600 (в этом случае Alicloud использует собственное значение по умолчанию). Поддерживается переменная среды `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`.
alicloud_assume_role_session_name псевдонимы: assume_role_session_name строка	session_name Alibaba Cloud. Имя сеанса, используемое при принятии роли. Если значение не указано, вызову AssumeRole передается имя сеанса ‘ansible’. Поддерживается переменная среды `ALICLOUD_ASSUME_ROLE_SESSION_NAME`.
alicloud_region псевдонимы: region, region_id строка / обязательный	Регион Alibaba Cloud. Если значение не указано, вместо него используется значение переменной среды `ALICLOUD_REGION`, `ALICLOUD_REGION_ID`.
alicloud_secret_key псевдонимы: secret_access_key, secret_key строка	Секретный ключ Alibaba Cloud. Если параметр не задан, вместо него используется значение переменной среды `ALICLOUD_SECRET_KEY`, `ALICLOUD_SECRET_ACCESS_KEY`.
alicloud_security_token псевдонимы: security_token строка	Токен безопасности Alibaba Cloud. Если значение не указано, вместо него используется значение переменной среды `ALICLOUD_SECURITY_TOKEN`.
ecs_role_name псевдонимы: role_name строка	Имя роли RAM, назначенной экземпляру ECS для выполнения операций API. Это значение можно получить в разделе «Управление доступом» консоли Alibaba Cloud. Если Ansible выполняется на экземпляре ECS с экземпляром RAM, использующим роль RAM, Ansible просто обращается к метаданным http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>, чтобы получить учетные данные STS. При запуске в ECS это предпочтительнее любого другого способа, поскольку позволяет не указывать учетные данные в коде. Вместо этого Ansible получает их динамически, что снижает вероятность утечки.
filters словарь добавлено в community.general 0.2.0	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и его значения. В качестве ключей фильтров можно использовать все параметры запроса. Описание параметров см. на странице https://www.alibabacloud.com/help/doc-detail/25506.htm. Ключи фильтров могут совпадать с именами параметров запроса либо быть написаны строчными буквами с использованием подчеркивания (`"_"`) или дефиса (`"-"`) для соединения слов в одном параметре. `InstanceIds` должен быть списком. `Tag.n.Key` и `Tag.n.Value` должны быть словарями; вместо них используется `tags`.
name_prefix строка добавлено в community.general 0.2.0	Используйте префикс имени экземпляра для фильтрации экземпляров ECS.
profile строка	Имя профиля Alicloud, указанное в файле общих учетных данных. Также его можно получить из переменной среды `ALICLOUD_PROFILE`.
shared_credentials_file строка	Путь к файлу общих учетных данных. Также его можно получить из переменной среды `ALICLOUD_SHARED_CREDENTIALS_FILE`. Если этот параметр не задан, но указан профиль, используется `~/.aliyun/config.json`.
tags псевдонимы: instance_tags словарь	Хеш/словарь тегов экземпляра. `{"key":"value"}`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Можно выполнять в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о тех, которые, возможно, необходимо внести в `check_mode`).

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета: ALICLOUD_ACCESS_KEY или ALICLOUD_ACCESS_KEY_ID, ALICLOUD_SECRET_KEY или ALICLOUD_SECRET_ACCESS_KEY, ALICLOUD_REGION или ALICLOUD_REGION_ID, ALICLOUD_SECURITY_TOKEN, ALICLOUD_ECS_ROLE_NAME, ALICLOUD_SHARED_CREDENTIALS_FILE, ALICLOUD_PROFILE, ALICLOUD_ASSUME_ROLE_ARN, ALICLOUD_ASSUME_ROLE_SESSION_NAME, ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.
ALICLOUD_REGION или ALICLOUD_REGION_ID обычно можно использовать для указания региона Alicloud, если он требуется; также его можно настроить в файле конфигурации footmark.

Примеры

# Fetch instances details according to setting different filters

- name: Find all instances in the specified region
  community.general.ali_instance_info:
  register: all_instances

- name: Find all instances based on the specified ids
  community.general.ali_instance_info:
    instance_ids:
      - "i-35b333d9"
      - "i-ddav43kd"
  register: instances_by_ids

- name: Find all instances based on the specified name_prefix
  community.general.ali_instance_info:
    name_prefix: "ecs_instance_"
  register: instances_by_name_prefix

- name: Find instances based on tags
  community.general.ali_instance_info:
    tags:
      Test: "add"

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

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

Ключ	Описание
ids list / elements=string	Список идентификаторов экземпляров ECS. Возвращается: всегда Пример: `["i-12345er", "i-3245fs"]`
instances list / elements=dictionary	Список экземпляров ECS. Возвращается: всегда
availability_zone string	Зона доступности, в которой находится экземпляр. Возвращается: всегда Пример: `"cn-beijing-a"`
block_device_mappings complex	Записи сопоставления блочных устройств для экземпляра, если они есть. Возвращается: всегда
attach_time string	Метка времени начала подключения. Возвращается: всегда Пример: `"2018-06-25T04:08:26Z"`
delete_on_termination boolean	Указывает, удаляется ли том при завершении работы экземпляра. Возвращается: всегда Пример: `true`
device_name string	Имя устройства, доступное экземпляру (например, /dev/xvda). Возвращается: всегда Пример: `"/dev/xvda"`
status string	Состояние подключения. Возвращается: всегда Пример: `"in_use"`
volume_id string	Идентификатор облачного диска. Возвращается: всегда Пример: `"d-2zei53pjsi117y6gf9t6"`
cpu integer	Количество ядер ЦП экземпляра. Возвращается: всегда Пример: `4`
creation_time string	Время создания экземпляра. Возвращается: всегда Пример: `"2018-06-25T04:08Z"`
description string	Описание экземпляра. Возвращается: всегда Пример: `"my ansible instance"`
eip complex	Сведения о EIP, связанном с экземпляром. Возвращается: всегда
allocation_id string	Идентификатор EIP. Возвращается: всегда Пример: `"eip-12345"`
internet_charge_type string	Тип тарификации интернет-трафика для EIP. Возвращается: всегда Пример: `"paybybandwidth"`
ip_address string	Адрес EIP. Возвращается: всегда Пример: `"42.10.2.2"`
expired_time string	Время окончания срока действия экземпляра. Возвращается: всегда Пример: `"2099-12-31T15:59Z"`
gpu complex	Сведения о GPU экземпляра. Возвращается: всегда
amount integer	Количество GPU. Возвращается: всегда Пример: `0`
spec string	Характеристики GPU. Возвращается: всегда Пример: `""`
host_name string	Имя хоста экземпляра. Возвращается: всегда Пример: `"iZ2zewaoZ"`
id string	Псевдоним instance_id. Возвращается: всегда Пример: `"i-abc12345"`
image_id string	Идентификатор образа, использованного для запуска экземпляра. Возвращается: всегда Пример: `"m-0011223344"`
inner_ip_address string	Внутренний IPv4-адрес классического экземпляра. Возвращается: всегда Пример: `"10.0.0.2"`
instance_charge_type string	Тип тарификации экземпляра. Возвращается: всегда Пример: `"PostPaid"`
instance_id string	Идентификатор ресурса экземпляра ECS. Возвращается: всегда Пример: `"i-abc12345"`
instance_name string	Имя экземпляра. Возвращается: всегда Пример: `"my-ecs"`
instance_type string	Тип запущенного экземпляра. Возвращается: всегда Пример: `"ecs.sn1ne.xlarge"`
instance_type_family string	Семейство типов, к которому относится экземпляр. Возвращается: всегда Пример: `"ecs.sn1ne"`
internet_charge_type string	Метод тарификации пропускной способности сети. Возвращается: всегда Пример: `"PayByBandwidth"`
internet_max_bandwidth_in integer	Максимальная входящая пропускная способность интернет-сети. Возвращается: всегда Пример: `200`
internet_max_bandwidth_out integer	Максимальная входящая пропускная способность интернет-сети. Возвращается: всегда Пример: `20`
io_optimized boolean	Указывает, оптимизирован ли экземпляр для операций ввода-вывода EBS. Возвращается: всегда Пример: `false`
memory integer	Объем памяти экземпляра. Возвращается: всегда Пример: `8192`
network_interfaces complex	Один или несколько сетевых интерфейсов экземпляра. Возвращается: всегда
mac_address string	MAC-адрес. Возвращается: всегда Пример: `"00:11:22:33:44:55"`
network_interface_id string	Идентификатор сетевого интерфейса. Возвращается: всегда Пример: `"eni-01234567"`
primary_ip_address string	Основной IPv4-адрес сетевого интерфейса в пределах виртуального коммутатора (vswitch). Возвращается: всегда Пример: `"10.0.0.1"`
osname string	Название операционной системы экземпляра. Возвращается: всегда Пример: `"CentOS"`
ostype string	Тип операционной системы экземпляра. Возвращается: всегда Пример: `"linux"`
private_ip_address string	IPv4-адрес сетевого интерфейса в пределах подсети. Возвращается: всегда Пример: `"10.0.0.1"`
public_ip_address string	Публичный IPv4-адрес, назначенный экземпляру, или адрес EIP. Возвращается: всегда Пример: `"43.0.0.1"`
resource_group_id string	Идентификатор группы ресурсов, к которой относится экземпляр. Возвращается: всегда Пример: `"my-ecs-group"`
security_groups list / elements=dictionary	Одна или несколько групп безопасности экземпляра. Возвращается: всегда
group_id string	Идентификатор группы безопасности. Возвращается: всегда Пример: `"sg-0123456"`
group_name string	Название группы безопасности. Возвращается: всегда Пример: `"my-security-group"`
status string	Текущий статус экземпляра. Возвращается: всегда Пример: `"running"`
tags dictionary	Теги, назначенные экземпляру, если они есть. Возвращается: всегда

vpc_id string	Идентификатор VPC, в которой находится экземпляр. Возвращается: всегда Пример: `"vpc-0011223344"`
vswitch_id string	Идентификатор виртуального коммутатора, в котором работает экземпляр. Возвращается: всегда Пример: `"vsw-dew00abcdef"`

Авторы

He Guimin (@xiaozhu36)

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

© 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/community/general/ali_instance_info_module.html