google.cloud.gcp_filestore_instance 模块 – 创建 GCP 实例

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_filestore_instance。

注意

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

概要 

Google Cloud Filestore 实例。

要求 

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

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 请求的用户代理字符串。
file_shares 列表 / 元素=字典 / 必填	实例上的文件系统共享。对于此版本，仅支持单个文件共享。
capacity_gb 整数 / 必填	文件共享容量（以 GiB 为单位）。对于标准层，此值必须至少为 1024 GiB，对于高级层，则必须为 2560 GiB。
name 字符串 / 必填	文件共享的名称（最多 16 个字符）。
labels 字典	表示用户提供的元数据的资源标签。
name 字符串 / 必填	实例的资源名称。
networks 列表 / 元素=字典 / 必填	连接到实例的 VPC 网络。对于此版本，仅支持单个网络。
modes 列表 / 元素=字符串 / 必填	为其分配 IP 地址的实例的 IP 版本。
network 字符串 / 必填	连接到实例的 GCE VPC 网络的名称。
reserved_ip_range 字符串	标识为此实例保留的 IP 地址范围的 /29 CIDR 块。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`
tier 字符串 / 必填	实例的服务层。一些有效的选项包括：“TIER_UNSPECIFIED”、“STANDARD”、“PREMIUM”、“BASIC_HDD”、“BASIC_SSD”、“HIGH_SCALE_SSD”
zone 字符串 / 必填	实例的 Filestore 区域的名称。

备注 

注意

API 参考：https://cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.instances/create
官方文档：https://cloud.google.com/filestore/docs/creating-instances
与 Kubernetes 一起使用：https://cloud.google.com/filestore/docs/csi-driver
复制数据进出：https://cloud.google.com/filestore/docs/copying-data
对于身份验证，您可以使用 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。
只有在未设置剧本值时，才会使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。

示例 

- name: create a instance
  google.cloud.gcp_filestore_instance:
    name: test_object
    zone: us-central1-b
    tier: PREMIUM
    file_shares:
    - capacity_gb: 2660
      name: share1
    networks:
    - network: default
      modes:
      - MODE_IPV4
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

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

键	描述
createTime 字符串	RFC3339 文本格式的创建时间戳。返回：成功
description 字符串	实例的描述。返回：成功
etag 字符串	服务器指定的实例资源的 ETag，用于防止同时更新相互覆盖。返回：成功
fileShares 复杂类型	实例上的文件系统共享。对于此版本，仅支持单个文件共享。返回：成功
capacityGb 整数	文件共享容量（以 GiB 为单位）。对于标准层，此值必须至少为 1024 GiB，对于高级层，则必须为 2560 GiB。返回：成功
name 字符串	文件共享的名称（最多 16 个字符）。返回：成功
labels 字典	表示用户提供的元数据的资源标签。返回：成功
name 字符串	实例的资源名称。返回：成功
networks 复杂类型	连接到实例的 VPC 网络。对于此版本，仅支持单个网络。返回：成功
ipAddresses 列表 / 元素=字符串	IPv4 或 IPv6 地址列表。返回：成功
modes 列表 / 元素=字符串	为其分配 IP 地址的实例的 IP 版本。返回：成功
network 字符串	连接到实例的 GCE VPC 网络的名称。返回：成功
reservedIpRange 字符串	标识为此实例保留的 IP 地址范围的 /29 CIDR 块。返回：成功
tier 字符串	实例的服务层。返回：成功
zone 字符串	实例的 Filestore 区域的名称。返回：成功

作者

Google Inc. (@googlecloudplatform)