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

Примечание

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

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

Для использования в книге задач укажите: 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.
Значения переменных окружения будут использоваться только в том случае, если значения в книге задач не заданы.
Параметры 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–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_info_module.html