google.cloud.gcp_appengine_firewall_rule_info 模块 – 收集 GCP FirewallRule 信息

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他需求才能使用此模块，请参阅 需求 获取详细信息。

要在 playbook 中使用它，请指定：google.cloud.gcp_appengine_firewall_rule_info。

注意

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

概要

  • 收集 GCP FirewallRule 信息

需求

以下是执行此模块的主机所需的条件。

  • 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 请求的用户代理字符串。

project

字符串

要使用的 Google Cloud Platform 项目。

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 firewall rule
  gcp_appengine_firewall_rule_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

常见的返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

resources

复杂

资源列表

返回：始终

action

字符串

如果此规则匹配，则要执行的操作。

返回：成功

description

字符串

此规则的可选字符串描述。

返回：成功

priority

整数

定义规则评估顺序的正整数。

优先级最低的规则首先进行评估。

当没有先前的规则匹配时，优先级为 Int32.MaxValue 的默认规则匹配所有 IPv4 和 IPv6 流量。只有此规则的操作才能由用户修改。

返回：成功

sourceRange

字符串

此规则适用的请求的 IP 地址或范围，使用 CIDR 表示法定义。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)