Модуль google.cloud.gcp_compute_resource_policy_info — Сбор информации о политике GCP ResourcePolicy
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: 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
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
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. - для аутентификации можно установить 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 |
Максимальный допустимый срок хранения снимка. Возвращено: success |
|
onSourceDiskDelete string |
Указывает поведение, применяемое к запланированным снимкам при удалении исходного диска. Возвращено: success |
|
schedule complex |
Содержит один из элементов: `hourlySchedule`, `dailySchedule` или `weeklySchedule`. Возвращено: success |
|
dailySchedule complex |
Политика будет выполняться каждые n-е сутки в указанное время. Возвращено: success |
|
daysInCycle integer |
Количество дней между снимками. Возвращено: success |
|
startTime string |
Должно быть в формате UTC, который соответствует одному из значений: 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, как 13:00-5, так и 08:00 являются допустимыми. Возвращено: success |
|
hourlySchedule complex |
Политика будет выполняться каждые n-й час, начиная с указанного времени. Возвращено: success |
|
hoursInCycle integer |
Количество часов между снимками. Возвращено: success |
|
startTime string |
Время в окне для запуска операций. Должно быть в часовом формате “HH:MM”, где HH : [00-23] и MM : [00] GMT. Например: 21:00. Возвращено: success |
|
weeklySchedule complex |
Позволяет указать время снимка для каждого дня недели. Возвращено: success |
|
dayOfWeeks complex |
Может содержать до семи (по одному для каждого дня недели) времен снимка. Возвращено: success |
|
day string |
День недели для создания снимка. Например, MONDAY. Возвращено: success |
|
startTime string |
Время в окне для запуска операций. Должно быть в формате “HH:MM”, где HH : [00-23] и MM : [00-00] GMT. Возвращено: success |
|
snapshotProperties complex |
Свойства, с помощью которых создаются снимки, например, метки. Возвращено: success |
|
guestFlush boolean |
Выполнять ли снимок с учетом гостевой ОС. Возвращено: success |
|
labels dictionary |
Набор пар «ключ-значение». Возвращено: success |
|
storageLocations list / elements=string |
Расположение корзины Cloud Storage для хранения автоматического снимка (региональное или многорегиональное). Возвращено: success |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_resource_policy_info_module.html
