google.cloud.gcp_compute_instance_group_manager_info – Сбор информации для GCP InstanceGroupManager

Примечание

Этот плагин является частью коллекции google.cloud (версия 1.0.2).

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

Для использования в playbook, укажите: google.cloud.gcp_compute_instance_group_manager_info.

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

Описание

Сбор информации для GCP InstanceGroupManager

Требования

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

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, используя переменную среды 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.
Значения переменных окружения будут использоваться только в том случае, если значения в 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 строка		успех	Базовое имя экземпляра для использования в этой группе. Значение должно содержать от 1 до 58 символов. Имена экземпляров формируются путем добавления дефиса и случайной четырёхзначной строки к базовому имени экземпляра. Базовое имя экземпляра должно соответствовать RFC1035.
	creationTimestamp строка		успех	Дата и время создания этой управляемой группы экземпляров в формате RFC3339.
	currentActions complex		успех	Список действий для экземпляров и количество экземпляров в этой управляемой группе экземпляров, запланированных для каждого из этих действий.
		abandoning целое число	успех	Общее количество экземпляров в управляемой группе экземпляров, запланированных для удаления без удаления.
		creating целое число	успех	Количество экземпляров в управляемой группе экземпляров, запланированных для создания или в процессе создания. Если группе не удаётся создать какой-либо из этих экземпляров, она пытается снова, пока экземпляр не будет успешно создан. Если повторные попытки создания отключены, это поле не будет заполняться; вместо этого будет заполняться поле creatingWithoutRetries.
		creatingWithoutRetries целое число	успех	Количество экземпляров, которые управляемая группа экземпляров попытается создать. Группа пытается создать каждый экземпляр только один раз. Если группе не удаётся создать какой-либо из этих экземпляров, она уменьшает соответствующее значение targetSize группы.
		deleting целое число	успех	Количество экземпляров в управляемой группе экземпляров, запланированных для удаления или в процессе удаления.
		none целое число	успех	Количество экземпляров в управляемой группе экземпляров, которые работают и для которых не запланированы действия.
		recreating целое число	успех	Количество экземпляров в управляемой группе экземпляров, запланированных для пересоздания или в процессе пересоздания. При пересоздании экземпляра удаляется существующий корневой постоянный диск и создаётся новый диск из образа, определённого в шаблоне экземпляра.
		refreshing целое число	успех	Количество экземпляров в управляемой группе экземпляров, которые перенастраиваются с параметрами, не требующими перезапуска или пересоздания. Например, установка или удаление целевых пулов для экземпляра.
		restarting целое число	успех	Количество экземпляров в управляемой группе экземпляров, запланированных для перезапуска или в процессе перезапуска.
	description строка		успех	Необязательное описание этого ресурса. Используйте это свойство при создании ресурса.
	id целое число		успех	Уникальный идентификатор этого ресурса.
	instanceGroup словарь		успех	Управляемая группа экземпляров.
	instanceTemplate словарь		успех	Шаблон экземпляра, указанный для этой управляемой группы экземпляров. Группа использует этот шаблон для создания всех новых экземпляров в управляемой группе экземпляров.
	name строка		успех	Имя управляемой группы экземпляров. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035.
	namedPorts complex		успех	Назначенные порты, настроенные для групп экземпляров, дополняющих эту управляющую группу экземпляров.
		name строка	успех	Имя этого назначенного порта. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035.
		port целое число	успех	Номер порта, который может принимать значения от 1 до 65535.
	region строка		успех	Регион, в котором расположена эта управляемая группа экземпляров (для региональных ресурсов).
	targetPools список / элементы=строка		успех	Ресурсы целевых пулов, к которым добавляются экземпляры в поле instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе экземпляров.
	targetSize целое число		успех	Целевое количество работающих экземпляров для этой управляемой группы экземпляров. Удаление или удаление экземпляров уменьшает это число. Изменение размера группы изменяет это число.
	zone строка		успех	Зона, в которой расположена управляемая группа экземпляров.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_instance_group_manager_info_module.html