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

Примечание

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

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

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

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

Описание

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

Требования

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

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
  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 строка		успех	Ссылка на зону, в которой находится группа виртуальных машин.

Авторы

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_instance_group_info_module.html