google.cloud.gcp_resourcemanager_project_info – Gather info for GCP Project

Note

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

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

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

Synopsis

  • Gather info for GCP Project

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 Choices/Defaults Comments
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
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.

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 a project
  gcp_resourcemanager_project_info:
    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 Returned Description
resources
complex
always
List of resources

 
createTime
string
success
Time of creation.

 
id
string
success
The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter.
Trailing hyphens are prohibited.

 
labels
dictionary
success
The labels associated with this Project.
Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
No more than 256 labels can be associated with a given resource.
Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed .

 
lifecycleState
string
success
The Project lifecycle state.

 
name
string
success
The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.

 
number
integer
success
Number uniquely identifying the project.

 
parent
complex
success
A parent organization.

   
id
string
success
Id of the organization.

   
type
string
success
Must be organization.



Authors

  • Google Inc. (@googlecloudplatform)