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

Примечание

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

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

specificReservationRequired boolean	success	При установке в значение true, только ВМ, которые нацелены на эту резервацию по имени, могут использовать эту резервацию. В противном случае она может быть использована ВМ с аффинностью к любой резервации. По умолчанию false.
status string	success	Статус резервации.
zone string	success	Зона, в которой выполняется резервация.

Авторы

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