Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_resource_policy — создание 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.

  • Краткое описание
  • Требования
  • Параметры
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Политика, которую можно прикрепить к ресурсу для задания или планирования действий с этим ресурсом.

Требования

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

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

env_type

string

Указывает среду Ansible, в которой выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Это влияет только на строку User Agent для любых запросов к API.

group_placement_policy

dictionary

Политика ресурсов для экземпляров, используемых при настройке размещения.

availability_domain_count

integer

Количество доменов доступности, между которыми будут распределены экземпляры. Если два экземпляра находятся в разных доменах доступности, они не будут размещены в одной сети с низкой задержкой.

collocation

string

Параметр collocation указывает, следует ли размещать виртуальные машины в одном домене доступности в одной сети с низкой задержкой.

Укажите `COLLOCATED`, чтобы включить совместное размещение. Можно указать только вместе с `vm_count`. Если вычислительные экземпляры создаются с политикой COLLOCATED, одновременно необходимо создать ровно `vm_count` экземпляров с прикрепленной политикой ресурсов.

Допустимый вариант: «COLLOCATED»

vm_count

integer

Количество виртуальных машин в этой группе размещения.

instance_schedule_policy

dictionary

Политика ресурсов для планирования операций с экземплярами.

expiration_time

string

Время окончания действия расписания. Метка времени задается в формате RFC3339.

start_time

string

Время начала действия расписания. Метка времени задается в формате RFC3339.

time_zone

string / обязательный

Указывает часовой пояс, используемый для интерпретации расписания. Значение этого поля должно быть названием часового пояса из базы данных tz: http://en.wikipedia.org/wiki/Tz_database.

vm_start_schedule

dictionary

Задает расписание запуска экземпляров.

schedule

string / обязательный

Задает периодичность операции в формате unix-cron.

vm_stop_schedule

dictionary

Задает расписание остановки экземпляров.

schedule

string / обязательный

Задает периодичность операции в формате unix-cron.

name

string / обязательный

Имя ресурса, заданное клиентом при первоначальном создании ресурса. Длина имени ресурса должна составлять от 1 до 63 символов, а само имя должно соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])`?, то есть первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

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.

snapshot_schedule_policy

dictionary

Политика создания снимков постоянных дисков.

retention_policy

dictionary

Политика хранения, применяемая к снимкам, созданным этой политикой ресурсов.

max_retention_days

integer / обязательный

Максимальный срок хранения снимка.

on_source_disk_delete

string

Указывает, как поступать с запланированными снимками при удалении исходного диска.

Допустимые варианты: «KEEP_AUTO_SNAPSHOTS», «APPLY_RETENTION_POLICY»

По умолчанию: "KEEP_AUTO_SNAPSHOTS"

schedule

dictionary / обязательный

Содержит один из параметров: `hourlySchedule`, `dailySchedule` или `weeklySchedule`.

daily_schedule

dictionary

Политика выполняется каждые n дней в указанное время.

days_in_cycle

integer / обязательный

Количество дней между созданием снимков.

start_time

string / обязательный

Значение должно быть в формате 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 / обязательный

Количество часов между созданием снимков.

start_time

string / обязательный

Время начала операций в пределах временного интервала.

Время должно быть указано в часовом формате «HH:MM», где HH : [00-23] и MM : [00] по Гринвичу.

Например: 21:00.

weekly_schedule

dictionary

Позволяет указать время создания снимка для каждого дня недели.

day_of_weeks

list / элементы=dictionary / обязательный

Может содержать до семи значений времени создания снимка (по одному на каждый день недели).

day

string / обязательный

День недели, в который создается снимок, например MONDAY.

Допустимые варианты: «MONDAY», «TUESDAY», «WEDNESDAY», «THURSDAY», «FRIDAY», «SATURDAY», «SUNDAY»

start_time

string / обязательный

Время начала операций в пределах временного интервала.

Время должно быть указано в формате «HH:MM», где HH : [00-23] и MM : [00-00] по Гринвичу.

snapshot_properties

dictionary

Свойства, применяемые при создании снимков, например метки.

guest_flush

boolean

Следует ли создавать снимок с учетом состояния гостевой системы.

Варианты:

  • false
  • true

labels

dictionary

Набор пар «ключ — значение».

storage_locations

list / элементы=string

Расположение бакета Cloud Storage для хранения автоматических снимков (региональное или мульти-региональное).

state

string

Указывает, должен ли данный объект существовать в GCP.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примеры

- 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

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 / elements=string

Расположение сегмента Cloud Storage для хранения автоматического снимка (региональное или мультирегиональное).

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API