google.cloud.gcp_compute_region_instance_group_manager_info – Сбор информации о GCP RegionInstanceGroupManager

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в плейбуке укажите: google.cloud.gcp_compute_region_instance_group_manager_info.

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

Обзор

Сбор информации о GCP RegionInstanceGroupManager

Требования

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

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, который необходимо использовать.
region строка / обязательно		Регион, в котором находится управляемая группа виртуальных машин.
scopes список / элементы=строка		Массив используемых областей
service_account_contents jsonarg		Содержимое JSON-файла учетной записи службы, представленное либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к JSON-файлу учетной записи службы, если в качестве типа выбран serviceaccount.

Примечания

Примечание

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

Примеры

- name: get info on a region instance group manager
  gcp_compute_region_instance_group_manager_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое	Описание
resources complex			всегда	Список ресурсов
	autoHealingPolicies complex		успех	Политика автоматического исправления для этой группы управляемых виртуальных машин.
		healthCheck string	успех	URL для проверки работоспособности, которая сигнализирует об автоматическом исправления.
		initialDelaySec integer	успех	Количество секунд, которое группа управляемых виртуальных машин ожидает, прежде чем применить политики автоматического исправления к новым экземплярам или недавно пересозданным экземплярам.
	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		успех	Целевое количество работающих экземпляров для этой группы управляемых виртуальных машин. Удаление или отказ от экземпляров уменьшает это число. Изменение размера группы изменяет это число.

Авторы

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.10/collections/google/cloud/gcp_compute_region_instance_group_manager_info_module.html