google.cloud.gcp_serviceusage_service – Creates a GCP Service

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_serviceusage_service.

Synopsis

  • A service that is available for use .

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.
disable_dependent_services
boolean
    Choices:
  • no
  • yes
Indicates if dependent services should also be disabled. Can only be turned on if service is disabled.
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.
name
string / required
The resource name of the service .
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.
state
string
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP

Notes

Note

  • Getting Started: https://cloud.google.com/service-usage/docs/getting-started

  • 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: create a service
  google.cloud.gcp_serviceusage_service:
    name: spanner.googleapis.com
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

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

Key Returned Description
config
complex
success
The service configuration of the available service.
 
apis
complex
success
The list of API interfaces exported by this service.
   
name
string
success
Name of the API.
   
version
string
success
The version of the API.
 
name
string
success
The DNS address at which this service is available.
 
title
string
success
The product title for this service.
disableDependentServices
boolean
success
Indicates if dependent services should also be disabled. Can only be turned on if service is disabled.
name
string
success
The resource name of the service .
parent
string
success
The name of the parent of this service. For example 'projects/123' .
state
string
success
Whether or not the service has been enabled for use by the consumer.


Authors

  • Google Inc. (@googlecloudplatform)