google.cloud.gcp_compute_reservation_info – Сбор информации о резервации GCP

Примечание

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

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

Для использования в книге задач укажите: google.cloud.gcp_compute_reservation_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 a reservation
  gcp_compute_reservation_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ					Возвращаемое значение	Описание
resources сложный					всегда	Список ресурсов
	commitment строка				успех	Полный или частичный URL родительского обязательства. Это поле отображается для резерваций, привязанных к обязательству.
	creationTimestamp строка				успех	Дата и время создания в формате RFC3339.
	description строка				успех	Необязательное описание этого ресурса.
	id целое число				успех	Уникальный идентификатор ресурса.
	name строка				успех	Имя ресурса. Указывается клиентом при создании ресурса. Длина имени должна быть 1-63 символа и соответствовать RFC1035. В частности, длина имени должна быть 1-63 символа, и оно должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	specificReservation сложный				успех	Резервация для экземпляров с определенными форматами машин.
		count целое число			успех	Количество выделенных ресурсов.
		instanceProperties сложный			успех	Свойства экземпляра для резервации.
			guestAccelerators сложный		успех	Тип и количество ускорителей гостевой ОС.
				acceleratorCount целое число	успех	Количество карт ускорителей гостевой ОС, подключенных к этому экземпляру.
				acceleratorType строка	успех	Полный или частичный URL типа ускорителя, подключаемого к этому экземпляру. Например: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100` Если вы создаете шаблон экземпляра, укажите только имя ускорителя.
			localSsds сложный		успех	Объем локального SSD для резервирования с каждым экземпляром. Это резервирует диски типа `local-ssd`.
				diskSizeGb целое число	успех	Размер диска в ГБ в двоичной системе.
				interface строка	успех	Интерфейс диска для подключения этого диска.
			machineType строка		успех	Имя типа машины для резервации.
			minCpuPlatform строка		успех	Минимальная платформа процессора для резервации. Например, `"Intel Skylake"`. См. https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones для получения информации о доступных платформах процессоров.
		inUseCount целое число			успех	Количество используемых экземпляров.
	specificReservationRequired булево				успех	При установке в значение true, только виртуальные машины, нацеленные на эту резервацию по имени, могут использовать эту резервацию. В противном случае ее могут использовать виртуальные машины с аффинити к любой резервации. По умолчанию false.
	status строка				успех	Статус резервации.
	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_reservation_info_module.html