google.cloud.gcp_compute_resource_policy 模块 – 创建 GCP 资源策略

注意

此模块是 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。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在未解决的健全性测试失败。有关更多信息，请参阅讨论主题。

概要 

可以附加到资源的策略，用于指定或安排对该资源的操作。

要求 

执行此模块的主机需要以下要求。

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description 字符串	此资源的可选描述。创建资源时提供此属性。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
group_placement_policy 字典	用于放置配置的实例的资源策略。
availability_domain_count 整数	实例将在其间分布的可用性域数量。如果两个实例位于不同的可用性域，则它们不会放在同一个低延迟网络中。
collocation 字符串	Collocation 指定是否将虚拟机放在同一可用性域的同一低延迟网络上。指定 `COLLOCATED` 以启用并置。只能与 `vm_count` 一起指定。如果使用 COLLOCATED 策略创建计算实例，则必须同时使用附加的资源策略创建 exactly `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 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
snapshot_schedule_policy 字典	创建持久性磁盘快照的策略。
retention_policy 字典	应用于此资源策略创建的快照的保留策略。
max_retention_days 整数 / 必需	允许保留的快照的最大期限（天数）。
on_source_disk_delete 字符串	指定在源磁盘删除时应用于计划快照的行为。一些有效的选项包括：“KEEP_AUTO_SNAPSHOTS”、“APPLY_RETENTION_POLICY” 默认值： `"KEEP_AUTO_SNAPSHOTS"`
schedule 字典 / 必需	包含 `hourlySchedule`、`dailySchedule` 或 `weeklySchedule` 之一。
daily_schedule 字典	策略将在指定时间每隔 n 天执行。
days_in_cycle 整数 / 必需	快照之间的时间间隔（天数）。
start_time 字符串 / 必需	必须使用 UTC 格式，解析结果为 00:00、04:00、08:00、12:00、16:00 或 20:00 之一。例如，13:00-5 和 08:00 均有效。
hourly_schedule 字典	策略将在指定时间开始，每隔 n 小时执行。
hours_in_cycle 整数 / 必需	快照之间的时间间隔（小时数）。
start_time 字符串 / 必需	操作开始的时间窗口。必须使用小时格式“HH:MM”，其中 HH：[00-23]，MM：[00] GMT。例如：21:00。
weekly_schedule 字典	允许为每周的每一天指定快照时间。
day_of_weeks 列表 / 元素=字典 / 必需	最多可以包含七个快照时间（每周一天一个）。
day 字符串 / 必需	创建快照的星期几，例如 MONDAY。有效选项包括：“MONDAY”、“TUESDAY”、“WEDNESDAY”、“THURSDAY”、“FRIDAY”、“SATURDAY”、“SUNDAY”
start_time 字符串 / 必需	操作开始的时间窗口。必须使用格式“HH:MM”，其中 HH：[00-23]，MM：[00] GMT。
snapshot_properties 字典	创建快照时使用的属性，例如标签。
guest_flush 布尔值	是否执行“了解客户机”快照。选项 `false` `true`
labels 字典	一组键值对。
storage_locations 列表 / 元素=字符串	存储自动快照的云存储存储桶位置（区域或多区域）。
state 字符串	给定对象是否应该存在于 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 字符串	此资源的可选描述。创建资源时提供此属性。返回： success
groupPlacementPolicy 复杂类型	用于放置配置的实例的资源策略。返回： success
availabilityDomainCount 整数	实例将在其间分布的可用性域数量。如果两个实例位于不同的可用性域，则它们不会放在同一个低延迟网络中。返回： success
collocation 字符串	Collocation 指定是否将虚拟机放在同一可用性域的同一低延迟网络上。指定 `COLLOCATED` 以启用并置。只能与 `vm_count` 一起指定。如果使用 COLLOCATED 策略创建计算实例，则必须同时使用附加的资源策略创建 exactly `vm_count` 个实例。返回： success
vmCount 整数	此放置组中的虚拟机数量。返回： success
instanceSchedulePolicy 复杂类型	用于安排实例操作的资源策略。返回： success
expirationTime 字符串	计划的过期时间。时间戳是 RFC3339 字符串。返回： success
startTime 字符串	计划的开始时间。时间戳是 RFC3339 字符串。返回： success
timeZone 字符串	指定用于解释计划的时间区域。此字段的值必须是 tz 数据库中的时区名称：http://en.wikipedia.org/wiki/Tz_database。返回： success
vmStartSchedule 复杂类型	指定启动实例的计划。返回： success
schedule 字符串	使用 unix-cron 格式指定操作的频率。返回： success
vmStopSchedule 复杂类型	指定停止实例的计划。返回： success
schedule 字符串	使用 unix-cron 格式指定操作的频率。返回： success
name 字符串	最初创建资源时由客户端提供的资源名称。资源名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9][a-z0-9])`？这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。返回：* success
region 字符串	资源策略所在的区域。返回： success
snapshotSchedulePolicy 复杂类型	创建持久性磁盘快照的策略。返回： success
retentionPolicy 复杂类型	应用于此资源策略创建的快照的保留策略。返回： success
maxRetentionDays 整数	允许保留的快照的最大期限（天数）。返回： success
onSourceDiskDelete 字符串	指定在源磁盘删除时应用于计划快照的行为。返回： success
schedule 复杂类型	包含 `hourlySchedule`、`dailySchedule` 或 `weeklySchedule` 之一。返回： success
dailySchedule 复杂类型	策略将在指定时间每隔 n 天执行。返回： success
daysInCycle 整数	快照之间的时间间隔（天数）。返回： success
startTime 字符串	必须使用 UTC 格式，解析结果为 00:00、04:00、08:00、12:00、16:00 或 20:00 之一。例如，13:00-5 和 08:00 均有效。返回： success
hourlySchedule 复杂类型	策略将在指定时间开始，每隔 n 小时执行。返回： success
hoursInCycle 整数	快照之间的时间间隔（小时数）。返回： success
startTime 字符串	操作开始的时间窗口。必须使用小时格式“HH:MM”，其中 HH：[00-23]，MM：[00] GMT。例如：21:00。返回： success
weeklySchedule 复杂类型	允许为每周的每一天指定快照时间。返回： success
dayOfWeeks 复杂类型	最多可以包含七个快照时间（每周一天一个）。返回： success
day 字符串	创建快照的星期几，例如 MONDAY。返回： success
startTime 字符串	操作开始的时间窗口。必须使用格式“HH:MM”，其中 HH：[00-23]，MM：[00] GMT。返回： success
snapshotProperties 复杂类型	创建快照时使用的属性，例如标签。返回： success
guestFlush 布尔值	是否执行“了解客户机”快照。返回： success
labels 字典	一组键值对。返回： success
storageLocations 列表 / 元素=字符串	存储自动快照的云存储存储桶位置（区域或多区域）。返回： success

作者

Google Inc. (@googlecloudplatform)