community.general.gce_pd – utilize GCE persistent disk resources

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.gce_pd.

Synopsis
Requirements
Parameters
Examples

Synopsis

This module can create and destroy unformatted GCE persistent disks https://developers.google.com/compute/docs/disks#persistentdisks. It also supports attaching and detaching disks from running instances. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Requirements

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

python >= 2.6
apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials

Parameters

Parameter	Choices/Defaults	Comments
credentials_file path		path to the JSON file associated with the service account email
delete_on_termination boolean	no yes	If `yes`, deletes the volume when instance is terminated
detach_only boolean	no yes	do not destroy the disk, merely detach it from an instance
disk_type string	Default: "pd-standard"	Specify a `pd-standard` disk or `pd-ssd` for an SSD disk.
external_projects list / elements=string		A list of other projects (accessible with the provisioning credentials) to be searched for the image.
image string		the source image to use for the disk
image_family string		The image family to use to create the instance. If image has been used image_family is ignored. Cannot specify both image and source.
instance_name string		instance name if you wish to attach or detach the disk
mode string	READ_WRITE READ_ONLY ←	GCE mount mode of disk, READ_ONLY (default) or READ_WRITE
name string / required		name of the disk
pem_file path		path to the pem file associated with the service account email This option is deprecated. Use 'credentials_file'.
project_id string		your GCE project ID
service_account_email string		service account email
size_gb string	Default: "10"	whole integer size of disk (in GB) to create, default is 10 GB
snapshot string		the source snapshot to use for the disk
state string	Default: "present"	desired state of the persistent disk Available choices are: `active`, `present`, `absent`, `deleted`.
zone string	Default: "us-central1-b"	zone in which to create the disk

Examples

- name: Simple attachment action to an existing instance
  local_action:
    module: gce_pd
    instance_name: notlocalhost
    size_gb: 5
    name: pd

Authors

Eric Johnson (@erjohnso) <[email protected]>

© 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/community/general/gce_pd_module.html