gcp_compute_instance_group_manager_info – Сбор информации о GCP InstanceGroupManager

Новая версия с 2.7.

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

Обзор

Сбор информации о GCP InstanceGroupManager
Этот модуль назывался gcp_compute_instance_group_manager_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: gcp_compute_instance_group_manager_facts

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API.
filters список		Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project строка		Используемый проект Google Cloud Platform.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, его представляющей.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
zone строка / обязательно		Зона, в которой находится управляемая группа виртуальных машин.

Примечания

Примечание

для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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		успех	Ресурсы targetPool, к которым добавляются экземпляры в поле instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе экземпляров.
	targetSize integer		успех	Целевое количество запущенных экземпляров для этой управляемой группы экземпляров. Удаление или отмена экземпляров уменьшает это число. Изменение размера группы изменяет это число.
	zone string		успех	Зона, в которой расположена управляемая группа экземпляров.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Google Inc. (@googlecloudplatform)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_instance_group_manager_info_module.html