google.cloud.gcp_iam_role_info – Gather info for GCP Role

Note

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

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

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

Synopsis

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

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.

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.

- name: get info on a role
  gcp_iam_role_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

Key		Returned	Description
resources complex		always	List of resources
	deleted boolean	success	The current deleted state of the role.
	description string	success	Human-readable description for the role.
	includedPermissions list / elements=string	success	Names of permissions this role grants when bound in an IAM policy.
	name string	success	The name of the role.
	stage string	success	The current launch stage of the role.
	title string	success	A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_iam_role_info_module.html