Class: Ansible::Ruby::Modules::Purefa_snap

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

Overview

Create or delete volumes and volume snapshots on Pure Storage FlashArray.

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.



32
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_snap.rb', line 32

attribute :eradicate

#name ⇒ String

Returns The name of the source volume.

Returns:

  • (String) —

    The name of the source volume.



12
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_snap.rb', line 12

attribute :name

#overwrite ⇒ :yes, ...

Returns Define whether to overwrite existing volume when creating from snapshot.

Returns:

  • (:yes, :no, nil) —

    Define whether to overwrite existing volume when creating from snapshot.



24
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_snap.rb', line 24

attribute :overwrite

#state ⇒ :absent, ...

Returns Define whether the volume snapshot should exist or not.

Returns:

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

    Define whether the volume snapshot should exist or not.



28
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_snap.rb', line 28

attribute :state

#suffix ⇒ String?

Returns Suffix of snapshot name.

Returns:

  • (String, nil) —

    Suffix of snapshot name.



16
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_snap.rb', line 16

attribute :suffix

#target ⇒ String?

Returns Name of target volume if creating from snapshot.

Returns:

  • (String, nil) —

    Name of target volume if creating from snapshot.



20
 
# File 'lib/ansible/ruby/modules/generated/storage/purestorage/purefa_snap.rb', line 20

attribute :target