google.cloud.gcp_compute_resource_policy модуль — Создаёт политику GCP ResourcePolicy
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные условия, см. Требования для получения подробностей.
Для использования в playbook укажите: google.cloud.gcp_compute_resource_policy.
Обзор
- Политика, которая может быть прикреплена к ресурсу для задания или планирования действий над этим ресурсом.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
description строка | Необязательное описание этого ресурса. Укажите эту информацию при создании ресурса. |
env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. |
group_placement_policy словарь | Политика размещения ресурсов для экземпляров, используемых для конфигурации размещения. |
|
availability_domain_count целое число |
Количество областей доступности, по которым будут распределены экземпляры. Если два экземпляра находятся в разных областях доступности, они не будут размещены в одной сети с низкой задержкой. |
|
collocation строка |
Collocation определяет, следует ли размещать виртуальные машины в одной области доступности в одной сети с низкой задержкой. Укажите `COLLOCATED`, чтобы включить collocation. Может быть указан только вместе с `vm_count`. Если виртуальные машины создаются с политикой COLLOCATED, то ровно `vm_count` виртуальных машин должны быть созданы одновременно с прикрепленной политикой ресурса. Некоторые допустимые варианты: «COLLOCATED» |
|
vm_count целое число |
Количество виртуальных машин в этой группе размещения. |
instance_schedule_policy словарь | Политика ресурса для планирования операций экземпляра. |
|
expiration_time строка |
Время истечения срока действия расписания. Маркер времени — строка в формате RFC3339. |
|
start_time строка |
Время начала расписания. Маркер времени — строка в формате RFC3339. |
|
time_zone строка / обязательно |
Указывает часовой пояс, используемый для интерпретации расписания. Значение этого поля должно быть названием часового пояса из базы данных tz: http://en.wikipedia.org/wiki/Tz_database. |
|
vm_start_schedule словарь |
Указывает расписание запуска экземпляров. |
|
schedule строка / обязательно |
Указывает частоту операции в формате unix-cron. |
|
vm_stop_schedule словарь |
Указывает расписание остановки экземпляров. |
|
schedule строка / обязательно |
Указывает частоту операции в формате unix-cron. |
name строка / обязательно | Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя ресурса должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])`?, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
project строка | Проект Google Cloud Platform для использования. |
region строка / обязательно | Регион, в котором находится политика ресурса. |
scopes список / элементы=строка | Массив используемых областей. |
service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, представленное либо в виде словаря, либо в виде JSON-строки. |
service_account_email string | Необязательный адрес электронной почты учетной записи сервисного обслуживания, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к файлу JSON учетной записи сервисного обслуживания, если в качестве типа выбран serviceaccount. |
snapshot_schedule_policy dictionary | Политика создания снимков постоянных дисков. |
|
retention_policy dictionary |
Политика хранения, применяемая к снимкам, созданным этой политикой ресурсов. |
|
max_retention_days integer / required |
Максимальный допустимый срок хранения снимка. |
|
on_source_disk_delete string |
Указывает поведение, которое необходимо применить к запланированным снимкам при удалении исходного диска. Некоторые допустимые варианты: «KEEP_AUTO_SNAPSHOTS», «APPLY_RETENTION_POLICY» Default: |
|
schedule dictionary / required |
Содержит один из параметров `hourlySchedule`, `dailySchedule` или `weeklySchedule`. |
|
daily_schedule dictionary |
Политика будет выполняться каждые n дней в указанное время. |
|
days_in_cycle integer / required |
Количество дней между снимками. |
|
start_time string / required |
Должно быть в формате UTC, который соответствует одному из значений: 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, 13:00-5 и 08:00 являются допустимыми. |
|
hourly_schedule dictionary |
Политика будет выполняться каждые n часов, начиная с указанного времени. |
|
hours_in_cycle integer / required |
Количество часов между снимками. |
|
start_time string / required |
Время в пределах окна для начала операций. Должно быть в часовом формате «ЧЧ:ММ», где ЧЧ: [00-23] и ММ: [00] GMT. Например: 21:00. |
|
weekly_schedule dictionary |
Позволяет указать время снимка для каждого дня недели. |
|
day_of_weeks list / elements=dictionary / required |
Может содержать до семи (по одному для каждого дня недели) времен снимка. |
|
day string / required |
День недели для создания снимка. Например, MONDAY. Некоторые допустимые варианты: «MONDAY», «TUESDAY», «WEDNESDAY», «THURSDAY», «FRIDAY», «SATURDAY», «SUNDAY» |
|
start_time string / required |
Время в пределах окна для начала операций. Должно быть в формате «ЧЧ:ММ», где ЧЧ: [00-23] и ММ: [00-00] GMT. |
|
snapshot_properties dictionary |
Свойства, с помощью которых создаются снимки, например, метки. |
|
guest_flush boolean |
Необходимо ли выполнить снимок с учетом гостевой ОС. Choices:
|
|
labels dictionary |
Набор пар «ключ-значение». |
|
storage_locations list / elements=string |
Расположение корзины Cloud Storage для хранения автоматического снимка (региональное или многорегиональное). |
состояние строка | Существует ли данный объект в GCP Варианты:
|
Примеры
- name: create a resource policy
google.cloud.gcp_compute_resource_policy:
name: test_object
region: us-central1
snapshot_schedule_policy:
schedule:
daily_schedule:
days_in_cycle: 1
start_time: '04:00'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
description строка | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращаемое значение: успех |
groupPlacementPolicy сложный | Политика ресурса для виртуальных машин, используемая для конфигурации размещения. Возвращаемое значение: успех |
|
availabilityDomainCount целое число |
Количество областей доступности, по которым будут распределены виртуальные машины. Если две виртуальные машины находятся в разных областях доступности, они не будут помещены в одну сеть с низкой задержкой. Возвращаемое значение: успех |
|
collocation строка |
Collocation указывает, следует ли размещать виртуальные машины в одной и той же области доступности в одной и той же сети с низкой задержкой. Укажите `COLLOCATED`, чтобы включить collocation. Может быть указано только с `vm_count`. Если виртуальные машины создаются с политикой COLLOCATED, то ровно `vm_count` виртуальных машин должны быть созданы одновременно с прикрепленной политикой ресурса. Возвращаемое значение: успех |
|
vmCount целое число |
Количество виртуальных машин в этой группе размещения. Возвращаемое значение: успех |
instanceSchedulePolicy сложный | Политика ресурса для планирования операций с виртуальными машинами. Возвращаемое значение: успех |
|
expirationTime строка |
Время истечения срока действия расписания. Маркер времени — строка в формате RFC3339. Возвращаемое значение: успех |
|
startTime строка |
Время начала расписания. Маркер времени — строка в формате RFC3339. Возвращаемое значение: успех |
|
timeZone строка |
Указывает часовой пояс для интерпретации расписания. Значение этого поля должно быть названием часового пояса из базы данных tz: http://en.wikipedia.org/wiki/Tz_database. Возвращаемое значение: успех |
|
vmStartSchedule сложный |
Указывает расписание для запуска виртуальных машин. Возвращаемое значение: успех |
|
schedule строка |
Указывает частоту выполнения операции, используя формат unix-cron. Возвращаемое значение: успех |
|
vmStopSchedule сложный |
Указывает расписание для остановки виртуальных машин. Возвращаемое значение: успех |
|
schedule строка |
Указывает частоту выполнения операции, используя формат unix-cron. Возвращаемое значение: успех |
name строка | Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя ресурса должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])`?, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращаемое значение: успех |
region строка | Регион, в котором находится политика ресурса. Возвращаемое значение: успех |
snapshotSchedulePolicy сложный | Политика создания снимков постоянных дисков. Возвращаемое значение: успех |
|
retentionPolicy сложный |
Политика хранения, применяемая к снимкам, созданным этой политикой ресурса. Возвращаемое значение: успех |
|
maxRetentionDays целое число |
Максимальная продолжительность хранения снимка. Возвращаемое значение: успех |
|
onSourceDiskDelete строка |
Указывает поведение, которое должно применяться к запланированным снимкам при удалении исходного диска. Возвращаемое значение: успех |
|
расписание сложное |
Содержит один из `hourlySchedule`, `dailySchedule` или `weeklySchedule`. Возвращаемое значение: успех |
|
dailySchedule сложное |
Политика будет выполняться каждый n-ый день в указанное время. Возвращаемое значение: успех |
|
daysInCycle целое число |
Количество дней между снимками. Возвращаемое значение: успех |
|
startTime строка |
Это должно быть в формате UTC, который разрешается к одному из 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, оба 13:00-5 и 08:00 допустимы. Возвращаемое значение: успех |
|
hourlySchedule сложное |
Политика будет выполняться каждую n-ую ч в указанное время. Возвращаемое значение: успех |
|
hoursInCycle целое число |
Количество часов между снимками. Возвращаемое значение: успех |
|
startTime строка |
Время в течение окна для начала операций. Оно должно быть в формате часов «ЧЧ:ММ», где ЧЧ : [00-23] и ММ : [00] по Гринвичу. Например: 21:00. Возвращаемое значение: успех |
|
weeklySchedule сложное |
Позволяет указать время снимка для каждого дня недели. Возвращаемое значение: успех |
|
dayOfWeeks сложное |
Может содержать до семи (по одному на каждый день недели) времен снимка. Возвращаемое значение: успех |
|
day строка |
День недели для создания снимка. Например, ПОНЕДЕЛЬНИК. Возвращаемое значение: успех |
|
startTime строка |
Время в течение окна для начала операций. Оно должно быть в формате «ЧЧ:ММ», где ЧЧ : [00-23] и ММ : [00-00] по Гринвичу. Возвращаемое значение: успех |
|
snapshotProperties сложное |
Свойства, с помощью которых создаются снимки, такие как метки. Возвращаемое значение: успех |
|
guestFlush логическое значение |
Выполнять ли «осознающий гостя» снимок? Возвращаемое значение: успех |
|
метки словарь |
Набор пар ключ-значение. Возвращаемое значение: успех |
|
storageLocations список / элементы=строка |
Расположение облачного хранилища Google Cloud Storage для хранения автоматического снимка (региональное или многорегиональное). Возвращаемое значение: успех |
Ссылки на коллекцию
© 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_module.html
