google.cloud.gcp_compute_resource_policy_info 模块 – 收集 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_info。

注意

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

概要 

收集 GCP 资源策略信息

要求 

以下要求是在执行此模块的主机上所需的。

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
filters 列表 / 元素=字符串	过滤器值对列表。此处列出了可用的过滤器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。列表中的每个附加过滤器都将作为 AND 条件添加 (filter1 和 filter2)。
project 字符串	要使用的 Google Cloud Platform 项目。
region 字符串 / 必需	资源策略所在的区域。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

备注 

注意

对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。
对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。
对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。
对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。
只有在未设置 playbook 值时，才会使用环境变量值。
*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 复杂类型	资源列表返回：始终
description 字符串	此资源的可选描述。创建资源时提供此属性。返回：成功
groupPlacementPolicy 复杂类型	用于放置配置的实例的资源策略。返回：成功
availabilityDomainCount 整数	实例将分布在其上的可用区数量。如果两个实例位于不同的可用区，它们将不会放在同一个低延迟网络中。返回：成功
collocation 字符串	Collocation 指定是否将虚拟机放置在同一可用区上的同一低延迟网络中。指定 `COLLOCATED` 以启用位置关联。只能与 `vm_count` 一起指定。如果使用 COLLOCATED 策略创建计算实例，则必须同时使用附加的资源策略创建 exactly `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 字符串	指定在删除源磁盘时应用于计划快照的行为。返回：成功
schedule 复杂类型	包含 `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 字符串	窗口内开始操作的时间。必须使用小时格式“HH:MM”，其中 HH：[00-23]，MM：[00] GMT。例如：21:00。返回：成功
weeklySchedule 复杂类型	允许为每周的每一天指定快照时间。返回：成功
dayOfWeeks 复杂类型	最多可以包含七个（每周一天）快照时间。返回：成功
day 字符串	创建快照的星期几，例如 MONDAY。返回：成功
startTime 字符串	窗口内开始操作的时间。必须采用“HH:MM”格式，其中 HH：[00-23]，MM：[00-00] GMT。返回：成功
snapshotProperties 复杂类型	创建快照时使用的属性，例如标签。返回：成功
guestFlush 布尔值	是否执行“了解客户”快照。返回：成功
labels 字典	一组键值对。返回：成功
storageLocations 列表 / 元素=字符串	用于存储自动快照的 Cloud Storage 存储桶位置（区域或多区域）。返回：成功

作者

Google Inc. (@googlecloudplatform)