gcp_compute_instance_group_manager_facts – Сбор фактов для GCP InstanceGroupManager

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

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

Обзор

Сбор фактов для GCP InstanceGroupManager

Требования

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

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

Параметры

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

Примечания

Примечание

Для аутентификации можно установить service_account_file с помощью переменной окружения GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно установить service_account_email с помощью переменной окружения GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить auth_kind с помощью переменной окружения GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной окружения GCP_SCOPES.
Значения переменных окружения будут использованы только в том случае, если значения в плейбуке не заданы.
Параметры service_account_email и service_account_file взаимоисключают друг друга.

Примеры

- name:  a instance group manager facts
  gcp_compute_instance_group_manager_facts:
      zone: us-west1-a
      filters:
      - name = test_object
      project: test_project
      auth_kind: service_account
      service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
items сложное			всегда	Список элементов
	base_instance_name строка		успех	Базовое имя экземпляра для использования в этой группе. Значение должно быть длиной от 1 до 58 символов. Имена экземпляров формируются путем добавления дефиса и случайной четырёхсимвольной строки к базовому имени экземпляра. Базовое имя экземпляра должно соответствовать RFC1035.
	creation_timestamp строка		успех	Отметка времени создания этой управляемой группы экземпляров в формате RFC3339.
	current_actions сложное		успех	Список действий над экземплярами и количество экземпляров в этой управляемой группе экземпляров, запланированных для каждого из этих действий.
		abandoning целое число	успех	Общее количество экземпляров в управляемой группе экземпляров, запланированных для отмены. Отмена экземпляра удаляет его из управляемой группы экземпляров, не удаляя его сам по себе.
		creating целое число	успех	Количество экземпляров в управляемой группе экземпляров, запланированных для создания или в настоящее время создаваемых. Если группе не удаётся создать какой-либо из этих экземпляров, она пытается снова, пока не создаст экземпляр успешно. Если повторные попытки создания отключены, это поле не будет заполняться; вместо этого будет заполнено поле creatingWithoutRetries.
		creating_without_retries целое число	успех	Количество экземпляров, которые управляемая группа экземпляров попытается создать. Группа пытается создать каждый экземпляр только один раз. Если группе не удаётся создать какой-либо из этих экземпляров, она уменьшает значение targetSize группы соответственно.
		deleting целое число	успех	Количество экземпляров в управляемой группе экземпляров, запланированных для удаления или в настоящее время удаляемых.
		none целое число	успех	Количество экземпляров в управляемой группе экземпляров, которые работают и не имеют запланированных действий.
		recreating целое число	успех	Количество экземпляров в управляемой группе экземпляров, которые запланированы для повторного создания или в настоящее время повторно создаются. При повторном создании экземпляра удаляется существующий корневой постоянный диск и создается новый диск из образа, определённого в шаблоне экземпляра.
		refreshing целое число	успех	Количество экземпляров в управляемой группе экземпляров, которые перенастраиваются с помощью свойств, не требующих перезапуска или повторного создания. Например, установка или удаление целевых пулов для экземпляра.
		restarting целое число	успех	Количество экземпляров в управляемой группе экземпляров, которые запланированы для перезапуска или в настоящее время перезапускаются.
	description строка		успех	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
	id целое число		успех	Уникальный идентификатор этого ресурса.
	instance_group словарь		успех	Управляемая группа экземпляров.
	instance_template словарь		успех	Шаблон экземпляра, указанный для этой управляемой группы экземпляров. Группа использует этот шаблон для создания всех новых экземпляров в управляемой группе экземпляров.
	name строка		успех	Имя управляемой группы экземпляров. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035.
	named_ports сложное		успех	Назначенные порты, сконфигурированные для групп экземпляров, дополняющих эту управляемую группу экземпляров.
		name строка	успех	Имя этого назначенного порта. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035.
		port целое число	успех	Номер порта, который может быть значением от 1 до 65535.
	region строка		успех	Регион, в котором расположена эта управляемая группа экземпляров (для региональных ресурсов).
	target_pools список		успех	Ресурсы TargetPool, к которым добавляются экземпляры из поля instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе экземпляров.
	target_size целое число		успех	Целевое количество работающих экземпляров для этой управляемой группы экземпляров. Удаление или отмена экземпляров уменьшает это число. Изменение размера группы изменяет это число.
	zone строка		успех	Зона, в которой расположена управляемая группа экземпляров.

Статус

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

Авторы

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.7/modules/gcp_compute_instance_group_manager_facts_module.html