модуль google.cloud.gcp_compute_instance_group_manager_info — сбор информации о GCP InstanceGroupManager
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_instance_group_manager_info.
Краткое описание
- Сбор информации о GCP InstanceGroupManager
Требования
На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если в качестве типа учетных данных выбрано accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для всех запросов к API. |
filters list / elements=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / elements=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла сервисного аккаунта — в виде словаря или строки JSON, представляющей его. |
service_account_email string | Необязательный адрес электронной почты сервисного аккаунта, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбрано serviceaccount. |
zone string / обязательный | Зона, в которой находится управляемая группа экземпляров. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
- Параметры service_account_email и service_account_file являются взаимоисключающими.
Примеры
- name: get info on an instance group manager
gcp_compute_instance_group_manager_info:
zone: us-west1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
baseInstanceName string |
Базовое имя экземпляров в этой группе. Длина значения должна составлять от 1 до 58 символов. Имена экземпляров формируются добавлением дефиса и случайной строки из четырех символов к базовому имени. Базовое имя экземпляра должно соответствовать RFC1035. Возвращается: при успехе |
|
creationTimestamp string |
Время создания этой управляемой группы экземпляров в текстовом формате RFC3339. Возвращается: при успехе |
|
currentActions complex |
Список действий с экземплярами и количество экземпляров этой управляемой группы, запланированных для каждого из этих действий. Возвращается: при успехе |
|
abandoning integer |
Общее количество экземпляров управляемой группы, запланированных к исключению. Исключение экземпляра удаляет его из управляемой группы без его удаления. Возвращается: при успехе |
|
creating integer |
Количество экземпляров управляемой группы, создание которых запланировано или уже выполняется. Если группе не удается создать какой-либо из этих экземпляров, она повторяет попытку, пока не создаст экземпляр. Если повторные попытки создания отключены, это поле не заполняется; вместо него заполняется поле creatingWithoutRetries. Возвращается: при успехе |
|
creatingWithoutRetries integer |
Количество экземпляров, которые управляемая группа попытается создать. Группа предпринимает только одну попытку создания каждого экземпляра. Если группе не удается создать какой-либо из этих экземпляров, она соответствующим образом уменьшает значение targetSize. Возвращается: при успехе |
|
deleting integer |
Количество экземпляров управляемой группы, удаление которых запланировано или уже выполняется. Возвращается: при успехе |
|
none integer |
Количество работающих экземпляров управляемой группы, для которых не запланировано никаких действий. Возвращается: при успехе |
|
recreating integer |
Количество экземпляров управляемой группы, пересоздание которых запланировано или уже выполняется. Пересоздание экземпляра удаляет существующий корневой постоянный диск и создает новый диск из образа, заданного в шаблоне экземпляра. Возвращается: при успехе |
|
refreshing integer |
Количество экземпляров управляемой группы, параметры которых перенастраиваются без перезапуска или пересоздания. Например, это может быть установка или удаление целевых пулов для экземпляра. Возвращается: при успехе |
|
restarting integer |
Количество экземпляров управляемой группы, перезапуск которых запланирован или уже выполняется. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор этого ресурса. Возвращается: при успехе |
|
instanceGroup dictionary |
Управляемая группа экземпляров. Возвращается: при успехе |
|
instanceTemplate dictionary |
Шаблон экземпляра, указанный для этой управляемой группы экземпляров. Группа использует этот шаблон для создания всех новых экземпляров в управляемой группе. Возвращается: при успехе |
|
name string |
Имя управляемой группы экземпляров. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Возвращается: при успехе |
|
namedPorts complex |
Именованные порты, настроенные для групп экземпляров, связанных с этим диспетчером групп экземпляров. Возвращается: при успехе |
|
name string |
Имя этого именованного порта. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Возвращается: при успехе |
|
port integer |
Номер порта — значение от 1 до 65535. Возвращается: при успехе |
|
region string |
Регион, в котором находится эта управляемая группа экземпляров (для региональных ресурсов). Возвращается: при успехе |
|
targetPools list / elements=string |
Ресурсы TargetPool, в которые добавляются экземпляры из поля instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам управляемой группы. Возвращается: при успехе |
|
targetSize integer |
Целевое количество работающих экземпляров в этой управляемой группе. Удаление или исключение экземпляров уменьшает это число. Изменение размера группы изменяет это число. Возвращается: при успехе |
|
zone string |
Зона, в которой находится управляемая группа экземпляров. Возвращается: при успехе |
Ссылки на коллекцию
© 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/google/cloud/gcp_compute_instance_group_manager_info_module.html