community.google.gcp_storage_file – Return GC Storage content¶
Note
This plugin is part of the community.google collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.google
.
To use it in a playbook, specify: community.google.gcp_storage_file
.
Requirements¶
The below requirements are needed on the local controller node that executes this lookup.
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
Parameters¶
Notes¶
Note
for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.
for authentication, you can set service_account_contents using the c(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¶
- ansible.builtin.debug:
msg: |
the value of foo.txt is {{ lookup('community.google.gcp_storage_file',
bucket='gcp-bucket', src='mydir/foo.txt', project='project-name',
auth_kind='serviceaccount', service_account_file='/tmp/myserviceaccountfile.json') }}
Return Values¶
Common return values are documented here, the following are the fields unique to this lookup:
Key | Returned | Description |
---|---|---|
_raw
list
/ elements=string
|
success |
base64 encoded file content
|
Authors¶
Eric Anderson (!UNKNOWN) <eanderson@avinetworks.com>