google.cloud.gcp_filestore_instance_info module – Gather info for GCP Instance

Note

This module is part of the google.cloud collection (version 1.0.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_filestore_instance_info.

Synopsis

  • Gather info for GCP Instance

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter

Comments

auth_kind

string / required

The type of credential used.

Choices:

  • application

  • machineaccount

  • serviceaccount

env_type

string

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.

project

string

The Google Cloud Platform project to use.

scopes

list / elements=string

Array of scopes to be used

service_account_contents

jsonarg

The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.

zone

string / required

The name of the Filestore zone of the instance.

Notes

Note

  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.

  • for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: get info on an instance
  gcp_filestore_instance_info:
    zone: us-central1-b
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

resources

complex

List of resources

Returned: always

createTime

string

Creation timestamp in RFC3339 text format.

Returned: success

description

string

A description of the instance.

Returned: success

etag

string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

Returned: success

fileShares

complex

File system shares on the instance. For this version, only a single file share is supported.

Returned: success

capacityGb

integer

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

name

string

The name of the fileshare (16 characters or less) .

Returned: success

labels

dictionary

Resource labels to represent user-provided metadata.

Returned: success

name

string

The resource name of the instance.

Returned: success

networks

complex

VPC networks to which the instance is connected. For this version, only a single network is supported.

Returned: success

ipAddresses

list / elements=string

A list of IPv4 or IPv6 addresses.

Returned: success

modes

list / elements=string

IP versions for which the instance has IP addresses assigned.

Returned: success

network

string

The name of the GCE VPC network to which the instance is connected.

Returned: success

reservedIpRange

string

A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

Returned: success

tier

string

The service tier of the instance.

Returned: success

zone

string

The name of the Filestore zone of the instance.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)