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

Примечания

Примечание

Для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: facts

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

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

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