google.cloud.gcp_compute_resource_policy_info – Сбор информации о GCP ResourcePolicy

Примечание

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

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Сбор информации о GCP ResourcePolicy

Требования

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

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 для использования.
region строка / обязательно		Регион, в котором находится политика ресурсов.
scopes список / элементы=строка		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, представляющей его.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.

Примечания

Примечание

для аутентификации можно установить 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 resource policy
  gcp_compute_resource_policy_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Значения возврата

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

Ключи						Возвращаемое значение	Описание
resources complex						всегда	Список ресурсов
	groupPlacementPolicy complex					успех	Политика создания снимков постоянных дисков.
		availabilityDomainCount целое число				успех	Количество доступных областей, в которых будут распределены экземпляры. Если два экземпляра находятся в разных доступных областях, они не будут помещены в одну сеть с низкой задержкой.
		collocation строка				успех	Политика размещения виртуальных машин в одной доступной области в одной сети с низкой задержкой. Укажите `COLLOCATED`, чтобы включить коллокация. Может быть указано только с `vm_count`. Если вычислительные экземпляры создаются с политикой COLLOCATED, тогда ровно `vm_count` экземпляров должны быть созданы одновременно с прикреплённой политикой ресурсов.
		vmCount целое число				успех	Количество виртуальных машин в группе размещения.
	name строка					успех	Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя ресурса должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])`?, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	region строка					успех	Регион, в котором находится политика ресурса.
	snapshotSchedulePolicy complex					успех	Политика создания снимков постоянных дисков.
		retentionPolicy complex				успех	Политика хранения, применяемая к снимкам, созданным с помощью этой политики ресурсов.
			maxRetentionDays целое число			успех	Максимальный срок хранения снимка.
			onSourceDiskDelete строка			успех	Определяет поведение, применяемое к запланированным снимкам при удалении исходного диска.
		schedule complex				успех	Содержит одну из настроек `hourlySchedule`, `dailySchedule` или `weeklySchedule`.
			dailySchedule complex			успех	Политика будет выполняться каждые n-е суток в указанное время.
				daysInCycle целое число		успех	Количество дней между снимками.
				startTime строка		успех	Время в формате UTC, которое соответствует одному из значений 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, оба значения 13:00-5 и 08:00 являются допустимыми.
			hourlySchedule complex			успех	Политика будет выполняться каждые n-е часы, начиная с указанного времени.
				hoursInCycle целое число		успех	Количество часов между снимками.
				startTime строка		успех	Время начала операций в указанном интервале. Должно быть в формате "ЧЧ:ММ", где ЧЧ: [00-23] и ММ : [00] GMT. Например: 21:00 .
			weeklySchedule complex			успех	Позволяет указать время снимка для каждого дня недели.
				dayOfWeeks complex		успех	Может содержать до семи (по одному на каждый день недели) временных интервалов для снимков.
					day строка	успех	День недели для создания снимка. Например, ПОНЕДЕЛЬНИК.
					startTime строка	успех	Время начала операций в указанном интервале. Должен быть в формате "ЧЧ:ММ", где ЧЧ : [00-23] и ММ : [00-00] GMT.
		snapshotProperties complex				успех	Свойства, с которыми создаются снимки, такие как метки.
			guestFlush логический			успех	Выполнять ли снимок с учетом гостя?
			labels словарь			успех	Набор пар ключ-значение.
			storageLocations список / элементы=строка			успех	Расположение ведра облачного хранилища для хранения автоматического снимка (региональное или многорегиональное).

Авторы

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