ali_instance_facts – Сбор фактов об экземплярах Alibaba Cloud ECS
Новая версия с 2.8.
Обзор
- Этот модуль извлекает данные из открытого API в Alicloud. Модуль должен вызываться из самого экземпляра ECS.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- footmark >= 1.1.16
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alicloud_access_key строка | Ключ доступа к облаку Aliyun. Если не задано, будет использоваться значение переменной среды ALICLOUD_ACCESS_KEY, ALICLOUD_ACCESS_KEY_ID. Псевдонимы: access_key_id, access_key | |
| alicloud_region строка | Регион облака Aliyun для использования. Если не указано, будет использоваться значение переменной среды ALICLOUD_REGION, ALICLOUD_REGION_ID. Псевдонимы: region, region_id | |
| alicloud_secret_key строка | Секретный ключ облака Aliyun. Если не задано, будет использоваться значение переменной среды ALICLOUD_SECRET_KEY, ALICLOUD_SECRET_ACCESS_KEY. Псевдонимы: secret_access_key, secret_key | |
| alicloud_security_token строка | Токен безопасности облака Aliyun. Если не указано, будет использоваться значение переменной среды ALICLOUD_SECURITY_TOKEN. Псевдонимы: security_token | |
| availability_zone - | Идентификатор зоны доступности Aliyun, в которой запустить экземпляр Псевдонимы: alicloud_zone | |
| instance_ids - | Список идентификаторов экземпляров ECS. Псевдонимы: ids | |
| instance_names - | Список имен экземпляров ECS. Псевдонимы: names | |
| instance_tags - | Хэш/словарь меток экземпляров. {"key":"value"}
Псевдонимы: tags |
Примечания
Примечание
- Если параметры не заданы в модуле, следующие переменные среды могут использоваться в порядке убывания приоритета
ALICLOUD_ACCESS_KEYилиALICLOUD_ACCESS_KEY_ID,ALICLOUD_SECRET_KEYилиALICLOUD_SECRET_ACCESS_KEY,ALICLOUD_REGIONилиALICLOUD_REGION_ID,ALICLOUD_SECURITY_TOKEN -
ALICLOUD_REGIONилиALICLOUD_REGION_IDобычно используются для указания региона ALICLOUD, когда это необходимо, но это также можно настроить в файле конфигурации footmark
Примеры
# Fetch instances details according to setting different filters
- name: fetch instances details example
hosts: localhost
vars:
alicloud_access_key: <your-alicloud-access-key>
alicloud_secret_key: <your-alicloud-secret-key>
alicloud_region: cn-beijing
availability_zone: cn-beijing-a
tasks:
- name: Find all instances in the specified region
ali_instance_facts:
alicloud_access_key: '{{ alicloud_access_key }}'
alicloud_secret_key: '{{ alicloud_secret_key }}'
alicloud_region: '{{ alicloud_region }}'
register: all_instances
- name: Find all instances based on the specified ids
ali_instance_facts:
alicloud_access_key: '{{ alicloud_access_key }}'
alicloud_secret_key: '{{ alicloud_secret_key }}'
alicloud_region: '{{ alicloud_region }}'
instance_ids:
- "i-35b333d9"
- "i-ddav43kd"
register: instances_by_ids
- name: Find all instances based on the specified names/name-prefixes
ali_instance_facts:
alicloud_access_key: '{{ alicloud_access_key }}'
alicloud_secret_key: '{{ alicloud_secret_key }}'
alicloud_region: '{{ alicloud_region }}'
instance_names:
- "ecs_instance-1"
- "ecs_instance_2"
register: instances_by_ids
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| 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 целое число | всегда | Количество GPU. | ||
| spec строка | всегда | Характеристики GPU. | ||
| host_name строка | всегда | Имя хоста экземпляра. Пример: iZ2zewaoZ | ||
| id строка | всегда | Псевдоним instance_id. Пример: i-abc12345 | ||
| image_id строка | всегда | Идентификатор образа, используемого для запуска экземпляра. Пример: m-0011223344 | ||
| inner_ip_address строка | всегда | Внутренний IPv4-адрес классического экземпляра. Пример: 10.0.0.2 | ||
| instance_charge_type строка | всегда | Тип оплаты экземпляра. Пример: PostPaid | ||
| instance_id строка | всегда | Идентификатор ресурса экземпляра ECS. Пример: i-abc12345 | ||
| instance_name строка | всегда | Имя экземпляра. Пример: my-ecs | ||
| instance_type строка | всегда | Тип экземпляра запущенного экземпляра. Пример: ecs.sn1ne.xlarge | ||
| internet_charge_type строка | всегда | Метод оплаты сетевой пропускной способности. Пример: PayByBandwidth | ||
| internet_max_bandwidth_in целое число | всегда | Максимальная входящая пропускная способность из интернет-сети. Пример: 200 | ||
| internet_max_bandwidth_out целое число | всегда | Максимальная входящая пропускная способность из интернет-сети. Пример: 20 | ||
| io_optimized булево | всегда | Указывает, оптимизирован ли экземпляр для EBS I/O. | ||
| memory integer | always | Размер памяти экземпляра. Пример: 8192 | ||
| network_interfaces complex | always | Один или несколько сетевых интерфейсов для экземпляра. | ||
| mac_address string | always | MAC-адрес. Пример: 00:11:22:33:44:55 | ||
| network_interface_id string | always | ID сетевого интерфейса. Пример: eni-01234567 | ||
| primary_ip_address string | always | Основной IPv4-адрес сетевого интерфейса в vswitch. Пример: 10.0.0.1 | ||
| osname string | always | Имя операционной системы принадлежащего экземпляра. Пример: CentOS | ||
| ostype string | always | Тип операционной системы принадлежащего экземпляра. Пример: linux | ||
| private_ip_address string | always | IPv4-адрес сетевого интерфейса в подсети. Пример: 10.0.0.1 | ||
| public_ip_address string | always | Присвоенный публичный IPv4-адрес экземпляру. Пример: 43.0.0.1 | ||
| resource_group_id string | always | ID группы ресурсов, к которой принадлежит экземпляр. Пример: my-ecs-group | ||
| security_groups list of complex | always | Одна или несколько групп безопасности для экземпляра. | ||
| group_id string | always | ID группы безопасности. Пример: sg-0123456 | ||
| group_name string | always | Название группы безопасности. Пример: my-security-group | ||
| status string | always | Текущий статус экземпляра. Пример: running | ||
| tags dictionary | always | Присвоенные теги экземпляру. | ||
| vpc_id dictionary | always | ID VPC, в котором находится экземпляр. Пример: vpc-0011223344 | ||
| vswitch_id string | always | ID vswitch, в котором работает экземпляр. Пример: vsw-dew00abcdef | ||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- He Guimin (@xiaozhu36)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ для улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ali_instance_facts_module.html