gcp_compute_disk_facts - Gather facts for GCP Disk¶

New in version 2.7.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Gather facts for GCP Disk

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 required	Choices: machineaccount serviceaccount application	The type of credential used.
filters		A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters. Each additional filter in the list will act be added as an AND condition (filter1 and filter2)
project	Default: None	The Google Cloud Platform project to use.
scopes		Array of scopes to be used.
service_account_email		An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file		The path of a Service Account JSON file if serviceaccount is selected as type.
zone required		A reference to the zone where the disk resides.

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_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:  a disk facts
  gcp_compute_disk_facts:
      zone: us-central1-a
      filters:
      - name = test_object
      project: test_project
      auth_kind: service_account
      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
items complex			always	List of items
	size_gb int		success	Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
	description str		success	An optional description of this resource. Provide this property when you create the resource.
	source_snapshot dict		success	The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: * `https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot` * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` .
	last_detach_timestamp str		success	Last dettach timestamp in RFC3339 text format.
	labels dict		success	Labels to apply to this disk. A list of key->value pairs.
	licenses list		success	Any applicable publicly visible licenses.
	disk_encryption_key complex		success	Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
		raw_key str	success	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
		sha256 str	success	The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
	source_snapshot_encryption_key complex		success	The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
		raw_key str	success	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
		sha256 str	success	The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
	source_image str		success	The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: projects/debian-cloud/global/images/family/debian-8 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD To create a disk with a private image that you created, specify the image name in the following format: global/images/my-private-image You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-private-family .
	users list		success	Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance .
	name str		success	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
	zone str		success	A reference to the zone where the disk resides.
	source_snapshot_id str		success	The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
	id int		success	The unique identifier for the resource.
	source_image_id str		success	The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
	creation_timestamp str		success	Creation timestamp in RFC3339 text format.
	source_image_encryption_key complex		success	The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
		raw_key str	success	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
		sha256 str	success	The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
	last_attach_timestamp str		success	Last attach timestamp in RFC3339 text format.
	type str		success	URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.