Class: Ansible::Ruby::Modules::Purefa_pgsnap

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/storage/purestorage/purefa_pgsnap.rb

Overview

Create or delete local protection group snapshots on Pure Storage FlashArray. This module only supports local protection groups.

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

#eradicate ⇒ :yes, ...

Returns Define whether to eradicate the snapshot on delete or leave in trash.

Returns:

  • (:yes, :no, nil) —

    Define whether to eradicate the snapshot on delete or leave in trash.



25
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_pgsnap.rb', line 25

attribute :eradicate

#name ⇒ String

Returns The name of the source protection group.

Returns:

  • (String) —

    The name of the source protection group.



13
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_pgsnap.rb', line 13

attribute :name

#restore ⇒ String?

Returns Restore a specific volume from a protection group snapshot. This implies overwrite of the current full volume. USE WITH CARE!!.

Returns:

  • (String, nil) —

    Restore a specific volume from a protection group snapshot. This implies overwrite of the current full volume. USE WITH CARE!!



29
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_pgsnap.rb', line 29

attribute :restore

#state ⇒ :absent, ...

Returns Define whether the protection group snapshot should exist or not. Copy (added in 2.7) will force an overwrite of an exisitng volume from a snapshot.

Returns:

  • (:absent, :present, :copy, nil) —

    Define whether the protection group snapshot should exist or not. Copy (added in 2.7) will force an overwrite of an exisitng volume from a snapshot.



21
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_pgsnap.rb', line 21

attribute :state

#suffix ⇒ String?

Returns Suffix of snapshot name.

Returns:

  • (String, nil) —

    Suffix of snapshot name.



17
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_pgsnap.rb', line 17

attribute :suffix