Class: Ansible::Ruby::Modules::Gce_snapshot

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb

Overview

Manages snapshots for GCE instances. This module manages snapshots for the storage volumes of a GCE compute instance. If there are multiple volumes, each snapshot will be prepended with the disk name

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#credentials_file ⇒ String

Returns The path to the credentials file associated with the service account.

Returns:

  • (String) —

    The path to the credentials file associated with the service account



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb', line 32

attribute :credentials_file

#disks ⇒ String?

Returns A list of disks to create snapshots for. If none is provided, all of the volumes will be snapshotted.

Returns:

  • (String, nil) —

    A list of disks to create snapshots for. If none is provided, all of the volumes will be snapshotted



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb', line 20

attribute :disks

#instance_name ⇒ String

Returns The GCE instance to snapshot.

Returns:

  • (String) —

    The GCE instance to snapshot



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb', line 12

attribute :instance_name

#project_id ⇒ String

Returns The GCP project ID to use.

Returns:

  • (String) —

    The GCP project ID to use



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb', line 36

attribute :project_id

#service_account_email ⇒ String

Returns GCP service account email for the project where the instance resides.

Returns:

  • (String) —

    GCP service account email for the project where the instance resides



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb', line 28

attribute :service_account_email

#snapshot_name ⇒ String?

Returns The name of the snapshot to manage.

Returns:

  • (String, nil) —

    The name of the snapshot to manage



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb', line 16

attribute :snapshot_name

#state ⇒ :present, ...

Returns Whether a snapshot should be C(present) or C(absent).

Returns:

  • (:present, :absent, nil) —

    Whether a snapshot should be C(present) or C(absent)



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_snapshot.rb', line 24

attribute :state