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

Примечание

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

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

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

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

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

Обзор

Этот модуль извлекает данные из открытого 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 строка	ARN роли Alibaba Cloud. ARN роли, которую необходимо принять. Если ARN установлена в пустую строку, переключение роли не выполняется. Поддерживается переменная среды `ALICLOUD_ASSUME_ROLE_ARN`. Ansible будет выполняться с предоставленными учетными данными.
alicloud_assume_role_session_expiration псевдонимы: assume_role_session_expiration целое число	Срок действия сессии Alibaba Cloud. Время, по истечении которого установленная сессия для принятия роли истекает. Допустимый диапазон значений 900-3600 секунд. По умолчанию 3600 (в этом случае Alicloud использует собственное значение по умолчанию). Поддерживается переменная среды `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`.
alicloud_assume_role_session_name псевдонимы: assume_role_session_name строка	Имя сессии Alibaba Cloud. Имя сессии для использования при принятии роли. Если опущено, «ansible» передаётся в вызов AssumeRole в качестве имени сессии. Поддерживается переменная среды `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 Instance, Ansible будет обращаться к метаданным http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>, чтобы получить凭据. Это предпочтительный подход по сравнению с другими при работе в 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"}`.

END_OF_DOCUMENT_MARKER

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса без изменения целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	В режиме сравнения вернёт детали изменений (или возможных изменений в `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, когда это необходимо, но это также можно настроить в файле конфигурации.

Примеры

# 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 список / элементы=строка	Список идентификаторов экземпляров ECS Возвращается: всегда Пример: `["i-12345er", "i-3245fs"]`
instances сложный	Список экземпляров ECS Возвращается: всегда
availability_zone строка	Зона доступности, в которой находится экземпляр. Возвращается: всегда Пример: `"cn-beijing-a"`
block_device_mappings сложный	Любые записи сопоставления блочных устройств для экземпляра. Возвращается: всегда
attach_time строка	Отметка времени, когда началось подключение. Возвращается: всегда Пример: `"2018-06-25T04:08:26Z"`
delete_on_termination булево	Указывает, будет ли том удален при завершении работы экземпляра. Возвращается: всегда Пример: `true`
device_name строка	Имя устройства, предоставленное экземпляру (например, /dev/xvda). Возвращается: всегда Пример: `"/dev/xvda"`
status строка	Состояние подключения. Возвращается: всегда Пример: `"in_use"`
volume_id строка	Идентификатор облачного диска. Возвращается: всегда Пример: `"d-2zei53pjsi117y6gf9t6"`
cpu целое число	Количество ядер процессора экземпляра. Возвращается: всегда Пример: `4`
creation_time строка	Время создания экземпляра. Возвращается: всегда Пример: `"2018-06-25T04:08Z"`
description строка	Описание экземпляра. Возвращается: всегда Пример: `"my ansible instance"`
eip сложный	Атрибуты EIP, связанного с экземпляром. Возвращается: всегда
allocation_id строка	Идентификатор EIP. Возвращается: всегда Пример: `"eip-12345"`
internet_charge_type строка	Тип оплаты интернет-трафика для EIP. Возвращается: всегда Пример: `"paybybandwidth"`
ip_address строка	Адрес EIP. Возвращается: всегда Пример: `"42.10.2.2"`
expired_time строка	Время истечения срока действия экземпляра. Возвращается: всегда Пример: `"2099-12-31T15:59Z"`
gpu сложный	Атрибуты GPU экземпляра. Возвращается: всегда

amount integer	Количество графических процессоров. Returned: always Sample: `0`
spec string	Спецификация графического процессора. Returned: always Sample: `""`
host_name string	Имя хоста экземпляра. Returned: always Sample: `"iZ2zewaoZ"`
id string	Псевдоним instance_id. Returned: always Sample: `"i-abc12345"`
image_id string	Идентификатор образа, использованного для запуска экземпляра. Returned: always Sample: `"m-0011223344"`
inner_ip_address string	Внутренний IPv4-адрес классического экземпляра. Returned: always Sample: `"10.0.0.2"`
instance_charge_type string	Тип оплаты за экземпляр. Returned: always Sample: `"PostPaid"`
instance_id string	Идентификатор ресурса экземпляра ECS. Returned: always Sample: `"i-abc12345"`
instance_name string	Имя экземпляра. Returned: always Sample: `"my-ecs"`
instance_type string	Тип экземпляра работающего экземпляра. Returned: always Sample: `"ecs.sn1ne.xlarge"`
instance_type_family string	Семейство типов экземпляров, к которому принадлежит экземпляр. Returned: always Sample: `"ecs.sn1ne"`
internet_charge_type string	Метод оплаты за сетевой трафик. Returned: always Sample: `"PayByBandwidth"`
internet_max_bandwidth_in integer	Максимальная входящая пропускная способность из интернет-сети. Returned: always Sample: `200`
internet_max_bandwidth_out integer	Максимальная входящая пропускная способность из интернет-сети. Returned: always Sample: `20`
io_optimized boolean	Указывает, оптимизирован ли экземпляр для ввода-вывода EBS. Returned: always Sample: `false`
memory integer	Объём памяти экземпляра. Returned: always Sample: `8192`
network_interfaces complex	Один или несколько сетевых интерфейсов для экземпляра. Returned: always

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	Идентификатор vswitch, в котором работает экземпляр. Возвращается: всегда Пример: `"vsw-dew00abcdef"`

Авторы

He Guimin (@xiaozhu36)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ali_instance_info_module.html