Class: Ansible::Ruby::Modules::Na_elementsw_snapshot

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

Overview

Create, Modify or Delete Snapshot on Element OS Cluster.

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

#account_id ⇒ String

Returns Account ID or Name of Parent/Source Volume.

Returns:

  • (String) —

    Account ID or Name of Parent/Source Volume.



24
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 24

attribute :account_id

#enable_remote_replication ⇒ Symbol?

Returns Flag, whether to replicate the snapshot created to a remote replication cluster.,To enable specify ‘true’ value.

Returns:

  • (Symbol, nil) —

    Flag, whether to replicate the snapshot created to a remote replication cluster.,To enable specify ‘true’ value.



35
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 35

attribute :enable_remote_replication

#expiration_time ⇒ String?

Returns The date and time (format ISO 8601 date string) at which this snapshot will expire.

Returns:

  • (String, nil) —

    The date and time (format ISO 8601 date string) at which this snapshot will expire.



42
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 42

attribute :expiration_time

#name ⇒ String?

Returns Name of new snapshot create.,If unspecified, date and time when the snapshot was taken is used.

Returns:

  • (String, nil) —

    Name of new snapshot create.,If unspecified, date and time when the snapshot was taken is used.



12
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 12

attribute :name

#password ⇒ String?

Returns Element OS access account password.

Returns:

  • (String, nil) —

    Element OS access account password



46
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 46

attribute :password

#retention ⇒ Object?

Returns Retention period for the snapshot.,Format is ‘HH:mm:ss’.

Returns:

  • (Object, nil) —

    Retention period for the snapshot.,Format is ‘HH:mm:ss’.



28
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 28

attribute :retention

#snap_mirror_label ⇒ Object?

Returns Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.

Returns:

  • (Object, nil) —

    Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.



39
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 39

attribute :snap_mirror_label

#src_snapshot_id ⇒ String?

Returns ID or Name of an existing snapshot.,Required when C(state=present), to modify snapshot properties.,Required when C(state=present), to create snapshot from another snapshot in the volume.,Required when C(state=absent), to delete snapshot.

Returns:

  • (String, nil) —

    ID or Name of an existing snapshot.,Required when C(state=present), to modify snapshot properties.,Required when C(state=present), to create snapshot from another snapshot in the volume.,Required when C(state=absent), to delete snapshot.



31
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 31

attribute :src_snapshot_id

#src_volume_id ⇒ Integer, String

Returns ID or Name of active volume.

Returns:

  • (Integer, String) —

    ID or Name of active volume.



20
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 20

attribute :src_volume_id

#state ⇒ :present, ...

Returns Whether the specified snapshot should exist or not.

Returns:

  • (:present, :absent, nil) —

    Whether the specified snapshot should exist or not.



16
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 16

attribute :state

#username ⇒ String?

Returns Element OS access account user-name.

Returns:

  • (String, nil) —

    Element OS access account user-name



50
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/na_elementsw_snapshot.rb', line 50

attribute :username