Модуль google.cloud.gcp_compute_resource_policy_info — сбор сведений о ResourcePolicy в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_resource_policy_info.
Краткое описание
- Сбор сведений о ResourcePolicy в GCP
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для любых запросов к API. |
filters list / элементы=string | Список пар «фильтр — значение». Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 и filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
region string / обязательный | Регион, в котором находится политика ресурсов. |
scopes list / элементы=string | Массив областей доступа, которые следует использовать |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы. Используется, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации можно задать 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 | Список ресурсов Возвращается: всегда |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: при успешном выполнении |
|
groupPlacementPolicy complex |
Политика ресурсов для экземпляров, используемая при настройке размещения. Возвращается: при успешном выполнении |
|
availabilityDomainCount integer |
Количество доменов доступности, между которыми будут распределены экземпляры. Если два экземпляра находятся в разных доменах доступности, они не будут размещены в одной сети с низкой задержкой. Возвращается: при успешном выполнении |
|
collocation string |
Параметр Collocation указывает, следует ли размещать виртуальные машины в одном домене доступности в одной сети с низкой задержкой. Укажите `COLLOCATED`, чтобы включить совместное размещение. Этот параметр можно указать только вместе с `vm_count`. Если вычислительные экземпляры создаются с политикой COLLOCATED, необходимо одновременно создать ровно `vm_count` экземпляров с прикрепленной политикой ресурсов. Возвращается: при успешном выполнении |
|
vmCount integer |
Количество виртуальных машин в этой группе размещения. Возвращается: при успешном выполнении |
|
instanceSchedulePolicy complex |
Политика ресурсов для планирования операций с экземплярами. Возвращается: при успешном выполнении |
|
expirationTime string |
Время окончания действия расписания. Временная метка представлена строкой RFC3339. Возвращается: при успешном выполнении |
|
startTime string |
Время начала действия расписания. Временная метка представлена строкой RFC3339. Возвращается: при успешном выполнении |
|
timeZone string |
Указывает часовой пояс, используемый при интерпретации расписания. Значение этого поля должно быть названием часового пояса из базы данных tz: http://en.wikipedia.org/wiki/Tz_database. Возвращается: при успешном выполнении |
|
vmStartSchedule complex |
Задает расписание запуска экземпляров. Возвращается: при успешном выполнении |
|
schedule string |
Задает периодичность операции в формате unix-cron. Возвращается: при успешном выполнении |
|
vmStopSchedule complex |
Задает расписание остановки экземпляров. Возвращается: при успешном выполнении |
|
schedule string |
Задает периодичность операции в формате unix-cron. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса, заданное клиентом при его первоначальном создании. Имя ресурса должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])`? Это означает, что первым символом должна быть строчная буква, а все последующие символы должны быть дефисом, строчной буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успешном выполнении |
|
region string |
Регион, в котором находится политика ресурсов. Возвращается: при успешном выполнении |
|
snapshotSchedulePolicy complex |
Политика создания снимков постоянных дисков. Возвращается: при успешном выполнении |
|
retentionPolicy complex |
Политика хранения, применяемая к снимкам, созданным этой политикой ресурсов. Возвращается: при успешном выполнении |
|
maxRetentionDays integer |
Максимальный срок хранения снимка. Возвращается: при успешном выполнении |
|
onSourceDiskDelete string |
Задает поведение для запланированных снимков при удалении исходного диска. Возвращается: при успешном выполнении |
|
schedule complex |
Содержит один из параметров `hourlySchedule`, `dailySchedule` или `weeklySchedule`. Возвращается: при успешном выполнении |
|
dailySchedule complex |
Политика выполняется каждый n-й день в указанное время. Возвращается: при успешном выполнении |
|
daysInCycle integer |
Количество дней между снимками. Возвращается: при успешном выполнении |
|
startTime string |
Значение должно быть указано в формате UTC и соответствовать одному из значений: 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, допустимы значения 13:00-5 и 08:00. Возвращается: при успешном выполнении |
|
hourlySchedule complex |
Политика выполняется каждый n-й час, начиная с указанного времени. Возвращается: при успешном выполнении |
|
hoursInCycle integer |
Количество часов между снимками. Возвращается: при успешном выполнении |
|
startTime string |
Время начала операций в пределах временного окна. Оно должно быть указано в часовом формате «HH:MM», где HH : [00-23], а MM : [00], GMT. Например: 21:00. Возвращается: при успешном выполнении |
|
weeklySchedule complex |
Позволяет задавать время создания снимка для каждого дня недели. Возвращается: при успешном выполнении |
|
dayOfWeeks complex |
Может содержать до семи значений времени создания снимка (по одному для каждого дня недели). Возвращается: при успешном выполнении |
|
day string |
День недели, в который следует создать снимок, например MONDAY. Возвращается: при успешном выполнении |
|
startTime string |
Время начала операций в пределах временного окна. Оно должно быть указано в формате «HH:MM», где HH : [00-23], а MM : [00-00], GMT. Возвращается: при успешном выполнении |
|
snapshotProperties complex |
Свойства, с которыми создаются снимки, например метки. Возвращается: при успешном выполнении |
|
guestFlush boolean |
Следует ли создавать снимок с учетом состояния гостевой системы. Возвращается: при успешном выполнении |
|
labels dictionary |
Набор пар «ключ — значение». Возвращается: при успешном выполнении |
|
storageLocations list / элементы=string |
Расположение сегмента Cloud Storage для хранения автоматически создаваемых снимков (региональное или мультирегиональное). Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_resource_policy_info_module.html
