gcp_compute_instance_group_info – Сбор информации о группе виртуальных машин GCP

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

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

Описание

Сбор информации о группе виртуальных машин GCP
Этот модуль назывался gcp_compute_instance_group_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_compute_instance_group_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		Содержимое файла Service Account JSON, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка		Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу Service Account 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.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

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

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

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

Ключ			Возвращаемое значение	Описание
resources сложное			всегда	Список ресурсов
	creationTimestamp строка		успех	Дата и время создания в формате RFC3339.
	description строка		успех	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
	id целое число		успех	Уникальный идентификатор этой группы виртуальных машин.
	instances список		успех	Список виртуальных машин, связанных с этой группой виртуальных машин. Все виртуальные машины должны быть созданы перед добавлением в группу виртуальных машин. Все виртуальные машины, которые не находятся в этом списке, будут удалены из группы виртуальных машин, но не будут удалены. Будет возвращен только полный идентификатор виртуальной машины.
	name строка		успех	Название группы виртуальных машин. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035.
	namedPorts сложное		успех	Присваивает имя номеру порта. Например: {name: "http", port: 80}. Это позволяет системе ссылаться на порты по назначенному имени вместо номера порта. Имена портов могут также содержать несколько портов. Например: [{name: "http", port: 80},{name: "http", port: 8080}] Имена портов применяются ко всем виртуальным машинам в этой группе виртуальных машин.
		name строка	успех	Имя для этого имени порта. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035.
		port целое число	успех	Номер порта, который может принимать значения от 1 до 65535.
	network словарь		успех	Сеть, к которой принадлежат все виртуальные машины в группе виртуальных машин.
	region строка		успех	Регион расположения группы виртуальных машин (для региональных ресурсов).
	subnetwork словарь		успех	Подсеть, к которой принадлежат все виртуальные машины в группе виртуальных машин.
	zone строка		успех	Ссылка на зону, в которой расположена группа виртуальных машин.

Статус

Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается сообществом 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_info_module.html