/ home / delowan / delowan.googlecloud / 1.0.2 / module / gcp_filestore_instance

delowan.googlecloud.gcp_filestore_instance (1.0.2) — module

Creates a GCP Instance

Authors: Google Inc. (@googlecloudplatform)

preview | supported by community

Install collection

Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2

Add to requirements.yml

  collections:
    - name: delowan.googlecloud
      version: 1.0.2

Description

A Google Cloud Filestore instance.

Requirements

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

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

name:
description:
- The resource name of the instance.
required: true
type: str

tier:
description:
- The service tier of the instance.
- 'Some valid choices include: "TIER_UNSPECIFIED", "STANDARD", "PREMIUM", "BASIC_HDD",
"BASIC_SSD", "HIGH_SCALE_SSD"'
required: true
type: str

zone:
description:
- The name of the Filestore zone of the instance.
required: true
type: str

state:
choices:
- present
- absent
default: present
description:
- Whether the given object should exist in GCP
type: str

labels:
description:
- Resource labels to represent user-provided metadata.
required: false
type: dict

scopes:
description:
- Array of scopes to be used
elements: str
type: list

project:
description:
- The Google Cloud Platform project to use.
type: str

env_type:
description:
- Specifies which Ansible environment you're running this module within.
- This should not be set unless you know what you're doing.
- This only alters the User Agent string for any API requests.
type: str

networks:
description:
- VPC networks to which the instance is connected. For this version, only a single
network is supported.
elements: dict
required: true
suboptions:
modes:
description:
- IP versions for which the instance has IP addresses assigned.
elements: str
required: true
type: list
network:
description:
- The name of the GCE VPC network to which the instance is connected.
required: true
type: str
reserved_ip_range:
description:
- A /29 CIDR block that identifies the range of IP addresses reserved for this
instance.
required: false
type: str
type: list

auth_kind:
choices:
- application
- machineaccount
- serviceaccount
description:
- The type of credential used.
required: true
type: str

description:
description:
- A description of the instance.
required: false
type: str

file_shares:
description:
- File system shares on the instance. For this version, only a single file share is
supported.
elements: dict
required: true
suboptions:
capacity_gb:
description:
- File share capacity in GiB. This must be at least 1024 GiB for the standard
tier, or 2560 GiB for the premium tier.
required: true
type: int
name:
description:
- The name of the fileshare (16 characters or less) .
required: true
type: str
type: list

service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path

service_account_email:
description:
- An optional service account email address if machineaccount is selected and the
user does not wish to use the default email.
type: str

service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a JSON
string that represents it.
type: jsonarg

Outputs

createTime:
  description:
  - Creation timestamp in RFC3339 text format.
  returned: success
  type: str
description:
  description:
  - A description of the instance.
  returned: success
  type: str
etag:
  description:
  - Server-specified ETag for the instance resource to prevent simultaneous updates
    from overwriting each other.
  returned: success
  type: str
fileShares:
  contains:
    capacityGb:
      description:
      - File share capacity in GiB. This must be at least 1024 GiB for the standard
        tier, or 2560 GiB for the premium tier.
      returned: success
      type: int
    name:
      description:
      - The name of the fileshare (16 characters or less) .
      returned: success
      type: str
  description:
  - File system shares on the instance. For this version, only a single file share
    is supported.
  returned: success
  type: complex
labels:
  description:
  - Resource labels to represent user-provided metadata.
  returned: success
  type: dict
name:
  description:
  - The resource name of the instance.
  returned: success
  type: str
networks:
  contains:
    ipAddresses:
      description:
      - A list of IPv4 or IPv6 addresses.
      returned: success
      type: list
    modes:
      description:
      - IP versions for which the instance has IP addresses assigned.
      returned: success
      type: list
    network:
      description:
      - The name of the GCE VPC network to which the instance is connected.
      returned: success
      type: str
    reservedIpRange:
      description:
      - A /29 CIDR block that identifies the range of IP addresses reserved for this
        instance.
      returned: success
      type: str
  description:
  - VPC networks to which the instance is connected. For this version, only a single
    network is supported.
  returned: success
  type: complex
tier:
  description:
  - The service tier of the instance.
  returned: success
  type: str
zone:
  description:
  - The name of the Filestore zone of the instance.
  returned: success
  type: str